168cf027fSGrygorii Strashko /* SPDX-License-Identifier: GPL-2.0 */
284640e27SKaricheri, Muralidharan /*
384640e27SKaricheri, Muralidharan * NetCP driver local header
484640e27SKaricheri, Muralidharan *
584640e27SKaricheri, Muralidharan * Copyright (C) 2014 Texas Instruments Incorporated
684640e27SKaricheri, Muralidharan * Authors: Sandeep Nair <sandeep_n@ti.com>
784640e27SKaricheri, Muralidharan * Sandeep Paulraj <s-paulraj@ti.com>
884640e27SKaricheri, Muralidharan * Cyril Chemparathy <cyril@ti.com>
984640e27SKaricheri, Muralidharan * Santosh Shilimkar <santosh.shilimkar@ti.com>
1084640e27SKaricheri, Muralidharan * Wingman Kwok <w-kwok2@ti.com>
1184640e27SKaricheri, Muralidharan * Murali Karicheri <m-karicheri2@ti.com>
1284640e27SKaricheri, Muralidharan */
1384640e27SKaricheri, Muralidharan #ifndef __NETCP_H__
1484640e27SKaricheri, Muralidharan #define __NETCP_H__
1584640e27SKaricheri, Muralidharan
1684640e27SKaricheri, Muralidharan #include <linux/netdevice.h>
1784640e27SKaricheri, Muralidharan #include <linux/soc/ti/knav_dma.h>
186a8162e9SMichael Scherban #include <linux/u64_stats_sync.h>
1984640e27SKaricheri, Muralidharan
2084640e27SKaricheri, Muralidharan /* Maximum Ethernet frame size supported by Keystone switch */
2184640e27SKaricheri, Muralidharan #define NETCP_MAX_FRAME_SIZE 9504
2284640e27SKaricheri, Muralidharan
2384640e27SKaricheri, Muralidharan #define SGMII_LINK_MAC_MAC_AUTONEG 0
2484640e27SKaricheri, Muralidharan #define SGMII_LINK_MAC_PHY 1
2584640e27SKaricheri, Muralidharan #define SGMII_LINK_MAC_MAC_FORCED 2
2684640e27SKaricheri, Muralidharan #define SGMII_LINK_MAC_FIBER 3
2784640e27SKaricheri, Muralidharan #define SGMII_LINK_MAC_PHY_NO_MDIO 4
28478e9a5fSMurali Karicheri #define RGMII_LINK_MAC_PHY 5
29478e9a5fSMurali Karicheri #define RGMII_LINK_MAC_PHY_NO_MDIO 7
3084640e27SKaricheri, Muralidharan #define XGMII_LINK_MAC_PHY 10
3184640e27SKaricheri, Muralidharan #define XGMII_LINK_MAC_MAC_FORCED 11
3284640e27SKaricheri, Muralidharan
3384640e27SKaricheri, Muralidharan struct netcp_device;
3484640e27SKaricheri, Muralidharan
3584640e27SKaricheri, Muralidharan struct netcp_tx_pipe {
3684640e27SKaricheri, Muralidharan struct netcp_device *netcp_device;
3784640e27SKaricheri, Muralidharan void *dma_queue;
3884640e27SKaricheri, Muralidharan unsigned int dma_queue_id;
39e170f409SKaricheri, Muralidharan /* To port for packet forwarded to switch. Used only by ethss */
40e170f409SKaricheri, Muralidharan u8 switch_to_port;
41e170f409SKaricheri, Muralidharan #define SWITCH_TO_PORT_IN_TAGINFO BIT(0)
42e170f409SKaricheri, Muralidharan u8 flags;
4384640e27SKaricheri, Muralidharan void *dma_channel;
4484640e27SKaricheri, Muralidharan const char *dma_chan_name;
4584640e27SKaricheri, Muralidharan };
4684640e27SKaricheri, Muralidharan
4784640e27SKaricheri, Muralidharan #define ADDR_NEW BIT(0)
4884640e27SKaricheri, Muralidharan #define ADDR_VALID BIT(1)
4984640e27SKaricheri, Muralidharan
5084640e27SKaricheri, Muralidharan enum netcp_addr_type {
5184640e27SKaricheri, Muralidharan ADDR_ANY,
5284640e27SKaricheri, Muralidharan ADDR_DEV,
5384640e27SKaricheri, Muralidharan ADDR_UCAST,
5484640e27SKaricheri, Muralidharan ADDR_MCAST,
5584640e27SKaricheri, Muralidharan ADDR_BCAST
5684640e27SKaricheri, Muralidharan };
5784640e27SKaricheri, Muralidharan
5884640e27SKaricheri, Muralidharan struct netcp_addr {
5984640e27SKaricheri, Muralidharan struct netcp_intf *netcp;
6084640e27SKaricheri, Muralidharan unsigned char addr[ETH_ALEN];
6184640e27SKaricheri, Muralidharan enum netcp_addr_type type;
6284640e27SKaricheri, Muralidharan unsigned int flags;
6384640e27SKaricheri, Muralidharan struct list_head node;
6484640e27SKaricheri, Muralidharan };
6584640e27SKaricheri, Muralidharan
666a8162e9SMichael Scherban struct netcp_stats {
676a8162e9SMichael Scherban struct u64_stats_sync syncp_rx ____cacheline_aligned_in_smp;
686a8162e9SMichael Scherban u64 rx_packets;
696a8162e9SMichael Scherban u64 rx_bytes;
706a8162e9SMichael Scherban u32 rx_errors;
716a8162e9SMichael Scherban u32 rx_dropped;
726a8162e9SMichael Scherban
736a8162e9SMichael Scherban struct u64_stats_sync syncp_tx ____cacheline_aligned_in_smp;
746a8162e9SMichael Scherban u64 tx_packets;
756a8162e9SMichael Scherban u64 tx_bytes;
766a8162e9SMichael Scherban u32 tx_errors;
776a8162e9SMichael Scherban u32 tx_dropped;
786a8162e9SMichael Scherban };
796a8162e9SMichael Scherban
8084640e27SKaricheri, Muralidharan struct netcp_intf {
8184640e27SKaricheri, Muralidharan struct device *dev;
8284640e27SKaricheri, Muralidharan struct device *ndev_dev;
8384640e27SKaricheri, Muralidharan struct net_device *ndev;
8484640e27SKaricheri, Muralidharan bool big_endian;
8584640e27SKaricheri, Muralidharan unsigned int tx_compl_qid;
8684640e27SKaricheri, Muralidharan void *tx_pool;
8784640e27SKaricheri, Muralidharan struct list_head txhook_list_head;
8884640e27SKaricheri, Muralidharan unsigned int tx_pause_threshold;
8984640e27SKaricheri, Muralidharan void *tx_compl_q;
9084640e27SKaricheri, Muralidharan
9184640e27SKaricheri, Muralidharan unsigned int tx_resume_threshold;
9284640e27SKaricheri, Muralidharan void *rx_queue;
9384640e27SKaricheri, Muralidharan void *rx_pool;
9484640e27SKaricheri, Muralidharan struct list_head rxhook_list_head;
9584640e27SKaricheri, Muralidharan unsigned int rx_queue_id;
9684640e27SKaricheri, Muralidharan void *rx_fdq[KNAV_DMA_FDQ_PER_CHAN];
9784640e27SKaricheri, Muralidharan struct napi_struct rx_napi;
9884640e27SKaricheri, Muralidharan struct napi_struct tx_napi;
994cd85a61SKaricheri, Muralidharan #define ETH_SW_CAN_REMOVE_ETH_FCS BIT(0)
1004cd85a61SKaricheri, Muralidharan u32 hw_cap;
10184640e27SKaricheri, Muralidharan
1026a8162e9SMichael Scherban /* 64-bit netcp stats */
1036a8162e9SMichael Scherban struct netcp_stats stats;
1046a8162e9SMichael Scherban
10584640e27SKaricheri, Muralidharan void *rx_channel;
10684640e27SKaricheri, Muralidharan const char *dma_chan_name;
10784640e27SKaricheri, Muralidharan u32 rx_pool_size;
10884640e27SKaricheri, Muralidharan u32 rx_pool_region_id;
10984640e27SKaricheri, Muralidharan u32 tx_pool_size;
11084640e27SKaricheri, Muralidharan u32 tx_pool_region_id;
11184640e27SKaricheri, Muralidharan struct list_head module_head;
11284640e27SKaricheri, Muralidharan struct list_head interface_list;
11384640e27SKaricheri, Muralidharan struct list_head addr_list;
11484640e27SKaricheri, Muralidharan bool netdev_registered;
11584640e27SKaricheri, Muralidharan bool primary_module_attached;
11684640e27SKaricheri, Muralidharan
11784640e27SKaricheri, Muralidharan /* Lock used for protecting Rx/Tx hook list management */
11884640e27SKaricheri, Muralidharan spinlock_t lock;
11984640e27SKaricheri, Muralidharan struct netcp_device *netcp_device;
12084640e27SKaricheri, Muralidharan struct device_node *node_interface;
12184640e27SKaricheri, Muralidharan
12284640e27SKaricheri, Muralidharan /* DMA configuration data */
12384640e27SKaricheri, Muralidharan u32 msg_enable;
12484640e27SKaricheri, Muralidharan u32 rx_queue_depths[KNAV_DMA_FDQ_PER_CHAN];
12584640e27SKaricheri, Muralidharan };
12684640e27SKaricheri, Muralidharan
12784640e27SKaricheri, Muralidharan #define NETCP_PSDATA_LEN KNAV_DMA_NUM_PS_WORDS
12884640e27SKaricheri, Muralidharan struct netcp_packet {
12984640e27SKaricheri, Muralidharan struct sk_buff *skb;
1309dd2d6c5SArnd Bergmann __le32 *epib;
13184640e27SKaricheri, Muralidharan u32 *psdata;
13269d707d0SKaricheri, Muralidharan u32 eflags;
13384640e27SKaricheri, Muralidharan unsigned int psdata_len;
13484640e27SKaricheri, Muralidharan struct netcp_intf *netcp;
13584640e27SKaricheri, Muralidharan struct netcp_tx_pipe *tx_pipe;
13684640e27SKaricheri, Muralidharan bool rxtstamp_complete;
13784640e27SKaricheri, Muralidharan void *ts_context;
13884640e27SKaricheri, Muralidharan
1396246168bSWingMan Kwok void (*txtstamp)(void *ctx, struct sk_buff *skb);
14084640e27SKaricheri, Muralidharan };
14184640e27SKaricheri, Muralidharan
netcp_push_psdata(struct netcp_packet * p_info,unsigned int bytes)14284640e27SKaricheri, Muralidharan static inline u32 *netcp_push_psdata(struct netcp_packet *p_info,
14384640e27SKaricheri, Muralidharan unsigned int bytes)
14484640e27SKaricheri, Muralidharan {
14584640e27SKaricheri, Muralidharan u32 *buf;
14684640e27SKaricheri, Muralidharan unsigned int words;
14784640e27SKaricheri, Muralidharan
14884640e27SKaricheri, Muralidharan if ((bytes & 0x03) != 0)
14984640e27SKaricheri, Muralidharan return NULL;
15084640e27SKaricheri, Muralidharan words = bytes >> 2;
15184640e27SKaricheri, Muralidharan
15284640e27SKaricheri, Muralidharan if ((p_info->psdata_len + words) > NETCP_PSDATA_LEN)
15384640e27SKaricheri, Muralidharan return NULL;
15484640e27SKaricheri, Muralidharan
15584640e27SKaricheri, Muralidharan p_info->psdata_len += words;
15684640e27SKaricheri, Muralidharan buf = &p_info->psdata[NETCP_PSDATA_LEN - p_info->psdata_len];
15784640e27SKaricheri, Muralidharan return buf;
15884640e27SKaricheri, Muralidharan }
15984640e27SKaricheri, Muralidharan
netcp_align_psdata(struct netcp_packet * p_info,unsigned int byte_align)16084640e27SKaricheri, Muralidharan static inline int netcp_align_psdata(struct netcp_packet *p_info,
16184640e27SKaricheri, Muralidharan unsigned int byte_align)
16284640e27SKaricheri, Muralidharan {
16384640e27SKaricheri, Muralidharan int padding;
16484640e27SKaricheri, Muralidharan
16584640e27SKaricheri, Muralidharan switch (byte_align) {
16684640e27SKaricheri, Muralidharan case 0:
16784640e27SKaricheri, Muralidharan padding = -EINVAL;
16884640e27SKaricheri, Muralidharan break;
16984640e27SKaricheri, Muralidharan case 1:
17084640e27SKaricheri, Muralidharan case 2:
17184640e27SKaricheri, Muralidharan case 4:
17284640e27SKaricheri, Muralidharan padding = 0;
17384640e27SKaricheri, Muralidharan break;
17484640e27SKaricheri, Muralidharan case 8:
17584640e27SKaricheri, Muralidharan padding = (p_info->psdata_len << 2) % 8;
17684640e27SKaricheri, Muralidharan break;
17784640e27SKaricheri, Muralidharan case 16:
17884640e27SKaricheri, Muralidharan padding = (p_info->psdata_len << 2) % 16;
17984640e27SKaricheri, Muralidharan break;
18084640e27SKaricheri, Muralidharan default:
18184640e27SKaricheri, Muralidharan padding = (p_info->psdata_len << 2) % byte_align;
18284640e27SKaricheri, Muralidharan break;
18384640e27SKaricheri, Muralidharan }
18484640e27SKaricheri, Muralidharan return padding;
18584640e27SKaricheri, Muralidharan }
18684640e27SKaricheri, Muralidharan
18784640e27SKaricheri, Muralidharan struct netcp_module {
18884640e27SKaricheri, Muralidharan const char *name;
18984640e27SKaricheri, Muralidharan struct module *owner;
19084640e27SKaricheri, Muralidharan bool primary;
19184640e27SKaricheri, Muralidharan
19284640e27SKaricheri, Muralidharan /* probe/remove: called once per NETCP instance */
19384640e27SKaricheri, Muralidharan int (*probe)(struct netcp_device *netcp_device,
19484640e27SKaricheri, Muralidharan struct device *device, struct device_node *node,
19584640e27SKaricheri, Muralidharan void **inst_priv);
19684640e27SKaricheri, Muralidharan int (*remove)(struct netcp_device *netcp_device, void *inst_priv);
19784640e27SKaricheri, Muralidharan
19884640e27SKaricheri, Muralidharan /* attach/release: called once per network interface */
19984640e27SKaricheri, Muralidharan int (*attach)(void *inst_priv, struct net_device *ndev,
20084640e27SKaricheri, Muralidharan struct device_node *node, void **intf_priv);
20184640e27SKaricheri, Muralidharan int (*release)(void *intf_priv);
20284640e27SKaricheri, Muralidharan int (*open)(void *intf_priv, struct net_device *ndev);
20384640e27SKaricheri, Muralidharan int (*close)(void *intf_priv, struct net_device *ndev);
20484640e27SKaricheri, Muralidharan int (*add_addr)(void *intf_priv, struct netcp_addr *naddr);
20584640e27SKaricheri, Muralidharan int (*del_addr)(void *intf_priv, struct netcp_addr *naddr);
20684640e27SKaricheri, Muralidharan int (*add_vid)(void *intf_priv, int vid);
20784640e27SKaricheri, Muralidharan int (*del_vid)(void *intf_priv, int vid);
20884640e27SKaricheri, Muralidharan int (*ioctl)(void *intf_priv, struct ifreq *req, int cmd);
2090542a87cSWingMan Kwok int (*set_rx_mode)(void *intf_priv, bool promisc);
21084640e27SKaricheri, Muralidharan
21184640e27SKaricheri, Muralidharan /* used internally */
21284640e27SKaricheri, Muralidharan struct list_head module_list;
21384640e27SKaricheri, Muralidharan struct list_head interface_list;
21484640e27SKaricheri, Muralidharan };
21584640e27SKaricheri, Muralidharan
21684640e27SKaricheri, Muralidharan int netcp_register_module(struct netcp_module *module);
21784640e27SKaricheri, Muralidharan void netcp_unregister_module(struct netcp_module *module);
21884640e27SKaricheri, Muralidharan void *netcp_module_get_intf_data(struct netcp_module *module,
21984640e27SKaricheri, Muralidharan struct netcp_intf *intf);
22084640e27SKaricheri, Muralidharan
22184640e27SKaricheri, Muralidharan int netcp_txpipe_init(struct netcp_tx_pipe *tx_pipe,
22284640e27SKaricheri, Muralidharan struct netcp_device *netcp_device,
22384640e27SKaricheri, Muralidharan const char *dma_chan_name, unsigned int dma_queue_id);
22484640e27SKaricheri, Muralidharan int netcp_txpipe_open(struct netcp_tx_pipe *tx_pipe);
22584640e27SKaricheri, Muralidharan int netcp_txpipe_close(struct netcp_tx_pipe *tx_pipe);
22684640e27SKaricheri, Muralidharan
22784640e27SKaricheri, Muralidharan typedef int netcp_hook_rtn(int order, void *data, struct netcp_packet *packet);
22884640e27SKaricheri, Muralidharan int netcp_register_txhook(struct netcp_intf *netcp_priv, int order,
22984640e27SKaricheri, Muralidharan netcp_hook_rtn *hook_rtn, void *hook_data);
23084640e27SKaricheri, Muralidharan int netcp_unregister_txhook(struct netcp_intf *netcp_priv, int order,
23184640e27SKaricheri, Muralidharan netcp_hook_rtn *hook_rtn, void *hook_data);
23284640e27SKaricheri, Muralidharan int netcp_register_rxhook(struct netcp_intf *netcp_priv, int order,
23384640e27SKaricheri, Muralidharan netcp_hook_rtn *hook_rtn, void *hook_data);
23484640e27SKaricheri, Muralidharan int netcp_unregister_rxhook(struct netcp_intf *netcp_priv, int order,
23584640e27SKaricheri, Muralidharan netcp_hook_rtn *hook_rtn, void *hook_data);
23684640e27SKaricheri, Muralidharan
23784640e27SKaricheri, Muralidharan /* SGMII functions */
23884640e27SKaricheri, Muralidharan int netcp_sgmii_reset(void __iomem *sgmii_ofs, int port);
2397025e88aSWingMan Kwok bool netcp_sgmii_rtreset(void __iomem *sgmii_ofs, int port, bool set);
24084640e27SKaricheri, Muralidharan int netcp_sgmii_get_port_link(void __iomem *sgmii_ofs, int port);
24184640e27SKaricheri, Muralidharan int netcp_sgmii_config(void __iomem *sgmii_ofs, int port, u32 interface);
24284640e27SKaricheri, Muralidharan
24384640e27SKaricheri, Muralidharan /* XGBE SERDES init functions */
24484640e27SKaricheri, Muralidharan int netcp_xgbe_serdes_init(void __iomem *serdes_regs, void __iomem *xgbe_regs);
24584640e27SKaricheri, Muralidharan
24684640e27SKaricheri, Muralidharan #endif /* __NETCP_H__ */
247