drivers/net/dsa/microchip/ksz_common.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Microchip switch driver common header
   3  *
   4  * Copyright (C) 2017-2019 Microchip Technology Inc.
   5  */
   6
   7 #ifndef __KSZ_COMMON_H
   8 #define __KSZ_COMMON_H
   9
  10 #include <linux/etherdevice.h>
  11 #include <linux/kernel.h>
  12 #include <linux/mutex.h>
  13 #include <linux/phy.h>
  14 #include <linux/regmap.h>
  15 #include <net/dsa.h>
  16
  17 struct vlan_table {
  18         u32 table[3];
  19 };
  20
  21 struct ksz_port_mib {
  22         struct mutex cnt_mutex;         /* structure access */
  23         u8 cnt_ptr;
  24         u64 *counters;
  25         struct rtnl_link_stats64 stats64;
  26         struct spinlock stats64_lock;
  27 };
  28
  29 struct ksz_port {
  30         bool remove_tag;                /* Remove Tag flag set, for ksz8795 only */
  31         int stp_state;
  32         struct phy_device phydev;
  33
  34         u32 on:1;                       /* port is not disabled by hardware */
  35         u32 phy:1;                      /* port has a PHY */
  36         u32 fiber:1;                    /* port is fiber */
  37         u32 sgmii:1;                    /* port is SGMII */
  38         u32 force:1;
  39         u32 read:1;                     /* read MIB counters in background */
  40         u32 freeze:1;                   /* MIB counter freeze is enabled */
  41
  42         struct ksz_port_mib mib;
  43         phy_interface_t interface;
  44         u16 max_frame;
  45 };
  46
  47 struct ksz_device {
  48         struct dsa_switch *ds;
  49         struct ksz_platform_data *pdata;
  50         const char *name;
  51
  52         struct mutex dev_mutex;         /* device access */
  53         struct mutex regmap_mutex;      /* regmap access */
  54         struct mutex alu_mutex;         /* ALU access */
  55         struct mutex vlan_mutex;        /* vlan access */
  56         const struct ksz_dev_ops *dev_ops;
  57
  58         struct device *dev;
  59         struct regmap *regmap[3];
  60
  61         void *priv;
  62
  63         struct gpio_desc *reset_gpio;   /* Optional reset GPIO */
  64
  65         /* chip specific data */
  66         u32 chip_id;
  67         int num_vlans;
  68         int num_alus;
  69         int num_statics;
  70         int cpu_port;                   /* port connected to CPU */
  71         int cpu_ports;                  /* port bitmap can be cpu port */
  72         int phy_port_cnt;
  73         int port_cnt;
  74         u8 reg_mib_cnt;
  75         int mib_cnt;
  76         const struct mib_names *mib_names;
  77         phy_interface_t compat_interface;
  78         u32 regs_size;
  79         bool phy_errata_9477;
  80         bool ksz87xx_eee_link_erratum;
  81         bool synclko_125;
  82         bool synclko_disable;
  83
  84         struct vlan_table *vlan_cache;
  85
  86         struct ksz_port *ports;
  87         struct delayed_work mib_read;
  88         unsigned long mib_read_interval;
  89         u16 mirror_rx;
  90         u16 mirror_tx;
  91         u32 features;                   /* chip specific features */
  92         u32 overrides;                  /* chip functions set by user */
  93         u16 host_mask;
  94         u16 port_mask;
  95 };
  96
  97 struct alu_struct {
  98         /* entry 1 */
  99         u8      is_static:1;
 100         u8      is_src_filter:1;
 101         u8      is_dst_filter:1;
 102         u8      prio_age:3;
 103         u32     _reserv_0_1:23;
 104         u8      mstp:3;
 105         /* entry 2 */
 106         u8      is_override:1;
 107         u8      is_use_fid:1;
 108         u32     _reserv_1_1:23;
 109         u8      port_forward:7;
 110         /* entry 3 & 4*/
 111         u32     _reserv_2_1:9;
 112         u8      fid:7;
 113         u8      mac[ETH_ALEN];
 114 };
 115
 116 struct ksz_dev_ops {
 117         u32 (*get_port_addr)(int port, int offset);
 118         void (*cfg_port_member)(struct ksz_device *dev, int port, u8 member);
 119         void (*flush_dyn_mac_table)(struct ksz_device *dev, int port);
 120         void (*port_cleanup)(struct ksz_device *dev, int port);
 121         void (*port_setup)(struct ksz_device *dev, int port, bool cpu_port);
 122         void (*r_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 *val);
 123         void (*w_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 val);
 124         int (*r_dyn_mac_table)(struct ksz_device *dev, u16 addr, u8 *mac_addr,
 125                                u8 *fid, u8 *src_port, u8 *timestamp,
 126                                u16 *entries);
 127         int (*r_sta_mac_table)(struct ksz_device *dev, u16 addr,
 128                                struct alu_struct *alu);
 129         void (*w_sta_mac_table)(struct ksz_device *dev, u16 addr,
 130                                 struct alu_struct *alu);
 131         void (*r_mib_cnt)(struct ksz_device *dev, int port, u16 addr,
 132                           u64 *cnt);
 133         void (*r_mib_pkt)(struct ksz_device *dev, int port, u16 addr,
 134                           u64 *dropped, u64 *cnt);
 135         void (*r_mib_stat64)(struct ksz_device *dev, int port);
 136         void (*freeze_mib)(struct ksz_device *dev, int port, bool freeze);
 137         void (*port_init_cnt)(struct ksz_device *dev, int port);
 138         int (*shutdown)(struct ksz_device *dev);
 139         int (*detect)(struct ksz_device *dev);
 140         int (*init)(struct ksz_device *dev);
 141         void (*exit)(struct ksz_device *dev);
 142 };
 143
 144 struct ksz_device *ksz_switch_alloc(struct device *base, void *priv);
 145 int ksz_switch_register(struct ksz_device *dev,
 146                         const struct ksz_dev_ops *ops);
 147 void ksz_switch_remove(struct ksz_device *dev);
 148
 149 int ksz8_switch_register(struct ksz_device *dev);
 150 int ksz9477_switch_register(struct ksz_device *dev);
 151
 152 void ksz_update_port_member(struct ksz_device *dev, int port);
 153 void ksz_init_mib_timer(struct ksz_device *dev);
 154
 155 /* Common DSA access functions */
 156
 157 int ksz_phy_read16(struct dsa_switch *ds, int addr, int reg);
 158 int ksz_phy_write16(struct dsa_switch *ds, int addr, int reg, u16 val);
 159 void ksz_mac_link_down(struct dsa_switch *ds, int port, unsigned int mode,
 160                        phy_interface_t interface);
 161 int ksz_sset_count(struct dsa_switch *ds, int port, int sset);
 162 void ksz_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *buf);
 163 int ksz_port_bridge_join(struct dsa_switch *ds, int port,
 164                          struct dsa_bridge bridge, bool *tx_fwd_offload,
 165                          struct netlink_ext_ack *extack);
 166 void ksz_port_bridge_leave(struct dsa_switch *ds, int port,
 167                            struct dsa_bridge bridge);
 168 void ksz_port_fast_age(struct dsa_switch *ds, int port);
 169 int ksz_port_fdb_dump(struct dsa_switch *ds, int port, dsa_fdb_dump_cb_t *cb,
 170                       void *data);
 171 int ksz_port_mdb_add(struct dsa_switch *ds, int port,
 172                      const struct switchdev_obj_port_mdb *mdb,
 173                      struct dsa_db db);
 174 int ksz_port_mdb_del(struct dsa_switch *ds, int port,
 175                      const struct switchdev_obj_port_mdb *mdb,
 176                      struct dsa_db db);
 177 int ksz_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy);
 178
 179 /* Common register access functions */
 180
 181 static inline int ksz_read8(struct ksz_device *dev, u32 reg, u8 *val)
 182 {
 183         unsigned int value;
 184         int ret = regmap_read(dev->regmap[0], reg, &value);
 185
 186         *val = value;
 187         return ret;
 188 }
 189
 190 static inline int ksz_read16(struct ksz_device *dev, u32 reg, u16 *val)
 191 {
 192         unsigned int value;
 193         int ret = regmap_read(dev->regmap[1], reg, &value);
 194
 195         *val = value;
 196         return ret;
 197 }
 198
 199 static inline int ksz_read32(struct ksz_device *dev, u32 reg, u32 *val)
 200 {
 201         unsigned int value;
 202         int ret = regmap_read(dev->regmap[2], reg, &value);
 203
 204         *val = value;
 205         return ret;
 206 }
 207
 208 static inline int ksz_read64(struct ksz_device *dev, u32 reg, u64 *val)
 209 {
 210         u32 value[2];
 211         int ret;
 212
 213         ret = regmap_bulk_read(dev->regmap[2], reg, value, 2);
 214         if (!ret)
 215                 *val = (u64)value[0] << 32 | value[1];
 216
 217         return ret;
 218 }
 219
 220 static inline int ksz_write8(struct ksz_device *dev, u32 reg, u8 value)
 221 {
 222         return regmap_write(dev->regmap[0], reg, value);
 223 }
 224
 225 static inline int ksz_write16(struct ksz_device *dev, u32 reg, u16 value)
 226 {
 227         return regmap_write(dev->regmap[1], reg, value);
 228 }
 229
 230 static inline int ksz_write32(struct ksz_device *dev, u32 reg, u32 value)
 231 {
 232         return regmap_write(dev->regmap[2], reg, value);
 233 }
 234
 235 static inline int ksz_write64(struct ksz_device *dev, u32 reg, u64 value)
 236 {
 237         u32 val[2];
 238
 239         /* Ick! ToDo: Add 64bit R/W to regmap on 32bit systems */
 240         value = swab64(value);
 241         val[0] = swab32(value & 0xffffffffULL);
 242         val[1] = swab32(value >> 32ULL);
 243
 244         return regmap_bulk_write(dev->regmap[2], reg, val, 2);
 245 }
 246
 247 static inline void ksz_pread8(struct ksz_device *dev, int port, int offset,
 248                               u8 *data)
 249 {
 250         ksz_read8(dev, dev->dev_ops->get_port_addr(port, offset), data);
 251 }
 252
 253 static inline void ksz_pread16(struct ksz_device *dev, int port, int offset,
 254                                u16 *data)
 255 {
 256         ksz_read16(dev, dev->dev_ops->get_port_addr(port, offset), data);
 257 }
 258
 259 static inline void ksz_pread32(struct ksz_device *dev, int port, int offset,
 260                                u32 *data)
 261 {
 262         ksz_read32(dev, dev->dev_ops->get_port_addr(port, offset), data);
 263 }
 264
 265 static inline void ksz_pwrite8(struct ksz_device *dev, int port, int offset,
 266                                u8 data)
 267 {
 268         ksz_write8(dev, dev->dev_ops->get_port_addr(port, offset), data);
 269 }
 270
 271 static inline void ksz_pwrite16(struct ksz_device *dev, int port, int offset,
 272                                 u16 data)
 273 {
 274         ksz_write16(dev, dev->dev_ops->get_port_addr(port, offset), data);
 275 }
 276
 277 static inline void ksz_pwrite32(struct ksz_device *dev, int port, int offset,
 278                                 u32 data)
 279 {
 280         ksz_write32(dev, dev->dev_ops->get_port_addr(port, offset), data);
 281 }
 282
 283 static inline void ksz_regmap_lock(void *__mtx)
 284 {
 285         struct mutex *mtx = __mtx;
 286         mutex_lock(mtx);
 287 }
 288
 289 static inline void ksz_regmap_unlock(void *__mtx)
 290 {
 291         struct mutex *mtx = __mtx;
 292         mutex_unlock(mtx);
 293 }
 294
 295 /* Regmap tables generation */
 296 #define KSZ_SPI_OP_RD           3
 297 #define KSZ_SPI_OP_WR           2
 298
 299 #define swabnot_used(x)         0
 300
 301 #define KSZ_SPI_OP_FLAG_MASK(opcode, swp, regbits, regpad)              \
 302         swab##swp((opcode) << ((regbits) + (regpad)))
 303
 304 #define KSZ_REGMAP_ENTRY(width, swp, regbits, regpad, regalign)         \
 305         {                                                               \
 306                 .name = #width,                                         \
 307                 .val_bits = (width),                                    \
 308                 .reg_stride = 1,                                        \
 309                 .reg_bits = (regbits) + (regalign),                     \
 310                 .pad_bits = (regpad),                                   \
 311                 .max_register = BIT(regbits) - 1,                       \
 312                 .cache_type = REGCACHE_NONE,                            \
 313                 .read_flag_mask =                                       \
 314                         KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_RD, swp,        \
 315                                              regbits, regpad),          \
 316                 .write_flag_mask =                                      \
 317                         KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_WR, swp,        \
 318                                              regbits, regpad),          \
 319                 .lock = ksz_regmap_lock,                                \
 320                 .unlock = ksz_regmap_unlock,                            \
 321                 .reg_format_endian = REGMAP_ENDIAN_BIG,                 \
 322                 .val_format_endian = REGMAP_ENDIAN_BIG                  \
 323         }
 324
 325 #define KSZ_REGMAP_TABLE(ksz, swp, regbits, regpad, regalign)           \
 326         static const struct regmap_config ksz##_regmap_config[] = {     \
 327                 KSZ_REGMAP_ENTRY(8, swp, (regbits), (regpad), (regalign)), \
 328                 KSZ_REGMAP_ENTRY(16, swp, (regbits), (regpad), (regalign)), \
 329                 KSZ_REGMAP_ENTRY(32, swp, (regbits), (regpad), (regalign)), \
 330         }
 331
 332 #endif