// SPDX-License-Identifier: GPL-2.0+ // Copyright (c) 2016-2017 Hisilicon Limited. #ifndef __HNS3_ENET_H #define __HNS3_ENET_H #include #include "hnae3.h" #define HNS3_MOD_VERSION "1.0" extern const char hns3_driver_version[]; enum hns3_nic_state { HNS3_NIC_STATE_TESTING, HNS3_NIC_STATE_RESETTING, HNS3_NIC_STATE_REINITING, HNS3_NIC_STATE_DOWN, HNS3_NIC_STATE_DISABLED, HNS3_NIC_STATE_REMOVING, HNS3_NIC_STATE_SERVICE_INITED, HNS3_NIC_STATE_SERVICE_SCHED, HNS3_NIC_STATE2_RESET_REQUESTED, HNS3_NIC_STATE_MAX }; #define HNS3_RING_RX_RING_BASEADDR_L_REG 0x00000 #define HNS3_RING_RX_RING_BASEADDR_H_REG 0x00004 #define HNS3_RING_RX_RING_BD_NUM_REG 0x00008 #define HNS3_RING_RX_RING_BD_LEN_REG 0x0000C #define HNS3_RING_RX_RING_TAIL_REG 0x00018 #define HNS3_RING_RX_RING_HEAD_REG 0x0001C #define HNS3_RING_RX_RING_FBDNUM_REG 0x00020 #define HNS3_RING_RX_RING_PKTNUM_RECORD_REG 0x0002C #define HNS3_RING_TX_RING_BASEADDR_L_REG 0x00040 #define HNS3_RING_TX_RING_BASEADDR_H_REG 0x00044 #define HNS3_RING_TX_RING_BD_NUM_REG 0x00048 #define HNS3_RING_TX_RING_TC_REG 0x00050 #define HNS3_RING_TX_RING_TAIL_REG 0x00058 #define HNS3_RING_TX_RING_HEAD_REG 0x0005C #define HNS3_RING_TX_RING_FBDNUM_REG 0x00060 #define HNS3_RING_TX_RING_OFFSET_REG 0x00064 #define HNS3_RING_TX_RING_PKTNUM_RECORD_REG 0x0006C #define HNS3_RING_PREFETCH_EN_REG 0x0007C #define HNS3_RING_CFG_VF_NUM_REG 0x00080 #define HNS3_RING_ASID_REG 0x0008C #define HNS3_RING_RX_VM_REG 0x00090 #define HNS3_RING_T0_BE_RST 0x00094 #define HNS3_RING_COULD_BE_RST 0x00098 #define HNS3_RING_WRR_WEIGHT_REG 0x0009c #define HNS3_RING_INTMSK_RXWL_REG 0x000A0 #define HNS3_RING_INTSTS_RX_RING_REG 0x000A4 #define HNS3_RX_RING_INT_STS_REG 0x000A8 #define HNS3_RING_INTMSK_TXWL_REG 0x000AC #define HNS3_RING_INTSTS_TX_RING_REG 0x000B0 #define HNS3_TX_RING_INT_STS_REG 0x000B4 #define HNS3_RING_INTMSK_RX_OVERTIME_REG 0x000B8 #define HNS3_RING_INTSTS_RX_OVERTIME_REG 0x000BC #define HNS3_RING_INTMSK_TX_OVERTIME_REG 0x000C4 #define HNS3_RING_INTSTS_TX_OVERTIME_REG 0x000C8 #define HNS3_RING_MB_CTRL_REG 0x00100 #define HNS3_RING_MB_DATA_BASE_REG 0x00200 #define HNS3_TX_REG_OFFSET 0x40 #define HNS3_RX_HEAD_SIZE 256 #define HNS3_TX_TIMEOUT (5 * HZ) #define HNS3_RING_NAME_LEN 16 #define HNS3_BUFFER_SIZE_2048 2048 #define HNS3_RING_MAX_PENDING 32768 #define HNS3_RING_MIN_PENDING 8 #define HNS3_RING_BD_MULTIPLE 8 #define HNS3_MAX_MTU 9728 #define HNS3_BD_SIZE_512_TYPE 0 #define HNS3_BD_SIZE_1024_TYPE 1 #define HNS3_BD_SIZE_2048_TYPE 2 #define HNS3_BD_SIZE_4096_TYPE 3 #define HNS3_RX_FLAG_VLAN_PRESENT 0x1 #define HNS3_RX_FLAG_L3ID_IPV4 0x0 #define HNS3_RX_FLAG_L3ID_IPV6 0x1 #define HNS3_RX_FLAG_L4ID_UDP 0x0 #define HNS3_RX_FLAG_L4ID_TCP 0x1 #define HNS3_RXD_DMAC_S 0 #define HNS3_RXD_DMAC_M (0x3 << HNS3_RXD_DMAC_S) #define HNS3_RXD_VLAN_S 2 #define HNS3_RXD_VLAN_M (0x3 << HNS3_RXD_VLAN_S) #define HNS3_RXD_L3ID_S 4 #define HNS3_RXD_L3ID_M (0xf << HNS3_RXD_L3ID_S) #define HNS3_RXD_L4ID_S 8 #define HNS3_RXD_L4ID_M (0xf << HNS3_RXD_L4ID_S) #define HNS3_RXD_FRAG_B 12 #define HNS3_RXD_STRP_TAGP_S 13 #define HNS3_RXD_STRP_TAGP_M (0x3 << HNS3_RXD_STRP_TAGP_S) #define HNS3_RXD_L2E_B 16 #define HNS3_RXD_L3E_B 17 #define HNS3_RXD_L4E_B 18 #define HNS3_RXD_TRUNCAT_B 19 #define HNS3_RXD_HOI_B 20 #define HNS3_RXD_DOI_B 21 #define HNS3_RXD_OL3E_B 22 #define HNS3_RXD_OL4E_B 23 #define HNS3_RXD_ODMAC_S 0 #define HNS3_RXD_ODMAC_M (0x3 << HNS3_RXD_ODMAC_S) #define HNS3_RXD_OVLAN_S 2 #define HNS3_RXD_OVLAN_M (0x3 << HNS3_RXD_OVLAN_S) #define HNS3_RXD_OL3ID_S 4 #define HNS3_RXD_OL3ID_M (0xf << HNS3_RXD_OL3ID_S) #define HNS3_RXD_OL4ID_S 8 #define HNS3_RXD_OL4ID_M (0xf << HNS3_RXD_OL4ID_S) #define HNS3_RXD_FBHI_S 12 #define HNS3_RXD_FBHI_M (0x3 << HNS3_RXD_FBHI_S) #define HNS3_RXD_FBLI_S 14 #define HNS3_RXD_FBLI_M (0x3 << HNS3_RXD_FBLI_S) #define HNS3_RXD_BDTYPE_S 0 #define HNS3_RXD_BDTYPE_M (0xf << HNS3_RXD_BDTYPE_S) #define HNS3_RXD_VLD_B 4 #define HNS3_RXD_UDP0_B 5 #define HNS3_RXD_EXTEND_B 7 #define HNS3_RXD_FE_B 8 #define HNS3_RXD_LUM_B 9 #define HNS3_RXD_CRCP_B 10 #define HNS3_RXD_L3L4P_B 11 #define HNS3_RXD_TSIND_S 12 #define HNS3_RXD_TSIND_M (0x7 << HNS3_RXD_TSIND_S) #define HNS3_RXD_LKBK_B 15 #define HNS3_RXD_HDL_S 16 #define HNS3_RXD_HDL_M (0x7ff << HNS3_RXD_HDL_S) #define HNS3_RXD_HSIND_B 31 #define HNS3_TXD_L3T_S 0 #define HNS3_TXD_L3T_M (0x3 << HNS3_TXD_L3T_S) #define HNS3_TXD_L4T_S 2 #define HNS3_TXD_L4T_M (0x3 << HNS3_TXD_L4T_S) #define HNS3_TXD_L3CS_B 4 #define HNS3_TXD_L4CS_B 5 #define HNS3_TXD_VLAN_B 6 #define HNS3_TXD_TSO_B 7 #define HNS3_TXD_L2LEN_S 8 #define HNS3_TXD_L2LEN_M (0xff << HNS3_TXD_L2LEN_S) #define HNS3_TXD_L3LEN_S 16 #define HNS3_TXD_L3LEN_M (0xff << HNS3_TXD_L3LEN_S) #define HNS3_TXD_L4LEN_S 24 #define HNS3_TXD_L4LEN_M (0xff << HNS3_TXD_L4LEN_S) #define HNS3_TXD_OL3T_S 0 #define HNS3_TXD_OL3T_M (0x3 << HNS3_TXD_OL3T_S) #define HNS3_TXD_OVLAN_B 2 #define HNS3_TXD_MACSEC_B 3 #define HNS3_TXD_TUNTYPE_S 4 #define HNS3_TXD_TUNTYPE_M (0xf << HNS3_TXD_TUNTYPE_S) #define HNS3_TXD_BDTYPE_S 0 #define HNS3_TXD_BDTYPE_M (0xf << HNS3_TXD_BDTYPE_S) #define HNS3_TXD_FE_B 4 #define HNS3_TXD_SC_S 5 #define HNS3_TXD_SC_M (0x3 << HNS3_TXD_SC_S) #define HNS3_TXD_EXTEND_B 7 #define HNS3_TXD_VLD_B 8 #define HNS3_TXD_RI_B 9 #define HNS3_TXD_RA_B 10 #define HNS3_TXD_TSYN_B 11 #define HNS3_TXD_DECTTL_S 12 #define HNS3_TXD_DECTTL_M (0xf << HNS3_TXD_DECTTL_S) #define HNS3_TXD_MSS_S 0 #define HNS3_TXD_MSS_M (0x3fff << HNS3_TXD_MSS_S) #define HNS3_VECTOR_TX_IRQ BIT_ULL(0) #define HNS3_VECTOR_RX_IRQ BIT_ULL(1) #define HNS3_VECTOR_NOT_INITED 0 #define HNS3_VECTOR_INITED 1 #define HNS3_MAX_BD_SIZE 65535 #define HNS3_MAX_BD_PER_FRAG 8 #define HNS3_MAX_BD_PER_PKT MAX_SKB_FRAGS #define HNS3_VECTOR_GL0_OFFSET 0x100 #define HNS3_VECTOR_GL1_OFFSET 0x200 #define HNS3_VECTOR_GL2_OFFSET 0x300 #define HNS3_VECTOR_RL_OFFSET 0x900 #define HNS3_VECTOR_RL_EN_B 6 enum hns3_pkt_l3t_type { HNS3_L3T_NONE, HNS3_L3T_IPV6, HNS3_L3T_IPV4, HNS3_L3T_RESERVED }; enum hns3_pkt_l4t_type { HNS3_L4T_UNKNOWN, HNS3_L4T_TCP, HNS3_L4T_UDP, HNS3_L4T_SCTP }; enum hns3_pkt_ol3t_type { HNS3_OL3T_NONE, HNS3_OL3T_IPV6, HNS3_OL3T_IPV4_NO_CSUM, HNS3_OL3T_IPV4_CSUM }; enum hns3_pkt_tun_type { HNS3_TUN_NONE, HNS3_TUN_MAC_IN_UDP, HNS3_TUN_NVGRE, HNS3_TUN_OTHER }; /* hardware spec ring buffer format */ struct __packed hns3_desc { __le64 addr; union { struct { __le16 vlan_tag; __le16 send_size; union { __le32 type_cs_vlan_tso_len; struct { __u8 type_cs_vlan_tso; __u8 l2_len; __u8 l3_len; __u8 l4_len; }; }; __le16 outer_vlan_tag; __le16 tv; union { __le32 ol_type_vlan_len_msec; struct { __u8 ol_type_vlan_msec; __u8 ol2_len; __u8 ol3_len; __u8 ol4_len; }; }; __le32 paylen; __le16 bdtp_fe_sc_vld_ra_ri; __le16 mss; } tx; struct { __le32 l234_info; __le16 pkt_len; __le16 size; __le32 rss_hash; __le16 fd_id; __le16 vlan_tag; union { __le32 ol_info; struct { __le16 o_dm_vlan_id_fb; __le16 ot_vlan_tag; }; }; __le32 bd_base_info; } rx; }; }; struct hns3_desc_cb { dma_addr_t dma; /* dma address of this desc */ void *buf; /* cpu addr for a desc */ /* priv data for the desc, e.g. skb when use with ip stack*/ void *priv; u16 page_offset; u16 reuse_flag; u32 length; /* length of the buffer */ /* desc type, used by the ring user to mark the type of the priv data */ u16 type; }; enum hns3_pkt_l3type { HNS3_L3_TYPE_IPV4, HNS3_L3_TYPE_IPV6, HNS3_L3_TYPE_ARP, HNS3_L3_TYPE_RARP, HNS3_L3_TYPE_IPV4_OPT, HNS3_L3_TYPE_IPV6_EXT, HNS3_L3_TYPE_LLDP, HNS3_L3_TYPE_BPDU, HNS3_L3_TYPE_MAC_PAUSE, HNS3_L3_TYPE_PFC_PAUSE,/* 0x9*/ /* reserved for 0xA~0xB*/ HNS3_L3_TYPE_CNM = 0xc, /* reserved for 0xD~0xE*/ HNS3_L3_TYPE_PARSE_FAIL = 0xf /* must be last */ }; enum hns3_pkt_l4type { HNS3_L4_TYPE_UDP, HNS3_L4_TYPE_TCP, HNS3_L4_TYPE_GRE, HNS3_L4_TYPE_SCTP, HNS3_L4_TYPE_IGMP, HNS3_L4_TYPE_ICMP, /* reserved for 0x6~0xE */ HNS3_L4_TYPE_PARSE_FAIL = 0xf /* must be last */ }; enum hns3_pkt_ol3type { HNS3_OL3_TYPE_IPV4 = 0, HNS3_OL3_TYPE_IPV6, /* reserved for 0x2~0x3 */ HNS3_OL3_TYPE_IPV4_OPT = 4, HNS3_OL3_TYPE_IPV6_EXT, /* reserved for 0x6~0xE*/ HNS3_OL3_TYPE_PARSE_FAIL = 0xf /* must be last */ }; enum hns3_pkt_ol4type { HNS3_OL4_TYPE_NO_TUN, HNS3_OL4_TYPE_MAC_IN_UDP, HNS3_OL4_TYPE_NVGRE, HNS3_OL4_TYPE_UNKNOWN }; struct ring_stats { u64 io_err_cnt; u64 sw_err_cnt; u64 seg_pkt_cnt; union { struct { u64 tx_pkts; u64 tx_bytes; u64 tx_err_cnt; u64 restart_queue; u64 tx_busy; }; struct { u64 rx_pkts; u64 rx_bytes; u64 rx_err_cnt; u64 reuse_pg_cnt; u64 err_pkt_len; u64 non_vld_descs; u64 err_bd_num; u64 l2_err; u64 l3l4_csum_err; }; }; }; struct hns3_enet_ring { u8 __iomem *io_base; /* base io address for the ring */ struct hns3_desc *desc; /* dma map address space */ struct hns3_desc_cb *desc_cb; struct hns3_enet_ring *next; struct hns3_enet_tqp_vector *tqp_vector; struct hnae3_queue *tqp; char ring_name[HNS3_RING_NAME_LEN]; struct device *dev; /* will be used for DMA mapping of descriptors */ /* statistic */ struct ring_stats stats; struct u64_stats_sync syncp; dma_addr_t desc_dma_addr; u32 buf_size; /* size for hnae_desc->addr, preset by AE */ u16 desc_num; /* total number of desc */ u16 max_desc_num_per_pkt; u16 max_raw_data_sz_per_desc; u16 max_pkt_size; int next_to_use; /* idx of next spare desc */ /* idx of lastest sent desc, the ring is empty when equal to * next_to_use */ int next_to_clean; u32 flag; /* ring attribute */ int irq_init_flag; int numa_node; cpumask_t affinity_mask; }; struct hns_queue; struct hns3_nic_ring_data { struct hns3_enet_ring *ring; struct napi_struct napi; int queue_index; int (*poll_one)(struct hns3_nic_ring_data *, int, void *); void (*ex_process)(struct hns3_nic_ring_data *, struct sk_buff *); void (*fini_process)(struct hns3_nic_ring_data *); }; struct hns3_nic_ops { int (*fill_desc)(struct hns3_enet_ring *ring, void *priv, int size, dma_addr_t dma, int frag_end, enum hns_desc_type type); int (*maybe_stop_tx)(struct sk_buff **out_skb, int *bnum, struct hns3_enet_ring *ring); void (*get_rxd_bnum)(u32 bnum_flag, int *out_bnum); }; enum hns3_flow_level_range { HNS3_FLOW_LOW = 0, HNS3_FLOW_MID = 1, HNS3_FLOW_HIGH = 2, HNS3_FLOW_ULTRA = 3, }; enum hns3_link_mode_bits { HNS3_LM_FIBRE_BIT = BIT(0), HNS3_LM_AUTONEG_BIT = BIT(1), HNS3_LM_TP_BIT = BIT(2), HNS3_LM_PAUSE_BIT = BIT(3), HNS3_LM_BACKPLANE_BIT = BIT(4), HNS3_LM_10BASET_HALF_BIT = BIT(5), HNS3_LM_10BASET_FULL_BIT = BIT(6), HNS3_LM_100BASET_HALF_BIT = BIT(7), HNS3_LM_100BASET_FULL_BIT = BIT(8), HNS3_LM_1000BASET_FULL_BIT = BIT(9), HNS3_LM_10000BASEKR_FULL_BIT = BIT(10), HNS3_LM_25000BASEKR_FULL_BIT = BIT(11), HNS3_LM_40000BASELR4_FULL_BIT = BIT(12), HNS3_LM_50000BASEKR2_FULL_BIT = BIT(13), HNS3_LM_100000BASEKR4_FULL_BIT = BIT(14), HNS3_LM_COUNT = 15 }; #define HNS3_INT_GL_MAX 0x1FE0 #define HNS3_INT_GL_50K 0x0014 #define HNS3_INT_GL_20K 0x0032 #define HNS3_INT_GL_18K 0x0036 #define HNS3_INT_GL_8K 0x007C #define HNS3_INT_RL_MAX 0x00EC #define HNS3_INT_RL_ENABLE_MASK 0x40 #define HNS3_INT_ADAPT_DOWN_START 100 struct hns3_enet_coalesce { u16 int_gl; u8 gl_adapt_enable; enum hns3_flow_level_range flow_level; }; struct hns3_enet_ring_group { /* array of pointers to rings */ struct hns3_enet_ring *ring; u64 total_bytes; /* total bytes processed this group */ u64 total_packets; /* total packets processed this group */ u16 count; struct hns3_enet_coalesce coal; }; struct hns3_enet_tqp_vector { struct hnae3_handle *handle; u8 __iomem *mask_addr; int vector_irq; int irq_init_flag; u16 idx; /* index in the TQP vector array per handle. */ struct napi_struct napi; struct hns3_enet_ring_group rx_group; struct hns3_enet_ring_group tx_group; u16 num_tqps; /* total number of tqps in TQP vector */ char name[HNAE3_INT_NAME_LEN]; /* when 0 should adjust interrupt coalesce parameter */ u8 int_adapt_down; unsigned long last_jiffies; } ____cacheline_internodealigned_in_smp; enum hns3_udp_tnl_type { HNS3_UDP_TNL_VXLAN, HNS3_UDP_TNL_GENEVE, HNS3_UDP_TNL_MAX, }; struct hns3_udp_tunnel { u16 dst_port; int used; }; struct hns3_nic_priv { struct hnae3_handle *ae_handle; u32 enet_ver; u32 port_id; struct net_device *netdev; struct device *dev; struct hns3_nic_ops ops; /** * the cb for nic to manage the ring buffer, the first half of the * array is for tx_ring and vice versa for the second half */ struct hns3_nic_ring_data *ring_data; struct hns3_enet_tqp_vector *tqp_vector; u16 vector_num; /* The most recently read link state */ int link; u64 tx_timeout_count; unsigned long state; struct timer_list service_timer; struct work_struct service_task; struct notifier_block notifier_block; /* Vxlan/Geneve information */ struct hns3_udp_tunnel udp_tnl[HNS3_UDP_TNL_MAX]; unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)]; }; union l3_hdr_info { struct iphdr *v4; struct ipv6hdr *v6; unsigned char *hdr; }; union l4_hdr_info { struct tcphdr *tcp; struct udphdr *udp; unsigned char *hdr; }; /* the distance between [begin, end) in a ring buffer * note: there is a unuse slot between the begin and the end */ static inline int ring_dist(struct hns3_enet_ring *ring, int begin, int end) { return (end - begin + ring->desc_num) % ring->desc_num; } static inline int ring_space(struct hns3_enet_ring *ring) { return ring->desc_num - ring_dist(ring, ring->next_to_clean, ring->next_to_use) - 1; } static inline int is_ring_empty(struct hns3_enet_ring *ring) { return ring->next_to_use == ring->next_to_clean; } static inline void hns3_write_reg(void __iomem *base, u32 reg, u32 value) { u8 __iomem *reg_addr = READ_ONCE(base); writel(value, reg_addr + reg); } #define hns3_write_dev(a, reg, value) \ hns3_write_reg((a)->io_base, (reg), (value)) #define hnae3_queue_xmit(tqp, buf_num) writel_relaxed(buf_num, \ (tqp)->io_base + HNS3_RING_TX_RING_TAIL_REG) #define ring_to_dev(ring) (&(ring)->tqp->handle->pdev->dev) #define ring_to_dma_dir(ring) (HNAE3_IS_TX_RING(ring) ? \ DMA_TO_DEVICE : DMA_FROM_DEVICE) #define tx_ring_data(priv, idx) ((priv)->ring_data[idx]) #define hnae3_buf_size(_ring) ((_ring)->buf_size) #define hnae3_page_order(_ring) (get_order(hnae3_buf_size(_ring))) #define hnae3_page_size(_ring) (PAGE_SIZE << hnae3_page_order(_ring)) /* iterator for handling rings in ring group */ #define hns3_for_each_ring(pos, head) \ for (pos = (head).ring; pos; pos = pos->next) #define hns3_get_handle(ndev) \ (((struct hns3_nic_priv *)netdev_priv(ndev))->ae_handle) #define hns3_gl_usec_to_reg(int_gl) (int_gl >> 1) #define hns3_gl_round_down(int_gl) round_down(int_gl, 2) #define hns3_rl_usec_to_reg(int_rl) (int_rl >> 2) #define hns3_rl_round_down(int_rl) round_down(int_rl, 4) void hns3_ethtool_set_ops(struct net_device *netdev); int hns3_set_channels(struct net_device *netdev, struct ethtool_channels *ch); bool hns3_clean_tx_ring(struct hns3_enet_ring *ring, int budget); int hns3_init_all_ring(struct hns3_nic_priv *priv); int hns3_uninit_all_ring(struct hns3_nic_priv *priv); int hns3_nic_reset_all_ring(struct hnae3_handle *h); netdev_tx_t hns3_nic_net_xmit(struct sk_buff *skb, struct net_device *netdev); int hns3_clean_rx_ring( struct hns3_enet_ring *ring, int budget, void (*rx_fn)(struct hns3_enet_ring *, struct sk_buff *)); void hns3_set_vector_coalesce_rx_gl(struct hns3_enet_tqp_vector *tqp_vector, u32 gl_value); void hns3_set_vector_coalesce_tx_gl(struct hns3_enet_tqp_vector *tqp_vector, u32 gl_value); void hns3_set_vector_coalesce_rl(struct hns3_enet_tqp_vector *tqp_vector, u32 rl_value); #ifdef CONFIG_HNS3_DCB void hns3_dcbnl_setup(struct hnae3_handle *handle); #else static inline void hns3_dcbnl_setup(struct hnae3_handle *handle) {} #endif #endif