target/linux/generic/backport-6.1/801-v6.4-02-net-dsa-qca8k-add-LEDs-basic-support.patch

   1 From 1e264f9d2918b5737023c44a23ae04def1095210 Mon Sep 17 00:00:00 2001
   2 From: Christian Marangi <ansuelsmth@gmail.com>
   3 Date: Mon, 17 Apr 2023 17:17:24 +0200
   4 Subject: [PATCH 2/9] net: dsa: qca8k: add LEDs basic support
   5
   6 Add LEDs basic support for qca8k Switch Family by adding basic
   7 brightness_set() support.
   8
   9 Since these LEDs refelect port status, the default label is set to
  10 ":port". DT binding should describe the color and function of the
  11 LEDs using standard LEDs api.
  12 Each LED always have the device name as prefix. The device name is
  13 composed from the mii bus id and the PHY addr resulting in example
  14 names like:
  15 - qca8k-0.0:00:amber:lan
  16 - qca8k-0.0:00:white:lan
  17 - qca8k-0.0:01:amber:lan
  18 - qca8k-0.0:01:white:lan
  19
  20 These LEDs supports only blocking variant of the brightness_set()
  21 function since they can sleep during access of the switch leds to set
  22 the brightness.
  23
  24 While at it add to the qca8k header file each mode defined by the Switch
  25 Documentation for future use.
  26
  27 Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
  28 Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
  29 Signed-off-by: David S. Miller <davem@davemloft.net>
  30 ---
  31  drivers/net/dsa/qca/Kconfig      |   8 ++
  32  drivers/net/dsa/qca/Makefile     |   3 +
  33  drivers/net/dsa/qca/qca8k-8xxx.c |   5 +
  34  drivers/net/dsa/qca/qca8k-leds.c | 239 +++++++++++++++++++++++++++++++
  35  drivers/net/dsa/qca/qca8k.h      |  60 ++++++++
  36  drivers/net/dsa/qca/qca8k_leds.h |  16 +++
  37  6 files changed, 331 insertions(+)
  38  create mode 100644 drivers/net/dsa/qca/qca8k-leds.c
  39  create mode 100644 drivers/net/dsa/qca/qca8k_leds.h
  40
  41 --- a/drivers/net/dsa/qca/Kconfig
  42 +++ b/drivers/net/dsa/qca/Kconfig
  43 @@ -15,3 +15,11 @@ config NET_DSA_QCA8K
  44         help
  45           This enables support for the Qualcomm Atheros QCA8K Ethernet
  46           switch chips.
  47 +
  48 +config NET_DSA_QCA8K_LEDS_SUPPORT
  49 +       bool "Qualcomm Atheros QCA8K Ethernet switch family LEDs support"
  50 +       depends on NET_DSA_QCA8K
  51 +       depends on LEDS_CLASS
  52 +       help
  53 +         This enabled support for LEDs present on the Qualcomm Atheros
  54 +         QCA8K Ethernet switch chips.
  55 --- a/drivers/net/dsa/qca/Makefile
  56 +++ b/drivers/net/dsa/qca/Makefile
  57 @@ -2,3 +2,6 @@
  58  obj-$(CONFIG_NET_DSA_AR9331)   += ar9331.o
  59  obj-$(CONFIG_NET_DSA_QCA8K)    += qca8k.o
  60  qca8k-y                        += qca8k-common.o qca8k-8xxx.o
  61 +ifdef CONFIG_NET_DSA_QCA8K_LEDS_SUPPORT
  62 +qca8k-y                                += qca8k-leds.o
  63 +endif
  64 --- a/drivers/net/dsa/qca/qca8k-8xxx.c
  65 +++ b/drivers/net/dsa/qca/qca8k-8xxx.c
  66 @@ -22,6 +22,7 @@
  67  #include <linux/dsa/tag_qca.h>
  68
  69  #include "qca8k.h"
  70 +#include "qca8k_leds.h"
  71
  72  static void
  73  qca8k_split_addr(u32 regaddr, u16 *r1, u16 *r2, u16 *page)
  74 @@ -1851,6 +1852,10 @@ qca8k_setup(struct dsa_switch *ds)
  75         if (ret)
  76                 return ret;
  77
  78 +       ret = qca8k_setup_led_ctrl(priv);
  79 +       if (ret)
  80 +               return ret;
  81 +
  82         qca8k_setup_pcs(priv, &priv->pcs_port_0, 0);
  83         qca8k_setup_pcs(priv, &priv->pcs_port_6, 6);
  84
  85 --- /dev/null
  86 +++ b/drivers/net/dsa/qca/qca8k-leds.c
  87 @@ -0,0 +1,239 @@
  88 +// SPDX-License-Identifier: GPL-2.0
  89 +#include <linux/regmap.h>
  90 +#include <net/dsa.h>
  91 +
  92 +#include "qca8k.h"
  93 +#include "qca8k_leds.h"
  94 +
  95 +static int
  96 +qca8k_get_enable_led_reg(int port_num, int led_num, struct qca8k_led_pattern_en *reg_info)
  97 +{
  98 +       switch (port_num) {
  99 +       case 0:
 100 +               reg_info->reg = QCA8K_LED_CTRL_REG(led_num);
 101 +               reg_info->shift = QCA8K_LED_PHY0123_CONTROL_RULE_SHIFT;
 102 +               break;
 103 +       case 1:
 104 +       case 2:
 105 +       case 3:
 106 +               /* Port 123 are controlled on a different reg */
 107 +               reg_info->reg = QCA8K_LED_CTRL3_REG;
 108 +               reg_info->shift = QCA8K_LED_PHY123_PATTERN_EN_SHIFT(port_num, led_num);
 109 +               break;
 110 +       case 4:
 111 +               reg_info->reg = QCA8K_LED_CTRL_REG(led_num);
 112 +               reg_info->shift = QCA8K_LED_PHY4_CONTROL_RULE_SHIFT;
 113 +               break;
 114 +       default:
 115 +               return -EINVAL;
 116 +       }
 117 +
 118 +       return 0;
 119 +}
 120 +
 121 +static int
 122 +qca8k_led_brightness_set(struct qca8k_led *led,
 123 +                        enum led_brightness brightness)
 124 +{
 125 +       struct qca8k_led_pattern_en reg_info;
 126 +       struct qca8k_priv *priv = led->priv;
 127 +       u32 mask, val;
 128 +
 129 +       qca8k_get_enable_led_reg(led->port_num, led->led_num, &reg_info);
 130 +
 131 +       val = QCA8K_LED_ALWAYS_OFF;
 132 +       if (brightness)
 133 +               val = QCA8K_LED_ALWAYS_ON;
 134 +
 135 +       /* HW regs to control brightness is special and port 1-2-3
 136 +        * are placed in a different reg.
 137 +        *
 138 +        * To control port 0 brightness:
 139 +        * - the 2 bit (15, 14) of:
 140 +        *   - QCA8K_LED_CTRL0_REG for led1
 141 +        *   - QCA8K_LED_CTRL1_REG for led2
 142 +        *   - QCA8K_LED_CTRL2_REG for led3
 143 +        *
 144 +        * To control port 4:
 145 +        * - the 2 bit (31, 30) of:
 146 +        *   - QCA8K_LED_CTRL0_REG for led1
 147 +        *   - QCA8K_LED_CTRL1_REG for led2
 148 +        *   - QCA8K_LED_CTRL2_REG for led3
 149 +        *
 150 +        * To control port 1:
 151 +        *   - the 2 bit at (9, 8) of QCA8K_LED_CTRL3_REG are used for led1
 152 +        *   - the 2 bit at (11, 10) of QCA8K_LED_CTRL3_REG are used for led2
 153 +        *   - the 2 bit at (13, 12) of QCA8K_LED_CTRL3_REG are used for led3
 154 +        *
 155 +        * To control port 2:
 156 +        *   - the 2 bit at (15, 14) of QCA8K_LED_CTRL3_REG are used for led1
 157 +        *   - the 2 bit at (17, 16) of QCA8K_LED_CTRL3_REG are used for led2
 158 +        *   - the 2 bit at (19, 18) of QCA8K_LED_CTRL3_REG are used for led3
 159 +        *
 160 +        * To control port 3:
 161 +        *   - the 2 bit at (21, 20) of QCA8K_LED_CTRL3_REG are used for led1
 162 +        *   - the 2 bit at (23, 22) of QCA8K_LED_CTRL3_REG are used for led2
 163 +        *   - the 2 bit at (25, 24) of QCA8K_LED_CTRL3_REG are used for led3
 164 +        *
 165 +        * To abstract this and have less code, we use the port and led numm
 166 +        * to calculate the shift and the correct reg due to this problem of
 167 +        * not having a 1:1 map of LED with the regs.
 168 +        */
 169 +       if (led->port_num == 0 || led->port_num == 4) {
 170 +               mask = QCA8K_LED_PATTERN_EN_MASK;
 171 +               val <<= QCA8K_LED_PATTERN_EN_SHIFT;
 172 +       } else {
 173 +               mask = QCA8K_LED_PHY123_PATTERN_EN_MASK;
 174 +       }
 175 +
 176 +       return regmap_update_bits(priv->regmap, reg_info.reg,
 177 +                                 mask << reg_info.shift,
 178 +                                 val << reg_info.shift);
 179 +}
 180 +
 181 +static int
 182 +qca8k_cled_brightness_set_blocking(struct led_classdev *ldev,
 183 +                                  enum led_brightness brightness)
 184 +{
 185 +       struct qca8k_led *led = container_of(ldev, struct qca8k_led, cdev);
 186 +
 187 +       return qca8k_led_brightness_set(led, brightness);
 188 +}
 189 +
 190 +static enum led_brightness
 191 +qca8k_led_brightness_get(struct qca8k_led *led)
 192 +{
 193 +       struct qca8k_led_pattern_en reg_info;
 194 +       struct qca8k_priv *priv = led->priv;
 195 +       u32 val;
 196 +       int ret;
 197 +
 198 +       qca8k_get_enable_led_reg(led->port_num, led->led_num, &reg_info);
 199 +
 200 +       ret = regmap_read(priv->regmap, reg_info.reg, &val);
 201 +       if (ret)
 202 +               return 0;
 203 +
 204 +       val >>= reg_info.shift;
 205 +
 206 +       if (led->port_num == 0 || led->port_num == 4) {
 207 +               val &= QCA8K_LED_PATTERN_EN_MASK;
 208 +               val >>= QCA8K_LED_PATTERN_EN_SHIFT;
 209 +       } else {
 210 +               val &= QCA8K_LED_PHY123_PATTERN_EN_MASK;
 211 +       }
 212 +
 213 +       /* Assume brightness ON only when the LED is set to always ON */
 214 +       return val == QCA8K_LED_ALWAYS_ON;
 215 +}
 216 +
 217 +static int
 218 +qca8k_parse_port_leds(struct qca8k_priv *priv, struct fwnode_handle *port, int port_num)
 219 +{
 220 +       struct fwnode_handle *led = NULL, *leds = NULL;
 221 +       struct led_init_data init_data = { };
 222 +       struct dsa_switch *ds = priv->ds;
 223 +       enum led_default_state state;
 224 +       struct qca8k_led *port_led;
 225 +       int led_num, led_index;
 226 +       int ret;
 227 +
 228 +       leds = fwnode_get_named_child_node(port, "leds");
 229 +       if (!leds) {
 230 +               dev_dbg(priv->dev, "No Leds node specified in device tree for port %d!\n",
 231 +                       port_num);
 232 +               return 0;
 233 +       }
 234 +
 235 +       fwnode_for_each_child_node(leds, led) {
 236 +               /* Reg represent the led number of the port.
 237 +                * Each port can have at most 3 leds attached
 238 +                * Commonly:
 239 +                * 1. is gigabit led
 240 +                * 2. is mbit led
 241 +                * 3. additional status led
 242 +                */
 243 +               if (fwnode_property_read_u32(led, "reg", &led_num))
 244 +                       continue;
 245 +
 246 +               if (led_num >= QCA8K_LED_PORT_COUNT) {
 247 +                       dev_warn(priv->dev, "Invalid LED reg %d defined for port %d",
 248 +                                led_num, port_num);
 249 +                       continue;
 250 +               }
 251 +
 252 +               led_index = QCA8K_LED_PORT_INDEX(port_num, led_num);
 253 +
 254 +               port_led = &priv->ports_led[led_index];
 255 +               port_led->port_num = port_num;
 256 +               port_led->led_num = led_num;
 257 +               port_led->priv = priv;
 258 +
 259 +               state = led_init_default_state_get(led);
 260 +               switch (state) {
 261 +               case LEDS_DEFSTATE_ON:
 262 +                       port_led->cdev.brightness = 1;
 263 +                       qca8k_led_brightness_set(port_led, 1);
 264 +                       break;
 265 +               case LEDS_DEFSTATE_KEEP:
 266 +                       port_led->cdev.brightness =
 267 +                                       qca8k_led_brightness_get(port_led);
 268 +                       break;
 269 +               default:
 270 +                       port_led->cdev.brightness = 0;
 271 +                       qca8k_led_brightness_set(port_led, 0);
 272 +               }
 273 +
 274 +               port_led->cdev.max_brightness = 1;
 275 +               port_led->cdev.brightness_set_blocking = qca8k_cled_brightness_set_blocking;
 276 +               init_data.default_label = ":port";
 277 +               init_data.fwnode = led;
 278 +               init_data.devname_mandatory = true;
 279 +               init_data.devicename = kasprintf(GFP_KERNEL, "%s:0%d", ds->slave_mii_bus->id,
 280 +                                                port_num);
 281 +               if (!init_data.devicename)
 282 +                       return -ENOMEM;
 283 +
 284 +               ret = devm_led_classdev_register_ext(priv->dev, &port_led->cdev, &init_data);
 285 +               if (ret)
 286 +                       dev_warn(priv->dev, "Failed to init LED %d for port %d", led_num, port_num);
 287 +
 288 +               kfree(init_data.devicename);
 289 +       }
 290 +
 291 +       return 0;
 292 +}
 293 +
 294 +int
 295 +qca8k_setup_led_ctrl(struct qca8k_priv *priv)
 296 +{
 297 +       struct fwnode_handle *ports, *port;
 298 +       int port_num;
 299 +       int ret;
 300 +
 301 +       ports = device_get_named_child_node(priv->dev, "ports");
 302 +       if (!ports) {
 303 +               dev_info(priv->dev, "No ports node specified in device tree!");
 304 +               return 0;
 305 +       }
 306 +
 307 +       fwnode_for_each_child_node(ports, port) {
 308 +               if (fwnode_property_read_u32(port, "reg", &port_num))
 309 +                       continue;
 310 +
 311 +               /* Skip checking for CPU port 0 and CPU port 6 as not supported */
 312 +               if (port_num == 0 || port_num == 6)
 313 +                       continue;
 314 +
 315 +               /* Each port can have at most 3 different leds attached.
 316 +                * Switch port starts from 0 to 6, but port 0 and 6 are CPU
 317 +                * port. The port index needs to be decreased by one to identify
 318 +                * the correct port for LED setup.
 319 +                */
 320 +               ret = qca8k_parse_port_leds(priv, port, qca8k_port_to_phy(port_num));
 321 +               if (ret)
 322 +                       return ret;
 323 +       }
 324 +
 325 +       return 0;
 326 +}
 327 --- a/drivers/net/dsa/qca/qca8k.h
 328 +++ b/drivers/net/dsa/qca/qca8k.h
 329 @@ -11,6 +11,7 @@
 330  #include <linux/delay.h>
 331  #include <linux/regmap.h>
 332  #include <linux/gpio.h>
 333 +#include <linux/leds.h>
 334  #include <linux/dsa/tag_qca.h>
 335
 336  #define QCA8K_ETHERNET_MDIO_PRIORITY                   7
 337 @@ -85,6 +86,51 @@
 338  #define   QCA8K_MDIO_MASTER_DATA(x)                    FIELD_PREP(QCA8K_MDIO_MASTER_DATA_MASK, x)
 339  #define   QCA8K_MDIO_MASTER_MAX_PORTS                  5
 340  #define   QCA8K_MDIO_MASTER_MAX_REG                    32
 341 +
 342 +/* LED control register */
 343 +#define QCA8K_LED_PORT_COUNT                           3
 344 +#define QCA8K_LED_COUNT                                        ((QCA8K_NUM_PORTS - QCA8K_NUM_CPU_PORTS) * QCA8K_LED_PORT_COUNT)
 345 +#define QCA8K_LED_RULE_COUNT                           6
 346 +#define QCA8K_LED_RULE_MAX                             11
 347 +#define QCA8K_LED_PORT_INDEX(_phy, _led)               (((_phy) * QCA8K_LED_PORT_COUNT) + (_led))
 348 +
 349 +#define QCA8K_LED_PHY123_PATTERN_EN_SHIFT(_phy, _led)  ((((_phy) - 1) * 6) + 8 + (2 * (_led)))
 350 +#define QCA8K_LED_PHY123_PATTERN_EN_MASK               GENMASK(1, 0)
 351 +
 352 +#define QCA8K_LED_PHY0123_CONTROL_RULE_SHIFT           0
 353 +#define QCA8K_LED_PHY4_CONTROL_RULE_SHIFT              16
 354 +
 355 +#define QCA8K_LED_CTRL_REG(_i)                         (0x050 + (_i) * 4)
 356 +#define QCA8K_LED_CTRL0_REG                            0x50
 357 +#define QCA8K_LED_CTRL1_REG                            0x54
 358 +#define QCA8K_LED_CTRL2_REG                            0x58
 359 +#define QCA8K_LED_CTRL3_REG                            0x5C
 360 +#define   QCA8K_LED_CTRL_SHIFT(_i)                     (((_i) % 2) * 16)
 361 +#define   QCA8K_LED_CTRL_MASK                          GENMASK(15, 0)
 362 +#define QCA8K_LED_RULE_MASK                            GENMASK(13, 0)
 363 +#define QCA8K_LED_BLINK_FREQ_MASK                      GENMASK(1, 0)
 364 +#define QCA8K_LED_BLINK_FREQ_SHITF                     0
 365 +#define   QCA8K_LED_BLINK_2HZ                          0
 366 +#define   QCA8K_LED_BLINK_4HZ                          1
 367 +#define   QCA8K_LED_BLINK_8HZ                          2
 368 +#define   QCA8K_LED_BLINK_AUTO                         3
 369 +#define QCA8K_LED_LINKUP_OVER_MASK                     BIT(2)
 370 +#define QCA8K_LED_TX_BLINK_MASK                                BIT(4)
 371 +#define QCA8K_LED_RX_BLINK_MASK                                BIT(5)
 372 +#define QCA8K_LED_COL_BLINK_MASK                       BIT(7)
 373 +#define QCA8K_LED_LINK_10M_EN_MASK                     BIT(8)
 374 +#define QCA8K_LED_LINK_100M_EN_MASK                    BIT(9)
 375 +#define QCA8K_LED_LINK_1000M_EN_MASK                   BIT(10)
 376 +#define QCA8K_LED_POWER_ON_LIGHT_MASK                  BIT(11)
 377 +#define QCA8K_LED_HALF_DUPLEX_MASK                     BIT(12)
 378 +#define QCA8K_LED_FULL_DUPLEX_MASK                     BIT(13)
 379 +#define QCA8K_LED_PATTERN_EN_MASK                      GENMASK(15, 14)
 380 +#define QCA8K_LED_PATTERN_EN_SHIFT                     14
 381 +#define   QCA8K_LED_ALWAYS_OFF                         0
 382 +#define   QCA8K_LED_ALWAYS_BLINK_4HZ                   1
 383 +#define   QCA8K_LED_ALWAYS_ON                          2
 384 +#define   QCA8K_LED_RULE_CONTROLLED                    3
 385 +
 386  #define QCA8K_GOL_MAC_ADDR0                            0x60
 387  #define QCA8K_GOL_MAC_ADDR1                            0x64
 388  #define QCA8K_MAX_FRAME_SIZE                           0x78
 389 @@ -382,6 +428,19 @@ struct qca8k_pcs {
 390         int port;
 391  };
 392
 393 +struct qca8k_led_pattern_en {
 394 +       u32 reg;
 395 +       u8 shift;
 396 +};
 397 +
 398 +struct qca8k_led {
 399 +       u8 port_num;
 400 +       u8 led_num;
 401 +       u16 old_rule;
 402 +       struct qca8k_priv *priv;
 403 +       struct led_classdev cdev;
 404 +};
 405 +
 406  struct qca8k_priv {
 407         u8 switch_id;
 408         u8 switch_revision;
 409 @@ -406,6 +465,7 @@ struct qca8k_priv {
 410         struct qca8k_pcs pcs_port_0;
 411         struct qca8k_pcs pcs_port_6;
 412         const struct qca8k_match_data *info;
 413 +       struct qca8k_led ports_led[QCA8K_LED_COUNT];
 414  };
 415
 416  struct qca8k_mib_desc {
 417 --- /dev/null
 418 +++ b/drivers/net/dsa/qca/qca8k_leds.h
 419 @@ -0,0 +1,16 @@
 420 +/* SPDX-License-Identifier: GPL-2.0-only */
 421 +
 422 +#ifndef __QCA8K_LEDS_H
 423 +#define __QCA8K_LEDS_H
 424 +
 425 +/* Leds Support function */
 426 +#ifdef CONFIG_NET_DSA_QCA8K_LEDS_SUPPORT
 427 +int qca8k_setup_led_ctrl(struct qca8k_priv *priv);
 428 +#else
 429 +static inline int qca8k_setup_led_ctrl(struct qca8k_priv *priv)
 430 +{
 431 +       return 0;
 432 +}
 433 +#endif
 434 +
 435 +#endif /* __QCA8K_LEDS_H */