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 #define KSZ_MAX_NUM_PORTS 8 18 19 struct vlan_table { 20 u32 table[3]; 21 }; 22 23 struct ksz_port_mib { 24 struct mutex cnt_mutex; /* structure access */ 25 u8 cnt_ptr; 26 u64 *counters; 27 struct rtnl_link_stats64 stats64; 28 struct ethtool_pause_stats pause_stats; 29 struct spinlock stats64_lock; 30 }; 31 32 struct ksz_mib_names { 33 int index; 34 char string[ETH_GSTRING_LEN]; 35 }; 36 37 struct ksz_chip_data { 38 u32 chip_id; 39 const char *dev_name; 40 int num_vlans; 41 int num_alus; 42 int num_statics; 43 int cpu_ports; 44 int port_cnt; 45 const struct ksz_dev_ops *ops; 46 bool phy_errata_9477; 47 bool ksz87xx_eee_link_erratum; 48 const struct ksz_mib_names *mib_names; 49 int mib_cnt; 50 u8 reg_mib_cnt; 51 const u16 *regs; 52 const u32 *masks; 53 const u8 *shifts; 54 int stp_ctrl_reg; 55 int broadcast_ctrl_reg; 56 int multicast_ctrl_reg; 57 int start_ctrl_reg; 58 bool supports_mii[KSZ_MAX_NUM_PORTS]; 59 bool supports_rmii[KSZ_MAX_NUM_PORTS]; 60 bool supports_rgmii[KSZ_MAX_NUM_PORTS]; 61 bool internal_phy[KSZ_MAX_NUM_PORTS]; 62 }; 63 64 struct ksz_port { 65 bool remove_tag; /* Remove Tag flag set, for ksz8795 only */ 66 int stp_state; 67 struct phy_device phydev; 68 69 u32 on:1; /* port is not disabled by hardware */ 70 u32 phy:1; /* port has a PHY */ 71 u32 fiber:1; /* port is fiber */ 72 u32 sgmii:1; /* port is SGMII */ 73 u32 force:1; 74 u32 read:1; /* read MIB counters in background */ 75 u32 freeze:1; /* MIB counter freeze is enabled */ 76 77 struct ksz_port_mib mib; 78 phy_interface_t interface; 79 u16 max_frame; 80 }; 81 82 struct ksz_device { 83 struct dsa_switch *ds; 84 struct ksz_platform_data *pdata; 85 const struct ksz_chip_data *info; 86 87 struct mutex dev_mutex; /* device access */ 88 struct mutex regmap_mutex; /* regmap access */ 89 struct mutex alu_mutex; /* ALU access */ 90 struct mutex vlan_mutex; /* vlan access */ 91 const struct ksz_dev_ops *dev_ops; 92 93 struct device *dev; 94 struct regmap *regmap[3]; 95 96 void *priv; 97 98 struct gpio_desc *reset_gpio; /* Optional reset GPIO */ 99 100 /* chip specific data */ 101 u32 chip_id; 102 u8 chip_rev; 103 int cpu_port; /* port connected to CPU */ 104 int phy_port_cnt; 105 phy_interface_t compat_interface; 106 bool synclko_125; 107 bool synclko_disable; 108 109 struct vlan_table *vlan_cache; 110 111 struct ksz_port *ports; 112 struct delayed_work mib_read; 113 unsigned long mib_read_interval; 114 u16 mirror_rx; 115 u16 mirror_tx; 116 u32 features; /* chip specific features */ 117 u16 port_mask; 118 }; 119 120 /* List of supported models */ 121 enum ksz_model { 122 KSZ8795, 123 KSZ8794, 124 KSZ8765, 125 KSZ8830, 126 KSZ9477, 127 KSZ9897, 128 KSZ9893, 129 KSZ9567, 130 LAN9370, 131 LAN9371, 132 LAN9372, 133 LAN9373, 134 LAN9374, 135 }; 136 137 enum ksz_chip_id { 138 KSZ8795_CHIP_ID = 0x8795, 139 KSZ8794_CHIP_ID = 0x8794, 140 KSZ8765_CHIP_ID = 0x8765, 141 KSZ8830_CHIP_ID = 0x8830, 142 KSZ9477_CHIP_ID = 0x00947700, 143 KSZ9897_CHIP_ID = 0x00989700, 144 KSZ9893_CHIP_ID = 0x00989300, 145 KSZ9567_CHIP_ID = 0x00956700, 146 LAN9370_CHIP_ID = 0x00937000, 147 LAN9371_CHIP_ID = 0x00937100, 148 LAN9372_CHIP_ID = 0x00937200, 149 LAN9373_CHIP_ID = 0x00937300, 150 LAN9374_CHIP_ID = 0x00937400, 151 }; 152 153 enum ksz_regs { 154 REG_IND_CTRL_0, 155 REG_IND_DATA_8, 156 REG_IND_DATA_CHECK, 157 REG_IND_DATA_HI, 158 REG_IND_DATA_LO, 159 REG_IND_MIB_CHECK, 160 REG_IND_BYTE, 161 P_FORCE_CTRL, 162 P_LINK_STATUS, 163 P_LOCAL_CTRL, 164 P_NEG_RESTART_CTRL, 165 P_REMOTE_STATUS, 166 P_SPEED_STATUS, 167 S_TAIL_TAG_CTRL, 168 P_STP_CTRL, 169 S_START_CTRL, 170 S_BROADCAST_CTRL, 171 S_MULTICAST_CTRL, 172 }; 173 174 enum ksz_masks { 175 PORT_802_1P_REMAPPING, 176 SW_TAIL_TAG_ENABLE, 177 MIB_COUNTER_OVERFLOW, 178 MIB_COUNTER_VALID, 179 VLAN_TABLE_FID, 180 VLAN_TABLE_MEMBERSHIP, 181 VLAN_TABLE_VALID, 182 STATIC_MAC_TABLE_VALID, 183 STATIC_MAC_TABLE_USE_FID, 184 STATIC_MAC_TABLE_FID, 185 STATIC_MAC_TABLE_OVERRIDE, 186 STATIC_MAC_TABLE_FWD_PORTS, 187 DYNAMIC_MAC_TABLE_ENTRIES_H, 188 DYNAMIC_MAC_TABLE_MAC_EMPTY, 189 DYNAMIC_MAC_TABLE_NOT_READY, 190 DYNAMIC_MAC_TABLE_ENTRIES, 191 DYNAMIC_MAC_TABLE_FID, 192 DYNAMIC_MAC_TABLE_SRC_PORT, 193 DYNAMIC_MAC_TABLE_TIMESTAMP, 194 }; 195 196 enum ksz_shifts { 197 VLAN_TABLE_MEMBERSHIP_S, 198 VLAN_TABLE, 199 STATIC_MAC_FWD_PORTS, 200 STATIC_MAC_FID, 201 DYNAMIC_MAC_ENTRIES_H, 202 DYNAMIC_MAC_ENTRIES, 203 DYNAMIC_MAC_FID, 204 DYNAMIC_MAC_TIMESTAMP, 205 DYNAMIC_MAC_SRC_PORT, 206 }; 207 208 struct alu_struct { 209 /* entry 1 */ 210 u8 is_static:1; 211 u8 is_src_filter:1; 212 u8 is_dst_filter:1; 213 u8 prio_age:3; 214 u32 _reserv_0_1:23; 215 u8 mstp:3; 216 /* entry 2 */ 217 u8 is_override:1; 218 u8 is_use_fid:1; 219 u32 _reserv_1_1:23; 220 u8 port_forward:7; 221 /* entry 3 & 4*/ 222 u32 _reserv_2_1:9; 223 u8 fid:7; 224 u8 mac[ETH_ALEN]; 225 }; 226 227 struct ksz_dev_ops { 228 int (*setup)(struct dsa_switch *ds); 229 u32 (*get_port_addr)(int port, int offset); 230 void (*cfg_port_member)(struct ksz_device *dev, int port, u8 member); 231 void (*flush_dyn_mac_table)(struct ksz_device *dev, int port); 232 void (*port_cleanup)(struct ksz_device *dev, int port); 233 void (*port_setup)(struct ksz_device *dev, int port, bool cpu_port); 234 void (*r_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 *val); 235 void (*w_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 val); 236 void (*r_mib_cnt)(struct ksz_device *dev, int port, u16 addr, 237 u64 *cnt); 238 void (*r_mib_pkt)(struct ksz_device *dev, int port, u16 addr, 239 u64 *dropped, u64 *cnt); 240 void (*r_mib_stat64)(struct ksz_device *dev, int port); 241 int (*vlan_filtering)(struct ksz_device *dev, int port, 242 bool flag, struct netlink_ext_ack *extack); 243 int (*vlan_add)(struct ksz_device *dev, int port, 244 const struct switchdev_obj_port_vlan *vlan, 245 struct netlink_ext_ack *extack); 246 int (*vlan_del)(struct ksz_device *dev, int port, 247 const struct switchdev_obj_port_vlan *vlan); 248 int (*mirror_add)(struct ksz_device *dev, int port, 249 struct dsa_mall_mirror_tc_entry *mirror, 250 bool ingress, struct netlink_ext_ack *extack); 251 void (*mirror_del)(struct ksz_device *dev, int port, 252 struct dsa_mall_mirror_tc_entry *mirror); 253 int (*fdb_add)(struct ksz_device *dev, int port, 254 const unsigned char *addr, u16 vid, struct dsa_db db); 255 int (*fdb_del)(struct ksz_device *dev, int port, 256 const unsigned char *addr, u16 vid, struct dsa_db db); 257 int (*fdb_dump)(struct ksz_device *dev, int port, 258 dsa_fdb_dump_cb_t *cb, void *data); 259 int (*mdb_add)(struct ksz_device *dev, int port, 260 const struct switchdev_obj_port_mdb *mdb, 261 struct dsa_db db); 262 int (*mdb_del)(struct ksz_device *dev, int port, 263 const struct switchdev_obj_port_mdb *mdb, 264 struct dsa_db db); 265 void (*get_caps)(struct ksz_device *dev, int port, 266 struct phylink_config *config); 267 int (*change_mtu)(struct ksz_device *dev, int port, int mtu); 268 int (*max_mtu)(struct ksz_device *dev, int port); 269 void (*freeze_mib)(struct ksz_device *dev, int port, bool freeze); 270 void (*port_init_cnt)(struct ksz_device *dev, int port); 271 void (*config_cpu_port)(struct dsa_switch *ds); 272 int (*enable_stp_addr)(struct ksz_device *dev); 273 int (*reset)(struct ksz_device *dev); 274 int (*init)(struct ksz_device *dev); 275 void (*exit)(struct ksz_device *dev); 276 }; 277 278 struct ksz_device *ksz_switch_alloc(struct device *base, void *priv); 279 int ksz_switch_register(struct ksz_device *dev); 280 void ksz_switch_remove(struct ksz_device *dev); 281 282 void ksz_init_mib_timer(struct ksz_device *dev); 283 void ksz_r_mib_stats64(struct ksz_device *dev, int port); 284 void ksz_port_stp_state_set(struct dsa_switch *ds, int port, u8 state); 285 extern const struct ksz_chip_data ksz_switch_chips[]; 286 287 /* Common register access functions */ 288 289 static inline int ksz_read8(struct ksz_device *dev, u32 reg, u8 *val) 290 { 291 unsigned int value; 292 int ret = regmap_read(dev->regmap[0], reg, &value); 293 294 *val = value; 295 return ret; 296 } 297 298 static inline int ksz_read16(struct ksz_device *dev, u32 reg, u16 *val) 299 { 300 unsigned int value; 301 int ret = regmap_read(dev->regmap[1], reg, &value); 302 303 *val = value; 304 return ret; 305 } 306 307 static inline int ksz_read32(struct ksz_device *dev, u32 reg, u32 *val) 308 { 309 unsigned int value; 310 int ret = regmap_read(dev->regmap[2], reg, &value); 311 312 *val = value; 313 return ret; 314 } 315 316 static inline int ksz_read64(struct ksz_device *dev, u32 reg, u64 *val) 317 { 318 u32 value[2]; 319 int ret; 320 321 ret = regmap_bulk_read(dev->regmap[2], reg, value, 2); 322 if (!ret) 323 *val = (u64)value[0] << 32 | value[1]; 324 325 return ret; 326 } 327 328 static inline int ksz_write8(struct ksz_device *dev, u32 reg, u8 value) 329 { 330 return regmap_write(dev->regmap[0], reg, value); 331 } 332 333 static inline int ksz_write16(struct ksz_device *dev, u32 reg, u16 value) 334 { 335 return regmap_write(dev->regmap[1], reg, value); 336 } 337 338 static inline int ksz_write32(struct ksz_device *dev, u32 reg, u32 value) 339 { 340 return regmap_write(dev->regmap[2], reg, value); 341 } 342 343 static inline int ksz_write64(struct ksz_device *dev, u32 reg, u64 value) 344 { 345 u32 val[2]; 346 347 /* Ick! ToDo: Add 64bit R/W to regmap on 32bit systems */ 348 value = swab64(value); 349 val[0] = swab32(value & 0xffffffffULL); 350 val[1] = swab32(value >> 32ULL); 351 352 return regmap_bulk_write(dev->regmap[2], reg, val, 2); 353 } 354 355 static inline void ksz_pread8(struct ksz_device *dev, int port, int offset, 356 u8 *data) 357 { 358 ksz_read8(dev, dev->dev_ops->get_port_addr(port, offset), data); 359 } 360 361 static inline void ksz_pread16(struct ksz_device *dev, int port, int offset, 362 u16 *data) 363 { 364 ksz_read16(dev, dev->dev_ops->get_port_addr(port, offset), data); 365 } 366 367 static inline void ksz_pread32(struct ksz_device *dev, int port, int offset, 368 u32 *data) 369 { 370 ksz_read32(dev, dev->dev_ops->get_port_addr(port, offset), data); 371 } 372 373 static inline void ksz_pwrite8(struct ksz_device *dev, int port, int offset, 374 u8 data) 375 { 376 ksz_write8(dev, dev->dev_ops->get_port_addr(port, offset), data); 377 } 378 379 static inline void ksz_pwrite16(struct ksz_device *dev, int port, int offset, 380 u16 data) 381 { 382 ksz_write16(dev, dev->dev_ops->get_port_addr(port, offset), data); 383 } 384 385 static inline void ksz_pwrite32(struct ksz_device *dev, int port, int offset, 386 u32 data) 387 { 388 ksz_write32(dev, dev->dev_ops->get_port_addr(port, offset), data); 389 } 390 391 static inline void ksz_regmap_lock(void *__mtx) 392 { 393 struct mutex *mtx = __mtx; 394 mutex_lock(mtx); 395 } 396 397 static inline void ksz_regmap_unlock(void *__mtx) 398 { 399 struct mutex *mtx = __mtx; 400 mutex_unlock(mtx); 401 } 402 403 /* STP State Defines */ 404 #define PORT_TX_ENABLE BIT(2) 405 #define PORT_RX_ENABLE BIT(1) 406 #define PORT_LEARN_DISABLE BIT(0) 407 408 /* Switch ID Defines */ 409 #define REG_CHIP_ID0 0x00 410 411 #define SW_FAMILY_ID_M GENMASK(15, 8) 412 #define KSZ87_FAMILY_ID 0x87 413 #define KSZ88_FAMILY_ID 0x88 414 415 #define KSZ8_PORT_STATUS_0 0x08 416 #define KSZ8_PORT_FIBER_MODE BIT(7) 417 418 #define SW_CHIP_ID_M GENMASK(7, 4) 419 #define KSZ87_CHIP_ID_94 0x6 420 #define KSZ87_CHIP_ID_95 0x9 421 #define KSZ88_CHIP_ID_63 0x3 422 423 #define SW_REV_ID_M GENMASK(7, 4) 424 425 /* Driver set switch broadcast storm protection at 10% rate. */ 426 #define BROADCAST_STORM_PROT_RATE 10 427 428 /* 148,800 frames * 67 ms / 100 */ 429 #define BROADCAST_STORM_VALUE 9969 430 431 #define BROADCAST_STORM_RATE_HI 0x07 432 #define BROADCAST_STORM_RATE_LO 0xFF 433 #define BROADCAST_STORM_RATE 0x07FF 434 435 #define MULTICAST_STORM_DISABLE BIT(6) 436 437 #define SW_START 0x01 438 439 /* Regmap tables generation */ 440 #define KSZ_SPI_OP_RD 3 441 #define KSZ_SPI_OP_WR 2 442 443 #define swabnot_used(x) 0 444 445 #define KSZ_SPI_OP_FLAG_MASK(opcode, swp, regbits, regpad) \ 446 swab##swp((opcode) << ((regbits) + (regpad))) 447 448 #define KSZ_REGMAP_ENTRY(width, swp, regbits, regpad, regalign) \ 449 { \ 450 .name = #width, \ 451 .val_bits = (width), \ 452 .reg_stride = 1, \ 453 .reg_bits = (regbits) + (regalign), \ 454 .pad_bits = (regpad), \ 455 .max_register = BIT(regbits) - 1, \ 456 .cache_type = REGCACHE_NONE, \ 457 .read_flag_mask = \ 458 KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_RD, swp, \ 459 regbits, regpad), \ 460 .write_flag_mask = \ 461 KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_WR, swp, \ 462 regbits, regpad), \ 463 .lock = ksz_regmap_lock, \ 464 .unlock = ksz_regmap_unlock, \ 465 .reg_format_endian = REGMAP_ENDIAN_BIG, \ 466 .val_format_endian = REGMAP_ENDIAN_BIG \ 467 } 468 469 #define KSZ_REGMAP_TABLE(ksz, swp, regbits, regpad, regalign) \ 470 static const struct regmap_config ksz##_regmap_config[] = { \ 471 KSZ_REGMAP_ENTRY(8, swp, (regbits), (regpad), (regalign)), \ 472 KSZ_REGMAP_ENTRY(16, swp, (regbits), (regpad), (regalign)), \ 473 KSZ_REGMAP_ENTRY(32, swp, (regbits), (regpad), (regalign)), \ 474 } 475 476 #endif 477