xref: /freebsd/sys/dev/igc/igc_base.h (revision 77d6c45afdca8a524a88edfb3097d4d9dc90b583)
1 /*-
2  * Copyright 2021 Intel Corp
3  * Copyright 2021 Rubicon Communications, LLC (Netgate)
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef _IGC_BASE_H_
8 #define _IGC_BASE_H_
9 
10 /* forward declaration */
11 s32 igc_init_hw_base(struct igc_hw *hw);
12 void igc_power_down_phy_copper_base(struct igc_hw *hw);
13 extern void igc_rx_fifo_flush_base(struct igc_hw *hw);
14 s32 igc_acquire_phy_base(struct igc_hw *hw);
15 void igc_release_phy_base(struct igc_hw *hw);
16 bool igc_is_device_id_i226(struct igc_hw *hw);
17 
18 /* Transmit Descriptor - Advanced */
19 union igc_adv_tx_desc {
20 	struct {
21 		__le64 buffer_addr;    /* Address of descriptor's data buf */
22 		__le32 cmd_type_len;
23 		__le32 olinfo_status;
24 	} read;
25 	struct {
26 		__le64 rsvd;       /* Reserved */
27 		__le32 nxtseq_seed;
28 		__le32 status;
29 	} wb;
30 };
31 
32 /* Context descriptors */
33 struct igc_adv_tx_context_desc {
34 	__le32 vlan_macip_lens;
35 	union {
36 		__le32 launch_time;
37 		__le32 seqnum_seed;
38 	};
39 	__le32 type_tucmd_mlhl;
40 	__le32 mss_l4len_idx;
41 };
42 
43 /* Adv Transmit Descriptor Config Masks */
44 #define IGC_ADVTXD_DTYP_CTXT	0x00200000 /* Advanced Context Descriptor */
45 #define IGC_ADVTXD_DTYP_DATA	0x00300000 /* Advanced Data Descriptor */
46 #define IGC_ADVTXD_DCMD_EOP	0x01000000 /* End of Packet */
47 #define IGC_ADVTXD_DCMD_IFCS	0x02000000 /* Insert FCS (Ethernet CRC) */
48 #define IGC_ADVTXD_DCMD_RS	0x08000000 /* Report Status */
49 #define IGC_ADVTXD_DCMD_DDTYP_ISCSI	0x10000000 /* DDP hdr type or iSCSI */
50 #define IGC_ADVTXD_DCMD_DEXT	0x20000000 /* Descriptor extension (1=Adv) */
51 #define IGC_ADVTXD_DCMD_VLE	0x40000000 /* VLAN pkt enable */
52 #define IGC_ADVTXD_DCMD_TSE	0x80000000 /* TCP Seg enable */
53 #define IGC_ADVTXD_MAC_LINKSEC	0x00040000 /* Apply LinkSec on pkt */
54 #define IGC_ADVTXD_MAC_TSTAMP		0x00080000 /* IEEE1588 Timestamp pkt */
55 #define IGC_ADVTXD_STAT_SN_CRC	0x00000002 /* NXTSEQ/SEED prsnt in WB */
56 #define IGC_ADVTXD_IDX_SHIFT		4  /* Adv desc Index shift */
57 #define IGC_ADVTXD_POPTS_ISCO_1ST	0x00000000 /* 1st TSO of iSCSI PDU */
58 #define IGC_ADVTXD_POPTS_ISCO_MDL	0x00000800 /* Middle TSO of iSCSI PDU */
59 #define IGC_ADVTXD_POPTS_ISCO_LAST	0x00001000 /* Last TSO of iSCSI PDU */
60 /* 1st & Last TSO-full iSCSI PDU*/
61 #define IGC_ADVTXD_POPTS_ISCO_FULL	0x00001800
62 #define IGC_ADVTXD_POPTS_IPSEC	0x00000400 /* IPSec offload request */
63 #define IGC_ADVTXD_PAYLEN_SHIFT	14 /* Adv desc PAYLEN shift */
64 
65 /* Advanced Transmit Context Descriptor Config */
66 #define IGC_ADVTXD_MACLEN_SHIFT	9  /* Adv ctxt desc mac len shift */
67 #define IGC_ADVTXD_VLAN_SHIFT		16  /* Adv ctxt vlan tag shift */
68 #define IGC_ADVTXD_TUCMD_IPV4		0x00000400  /* IP Packet Type: 1=IPv4 */
69 #define IGC_ADVTXD_TUCMD_IPV6		0x00000000  /* IP Packet Type: 0=IPv6 */
70 #define IGC_ADVTXD_TUCMD_L4T_UDP	0x00000000  /* L4 Packet TYPE of UDP */
71 #define IGC_ADVTXD_TUCMD_L4T_TCP	0x00000800  /* L4 Packet TYPE of TCP */
72 #define IGC_ADVTXD_TUCMD_L4T_SCTP	0x00001000  /* L4 Packet TYPE of SCTP */
73 #define IGC_ADVTXD_TUCMD_IPSEC_TYPE_ESP	0x00002000 /* IPSec Type ESP */
74 /* IPSec Encrypt Enable for ESP */
75 #define IGC_ADVTXD_TUCMD_IPSEC_ENCRYPT_EN	0x00004000
76 /* Req requires Markers and CRC */
77 #define IGC_ADVTXD_TUCMD_MKRREQ	0x00002000
78 #define IGC_ADVTXD_L4LEN_SHIFT	8  /* Adv ctxt L4LEN shift */
79 #define IGC_ADVTXD_MSS_SHIFT		16  /* Adv ctxt MSS shift */
80 /* Adv ctxt IPSec SA IDX mask */
81 #define IGC_ADVTXD_IPSEC_SA_INDEX_MASK	0x000000FF
82 /* Adv ctxt IPSec ESP len mask */
83 #define IGC_ADVTXD_IPSEC_ESP_LEN_MASK		0x000000FF
84 
85 #define IGC_RAR_ENTRIES_BASE		16
86 
87 /* Receive Descriptor - Advanced */
88 union igc_adv_rx_desc {
89 	struct {
90 		__le64 pkt_addr; /* Packet buffer address */
91 		__le64 hdr_addr; /* Header buffer address */
92 	} read;
93 	struct {
94 		struct {
95 			union {
96 				__le32 data;
97 				struct {
98 					__le16 pkt_info; /*RSS type, Pkt type*/
99 					/* Split Header, header buffer len */
100 					__le16 hdr_info;
101 				} hs_rss;
102 			} lo_dword;
103 			union {
104 				__le32 rss; /* RSS Hash */
105 				struct {
106 					__le16 ip_id; /* IP id */
107 					__le16 csum; /* Packet Checksum */
108 				} csum_ip;
109 			} hi_dword;
110 		} lower;
111 		struct {
112 			__le32 status_error; /* ext status/error */
113 			__le16 length; /* Packet length */
114 			__le16 vlan; /* VLAN tag */
115 		} upper;
116 	} wb;  /* writeback */
117 };
118 
119 /* Additional Transmit Descriptor Control definitions */
120 #define IGC_TXDCTL_QUEUE_ENABLE	0x02000000 /* Ena specific Tx Queue */
121 
122 /* Additional Receive Descriptor Control definitions */
123 #define IGC_RXDCTL_QUEUE_ENABLE	0x02000000 /* Ena specific Rx Queue */
124 
125 /* SRRCTL bit definitions */
126 #define IGC_SRRCTL_BSIZEPKT_SHIFT		10 /* Shift _right_ */
127 #define IGC_SRRCTL_BSIZEHDRSIZE_SHIFT		2  /* Shift _left_ */
128 #define IGC_SRRCTL_DESCTYPE_ADV_ONEBUF	0x02000000
129 
130 #endif /* _IGC_BASE_H_ */
131