xref: /linux/drivers/net/dsa/microchip/ksz_common.h (revision e7d759f31ca295d589f7420719c311870bb3166f)
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 #include <linux/irq.h>
17 #include <linux/platform_data/microchip-ksz.h>
18 
19 #include "ksz_ptp.h"
20 
21 #define KSZ_MAX_NUM_PORTS 8
22 
23 struct ksz_device;
24 struct ksz_port;
25 
26 enum ksz_regmap_width {
27 	KSZ_REGMAP_8,
28 	KSZ_REGMAP_16,
29 	KSZ_REGMAP_32,
30 	__KSZ_NUM_REGMAPS,
31 };
32 
33 struct vlan_table {
34 	u32 table[3];
35 };
36 
37 struct ksz_port_mib {
38 	struct mutex cnt_mutex;		/* structure access */
39 	u8 cnt_ptr;
40 	u64 *counters;
41 	struct rtnl_link_stats64 stats64;
42 	struct ethtool_pause_stats pause_stats;
43 	struct spinlock stats64_lock;
44 };
45 
46 struct ksz_mib_names {
47 	int index;
48 	char string[ETH_GSTRING_LEN];
49 };
50 
51 struct ksz_chip_data {
52 	u32 chip_id;
53 	const char *dev_name;
54 	int num_vlans;
55 	int num_alus;
56 	int num_statics;
57 	int cpu_ports;
58 	int port_cnt;
59 	u8 port_nirqs;
60 	u8 num_tx_queues;
61 	bool tc_cbs_supported;
62 	bool tc_ets_supported;
63 	const struct ksz_dev_ops *ops;
64 	bool ksz87xx_eee_link_erratum;
65 	const struct ksz_mib_names *mib_names;
66 	int mib_cnt;
67 	u8 reg_mib_cnt;
68 	const u16 *regs;
69 	const u32 *masks;
70 	const u8 *shifts;
71 	const u8 *xmii_ctrl0;
72 	const u8 *xmii_ctrl1;
73 	int stp_ctrl_reg;
74 	int broadcast_ctrl_reg;
75 	int multicast_ctrl_reg;
76 	int start_ctrl_reg;
77 	bool supports_mii[KSZ_MAX_NUM_PORTS];
78 	bool supports_rmii[KSZ_MAX_NUM_PORTS];
79 	bool supports_rgmii[KSZ_MAX_NUM_PORTS];
80 	bool internal_phy[KSZ_MAX_NUM_PORTS];
81 	bool gbit_capable[KSZ_MAX_NUM_PORTS];
82 	const struct regmap_access_table *wr_table;
83 	const struct regmap_access_table *rd_table;
84 };
85 
86 struct ksz_irq {
87 	u16 masked;
88 	u16 reg_mask;
89 	u16 reg_status;
90 	struct irq_domain *domain;
91 	int nirqs;
92 	int irq_num;
93 	char name[16];
94 	struct ksz_device *dev;
95 };
96 
97 struct ksz_ptp_irq {
98 	struct ksz_port *port;
99 	u16 ts_reg;
100 	bool ts_en;
101 	char name[16];
102 	int num;
103 };
104 
105 struct ksz_switch_macaddr {
106 	unsigned char addr[ETH_ALEN];
107 	refcount_t refcount;
108 };
109 
110 struct ksz_port {
111 	bool remove_tag;		/* Remove Tag flag set, for ksz8795 only */
112 	bool learning;
113 	int stp_state;
114 	struct phy_device phydev;
115 
116 	u32 fiber:1;			/* port is fiber */
117 	u32 force:1;
118 	u32 read:1;			/* read MIB counters in background */
119 	u32 freeze:1;			/* MIB counter freeze is enabled */
120 
121 	struct ksz_port_mib mib;
122 	phy_interface_t interface;
123 	u32 rgmii_tx_val;
124 	u32 rgmii_rx_val;
125 	struct ksz_device *ksz_dev;
126 	void *acl_priv;
127 	struct ksz_irq pirq;
128 	u8 num;
129 #if IS_ENABLED(CONFIG_NET_DSA_MICROCHIP_KSZ_PTP)
130 	struct hwtstamp_config tstamp_config;
131 	bool hwts_tx_en;
132 	bool hwts_rx_en;
133 	struct ksz_irq ptpirq;
134 	struct ksz_ptp_irq ptpmsg_irq[3];
135 	ktime_t tstamp_msg;
136 	struct completion tstamp_msg_comp;
137 #endif
138 	bool manual_flow;
139 };
140 
141 struct ksz_device {
142 	struct dsa_switch *ds;
143 	struct ksz_platform_data *pdata;
144 	const struct ksz_chip_data *info;
145 
146 	struct mutex dev_mutex;		/* device access */
147 	struct mutex regmap_mutex;	/* regmap access */
148 	struct mutex alu_mutex;		/* ALU access */
149 	struct mutex vlan_mutex;	/* vlan access */
150 	const struct ksz_dev_ops *dev_ops;
151 
152 	struct device *dev;
153 	struct regmap *regmap[__KSZ_NUM_REGMAPS];
154 
155 	void *priv;
156 	int irq;
157 
158 	struct gpio_desc *reset_gpio;	/* Optional reset GPIO */
159 
160 	/* chip specific data */
161 	u32 chip_id;
162 	u8 chip_rev;
163 	int cpu_port;			/* port connected to CPU */
164 	int phy_port_cnt;
165 	phy_interface_t compat_interface;
166 	bool synclko_125;
167 	bool synclko_disable;
168 	bool wakeup_source;
169 
170 	struct vlan_table *vlan_cache;
171 
172 	struct ksz_port *ports;
173 	struct delayed_work mib_read;
174 	unsigned long mib_read_interval;
175 	u16 mirror_rx;
176 	u16 mirror_tx;
177 	u16 port_mask;
178 	struct mutex lock_irq;		/* IRQ Access */
179 	struct ksz_irq girq;
180 	struct ksz_ptp_data ptp_data;
181 
182 	struct ksz_switch_macaddr *switch_macaddr;
183 	struct net_device *hsr_dev;     /* HSR */
184 	u8 hsr_ports;
185 };
186 
187 /* List of supported models */
188 enum ksz_model {
189 	KSZ8563,
190 	KSZ8795,
191 	KSZ8794,
192 	KSZ8765,
193 	KSZ8830,
194 	KSZ9477,
195 	KSZ9896,
196 	KSZ9897,
197 	KSZ9893,
198 	KSZ9563,
199 	KSZ9567,
200 	LAN9370,
201 	LAN9371,
202 	LAN9372,
203 	LAN9373,
204 	LAN9374,
205 };
206 
207 enum ksz_regs {
208 	REG_SW_MAC_ADDR,
209 	REG_IND_CTRL_0,
210 	REG_IND_DATA_8,
211 	REG_IND_DATA_CHECK,
212 	REG_IND_DATA_HI,
213 	REG_IND_DATA_LO,
214 	REG_IND_MIB_CHECK,
215 	REG_IND_BYTE,
216 	P_FORCE_CTRL,
217 	P_LINK_STATUS,
218 	P_LOCAL_CTRL,
219 	P_NEG_RESTART_CTRL,
220 	P_REMOTE_STATUS,
221 	P_SPEED_STATUS,
222 	S_TAIL_TAG_CTRL,
223 	P_STP_CTRL,
224 	S_START_CTRL,
225 	S_BROADCAST_CTRL,
226 	S_MULTICAST_CTRL,
227 	P_XMII_CTRL_0,
228 	P_XMII_CTRL_1,
229 };
230 
231 enum ksz_masks {
232 	PORT_802_1P_REMAPPING,
233 	SW_TAIL_TAG_ENABLE,
234 	MIB_COUNTER_OVERFLOW,
235 	MIB_COUNTER_VALID,
236 	VLAN_TABLE_FID,
237 	VLAN_TABLE_MEMBERSHIP,
238 	VLAN_TABLE_VALID,
239 	STATIC_MAC_TABLE_VALID,
240 	STATIC_MAC_TABLE_USE_FID,
241 	STATIC_MAC_TABLE_FID,
242 	STATIC_MAC_TABLE_OVERRIDE,
243 	STATIC_MAC_TABLE_FWD_PORTS,
244 	DYNAMIC_MAC_TABLE_ENTRIES_H,
245 	DYNAMIC_MAC_TABLE_MAC_EMPTY,
246 	DYNAMIC_MAC_TABLE_NOT_READY,
247 	DYNAMIC_MAC_TABLE_ENTRIES,
248 	DYNAMIC_MAC_TABLE_FID,
249 	DYNAMIC_MAC_TABLE_SRC_PORT,
250 	DYNAMIC_MAC_TABLE_TIMESTAMP,
251 	ALU_STAT_WRITE,
252 	ALU_STAT_READ,
253 	P_MII_TX_FLOW_CTRL,
254 	P_MII_RX_FLOW_CTRL,
255 };
256 
257 enum ksz_shifts {
258 	VLAN_TABLE_MEMBERSHIP_S,
259 	VLAN_TABLE,
260 	STATIC_MAC_FWD_PORTS,
261 	STATIC_MAC_FID,
262 	DYNAMIC_MAC_ENTRIES_H,
263 	DYNAMIC_MAC_ENTRIES,
264 	DYNAMIC_MAC_FID,
265 	DYNAMIC_MAC_TIMESTAMP,
266 	DYNAMIC_MAC_SRC_PORT,
267 	ALU_STAT_INDEX,
268 };
269 
270 enum ksz_xmii_ctrl0 {
271 	P_MII_100MBIT,
272 	P_MII_10MBIT,
273 	P_MII_FULL_DUPLEX,
274 	P_MII_HALF_DUPLEX,
275 };
276 
277 enum ksz_xmii_ctrl1 {
278 	P_RGMII_SEL,
279 	P_RMII_SEL,
280 	P_GMII_SEL,
281 	P_MII_SEL,
282 	P_GMII_1GBIT,
283 	P_GMII_NOT_1GBIT,
284 };
285 
286 struct alu_struct {
287 	/* entry 1 */
288 	u8	is_static:1;
289 	u8	is_src_filter:1;
290 	u8	is_dst_filter:1;
291 	u8	prio_age:3;
292 	u32	_reserv_0_1:23;
293 	u8	mstp:3;
294 	/* entry 2 */
295 	u8	is_override:1;
296 	u8	is_use_fid:1;
297 	u32	_reserv_1_1:23;
298 	u8	port_forward:7;
299 	/* entry 3 & 4*/
300 	u32	_reserv_2_1:9;
301 	u8	fid:7;
302 	u8	mac[ETH_ALEN];
303 };
304 
305 struct ksz_dev_ops {
306 	int (*setup)(struct dsa_switch *ds);
307 	void (*teardown)(struct dsa_switch *ds);
308 	u32 (*get_port_addr)(int port, int offset);
309 	void (*cfg_port_member)(struct ksz_device *dev, int port, u8 member);
310 	void (*flush_dyn_mac_table)(struct ksz_device *dev, int port);
311 	void (*port_cleanup)(struct ksz_device *dev, int port);
312 	void (*port_setup)(struct ksz_device *dev, int port, bool cpu_port);
313 	int (*set_ageing_time)(struct ksz_device *dev, unsigned int msecs);
314 	int (*r_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 *val);
315 	int (*w_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 val);
316 	void (*r_mib_cnt)(struct ksz_device *dev, int port, u16 addr,
317 			  u64 *cnt);
318 	void (*r_mib_pkt)(struct ksz_device *dev, int port, u16 addr,
319 			  u64 *dropped, u64 *cnt);
320 	void (*r_mib_stat64)(struct ksz_device *dev, int port);
321 	int  (*vlan_filtering)(struct ksz_device *dev, int port,
322 			       bool flag, struct netlink_ext_ack *extack);
323 	int  (*vlan_add)(struct ksz_device *dev, int port,
324 			 const struct switchdev_obj_port_vlan *vlan,
325 			 struct netlink_ext_ack *extack);
326 	int  (*vlan_del)(struct ksz_device *dev, int port,
327 			 const struct switchdev_obj_port_vlan *vlan);
328 	int (*mirror_add)(struct ksz_device *dev, int port,
329 			  struct dsa_mall_mirror_tc_entry *mirror,
330 			  bool ingress, struct netlink_ext_ack *extack);
331 	void (*mirror_del)(struct ksz_device *dev, int port,
332 			   struct dsa_mall_mirror_tc_entry *mirror);
333 	int (*fdb_add)(struct ksz_device *dev, int port,
334 		       const unsigned char *addr, u16 vid, struct dsa_db db);
335 	int (*fdb_del)(struct ksz_device *dev, int port,
336 		       const unsigned char *addr, u16 vid, struct dsa_db db);
337 	int (*fdb_dump)(struct ksz_device *dev, int port,
338 			dsa_fdb_dump_cb_t *cb, void *data);
339 	int (*mdb_add)(struct ksz_device *dev, int port,
340 		       const struct switchdev_obj_port_mdb *mdb,
341 		       struct dsa_db db);
342 	int (*mdb_del)(struct ksz_device *dev, int port,
343 		       const struct switchdev_obj_port_mdb *mdb,
344 		       struct dsa_db db);
345 	void (*get_caps)(struct ksz_device *dev, int port,
346 			 struct phylink_config *config);
347 	int (*change_mtu)(struct ksz_device *dev, int port, int mtu);
348 	void (*freeze_mib)(struct ksz_device *dev, int port, bool freeze);
349 	void (*port_init_cnt)(struct ksz_device *dev, int port);
350 	void (*phylink_mac_config)(struct ksz_device *dev, int port,
351 				   unsigned int mode,
352 				   const struct phylink_link_state *state);
353 	void (*phylink_mac_link_up)(struct ksz_device *dev, int port,
354 				    unsigned int mode,
355 				    phy_interface_t interface,
356 				    struct phy_device *phydev, int speed,
357 				    int duplex, bool tx_pause, bool rx_pause);
358 	void (*setup_rgmii_delay)(struct ksz_device *dev, int port);
359 	int (*tc_cbs_set_cinc)(struct ksz_device *dev, int port, u32 val);
360 	void (*get_wol)(struct ksz_device *dev, int port,
361 			struct ethtool_wolinfo *wol);
362 	int (*set_wol)(struct ksz_device *dev, int port,
363 		       struct ethtool_wolinfo *wol);
364 	void (*wol_pre_shutdown)(struct ksz_device *dev, bool *wol_enabled);
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);
370 };
371 
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);
375 
376 void ksz_init_mib_timer(struct ksz_device *dev);
377 bool ksz_is_port_mac_global_usable(struct dsa_switch *ds, int port);
378 void ksz_r_mib_stats64(struct ksz_device *dev, int port);
379 void ksz88xx_r_mib_stats64(struct ksz_device *dev, int port);
380 void ksz_port_stp_state_set(struct dsa_switch *ds, int port, u8 state);
381 bool ksz_get_gbit(struct ksz_device *dev, int port);
382 phy_interface_t ksz_get_xmii(struct ksz_device *dev, int port, bool gbit);
383 extern const struct ksz_chip_data ksz_switch_chips[];
384 int ksz_switch_macaddr_get(struct dsa_switch *ds, int port,
385 			   struct netlink_ext_ack *extack);
386 void ksz_switch_macaddr_put(struct dsa_switch *ds);
387 void ksz_switch_shutdown(struct ksz_device *dev);
388 
389 /* Common register access functions */
390 static inline struct regmap *ksz_regmap_8(struct ksz_device *dev)
391 {
392 	return dev->regmap[KSZ_REGMAP_8];
393 }
394 
395 static inline struct regmap *ksz_regmap_16(struct ksz_device *dev)
396 {
397 	return dev->regmap[KSZ_REGMAP_16];
398 }
399 
400 static inline struct regmap *ksz_regmap_32(struct ksz_device *dev)
401 {
402 	return dev->regmap[KSZ_REGMAP_32];
403 }
404 
405 static inline int ksz_read8(struct ksz_device *dev, u32 reg, u8 *val)
406 {
407 	unsigned int value;
408 	int ret = regmap_read(ksz_regmap_8(dev), reg, &value);
409 
410 	if (ret)
411 		dev_err(dev->dev, "can't read 8bit reg: 0x%x %pe\n", reg,
412 			ERR_PTR(ret));
413 
414 	*val = value;
415 	return ret;
416 }
417 
418 static inline int ksz_read16(struct ksz_device *dev, u32 reg, u16 *val)
419 {
420 	unsigned int value;
421 	int ret = regmap_read(ksz_regmap_16(dev), reg, &value);
422 
423 	if (ret)
424 		dev_err(dev->dev, "can't read 16bit reg: 0x%x %pe\n", reg,
425 			ERR_PTR(ret));
426 
427 	*val = value;
428 	return ret;
429 }
430 
431 static inline int ksz_read32(struct ksz_device *dev, u32 reg, u32 *val)
432 {
433 	unsigned int value;
434 	int ret = regmap_read(ksz_regmap_32(dev), reg, &value);
435 
436 	if (ret)
437 		dev_err(dev->dev, "can't read 32bit reg: 0x%x %pe\n", reg,
438 			ERR_PTR(ret));
439 
440 	*val = value;
441 	return ret;
442 }
443 
444 static inline int ksz_read64(struct ksz_device *dev, u32 reg, u64 *val)
445 {
446 	u32 value[2];
447 	int ret;
448 
449 	ret = regmap_bulk_read(ksz_regmap_32(dev), reg, value, 2);
450 	if (ret)
451 		dev_err(dev->dev, "can't read 64bit reg: 0x%x %pe\n", reg,
452 			ERR_PTR(ret));
453 	else
454 		*val = (u64)value[0] << 32 | value[1];
455 
456 	return ret;
457 }
458 
459 static inline int ksz_write8(struct ksz_device *dev, u32 reg, u8 value)
460 {
461 	int ret;
462 
463 	ret = regmap_write(ksz_regmap_8(dev), reg, value);
464 	if (ret)
465 		dev_err(dev->dev, "can't write 8bit reg: 0x%x %pe\n", reg,
466 			ERR_PTR(ret));
467 
468 	return ret;
469 }
470 
471 static inline int ksz_write16(struct ksz_device *dev, u32 reg, u16 value)
472 {
473 	int ret;
474 
475 	ret = regmap_write(ksz_regmap_16(dev), reg, value);
476 	if (ret)
477 		dev_err(dev->dev, "can't write 16bit reg: 0x%x %pe\n", reg,
478 			ERR_PTR(ret));
479 
480 	return ret;
481 }
482 
483 static inline int ksz_write32(struct ksz_device *dev, u32 reg, u32 value)
484 {
485 	int ret;
486 
487 	ret = regmap_write(ksz_regmap_32(dev), reg, value);
488 	if (ret)
489 		dev_err(dev->dev, "can't write 32bit reg: 0x%x %pe\n", reg,
490 			ERR_PTR(ret));
491 
492 	return ret;
493 }
494 
495 static inline int ksz_rmw16(struct ksz_device *dev, u32 reg, u16 mask,
496 			    u16 value)
497 {
498 	int ret;
499 
500 	ret = regmap_update_bits(ksz_regmap_16(dev), reg, mask, value);
501 	if (ret)
502 		dev_err(dev->dev, "can't rmw 16bit reg 0x%x: %pe\n", reg,
503 			ERR_PTR(ret));
504 
505 	return ret;
506 }
507 
508 static inline int ksz_rmw32(struct ksz_device *dev, u32 reg, u32 mask,
509 			    u32 value)
510 {
511 	int ret;
512 
513 	ret = regmap_update_bits(ksz_regmap_32(dev), reg, mask, value);
514 	if (ret)
515 		dev_err(dev->dev, "can't rmw 32bit reg 0x%x: %pe\n", reg,
516 			ERR_PTR(ret));
517 
518 	return ret;
519 }
520 
521 static inline int ksz_write64(struct ksz_device *dev, u32 reg, u64 value)
522 {
523 	u32 val[2];
524 
525 	/* Ick! ToDo: Add 64bit R/W to regmap on 32bit systems */
526 	value = swab64(value);
527 	val[0] = swab32(value & 0xffffffffULL);
528 	val[1] = swab32(value >> 32ULL);
529 
530 	return regmap_bulk_write(ksz_regmap_32(dev), reg, val, 2);
531 }
532 
533 static inline int ksz_rmw8(struct ksz_device *dev, int offset, u8 mask, u8 val)
534 {
535 	int ret;
536 
537 	ret = regmap_update_bits(ksz_regmap_8(dev), offset, mask, val);
538 	if (ret)
539 		dev_err(dev->dev, "can't rmw 8bit reg 0x%x: %pe\n", offset,
540 			ERR_PTR(ret));
541 
542 	return ret;
543 }
544 
545 static inline int ksz_pread8(struct ksz_device *dev, int port, int offset,
546 			     u8 *data)
547 {
548 	return ksz_read8(dev, dev->dev_ops->get_port_addr(port, offset), data);
549 }
550 
551 static inline int ksz_pread16(struct ksz_device *dev, int port, int offset,
552 			      u16 *data)
553 {
554 	return ksz_read16(dev, dev->dev_ops->get_port_addr(port, offset), data);
555 }
556 
557 static inline int ksz_pread32(struct ksz_device *dev, int port, int offset,
558 			      u32 *data)
559 {
560 	return ksz_read32(dev, dev->dev_ops->get_port_addr(port, offset), data);
561 }
562 
563 static inline int ksz_pwrite8(struct ksz_device *dev, int port, int offset,
564 			      u8 data)
565 {
566 	return ksz_write8(dev, dev->dev_ops->get_port_addr(port, offset), data);
567 }
568 
569 static inline int ksz_pwrite16(struct ksz_device *dev, int port, int offset,
570 			       u16 data)
571 {
572 	return ksz_write16(dev, dev->dev_ops->get_port_addr(port, offset),
573 			   data);
574 }
575 
576 static inline int ksz_pwrite32(struct ksz_device *dev, int port, int offset,
577 			       u32 data)
578 {
579 	return ksz_write32(dev, dev->dev_ops->get_port_addr(port, offset),
580 			   data);
581 }
582 
583 static inline int ksz_prmw8(struct ksz_device *dev, int port, int offset,
584 			    u8 mask, u8 val)
585 {
586 	return ksz_rmw8(dev, dev->dev_ops->get_port_addr(port, offset),
587 			mask, val);
588 }
589 
590 static inline int ksz_prmw32(struct ksz_device *dev, int port, int offset,
591 			     u32 mask, u32 val)
592 {
593 	return ksz_rmw32(dev, dev->dev_ops->get_port_addr(port, offset),
594 			 mask, val);
595 }
596 
597 static inline void ksz_regmap_lock(void *__mtx)
598 {
599 	struct mutex *mtx = __mtx;
600 	mutex_lock(mtx);
601 }
602 
603 static inline void ksz_regmap_unlock(void *__mtx)
604 {
605 	struct mutex *mtx = __mtx;
606 	mutex_unlock(mtx);
607 }
608 
609 static inline bool ksz_is_ksz87xx(struct ksz_device *dev)
610 {
611 	return dev->chip_id == KSZ8795_CHIP_ID ||
612 	       dev->chip_id == KSZ8794_CHIP_ID ||
613 	       dev->chip_id == KSZ8765_CHIP_ID;
614 }
615 
616 static inline bool ksz_is_ksz88x3(struct ksz_device *dev)
617 {
618 	return dev->chip_id == KSZ8830_CHIP_ID;
619 }
620 
621 static inline int is_lan937x(struct ksz_device *dev)
622 {
623 	return dev->chip_id == LAN9370_CHIP_ID ||
624 		dev->chip_id == LAN9371_CHIP_ID ||
625 		dev->chip_id == LAN9372_CHIP_ID ||
626 		dev->chip_id == LAN9373_CHIP_ID ||
627 		dev->chip_id == LAN9374_CHIP_ID;
628 }
629 
630 /* STP State Defines */
631 #define PORT_TX_ENABLE			BIT(2)
632 #define PORT_RX_ENABLE			BIT(1)
633 #define PORT_LEARN_DISABLE		BIT(0)
634 
635 /* Switch ID Defines */
636 #define REG_CHIP_ID0			0x00
637 
638 #define SW_FAMILY_ID_M			GENMASK(15, 8)
639 #define KSZ87_FAMILY_ID			0x87
640 #define KSZ88_FAMILY_ID			0x88
641 
642 #define KSZ8_PORT_STATUS_0		0x08
643 #define KSZ8_PORT_FIBER_MODE		BIT(7)
644 
645 #define SW_CHIP_ID_M			GENMASK(7, 4)
646 #define KSZ87_CHIP_ID_94		0x6
647 #define KSZ87_CHIP_ID_95		0x9
648 #define KSZ88_CHIP_ID_63		0x3
649 
650 #define SW_REV_ID_M			GENMASK(7, 4)
651 
652 /* KSZ9893, KSZ9563, KSZ8563 specific register  */
653 #define REG_CHIP_ID4			0x0f
654 #define SKU_ID_KSZ8563			0x3c
655 #define SKU_ID_KSZ9563			0x1c
656 
657 /* Driver set switch broadcast storm protection at 10% rate. */
658 #define BROADCAST_STORM_PROT_RATE	10
659 
660 /* 148,800 frames * 67 ms / 100 */
661 #define BROADCAST_STORM_VALUE		9969
662 
663 #define BROADCAST_STORM_RATE_HI		0x07
664 #define BROADCAST_STORM_RATE_LO		0xFF
665 #define BROADCAST_STORM_RATE		0x07FF
666 
667 #define MULTICAST_STORM_DISABLE		BIT(6)
668 
669 #define SW_START			0x01
670 
671 /* xMII configuration */
672 #define P_MII_DUPLEX_M			BIT(6)
673 #define P_MII_100MBIT_M			BIT(4)
674 
675 #define P_GMII_1GBIT_M			BIT(6)
676 #define P_RGMII_ID_IG_ENABLE		BIT(4)
677 #define P_RGMII_ID_EG_ENABLE		BIT(3)
678 #define P_MII_MAC_MODE			BIT(2)
679 #define P_MII_SEL_M			0x3
680 
681 /* Interrupt */
682 #define REG_SW_PORT_INT_STATUS__1	0x001B
683 #define REG_SW_PORT_INT_MASK__1		0x001F
684 
685 #define REG_PORT_INT_STATUS		0x001B
686 #define REG_PORT_INT_MASK		0x001F
687 
688 #define PORT_SRC_PHY_INT		1
689 #define PORT_SRC_PTP_INT		2
690 
691 #define KSZ8795_HUGE_PACKET_SIZE	2000
692 #define KSZ8863_HUGE_PACKET_SIZE	1916
693 #define KSZ8863_NORMAL_PACKET_SIZE	1536
694 #define KSZ8_LEGAL_PACKET_SIZE		1518
695 #define KSZ9477_MAX_FRAME_SIZE		9000
696 
697 #define KSZ8873_REG_GLOBAL_CTRL_12	0x0e
698 /* Drive Strength of I/O Pad
699  * 0: 8mA, 1: 16mA
700  */
701 #define KSZ8873_DRIVE_STRENGTH_16MA	BIT(6)
702 
703 #define KSZ8795_REG_SW_CTRL_20		0xa3
704 #define KSZ9477_REG_SW_IO_STRENGTH	0x010d
705 #define SW_DRIVE_STRENGTH_M		0x7
706 #define SW_DRIVE_STRENGTH_2MA		0
707 #define SW_DRIVE_STRENGTH_4MA		1
708 #define SW_DRIVE_STRENGTH_8MA		2
709 #define SW_DRIVE_STRENGTH_12MA		3
710 #define SW_DRIVE_STRENGTH_16MA		4
711 #define SW_DRIVE_STRENGTH_20MA		5
712 #define SW_DRIVE_STRENGTH_24MA		6
713 #define SW_DRIVE_STRENGTH_28MA		7
714 #define SW_HI_SPEED_DRIVE_STRENGTH_S	4
715 #define SW_LO_SPEED_DRIVE_STRENGTH_S	0
716 
717 #define KSZ9477_REG_PORT_OUT_RATE_0	0x0420
718 #define KSZ9477_OUT_RATE_NO_LIMIT	0
719 
720 #define KSZ9477_PORT_MRI_TC_MAP__4	0x0808
721 
722 #define KSZ9477_PORT_TC_MAP_S		4
723 #define KSZ9477_MAX_TC_PRIO		7
724 
725 /* CBS related registers */
726 #define REG_PORT_MTI_QUEUE_INDEX__4	0x0900
727 
728 #define REG_PORT_MTI_QUEUE_CTRL_0	0x0914
729 
730 #define MTI_SCHEDULE_MODE_M		GENMASK(7, 6)
731 #define MTI_SCHEDULE_STRICT_PRIO	0
732 #define MTI_SCHEDULE_WRR		2
733 #define MTI_SHAPING_M			GENMASK(5, 4)
734 #define MTI_SHAPING_OFF			0
735 #define MTI_SHAPING_SRP			1
736 #define MTI_SHAPING_TIME_AWARE		2
737 
738 #define KSZ9477_PORT_MTI_QUEUE_CTRL_1	0x0915
739 #define KSZ9477_DEFAULT_WRR_WEIGHT	1
740 
741 #define REG_PORT_MTI_HI_WATER_MARK	0x0916
742 #define REG_PORT_MTI_LO_WATER_MARK	0x0918
743 
744 /* Regmap tables generation */
745 #define KSZ_SPI_OP_RD		3
746 #define KSZ_SPI_OP_WR		2
747 
748 #define swabnot_used(x)		0
749 
750 #define KSZ_SPI_OP_FLAG_MASK(opcode, swp, regbits, regpad)		\
751 	swab##swp((opcode) << ((regbits) + (regpad)))
752 
753 #define KSZ_REGMAP_ENTRY(width, swp, regbits, regpad, regalign)		\
754 	{								\
755 		.name = #width,						\
756 		.val_bits = (width),					\
757 		.reg_stride = 1,					\
758 		.reg_bits = (regbits) + (regalign),			\
759 		.pad_bits = (regpad),					\
760 		.max_register = BIT(regbits) - 1,			\
761 		.cache_type = REGCACHE_NONE,				\
762 		.read_flag_mask =					\
763 			KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_RD, swp,	\
764 					     regbits, regpad),		\
765 		.write_flag_mask =					\
766 			KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_WR, swp,	\
767 					     regbits, regpad),		\
768 		.lock = ksz_regmap_lock,				\
769 		.unlock = ksz_regmap_unlock,				\
770 		.reg_format_endian = REGMAP_ENDIAN_BIG,			\
771 		.val_format_endian = REGMAP_ENDIAN_BIG			\
772 	}
773 
774 #define KSZ_REGMAP_TABLE(ksz, swp, regbits, regpad, regalign)		\
775 	static const struct regmap_config ksz##_regmap_config[] = {	\
776 		[KSZ_REGMAP_8] = KSZ_REGMAP_ENTRY(8, swp, (regbits), (regpad), (regalign)), \
777 		[KSZ_REGMAP_16] = KSZ_REGMAP_ENTRY(16, swp, (regbits), (regpad), (regalign)), \
778 		[KSZ_REGMAP_32] = KSZ_REGMAP_ENTRY(32, swp, (regbits), (regpad), (regalign)), \
779 	}
780 
781 #endif
782