1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Texas Instruments Ethernet Switch Driver
6 #ifndef DRIVERS_NET_ETHERNET_TI_CPSW_PRIV_H_
7 #define DRIVERS_NET_ETHERNET_TI_CPSW_PRIV_H_
9 #include "davinci_cpdma.h"
11 #define CPSW_DEBUG (NETIF_MSG_HW | NETIF_MSG_WOL | \
12 NETIF_MSG_DRV | NETIF_MSG_LINK | \
13 NETIF_MSG_IFUP | NETIF_MSG_INTR | \
14 NETIF_MSG_PROBE | NETIF_MSG_TIMER | \
15 NETIF_MSG_IFDOWN | NETIF_MSG_RX_ERR | \
16 NETIF_MSG_TX_ERR | NETIF_MSG_TX_DONE | \
17 NETIF_MSG_PKTDATA | NETIF_MSG_TX_QUEUED | \
20 #define cpsw_info(priv, type, format, ...) \
22 if (netif_msg_##type(priv) && net_ratelimit()) \
23 dev_info(priv->dev, format, ## __VA_ARGS__); \
26 #define cpsw_err(priv, type, format, ...) \
28 if (netif_msg_##type(priv) && net_ratelimit()) \
29 dev_err(priv->dev, format, ## __VA_ARGS__); \
32 #define cpsw_dbg(priv, type, format, ...) \
34 if (netif_msg_##type(priv) && net_ratelimit()) \
35 dev_dbg(priv->dev, format, ## __VA_ARGS__); \
38 #define cpsw_notice(priv, type, format, ...) \
40 if (netif_msg_##type(priv) && net_ratelimit()) \
41 dev_notice(priv->dev, format, ## __VA_ARGS__); \
44 #define ALE_ALL_PORTS 0x7
46 #define CPSW_MAJOR_VERSION(reg) (reg >> 8 & 0x7)
47 #define CPSW_MINOR_VERSION(reg) (reg & 0xff)
48 #define CPSW_RTL_VERSION(reg) ((reg >> 11) & 0x1f)
50 #define CPSW_VERSION_1 0x19010a
51 #define CPSW_VERSION_2 0x19010c
52 #define CPSW_VERSION_3 0x19010f
53 #define CPSW_VERSION_4 0x190112
55 #define HOST_PORT_NUM 0
56 #define CPSW_ALE_PORTS_NUM 3
57 #define CPSW_SLAVE_PORTS_NUM 2
58 #define SLIVER_SIZE 0x40
60 #define CPSW1_HOST_PORT_OFFSET 0x028
61 #define CPSW1_SLAVE_OFFSET 0x050
62 #define CPSW1_SLAVE_SIZE 0x040
63 #define CPSW1_CPDMA_OFFSET 0x100
64 #define CPSW1_STATERAM_OFFSET 0x200
65 #define CPSW1_HW_STATS 0x400
66 #define CPSW1_CPTS_OFFSET 0x500
67 #define CPSW1_ALE_OFFSET 0x600
68 #define CPSW1_SLIVER_OFFSET 0x700
69 #define CPSW1_WR_OFFSET 0x900
71 #define CPSW2_HOST_PORT_OFFSET 0x108
72 #define CPSW2_SLAVE_OFFSET 0x200
73 #define CPSW2_SLAVE_SIZE 0x100
74 #define CPSW2_CPDMA_OFFSET 0x800
75 #define CPSW2_HW_STATS 0x900
76 #define CPSW2_STATERAM_OFFSET 0xa00
77 #define CPSW2_CPTS_OFFSET 0xc00
78 #define CPSW2_ALE_OFFSET 0xd00
79 #define CPSW2_SLIVER_OFFSET 0xd80
80 #define CPSW2_BD_OFFSET 0x2000
81 #define CPSW2_WR_OFFSET 0x1200
83 #define CPDMA_RXTHRESH 0x0c0
84 #define CPDMA_RXFREE 0x0e0
85 #define CPDMA_TXHDP 0x00
86 #define CPDMA_RXHDP 0x20
87 #define CPDMA_TXCP 0x40
88 #define CPDMA_RXCP 0x60
90 #define CPSW_POLL_WEIGHT 64
91 #define CPSW_RX_VLAN_ENCAP_HDR_SIZE 4
92 #define CPSW_MIN_PACKET_SIZE (VLAN_ETH_ZLEN)
93 #define CPSW_MAX_PACKET_SIZE (VLAN_ETH_FRAME_LEN +\
95 CPSW_RX_VLAN_ENCAP_HDR_SIZE)
97 #define RX_PRIORITY_MAPPING 0x76543210
98 #define TX_PRIORITY_MAPPING 0x33221100
99 #define CPDMA_TX_PRIORITY_MAP 0x76543210
101 #define CPSW_VLAN_AWARE BIT(1)
102 #define CPSW_RX_VLAN_ENCAP BIT(2)
103 #define CPSW_ALE_VLAN_AWARE 1
105 #define CPSW_FIFO_NORMAL_MODE (0 << 16)
106 #define CPSW_FIFO_DUAL_MAC_MODE (1 << 16)
107 #define CPSW_FIFO_RATE_LIMIT_MODE (2 << 16)
109 #define CPSW_INTPACEEN (0x3f << 16)
110 #define CPSW_INTPRESCALE_MASK (0x7FF << 0)
111 #define CPSW_CMINTMAX_CNT 63
112 #define CPSW_CMINTMIN_CNT 2
113 #define CPSW_CMINTMAX_INTVL (1000 / CPSW_CMINTMIN_CNT)
114 #define CPSW_CMINTMIN_INTVL ((1000 / CPSW_CMINTMAX_CNT) + 1)
117 #define CPSW_MAX_QUEUES 8
118 #define CPSW_CPDMA_DESCS_POOL_SIZE_DEFAULT 256
119 #define CPSW_ALE_AGEOUT_DEFAULT 10 /* sec */
120 #define CPSW_FIFO_QUEUE_TYPE_SHIFT 16
121 #define CPSW_FIFO_SHAPE_EN_SHIFT 16
122 #define CPSW_FIFO_RATE_EN_SHIFT 20
123 #define CPSW_TC_NUM 4
124 #define CPSW_FIFO_SHAPERS_NUM (CPSW_TC_NUM - 1)
125 #define CPSW_PCT_MASK 0x7f
126 #define CPSW_BD_RAM_SIZE 0x2000
128 #define CPSW_RX_VLAN_ENCAP_HDR_PRIO_SHIFT 29
129 #define CPSW_RX_VLAN_ENCAP_HDR_PRIO_MSK GENMASK(2, 0)
130 #define CPSW_RX_VLAN_ENCAP_HDR_VID_SHIFT 16
131 #define CPSW_RX_VLAN_ENCAP_HDR_PKT_TYPE_SHIFT 8
132 #define CPSW_RX_VLAN_ENCAP_HDR_PKT_TYPE_MSK GENMASK(1, 0)
134 CPSW_RX_VLAN_ENCAP_HDR_PKT_VLAN_TAG = 0,
135 CPSW_RX_VLAN_ENCAP_HDR_PKT_RESERV,
136 CPSW_RX_VLAN_ENCAP_HDR_PKT_PRIO_TAG,
137 CPSW_RX_VLAN_ENCAP_HDR_PKT_UNTAG,
140 struct cpsw_wr_regs {
160 struct cpsw_ss_regs {
177 #define CPSW1_MAX_BLKS 0x00 /* Maximum FIFO Blocks */
178 #define CPSW1_BLK_CNT 0x04 /* FIFO Block Usage Count (Read Only) */
179 #define CPSW1_TX_IN_CTL 0x08 /* Transmit FIFO Control */
180 #define CPSW1_PORT_VLAN 0x0c /* VLAN Register */
181 #define CPSW1_TX_PRI_MAP 0x10 /* Tx Header Priority to Switch Pri Mapping */
182 #define CPSW1_TS_CTL 0x14 /* Time Sync Control */
183 #define CPSW1_TS_SEQ_LTYPE 0x18 /* Time Sync Sequence ID Offset and Msg Type */
184 #define CPSW1_TS_VLAN 0x1c /* Time Sync VLAN1 and VLAN2 */
187 #define CPSW2_CONTROL 0x00 /* Control Register */
188 #define CPSW2_MAX_BLKS 0x08 /* Maximum FIFO Blocks */
189 #define CPSW2_BLK_CNT 0x0c /* FIFO Block Usage Count (Read Only) */
190 #define CPSW2_TX_IN_CTL 0x10 /* Transmit FIFO Control */
191 #define CPSW2_PORT_VLAN 0x14 /* VLAN Register */
192 #define CPSW2_TX_PRI_MAP 0x18 /* Tx Header Priority to Switch Pri Mapping */
193 #define CPSW2_TS_SEQ_MTYPE 0x1c /* Time Sync Sequence ID Offset and Msg Type */
195 /* CPSW_PORT_V1 and V2 */
196 #define SA_LO 0x20 /* CPGMAC_SL Source Address Low */
197 #define SA_HI 0x24 /* CPGMAC_SL Source Address High */
198 #define SEND_PERCENT 0x28 /* Transmit Queue Send Percentages */
200 /* CPSW_PORT_V2 only */
201 #define RX_DSCP_PRI_MAP0 0x30 /* Rx DSCP Priority to Rx Packet Mapping */
202 #define RX_DSCP_PRI_MAP1 0x34 /* Rx DSCP Priority to Rx Packet Mapping */
203 #define RX_DSCP_PRI_MAP2 0x38 /* Rx DSCP Priority to Rx Packet Mapping */
204 #define RX_DSCP_PRI_MAP3 0x3c /* Rx DSCP Priority to Rx Packet Mapping */
205 #define RX_DSCP_PRI_MAP4 0x40 /* Rx DSCP Priority to Rx Packet Mapping */
206 #define RX_DSCP_PRI_MAP5 0x44 /* Rx DSCP Priority to Rx Packet Mapping */
207 #define RX_DSCP_PRI_MAP6 0x48 /* Rx DSCP Priority to Rx Packet Mapping */
208 #define RX_DSCP_PRI_MAP7 0x4c /* Rx DSCP Priority to Rx Packet Mapping */
210 /* Bit definitions for the CPSW2_CONTROL register */
211 #define PASS_PRI_TAGGED BIT(24) /* Pass Priority Tagged */
212 #define VLAN_LTYPE2_EN BIT(21) /* VLAN LTYPE 2 enable */
213 #define VLAN_LTYPE1_EN BIT(20) /* VLAN LTYPE 1 enable */
214 #define DSCP_PRI_EN BIT(16) /* DSCP Priority Enable */
215 #define TS_107 BIT(15) /* Tyme Sync Dest IP Address 107 */
216 #define TS_320 BIT(14) /* Time Sync Dest Port 320 enable */
217 #define TS_319 BIT(13) /* Time Sync Dest Port 319 enable */
218 #define TS_132 BIT(12) /* Time Sync Dest IP Addr 132 enable */
219 #define TS_131 BIT(11) /* Time Sync Dest IP Addr 131 enable */
220 #define TS_130 BIT(10) /* Time Sync Dest IP Addr 130 enable */
221 #define TS_129 BIT(9) /* Time Sync Dest IP Addr 129 enable */
222 #define TS_TTL_NONZERO BIT(8) /* Time Sync Time To Live Non-zero enable */
223 #define TS_ANNEX_F_EN BIT(6) /* Time Sync Annex F enable */
224 #define TS_ANNEX_D_EN BIT(4) /* Time Sync Annex D enable */
225 #define TS_LTYPE2_EN BIT(3) /* Time Sync LTYPE 2 enable */
226 #define TS_LTYPE1_EN BIT(2) /* Time Sync LTYPE 1 enable */
227 #define TS_TX_EN BIT(1) /* Time Sync Transmit Enable */
228 #define TS_RX_EN BIT(0) /* Time Sync Receive Enable */
230 #define CTRL_V2_TS_BITS \
231 (TS_320 | TS_319 | TS_132 | TS_131 | TS_130 | TS_129 |\
232 TS_TTL_NONZERO | TS_ANNEX_D_EN | TS_LTYPE1_EN | VLAN_LTYPE1_EN)
234 #define CTRL_V2_ALL_TS_MASK (CTRL_V2_TS_BITS | TS_TX_EN | TS_RX_EN)
235 #define CTRL_V2_TX_TS_BITS (CTRL_V2_TS_BITS | TS_TX_EN)
236 #define CTRL_V2_RX_TS_BITS (CTRL_V2_TS_BITS | TS_RX_EN)
239 #define CTRL_V3_TS_BITS \
240 (TS_107 | TS_320 | TS_319 | TS_132 | TS_131 | TS_130 | TS_129 |\
241 TS_TTL_NONZERO | TS_ANNEX_F_EN | TS_ANNEX_D_EN |\
242 TS_LTYPE1_EN | VLAN_LTYPE1_EN)
244 #define CTRL_V3_ALL_TS_MASK (CTRL_V3_TS_BITS | TS_TX_EN | TS_RX_EN)
245 #define CTRL_V3_TX_TS_BITS (CTRL_V3_TS_BITS | TS_TX_EN)
246 #define CTRL_V3_RX_TS_BITS (CTRL_V3_TS_BITS | TS_RX_EN)
248 /* Bit definitions for the CPSW2_TS_SEQ_MTYPE register */
249 #define TS_SEQ_ID_OFFSET_SHIFT (16) /* Time Sync Sequence ID Offset */
250 #define TS_SEQ_ID_OFFSET_MASK (0x3f)
251 #define TS_MSG_TYPE_EN_SHIFT (0) /* Time Sync Message Type Enable */
252 #define TS_MSG_TYPE_EN_MASK (0xffff)
254 /* The PTP event messages - Sync, Delay_Req, Pdelay_Req, and Pdelay_Resp. */
255 #define EVENT_MSG_BITS ((1<<0) | (1<<1) | (1<<2) | (1<<3))
257 /* Bit definitions for the CPSW1_TS_CTL register */
258 #define CPSW_V1_TS_RX_EN BIT(0)
259 #define CPSW_V1_TS_TX_EN BIT(4)
260 #define CPSW_V1_MSG_TYPE_OFS 16
262 /* Bit definitions for the CPSW1_TS_SEQ_LTYPE register */
263 #define CPSW_V1_SEQ_ID_OFS_SHIFT 16
265 #define CPSW_MAX_BLKS_TX 15
266 #define CPSW_MAX_BLKS_TX_SHIFT 4
267 #define CPSW_MAX_BLKS_RX 5
269 struct cpsw_host_regs {
275 u32 cpdma_tx_pri_map;
276 u32 cpdma_rx_chan_map;
279 struct cpsw_slave_data {
280 struct device_node *slave_node;
281 struct device_node *phy_node;
282 char phy_id[MII_BUS_ID_SIZE];
283 phy_interface_t phy_if;
284 u8 mac_addr[ETH_ALEN];
285 u16 dual_emac_res_vlan; /* Reserved VLAN for DualEMAC */
290 struct cpsw_platform_data {
291 struct cpsw_slave_data *slave_data;
292 u32 ss_reg_ofs; /* Subsystem control register offset */
293 u32 channels; /* number of cpdma channels (symmetric) */
294 u32 slaves; /* number of slave cpgmac ports */
295 u32 active_slave;/* time stamping, ethtool and SIOCGMIIPHY slave */
296 u32 bd_ram_size; /*buffer descriptor ram size */
297 u32 mac_control; /* Mac control register */
298 u16 default_vlan; /* Def VLAN for ALE lookup in VLAN aware mode*/
299 bool dual_emac; /* Enable Dual EMAC mode */
306 struct cpsw_slave_data *data;
307 struct phy_device *phy;
308 struct net_device *ndev;
310 struct cpsw_sl *mac_sl;
313 static inline u32 slave_read(struct cpsw_slave *slave, u32 offset)
315 return readl_relaxed(slave->regs + offset);
318 static inline void slave_write(struct cpsw_slave *slave, u32 val, u32 offset)
320 writel_relaxed(val, slave->regs + offset);
324 struct cpdma_chan *ch;
330 struct cpsw_platform_data data;
331 struct napi_struct napi_rx;
332 struct napi_struct napi_tx;
333 struct cpsw_ss_regs __iomem *regs;
334 struct cpsw_wr_regs __iomem *wr_regs;
335 u8 __iomem *hw_stats;
336 struct cpsw_host_regs __iomem *host_port_regs;
342 struct cpsw_slave *slaves;
343 struct cpdma_ctlr *dma;
344 struct cpsw_vector txv[CPSW_MAX_QUEUES];
345 struct cpsw_vector rxv[CPSW_MAX_QUEUES];
346 struct cpsw_ale *ale;
348 bool rx_irq_disabled;
349 bool tx_irq_disabled;
350 u32 irqs_table[IRQ_NUM];
353 struct devlink *devlink;
354 int rx_ch_num, tx_ch_num;
357 struct page_pool *page_pool[CPSW_MAX_QUEUES];
359 struct net_device *hw_bridge_dev;
361 u8 base_mac[ETH_ALEN];
365 struct net_device *ndev;
368 u8 mac_addr[ETH_ALEN];
372 int fifo_bw[CPSW_TC_NUM];
376 struct bpf_prog *xdp_prog;
377 struct xdp_rxq_info xdp_rxq[CPSW_MAX_QUEUES];
378 struct xdp_attachment_info xdpi;
381 struct cpsw_common *cpsw;
382 int offload_fwd_mark;
385 #define ndev_to_cpsw(ndev) (((struct cpsw_priv *)netdev_priv(ndev))->cpsw)
386 #define napi_to_cpsw(napi) container_of(napi, struct cpsw_common, napi)
388 extern int (*cpsw_slave_index)(struct cpsw_common *cpsw,
389 struct cpsw_priv *priv);
391 struct addr_sync_ctx {
392 struct net_device *ndev;
393 const u8 *addr; /* address to be synched */
394 int consumed; /* number of address instances */
395 int flush; /* flush flag */
398 #define CPSW_XMETA_OFFSET ALIGN(sizeof(struct xdp_frame), sizeof(long))
400 #define CPSW_XDP_CONSUMED 1
401 #define CPSW_XDP_PASS 0
403 struct __aligned(sizeof(long)) cpsw_meta_xdp {
404 struct net_device *ndev;
408 /* The buf includes headroom compatible with both skb and xdpf */
409 #define CPSW_HEADROOM_NA (max(XDP_PACKET_HEADROOM, NET_SKB_PAD) + NET_IP_ALIGN)
410 #define CPSW_HEADROOM ALIGN(CPSW_HEADROOM_NA, sizeof(long))
412 static inline int cpsw_is_xdpf_handle(void *handle)
414 return (unsigned long)handle & BIT(0);
417 static inline void *cpsw_xdpf_to_handle(struct xdp_frame *xdpf)
419 return (void *)((unsigned long)xdpf | BIT(0));
422 static inline struct xdp_frame *cpsw_handle_to_xdpf(void *handle)
424 return (struct xdp_frame *)((unsigned long)handle & ~BIT(0));
427 int cpsw_init_common(struct cpsw_common *cpsw, void __iomem *ss_regs,
428 int ale_ageout, phys_addr_t desc_mem_phys,
429 int descs_pool_size);
430 void cpsw_split_res(struct cpsw_common *cpsw);
431 int cpsw_fill_rx_channels(struct cpsw_priv *priv);
432 void cpsw_intr_enable(struct cpsw_common *cpsw);
433 void cpsw_intr_disable(struct cpsw_common *cpsw);
434 void cpsw_tx_handler(void *token, int len, int status);
435 int cpsw_create_xdp_rxqs(struct cpsw_common *cpsw);
436 void cpsw_destroy_xdp_rxqs(struct cpsw_common *cpsw);
437 int cpsw_ndo_bpf(struct net_device *ndev, struct netdev_bpf *bpf);
438 int cpsw_xdp_tx_frame(struct cpsw_priv *priv, struct xdp_frame *xdpf,
439 struct page *page, int port);
440 int cpsw_run_xdp(struct cpsw_priv *priv, int ch, struct xdp_buff *xdp,
441 struct page *page, int port, int *len);
442 irqreturn_t cpsw_tx_interrupt(int irq, void *dev_id);
443 irqreturn_t cpsw_rx_interrupt(int irq, void *dev_id);
444 irqreturn_t cpsw_misc_interrupt(int irq, void *dev_id);
445 int cpsw_tx_mq_poll(struct napi_struct *napi_tx, int budget);
446 int cpsw_tx_poll(struct napi_struct *napi_tx, int budget);
447 int cpsw_rx_mq_poll(struct napi_struct *napi_rx, int budget);
448 int cpsw_rx_poll(struct napi_struct *napi_rx, int budget);
449 void cpsw_rx_vlan_encap(struct sk_buff *skb);
450 void soft_reset(const char *module, void __iomem *reg);
451 void cpsw_set_slave_mac(struct cpsw_slave *slave, struct cpsw_priv *priv);
452 void cpsw_ndo_tx_timeout(struct net_device *ndev, unsigned int txqueue);
453 int cpsw_need_resplit(struct cpsw_common *cpsw);
454 int cpsw_ndo_ioctl(struct net_device *dev, struct ifreq *req, int cmd);
455 int cpsw_ndo_set_tx_maxrate(struct net_device *ndev, int queue, u32 rate);
456 int cpsw_ndo_setup_tc(struct net_device *ndev, enum tc_setup_type type,
458 bool cpsw_shp_is_off(struct cpsw_priv *priv);
459 void cpsw_cbs_resume(struct cpsw_slave *slave, struct cpsw_priv *priv);
460 void cpsw_mqprio_resume(struct cpsw_slave *slave, struct cpsw_priv *priv);
463 u32 cpsw_get_msglevel(struct net_device *ndev);
464 void cpsw_set_msglevel(struct net_device *ndev, u32 value);
465 int cpsw_get_coalesce(struct net_device *ndev, struct ethtool_coalesce *coal);
466 int cpsw_set_coalesce(struct net_device *ndev, struct ethtool_coalesce *coal);
467 int cpsw_get_sset_count(struct net_device *ndev, int sset);
468 void cpsw_get_strings(struct net_device *ndev, u32 stringset, u8 *data);
469 void cpsw_get_ethtool_stats(struct net_device *ndev,
470 struct ethtool_stats *stats, u64 *data);
471 void cpsw_get_pauseparam(struct net_device *ndev,
472 struct ethtool_pauseparam *pause);
473 void cpsw_get_wol(struct net_device *ndev, struct ethtool_wolinfo *wol);
474 int cpsw_set_wol(struct net_device *ndev, struct ethtool_wolinfo *wol);
475 int cpsw_get_regs_len(struct net_device *ndev);
476 void cpsw_get_regs(struct net_device *ndev, struct ethtool_regs *regs, void *p);
477 int cpsw_ethtool_op_begin(struct net_device *ndev);
478 void cpsw_ethtool_op_complete(struct net_device *ndev);
479 void cpsw_get_channels(struct net_device *ndev, struct ethtool_channels *ch);
480 int cpsw_get_link_ksettings(struct net_device *ndev,
481 struct ethtool_link_ksettings *ecmd);
482 int cpsw_set_link_ksettings(struct net_device *ndev,
483 const struct ethtool_link_ksettings *ecmd);
484 int cpsw_get_eee(struct net_device *ndev, struct ethtool_eee *edata);
485 int cpsw_set_eee(struct net_device *ndev, struct ethtool_eee *edata);
486 int cpsw_nway_reset(struct net_device *ndev);
487 void cpsw_get_ringparam(struct net_device *ndev,
488 struct ethtool_ringparam *ering);
489 int cpsw_set_ringparam(struct net_device *ndev,
490 struct ethtool_ringparam *ering);
491 int cpsw_set_channels_common(struct net_device *ndev,
492 struct ethtool_channels *chs,
493 cpdma_handler_fn rx_handler);
494 int cpsw_get_ts_info(struct net_device *ndev, struct ethtool_ts_info *info);
496 #endif /* DRIVERS_NET_ETHERNET_TI_CPSW_PRIV_H_ */