1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Microchip switch driver common header
4 * Copyright (C) 2017-2019 Microchip Technology Inc.
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>
16 #include <linux/irq.h>
20 #define KSZ_MAX_NUM_PORTS 8
25 enum ksz_regmap_width {
37 struct mutex cnt_mutex; /* structure access */
40 struct rtnl_link_stats64 stats64;
41 struct ethtool_pause_stats pause_stats;
42 struct spinlock stats64_lock;
45 struct ksz_mib_names {
47 char string[ETH_GSTRING_LEN];
50 struct ksz_chip_data {
60 bool tc_cbs_supported;
61 bool tc_ets_supported;
62 const struct ksz_dev_ops *ops;
63 bool ksz87xx_eee_link_erratum;
64 const struct ksz_mib_names *mib_names;
73 int broadcast_ctrl_reg;
74 int multicast_ctrl_reg;
76 bool supports_mii[KSZ_MAX_NUM_PORTS];
77 bool supports_rmii[KSZ_MAX_NUM_PORTS];
78 bool supports_rgmii[KSZ_MAX_NUM_PORTS];
79 bool internal_phy[KSZ_MAX_NUM_PORTS];
80 bool gbit_capable[KSZ_MAX_NUM_PORTS];
81 const struct regmap_access_table *wr_table;
82 const struct regmap_access_table *rd_table;
89 struct irq_domain *domain;
93 struct ksz_device *dev;
97 struct ksz_port *port;
105 bool remove_tag; /* Remove Tag flag set, for ksz8795 only */
108 struct phy_device phydev;
110 u32 fiber:1; /* port is fiber */
112 u32 read:1; /* read MIB counters in background */
113 u32 freeze:1; /* MIB counter freeze is enabled */
115 struct ksz_port_mib mib;
116 phy_interface_t interface;
119 struct ksz_device *ksz_dev;
122 #if IS_ENABLED(CONFIG_NET_DSA_MICROCHIP_KSZ_PTP)
123 struct hwtstamp_config tstamp_config;
126 struct ksz_irq ptpirq;
127 struct ksz_ptp_irq ptpmsg_irq[3];
129 struct completion tstamp_msg_comp;
134 struct dsa_switch *ds;
135 struct ksz_platform_data *pdata;
136 const struct ksz_chip_data *info;
138 struct mutex dev_mutex; /* device access */
139 struct mutex regmap_mutex; /* regmap access */
140 struct mutex alu_mutex; /* ALU access */
141 struct mutex vlan_mutex; /* vlan access */
142 const struct ksz_dev_ops *dev_ops;
145 struct regmap *regmap[__KSZ_NUM_REGMAPS];
150 struct gpio_desc *reset_gpio; /* Optional reset GPIO */
152 /* chip specific data */
155 int cpu_port; /* port connected to CPU */
157 phy_interface_t compat_interface;
159 bool synclko_disable;
161 struct vlan_table *vlan_cache;
163 struct ksz_port *ports;
164 struct delayed_work mib_read;
165 unsigned long mib_read_interval;
169 struct mutex lock_irq; /* IRQ Access */
171 struct ksz_ptp_data ptp_data;
174 /* List of supported models */
195 KSZ8563_CHIP_ID = 0x8563,
196 KSZ8795_CHIP_ID = 0x8795,
197 KSZ8794_CHIP_ID = 0x8794,
198 KSZ8765_CHIP_ID = 0x8765,
199 KSZ8830_CHIP_ID = 0x8830,
200 KSZ9477_CHIP_ID = 0x00947700,
201 KSZ9896_CHIP_ID = 0x00989600,
202 KSZ9897_CHIP_ID = 0x00989700,
203 KSZ9893_CHIP_ID = 0x00989300,
204 KSZ9563_CHIP_ID = 0x00956300,
205 KSZ9567_CHIP_ID = 0x00956700,
206 LAN9370_CHIP_ID = 0x00937000,
207 LAN9371_CHIP_ID = 0x00937100,
208 LAN9372_CHIP_ID = 0x00937200,
209 LAN9373_CHIP_ID = 0x00937300,
210 LAN9374_CHIP_ID = 0x00937400,
237 PORT_802_1P_REMAPPING,
239 MIB_COUNTER_OVERFLOW,
242 VLAN_TABLE_MEMBERSHIP,
244 STATIC_MAC_TABLE_VALID,
245 STATIC_MAC_TABLE_USE_FID,
246 STATIC_MAC_TABLE_FID,
247 STATIC_MAC_TABLE_OVERRIDE,
248 STATIC_MAC_TABLE_FWD_PORTS,
249 DYNAMIC_MAC_TABLE_ENTRIES_H,
250 DYNAMIC_MAC_TABLE_MAC_EMPTY,
251 DYNAMIC_MAC_TABLE_NOT_READY,
252 DYNAMIC_MAC_TABLE_ENTRIES,
253 DYNAMIC_MAC_TABLE_FID,
254 DYNAMIC_MAC_TABLE_SRC_PORT,
255 DYNAMIC_MAC_TABLE_TIMESTAMP,
263 VLAN_TABLE_MEMBERSHIP_S,
265 STATIC_MAC_FWD_PORTS,
267 DYNAMIC_MAC_ENTRIES_H,
270 DYNAMIC_MAC_TIMESTAMP,
271 DYNAMIC_MAC_SRC_PORT,
275 enum ksz_xmii_ctrl0 {
282 enum ksz_xmii_ctrl1 {
311 int (*setup)(struct dsa_switch *ds);
312 void (*teardown)(struct dsa_switch *ds);
313 u32 (*get_port_addr)(int port, int offset);
314 void (*cfg_port_member)(struct ksz_device *dev, int port, u8 member);
315 void (*flush_dyn_mac_table)(struct ksz_device *dev, int port);
316 void (*port_cleanup)(struct ksz_device *dev, int port);
317 void (*port_setup)(struct ksz_device *dev, int port, bool cpu_port);
318 int (*set_ageing_time)(struct ksz_device *dev, unsigned int msecs);
319 int (*r_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 *val);
320 int (*w_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 val);
321 void (*r_mib_cnt)(struct ksz_device *dev, int port, u16 addr,
323 void (*r_mib_pkt)(struct ksz_device *dev, int port, u16 addr,
324 u64 *dropped, u64 *cnt);
325 void (*r_mib_stat64)(struct ksz_device *dev, int port);
326 int (*vlan_filtering)(struct ksz_device *dev, int port,
327 bool flag, struct netlink_ext_ack *extack);
328 int (*vlan_add)(struct ksz_device *dev, int port,
329 const struct switchdev_obj_port_vlan *vlan,
330 struct netlink_ext_ack *extack);
331 int (*vlan_del)(struct ksz_device *dev, int port,
332 const struct switchdev_obj_port_vlan *vlan);
333 int (*mirror_add)(struct ksz_device *dev, int port,
334 struct dsa_mall_mirror_tc_entry *mirror,
335 bool ingress, struct netlink_ext_ack *extack);
336 void (*mirror_del)(struct ksz_device *dev, int port,
337 struct dsa_mall_mirror_tc_entry *mirror);
338 int (*fdb_add)(struct ksz_device *dev, int port,
339 const unsigned char *addr, u16 vid, struct dsa_db db);
340 int (*fdb_del)(struct ksz_device *dev, int port,
341 const unsigned char *addr, u16 vid, struct dsa_db db);
342 int (*fdb_dump)(struct ksz_device *dev, int port,
343 dsa_fdb_dump_cb_t *cb, void *data);
344 int (*mdb_add)(struct ksz_device *dev, int port,
345 const struct switchdev_obj_port_mdb *mdb,
347 int (*mdb_del)(struct ksz_device *dev, int port,
348 const struct switchdev_obj_port_mdb *mdb,
350 void (*get_caps)(struct ksz_device *dev, int port,
351 struct phylink_config *config);
352 int (*change_mtu)(struct ksz_device *dev, int port, int mtu);
353 void (*freeze_mib)(struct ksz_device *dev, int port, bool freeze);
354 void (*port_init_cnt)(struct ksz_device *dev, int port);
355 void (*phylink_mac_config)(struct ksz_device *dev, int port,
357 const struct phylink_link_state *state);
358 void (*phylink_mac_link_up)(struct ksz_device *dev, int port,
360 phy_interface_t interface,
361 struct phy_device *phydev, int speed,
362 int duplex, bool tx_pause, bool rx_pause);
363 void (*setup_rgmii_delay)(struct ksz_device *dev, int port);
364 int (*tc_cbs_set_cinc)(struct ksz_device *dev, int port, u32 val);
365 void (*config_cpu_port)(struct dsa_switch *ds);
366 int (*enable_stp_addr)(struct ksz_device *dev);
367 int (*reset)(struct ksz_device *dev);
368 int (*init)(struct ksz_device *dev);
369 void (*exit)(struct ksz_device *dev);
372 struct ksz_device *ksz_switch_alloc(struct device *base, void *priv);
373 int ksz_switch_register(struct ksz_device *dev);
374 void ksz_switch_remove(struct ksz_device *dev);
376 void ksz_init_mib_timer(struct ksz_device *dev);
377 void ksz_r_mib_stats64(struct ksz_device *dev, int port);
378 void ksz88xx_r_mib_stats64(struct ksz_device *dev, int port);
379 void ksz_port_stp_state_set(struct dsa_switch *ds, int port, u8 state);
380 bool ksz_get_gbit(struct ksz_device *dev, int port);
381 phy_interface_t ksz_get_xmii(struct ksz_device *dev, int port, bool gbit);
382 extern const struct ksz_chip_data ksz_switch_chips[];
384 /* Common register access functions */
385 static inline struct regmap *ksz_regmap_8(struct ksz_device *dev)
387 return dev->regmap[KSZ_REGMAP_8];
390 static inline struct regmap *ksz_regmap_16(struct ksz_device *dev)
392 return dev->regmap[KSZ_REGMAP_16];
395 static inline struct regmap *ksz_regmap_32(struct ksz_device *dev)
397 return dev->regmap[KSZ_REGMAP_32];
400 static inline int ksz_read8(struct ksz_device *dev, u32 reg, u8 *val)
403 int ret = regmap_read(ksz_regmap_8(dev), reg, &value);
406 dev_err(dev->dev, "can't read 8bit reg: 0x%x %pe\n", reg,
413 static inline int ksz_read16(struct ksz_device *dev, u32 reg, u16 *val)
416 int ret = regmap_read(ksz_regmap_16(dev), reg, &value);
419 dev_err(dev->dev, "can't read 16bit reg: 0x%x %pe\n", reg,
426 static inline int ksz_read32(struct ksz_device *dev, u32 reg, u32 *val)
429 int ret = regmap_read(ksz_regmap_32(dev), reg, &value);
432 dev_err(dev->dev, "can't read 32bit reg: 0x%x %pe\n", reg,
439 static inline int ksz_read64(struct ksz_device *dev, u32 reg, u64 *val)
444 ret = regmap_bulk_read(ksz_regmap_32(dev), reg, value, 2);
446 dev_err(dev->dev, "can't read 64bit reg: 0x%x %pe\n", reg,
449 *val = (u64)value[0] << 32 | value[1];
454 static inline int ksz_write8(struct ksz_device *dev, u32 reg, u8 value)
458 ret = regmap_write(ksz_regmap_8(dev), reg, value);
460 dev_err(dev->dev, "can't write 8bit reg: 0x%x %pe\n", reg,
466 static inline int ksz_write16(struct ksz_device *dev, u32 reg, u16 value)
470 ret = regmap_write(ksz_regmap_16(dev), reg, value);
472 dev_err(dev->dev, "can't write 16bit reg: 0x%x %pe\n", reg,
478 static inline int ksz_write32(struct ksz_device *dev, u32 reg, u32 value)
482 ret = regmap_write(ksz_regmap_32(dev), reg, value);
484 dev_err(dev->dev, "can't write 32bit reg: 0x%x %pe\n", reg,
490 static inline int ksz_rmw16(struct ksz_device *dev, u32 reg, u16 mask,
495 ret = regmap_update_bits(ksz_regmap_16(dev), reg, mask, value);
497 dev_err(dev->dev, "can't rmw 16bit reg 0x%x: %pe\n", reg,
503 static inline int ksz_rmw32(struct ksz_device *dev, u32 reg, u32 mask,
508 ret = regmap_update_bits(ksz_regmap_32(dev), reg, mask, value);
510 dev_err(dev->dev, "can't rmw 32bit reg 0x%x: %pe\n", reg,
516 static inline int ksz_write64(struct ksz_device *dev, u32 reg, u64 value)
520 /* Ick! ToDo: Add 64bit R/W to regmap on 32bit systems */
521 value = swab64(value);
522 val[0] = swab32(value & 0xffffffffULL);
523 val[1] = swab32(value >> 32ULL);
525 return regmap_bulk_write(ksz_regmap_32(dev), reg, val, 2);
528 static inline int ksz_rmw8(struct ksz_device *dev, int offset, u8 mask, u8 val)
532 ret = regmap_update_bits(ksz_regmap_8(dev), offset, mask, val);
534 dev_err(dev->dev, "can't rmw 8bit reg 0x%x: %pe\n", offset,
540 static inline int ksz_pread8(struct ksz_device *dev, int port, int offset,
543 return ksz_read8(dev, dev->dev_ops->get_port_addr(port, offset), data);
546 static inline int ksz_pread16(struct ksz_device *dev, int port, int offset,
549 return ksz_read16(dev, dev->dev_ops->get_port_addr(port, offset), data);
552 static inline int ksz_pread32(struct ksz_device *dev, int port, int offset,
555 return ksz_read32(dev, dev->dev_ops->get_port_addr(port, offset), data);
558 static inline int ksz_pwrite8(struct ksz_device *dev, int port, int offset,
561 return ksz_write8(dev, dev->dev_ops->get_port_addr(port, offset), data);
564 static inline int ksz_pwrite16(struct ksz_device *dev, int port, int offset,
567 return ksz_write16(dev, dev->dev_ops->get_port_addr(port, offset),
571 static inline int ksz_pwrite32(struct ksz_device *dev, int port, int offset,
574 return ksz_write32(dev, dev->dev_ops->get_port_addr(port, offset),
578 static inline int ksz_prmw8(struct ksz_device *dev, int port, int offset,
581 return ksz_rmw8(dev, dev->dev_ops->get_port_addr(port, offset),
585 static inline int ksz_prmw32(struct ksz_device *dev, int port, int offset,
588 return ksz_rmw32(dev, dev->dev_ops->get_port_addr(port, offset),
592 static inline void ksz_regmap_lock(void *__mtx)
594 struct mutex *mtx = __mtx;
598 static inline void ksz_regmap_unlock(void *__mtx)
600 struct mutex *mtx = __mtx;
604 static inline bool ksz_is_ksz87xx(struct ksz_device *dev)
606 return dev->chip_id == KSZ8795_CHIP_ID ||
607 dev->chip_id == KSZ8794_CHIP_ID ||
608 dev->chip_id == KSZ8765_CHIP_ID;
611 static inline bool ksz_is_ksz88x3(struct ksz_device *dev)
613 return dev->chip_id == KSZ8830_CHIP_ID;
616 static inline int is_lan937x(struct ksz_device *dev)
618 return dev->chip_id == LAN9370_CHIP_ID ||
619 dev->chip_id == LAN9371_CHIP_ID ||
620 dev->chip_id == LAN9372_CHIP_ID ||
621 dev->chip_id == LAN9373_CHIP_ID ||
622 dev->chip_id == LAN9374_CHIP_ID;
625 /* STP State Defines */
626 #define PORT_TX_ENABLE BIT(2)
627 #define PORT_RX_ENABLE BIT(1)
628 #define PORT_LEARN_DISABLE BIT(0)
630 /* Switch ID Defines */
631 #define REG_CHIP_ID0 0x00
633 #define SW_FAMILY_ID_M GENMASK(15, 8)
634 #define KSZ87_FAMILY_ID 0x87
635 #define KSZ88_FAMILY_ID 0x88
637 #define KSZ8_PORT_STATUS_0 0x08
638 #define KSZ8_PORT_FIBER_MODE BIT(7)
640 #define SW_CHIP_ID_M GENMASK(7, 4)
641 #define KSZ87_CHIP_ID_94 0x6
642 #define KSZ87_CHIP_ID_95 0x9
643 #define KSZ88_CHIP_ID_63 0x3
645 #define SW_REV_ID_M GENMASK(7, 4)
647 /* KSZ9893, KSZ9563, KSZ8563 specific register */
648 #define REG_CHIP_ID4 0x0f
649 #define SKU_ID_KSZ8563 0x3c
650 #define SKU_ID_KSZ9563 0x1c
652 /* Driver set switch broadcast storm protection at 10% rate. */
653 #define BROADCAST_STORM_PROT_RATE 10
655 /* 148,800 frames * 67 ms / 100 */
656 #define BROADCAST_STORM_VALUE 9969
658 #define BROADCAST_STORM_RATE_HI 0x07
659 #define BROADCAST_STORM_RATE_LO 0xFF
660 #define BROADCAST_STORM_RATE 0x07FF
662 #define MULTICAST_STORM_DISABLE BIT(6)
664 #define SW_START 0x01
666 /* xMII configuration */
667 #define P_MII_DUPLEX_M BIT(6)
668 #define P_MII_100MBIT_M BIT(4)
670 #define P_GMII_1GBIT_M BIT(6)
671 #define P_RGMII_ID_IG_ENABLE BIT(4)
672 #define P_RGMII_ID_EG_ENABLE BIT(3)
673 #define P_MII_MAC_MODE BIT(2)
674 #define P_MII_SEL_M 0x3
677 #define REG_SW_PORT_INT_STATUS__1 0x001B
678 #define REG_SW_PORT_INT_MASK__1 0x001F
680 #define REG_PORT_INT_STATUS 0x001B
681 #define REG_PORT_INT_MASK 0x001F
683 #define PORT_SRC_PHY_INT 1
684 #define PORT_SRC_PTP_INT 2
686 #define KSZ8795_HUGE_PACKET_SIZE 2000
687 #define KSZ8863_HUGE_PACKET_SIZE 1916
688 #define KSZ8863_NORMAL_PACKET_SIZE 1536
689 #define KSZ8_LEGAL_PACKET_SIZE 1518
690 #define KSZ9477_MAX_FRAME_SIZE 9000
692 #define KSZ9477_REG_PORT_OUT_RATE_0 0x0420
693 #define KSZ9477_OUT_RATE_NO_LIMIT 0
695 #define KSZ9477_PORT_MRI_TC_MAP__4 0x0808
697 #define KSZ9477_PORT_TC_MAP_S 4
698 #define KSZ9477_MAX_TC_PRIO 7
700 /* CBS related registers */
701 #define REG_PORT_MTI_QUEUE_INDEX__4 0x0900
703 #define REG_PORT_MTI_QUEUE_CTRL_0 0x0914
705 #define MTI_SCHEDULE_MODE_M GENMASK(7, 6)
706 #define MTI_SCHEDULE_STRICT_PRIO 0
707 #define MTI_SCHEDULE_WRR 2
708 #define MTI_SHAPING_M GENMASK(5, 4)
709 #define MTI_SHAPING_OFF 0
710 #define MTI_SHAPING_SRP 1
711 #define MTI_SHAPING_TIME_AWARE 2
713 #define KSZ9477_PORT_MTI_QUEUE_CTRL_1 0x0915
714 #define KSZ9477_DEFAULT_WRR_WEIGHT 1
716 #define REG_PORT_MTI_HI_WATER_MARK 0x0916
717 #define REG_PORT_MTI_LO_WATER_MARK 0x0918
719 /* Regmap tables generation */
720 #define KSZ_SPI_OP_RD 3
721 #define KSZ_SPI_OP_WR 2
723 #define swabnot_used(x) 0
725 #define KSZ_SPI_OP_FLAG_MASK(opcode, swp, regbits, regpad) \
726 swab##swp((opcode) << ((regbits) + (regpad)))
728 #define KSZ_REGMAP_ENTRY(width, swp, regbits, regpad, regalign) \
731 .val_bits = (width), \
733 .reg_bits = (regbits) + (regalign), \
734 .pad_bits = (regpad), \
735 .max_register = BIT(regbits) - 1, \
736 .cache_type = REGCACHE_NONE, \
738 KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_RD, swp, \
741 KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_WR, swp, \
743 .lock = ksz_regmap_lock, \
744 .unlock = ksz_regmap_unlock, \
745 .reg_format_endian = REGMAP_ENDIAN_BIG, \
746 .val_format_endian = REGMAP_ENDIAN_BIG \
749 #define KSZ_REGMAP_TABLE(ksz, swp, regbits, regpad, regalign) \
750 static const struct regmap_config ksz##_regmap_config[] = { \
751 [KSZ_REGMAP_8] = KSZ_REGMAP_ENTRY(8, swp, (regbits), (regpad), (regalign)), \
752 [KSZ_REGMAP_16] = KSZ_REGMAP_ENTRY(16, swp, (regbits), (regpad), (regalign)), \
753 [KSZ_REGMAP_32] = KSZ_REGMAP_ENTRY(32, swp, (regbits), (regpad), (regalign)), \