1/******************************************************************************
2  SPDX-License-Identifier: BSD-3-Clause
3
4  Copyright (c) 2001-2015, Intel Corporation
5  All rights reserved.
6
7  Redistribution and use in source and binary forms, with or without
8  modification, are permitted provided that the following conditions are met:
9
10   1. Redistributions of source code must retain the above copyright notice,
11      this list of conditions and the following disclaimer.
12
13   2. Redistributions in binary form must reproduce the above copyright
14      notice, this list of conditions and the following disclaimer in the
15      documentation and/or other materials provided with the distribution.
16
17   3. Neither the name of the Intel Corporation nor the names of its
18      contributors may be used to endorse or promote products derived from
19      this software without specific prior written permission.
20
21  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  POSSIBILITY OF SUCH DAMAGE.
32
33******************************************************************************/
34/*$FreeBSD: releng/12.0/sys/dev/e1000/e1000_82575.h 327865 2018-01-12 06:37:53Z eadler $*/
35
36#ifndef _E1000_82575_H_
37#define _E1000_82575_H_
38
39#define ID_LED_DEFAULT_82575_SERDES	((ID_LED_DEF1_DEF2 << 12) | \
40					 (ID_LED_DEF1_DEF2 <<  8) | \
41					 (ID_LED_DEF1_DEF2 <<  4) | \
42					 (ID_LED_OFF1_ON2))
43/*
44 * Receive Address Register Count
45 * Number of high/low register pairs in the RAR.  The RAR (Receive Address
46 * Registers) holds the directed and multicast addresses that we monitor.
47 * These entries are also used for MAC-based filtering.
48 */
49/*
50 * For 82576, there are an additional set of RARs that begin at an offset
51 * separate from the first set of RARs.
52 */
53#define E1000_RAR_ENTRIES_82575	16
54#define E1000_RAR_ENTRIES_82576	24
55#define E1000_RAR_ENTRIES_82580	24
56#define E1000_RAR_ENTRIES_I350	32
57#define E1000_SW_SYNCH_MB	0x00000100
58#define E1000_STAT_DEV_RST_SET	0x00100000
59#define E1000_CTRL_DEV_RST	0x20000000
60
61#ifdef E1000_BIT_FIELDS
62struct e1000_adv_data_desc {
63	__le64 buffer_addr;    /* Address of the descriptor's data buffer */
64	union {
65		u32 data;
66		struct {
67			u32 datalen:16; /* Data buffer length */
68			u32 rsvd:4;
69			u32 dtyp:4;  /* Descriptor type */
70			u32 dcmd:8;  /* Descriptor command */
71		} config;
72	} lower;
73	union {
74		u32 data;
75		struct {
76			u32 status:4;  /* Descriptor status */
77			u32 idx:4;
78			u32 popts:6;  /* Packet Options */
79			u32 paylen:18; /* Payload length */
80		} options;
81	} upper;
82};
83
84#define E1000_TXD_DTYP_ADV_C	0x2  /* Advanced Context Descriptor */
85#define E1000_TXD_DTYP_ADV_D	0x3  /* Advanced Data Descriptor */
86#define E1000_ADV_TXD_CMD_DEXT	0x20 /* Descriptor extension (0 = legacy) */
87#define E1000_ADV_TUCMD_IPV4	0x2  /* IP Packet Type: 1=IPv4 */
88#define E1000_ADV_TUCMD_IPV6	0x0  /* IP Packet Type: 0=IPv6 */
89#define E1000_ADV_TUCMD_L4T_UDP	0x0  /* L4 Packet TYPE of UDP */
90#define E1000_ADV_TUCMD_L4T_TCP	0x4  /* L4 Packet TYPE of TCP */
91#define E1000_ADV_TUCMD_MKRREQ	0x10 /* Indicates markers are required */
92#define E1000_ADV_DCMD_EOP	0x1  /* End of Packet */
93#define E1000_ADV_DCMD_IFCS	0x2  /* Insert FCS (Ethernet CRC) */
94#define E1000_ADV_DCMD_RS	0x8  /* Report Status */
95#define E1000_ADV_DCMD_VLE	0x40 /* Add VLAN tag */
96#define E1000_ADV_DCMD_TSE	0x80 /* TCP Seg enable */
97/* Extended Device Control */
98#define E1000_CTRL_EXT_NSICR	0x00000001 /* Disable Intr Clear all on read */
99
100struct e1000_adv_context_desc {
101	union {
102		u32 ip_config;
103		struct {
104			u32 iplen:9;
105			u32 maclen:7;
106			u32 vlan_tag:16;
107		} fields;
108	} ip_setup;
109	u32 seq_num;
110	union {
111		u64 l4_config;
112		struct {
113			u32 mkrloc:9;
114			u32 tucmd:11;
115			u32 dtyp:4;
116			u32 adv:8;
117			u32 rsvd:4;
118			u32 idx:4;
119			u32 l4len:8;
120			u32 mss:16;
121		} fields;
122	} l4_setup;
123};
124#endif
125
126/* SRRCTL bit definitions */
127#define E1000_SRRCTL_BSIZEPKT_SHIFT		10 /* Shift _right_ */
128#define E1000_SRRCTL_BSIZEHDRSIZE_MASK		0x00000F00
129#define E1000_SRRCTL_BSIZEHDRSIZE_SHIFT		2  /* Shift _left_ */
130#define E1000_SRRCTL_DESCTYPE_LEGACY		0x00000000
131#define E1000_SRRCTL_DESCTYPE_ADV_ONEBUF	0x02000000
132#define E1000_SRRCTL_DESCTYPE_HDR_SPLIT		0x04000000
133#define E1000_SRRCTL_DESCTYPE_HDR_SPLIT_ALWAYS	0x0A000000
134#define E1000_SRRCTL_DESCTYPE_HDR_REPLICATION	0x06000000
135#define E1000_SRRCTL_DESCTYPE_HDR_REPLICATION_LARGE_PKT 0x08000000
136#define E1000_SRRCTL_DESCTYPE_MASK		0x0E000000
137#define E1000_SRRCTL_TIMESTAMP			0x40000000
138#define E1000_SRRCTL_DROP_EN			0x80000000
139
140#define E1000_SRRCTL_BSIZEPKT_MASK		0x0000007F
141#define E1000_SRRCTL_BSIZEHDR_MASK		0x00003F00
142
143#define E1000_TX_HEAD_WB_ENABLE		0x1
144#define E1000_TX_SEQNUM_WB_ENABLE	0x2
145
146#define E1000_MRQC_ENABLE_RSS_4Q		0x00000002
147#define E1000_MRQC_ENABLE_VMDQ			0x00000003
148#define E1000_MRQC_ENABLE_VMDQ_RSS_2Q		0x00000005
149#define E1000_MRQC_RSS_FIELD_IPV4_UDP		0x00400000
150#define E1000_MRQC_RSS_FIELD_IPV6_UDP		0x00800000
151#define E1000_MRQC_RSS_FIELD_IPV6_UDP_EX	0x01000000
152#define E1000_MRQC_ENABLE_RSS_8Q		0x00000002
153
154#define E1000_VMRCTL_MIRROR_PORT_SHIFT		8
155#define E1000_VMRCTL_MIRROR_DSTPORT_MASK	(7 << \
156						 E1000_VMRCTL_MIRROR_PORT_SHIFT)
157#define E1000_VMRCTL_POOL_MIRROR_ENABLE		(1 << 0)
158#define E1000_VMRCTL_UPLINK_MIRROR_ENABLE	(1 << 1)
159#define E1000_VMRCTL_DOWNLINK_MIRROR_ENABLE	(1 << 2)
160
161#define E1000_EICR_TX_QUEUE ( \
162	E1000_EICR_TX_QUEUE0 |    \
163	E1000_EICR_TX_QUEUE1 |    \
164	E1000_EICR_TX_QUEUE2 |    \
165	E1000_EICR_TX_QUEUE3)
166
167#define E1000_EICR_RX_QUEUE ( \
168	E1000_EICR_RX_QUEUE0 |    \
169	E1000_EICR_RX_QUEUE1 |    \
170	E1000_EICR_RX_QUEUE2 |    \
171	E1000_EICR_RX_QUEUE3)
172
173#define E1000_EIMS_RX_QUEUE	E1000_EICR_RX_QUEUE
174#define E1000_EIMS_TX_QUEUE	E1000_EICR_TX_QUEUE
175
176#define EIMS_ENABLE_MASK ( \
177	E1000_EIMS_RX_QUEUE  | \
178	E1000_EIMS_TX_QUEUE  | \
179	E1000_EIMS_TCP_TIMER | \
180	E1000_EIMS_OTHER)
181
182/* Immediate Interrupt Rx (A.K.A. Low Latency Interrupt) */
183#define E1000_IMIR_PORT_IM_EN	0x00010000  /* TCP port enable */
184#define E1000_IMIR_PORT_BP	0x00020000  /* TCP port check bypass */
185#define E1000_IMIREXT_SIZE_BP	0x00001000  /* Packet size bypass */
186#define E1000_IMIREXT_CTRL_URG	0x00002000  /* Check URG bit in header */
187#define E1000_IMIREXT_CTRL_ACK	0x00004000  /* Check ACK bit in header */
188#define E1000_IMIREXT_CTRL_PSH	0x00008000  /* Check PSH bit in header */
189#define E1000_IMIREXT_CTRL_RST	0x00010000  /* Check RST bit in header */
190#define E1000_IMIREXT_CTRL_SYN	0x00020000  /* Check SYN bit in header */
191#define E1000_IMIREXT_CTRL_FIN	0x00040000  /* Check FIN bit in header */
192#define E1000_IMIREXT_CTRL_BP	0x00080000  /* Bypass check of ctrl bits */
193
194/* Receive Descriptor - Advanced */
195union e1000_adv_rx_desc {
196	struct {
197		__le64 pkt_addr; /* Packet buffer address */
198		__le64 hdr_addr; /* Header buffer address */
199	} read;
200	struct {
201		struct {
202			union {
203				__le32 data;
204				struct {
205					__le16 pkt_info; /*RSS type, Pkt type*/
206					/* Split Header, header buffer len */
207					__le16 hdr_info;
208				} hs_rss;
209			} lo_dword;
210			union {
211				__le32 rss; /* RSS Hash */
212				struct {
213					__le16 ip_id; /* IP id */
214					__le16 csum; /* Packet Checksum */
215				} csum_ip;
216			} hi_dword;
217		} lower;
218		struct {
219			__le32 status_error; /* ext status/error */
220			__le16 length; /* Packet length */
221			__le16 vlan; /* VLAN tag */
222		} upper;
223	} wb;  /* writeback */
224};
225
226#define E1000_RXDADV_RSSTYPE_MASK	0x0000000F
227#define E1000_RXDADV_RSSTYPE_SHIFT	12
228#define E1000_RXDADV_HDRBUFLEN_MASK	0x7FE0
229#define E1000_RXDADV_HDRBUFLEN_SHIFT	5
230#define E1000_RXDADV_SPLITHEADER_EN	0x00001000
231#define E1000_RXDADV_SPH		0x8000
232#define E1000_RXDADV_STAT_TS		0x10000 /* Pkt was time stamped */
233#define E1000_RXDADV_STAT_TSIP		0x08000 /* timestamp in packet */
234#define E1000_RXDADV_ERR_HBO		0x00800000
235
236/* RSS Hash results */
237#define E1000_RXDADV_RSSTYPE_NONE	0x00000000
238#define E1000_RXDADV_RSSTYPE_IPV4_TCP	0x00000001
239#define E1000_RXDADV_RSSTYPE_IPV4	0x00000002
240#define E1000_RXDADV_RSSTYPE_IPV6_TCP	0x00000003
241#define E1000_RXDADV_RSSTYPE_IPV6_EX	0x00000004
242#define E1000_RXDADV_RSSTYPE_IPV6	0x00000005
243#define E1000_RXDADV_RSSTYPE_IPV6_TCP_EX 0x00000006
244#define E1000_RXDADV_RSSTYPE_IPV4_UDP	0x00000007
245#define E1000_RXDADV_RSSTYPE_IPV6_UDP	0x00000008
246#define E1000_RXDADV_RSSTYPE_IPV6_UDP_EX 0x00000009
247
248/* RSS Packet Types as indicated in the receive descriptor */
249#define E1000_RXDADV_PKTTYPE_ILMASK	0x000000F0
250#define E1000_RXDADV_PKTTYPE_TLMASK	0x00000F00
251#define E1000_RXDADV_PKTTYPE_NONE	0x00000000
252#define E1000_RXDADV_PKTTYPE_IPV4	0x00000010 /* IPV4 hdr present */
253#define E1000_RXDADV_PKTTYPE_IPV4_EX	0x00000020 /* IPV4 hdr + extensions */
254#define E1000_RXDADV_PKTTYPE_IPV6	0x00000040 /* IPV6 hdr present */
255#define E1000_RXDADV_PKTTYPE_IPV6_EX	0x00000080 /* IPV6 hdr + extensions */
256#define E1000_RXDADV_PKTTYPE_TCP	0x00000100 /* TCP hdr present */
257#define E1000_RXDADV_PKTTYPE_UDP	0x00000200 /* UDP hdr present */
258#define E1000_RXDADV_PKTTYPE_SCTP	0x00000400 /* SCTP hdr present */
259#define E1000_RXDADV_PKTTYPE_NFS	0x00000800 /* NFS hdr present */
260
261#define E1000_RXDADV_PKTTYPE_IPSEC_ESP	0x00001000 /* IPSec ESP */
262#define E1000_RXDADV_PKTTYPE_IPSEC_AH	0x00002000 /* IPSec AH */
263#define E1000_RXDADV_PKTTYPE_LINKSEC	0x00004000 /* LinkSec Encap */
264#define E1000_RXDADV_PKTTYPE_ETQF	0x00008000 /* PKTTYPE is ETQF index */
265#define E1000_RXDADV_PKTTYPE_ETQF_MASK	0x00000070 /* ETQF has 8 indices */
266#define E1000_RXDADV_PKTTYPE_ETQF_SHIFT	4 /* Right-shift 4 bits */
267
268/* LinkSec results */
269/* Security Processing bit Indication */
270#define E1000_RXDADV_LNKSEC_STATUS_SECP		0x00020000
271#define E1000_RXDADV_LNKSEC_ERROR_BIT_MASK	0x18000000
272#define E1000_RXDADV_LNKSEC_ERROR_NO_SA_MATCH	0x08000000
273#define E1000_RXDADV_LNKSEC_ERROR_REPLAY_ERROR	0x10000000
274#define E1000_RXDADV_LNKSEC_ERROR_BAD_SIG	0x18000000
275
276#define E1000_RXDADV_IPSEC_STATUS_SECP			0x00020000
277#define E1000_RXDADV_IPSEC_ERROR_BIT_MASK		0x18000000
278#define E1000_RXDADV_IPSEC_ERROR_INVALID_PROTOCOL	0x08000000
279#define E1000_RXDADV_IPSEC_ERROR_INVALID_LENGTH		0x10000000
280#define E1000_RXDADV_IPSEC_ERROR_AUTHENTICATION_FAILED	0x18000000
281
282/* Transmit Descriptor - Advanced */
283union e1000_adv_tx_desc {
284	struct {
285		__le64 buffer_addr;    /* Address of descriptor's data buf */
286		__le32 cmd_type_len;
287		__le32 olinfo_status;
288	} read;
289	struct {
290		__le64 rsvd;       /* Reserved */
291		__le32 nxtseq_seed;
292		__le32 status;
293	} wb;
294};
295
296/* Adv Transmit Descriptor Config Masks */
297#define E1000_ADVTXD_DTYP_CTXT	0x00200000 /* Advanced Context Descriptor */
298#define E1000_ADVTXD_DTYP_DATA	0x00300000 /* Advanced Data Descriptor */
299#define E1000_ADVTXD_DCMD_EOP	0x01000000 /* End of Packet */
300#define E1000_ADVTXD_DCMD_IFCS	0x02000000 /* Insert FCS (Ethernet CRC) */
301#define E1000_ADVTXD_DCMD_RS	0x08000000 /* Report Status */
302#define E1000_ADVTXD_DCMD_DDTYP_ISCSI	0x10000000 /* DDP hdr type or iSCSI */
303#define E1000_ADVTXD_DCMD_DEXT	0x20000000 /* Descriptor extension (1=Adv) */
304#define E1000_ADVTXD_DCMD_VLE	0x40000000 /* VLAN pkt enable */
305#define E1000_ADVTXD_DCMD_TSE	0x80000000 /* TCP Seg enable */
306#define E1000_ADVTXD_MAC_LINKSEC	0x00040000 /* Apply LinkSec on pkt */
307#define E1000_ADVTXD_MAC_TSTAMP		0x00080000 /* IEEE1588 Timestamp pkt */
308#define E1000_ADVTXD_STAT_SN_CRC	0x00000002 /* NXTSEQ/SEED prsnt in WB */
309#define E1000_ADVTXD_IDX_SHIFT		4  /* Adv desc Index shift */
310#define E1000_ADVTXD_POPTS_ISCO_1ST	0x00000000 /* 1st TSO of iSCSI PDU */
311#define E1000_ADVTXD_POPTS_ISCO_MDL	0x00000800 /* Middle TSO of iSCSI PDU */
312#define E1000_ADVTXD_POPTS_ISCO_LAST	0x00001000 /* Last TSO of iSCSI PDU */
313/* 1st & Last TSO-full iSCSI PDU*/
314#define E1000_ADVTXD_POPTS_ISCO_FULL	0x00001800
315#define E1000_ADVTXD_POPTS_IPSEC	0x00000400 /* IPSec offload request */
316#define E1000_ADVTXD_PAYLEN_SHIFT	14 /* Adv desc PAYLEN shift */
317
318/* Context descriptors */
319struct e1000_adv_tx_context_desc {
320	__le32 vlan_macip_lens;
321	__le32 seqnum_seed;
322	__le32 type_tucmd_mlhl;
323	__le32 mss_l4len_idx;
324};
325
326#define E1000_ADVTXD_MACLEN_SHIFT	9  /* Adv ctxt desc mac len shift */
327#define E1000_ADVTXD_VLAN_SHIFT		16  /* Adv ctxt vlan tag shift */
328#define E1000_ADVTXD_TUCMD_IPV4		0x00000400  /* IP Packet Type: 1=IPv4 */
329#define E1000_ADVTXD_TUCMD_IPV6		0x00000000  /* IP Packet Type: 0=IPv6 */
330#define E1000_ADVTXD_TUCMD_L4T_UDP	0x00000000  /* L4 Packet TYPE of UDP */
331#define E1000_ADVTXD_TUCMD_L4T_TCP	0x00000800  /* L4 Packet TYPE of TCP */
332#define E1000_ADVTXD_TUCMD_L4T_SCTP	0x00001000  /* L4 Packet TYPE of SCTP */
333#define E1000_ADVTXD_TUCMD_IPSEC_TYPE_ESP	0x00002000 /* IPSec Type ESP */
334/* IPSec Encrypt Enable for ESP */
335#define E1000_ADVTXD_TUCMD_IPSEC_ENCRYPT_EN	0x00004000
336/* Req requires Markers and CRC */
337#define E1000_ADVTXD_TUCMD_MKRREQ	0x00002000
338#define E1000_ADVTXD_L4LEN_SHIFT	8  /* Adv ctxt L4LEN shift */
339#define E1000_ADVTXD_MSS_SHIFT		16  /* Adv ctxt MSS shift */
340/* Adv ctxt IPSec SA IDX mask */
341#define E1000_ADVTXD_IPSEC_SA_INDEX_MASK	0x000000FF
342/* Adv ctxt IPSec ESP len mask */
343#define E1000_ADVTXD_IPSEC_ESP_LEN_MASK		0x000000FF
344
345/* Additional Transmit Descriptor Control definitions */
346#define E1000_TXDCTL_QUEUE_ENABLE	0x02000000 /* Ena specific Tx Queue */
347#define E1000_TXDCTL_SWFLSH		0x04000000 /* Tx Desc. wbk flushing */
348/* Tx Queue Arbitration Priority 0=low, 1=high */
349#define E1000_TXDCTL_PRIORITY		0x08000000
350
351/* Additional Receive Descriptor Control definitions */
352#define E1000_RXDCTL_QUEUE_ENABLE	0x02000000 /* Ena specific Rx Queue */
353#define E1000_RXDCTL_SWFLSH		0x04000000 /* Rx Desc. wbk flushing */
354
355/* Direct Cache Access (DCA) definitions */
356#define E1000_DCA_CTRL_DCA_ENABLE	0x00000000 /* DCA Enable */
357#define E1000_DCA_CTRL_DCA_DISABLE	0x00000001 /* DCA Disable */
358
359#define E1000_DCA_CTRL_DCA_MODE_CB1	0x00 /* DCA Mode CB1 */
360#define E1000_DCA_CTRL_DCA_MODE_CB2	0x02 /* DCA Mode CB2 */
361
362#define E1000_DCA_RXCTRL_CPUID_MASK	0x0000001F /* Rx CPUID Mask */
363#define E1000_DCA_RXCTRL_DESC_DCA_EN	(1 << 5) /* DCA Rx Desc enable */
364#define E1000_DCA_RXCTRL_HEAD_DCA_EN	(1 << 6) /* DCA Rx Desc header ena */
365#define E1000_DCA_RXCTRL_DATA_DCA_EN	(1 << 7) /* DCA Rx Desc payload ena */
366#define E1000_DCA_RXCTRL_DESC_RRO_EN	(1 << 9) /* DCA Rx Desc Relax Order */
367
368#define E1000_DCA_TXCTRL_CPUID_MASK	0x0000001F /* Tx CPUID Mask */
369#define E1000_DCA_TXCTRL_DESC_DCA_EN	(1 << 5) /* DCA Tx Desc enable */
370#define E1000_DCA_TXCTRL_DESC_RRO_EN	(1 << 9) /* Tx rd Desc Relax Order */
371#define E1000_DCA_TXCTRL_TX_WB_RO_EN	(1 << 11) /* Tx Desc writeback RO bit */
372#define E1000_DCA_TXCTRL_DATA_RRO_EN	(1 << 13) /* Tx rd data Relax Order */
373
374#define E1000_DCA_TXCTRL_CPUID_MASK_82576	0xFF000000 /* Tx CPUID Mask */
375#define E1000_DCA_RXCTRL_CPUID_MASK_82576	0xFF000000 /* Rx CPUID Mask */
376#define E1000_DCA_TXCTRL_CPUID_SHIFT_82576	24 /* Tx CPUID */
377#define E1000_DCA_RXCTRL_CPUID_SHIFT_82576	24 /* Rx CPUID */
378
379/* Additional interrupt register bit definitions */
380#define E1000_ICR_LSECPNS	0x00000020 /* PN threshold - server */
381#define E1000_IMS_LSECPNS	E1000_ICR_LSECPNS /* PN threshold - server */
382#define E1000_ICS_LSECPNS	E1000_ICR_LSECPNS /* PN threshold - server */
383
384/* ETQF register bit definitions */
385#define E1000_ETQF_FILTER_ENABLE	(1 << 26)
386#define E1000_ETQF_IMM_INT		(1 << 29)
387#define E1000_ETQF_1588			(1 << 30)
388#define E1000_ETQF_QUEUE_ENABLE		(1U << 31)
389/*
390 * ETQF filter list: one static filter per filter consumer. This is
391 *                   to avoid filter collisions later. Add new filters
392 *                   here!!
393 *
394 * Current filters:
395 *    EAPOL 802.1x (0x888e): Filter 0
396 */
397#define E1000_ETQF_FILTER_EAPOL		0
398
399#define E1000_FTQF_VF_BP		0x00008000
400#define E1000_FTQF_1588_TIME_STAMP	0x08000000
401#define E1000_FTQF_MASK			0xF0000000
402#define E1000_FTQF_MASK_PROTO_BP	0x10000000
403#define E1000_FTQF_MASK_SOURCE_ADDR_BP	0x20000000
404#define E1000_FTQF_MASK_DEST_ADDR_BP	0x40000000
405#define E1000_FTQF_MASK_SOURCE_PORT_BP	0x80000000
406
407#define E1000_NVM_APME_82575		0x0400
408#define MAX_NUM_VFS			7
409
410#define E1000_DTXSWC_MAC_SPOOF_MASK	0x000000FF /* Per VF MAC spoof cntrl */
411#define E1000_DTXSWC_VLAN_SPOOF_MASK	0x0000FF00 /* Per VF VLAN spoof cntrl */
412#define E1000_DTXSWC_LLE_MASK		0x00FF0000 /* Per VF Local LB enables */
413#define E1000_DTXSWC_VLAN_SPOOF_SHIFT	8
414#define E1000_DTXSWC_LLE_SHIFT		16
415#define E1000_DTXSWC_VMDQ_LOOPBACK_EN	(1U << 31)  /* global VF LB enable */
416
417/* Easy defines for setting default pool, would normally be left a zero */
418#define E1000_VT_CTL_DEFAULT_POOL_SHIFT	7
419#define E1000_VT_CTL_DEFAULT_POOL_MASK	(0x7 << E1000_VT_CTL_DEFAULT_POOL_SHIFT)
420
421/* Other useful VMD_CTL register defines */
422#define E1000_VT_CTL_IGNORE_MAC		(1 << 28)
423#define E1000_VT_CTL_DISABLE_DEF_POOL	(1 << 29)
424#define E1000_VT_CTL_VM_REPL_EN		(1 << 30)
425
426/* Per VM Offload register setup */
427#define E1000_VMOLR_RLPML_MASK	0x00003FFF /* Long Packet Maximum Length mask */
428#define E1000_VMOLR_LPE		0x00010000 /* Accept Long packet */
429#define E1000_VMOLR_RSSE	0x00020000 /* Enable RSS */
430#define E1000_VMOLR_AUPE	0x01000000 /* Accept untagged packets */
431#define E1000_VMOLR_ROMPE	0x02000000 /* Accept overflow multicast */
432#define E1000_VMOLR_ROPE	0x04000000 /* Accept overflow unicast */
433#define E1000_VMOLR_BAM		0x08000000 /* Accept Broadcast packets */
434#define E1000_VMOLR_MPME	0x10000000 /* Multicast promiscuous mode */
435#define E1000_VMOLR_STRVLAN	0x40000000 /* Vlan stripping enable */
436#define E1000_VMOLR_STRCRC	0x80000000 /* CRC stripping enable */
437
438#define E1000_VMOLR_VPE		0x00800000 /* VLAN promiscuous enable */
439#define E1000_VMOLR_UPE		0x20000000 /* Unicast promisuous enable */
440#define E1000_DVMOLR_HIDVLAN	0x20000000 /* Vlan hiding enable */
441#define E1000_DVMOLR_STRVLAN	0x40000000 /* Vlan stripping enable */
442#define E1000_DVMOLR_STRCRC	0x80000000 /* CRC stripping enable */
443
444#define E1000_PBRWAC_WALPB	0x00000007 /* Wrap around event on LAN Rx PB */
445#define E1000_PBRWAC_PBE	0x00000008 /* Rx packet buffer empty */
446
447#define E1000_VLVF_ARRAY_SIZE		32
448#define E1000_VLVF_VLANID_MASK		0x00000FFF
449#define E1000_VLVF_POOLSEL_SHIFT	12
450#define E1000_VLVF_POOLSEL_MASK		(0xFF << E1000_VLVF_POOLSEL_SHIFT)
451#define E1000_VLVF_LVLAN		0x00100000
452#define E1000_VLVF_VLANID_ENABLE	0x80000000
453
454#define E1000_VMVIR_VLANA_DEFAULT	0x40000000 /* Always use default VLAN */
455#define E1000_VMVIR_VLANA_NEVER		0x80000000 /* Never insert VLAN tag */
456
457#define E1000_VF_INIT_TIMEOUT	200 /* Number of retries to clear RSTI */
458
459#define E1000_IOVCTL		0x05BBC
460#define E1000_IOVCTL_REUSE_VFQ	0x00000001
461
462#define E1000_RPLOLR_STRVLAN	0x40000000
463#define E1000_RPLOLR_STRCRC	0x80000000
464
465#define E1000_TCTL_EXT_COLD	0x000FFC00
466#define E1000_TCTL_EXT_COLD_SHIFT	10
467
468#define E1000_DTXCTL_8023LL	0x0004
469#define E1000_DTXCTL_VLAN_ADDED	0x0008
470#define E1000_DTXCTL_OOS_ENABLE	0x0010
471#define E1000_DTXCTL_MDP_EN	0x0020
472#define E1000_DTXCTL_SPOOF_INT	0x0040
473
474#define E1000_EEPROM_PCS_AUTONEG_DISABLE_BIT	(1 << 14)
475
476#define ALL_QUEUES		0xFFFF
477
478/* Rx packet buffer size defines */
479#define E1000_RXPBS_SIZE_MASK_82576	0x0000007F
480void e1000_vmdq_set_loopback_pf(struct e1000_hw *hw, bool enable);
481void e1000_vmdq_set_anti_spoofing_pf(struct e1000_hw *hw, bool enable, int pf);
482void e1000_vmdq_set_replication_pf(struct e1000_hw *hw, bool enable);
483s32 e1000_init_nvm_params_82575(struct e1000_hw *hw);
484s32  e1000_init_hw_82575(struct e1000_hw *hw);
485
486enum e1000_promisc_type {
487	e1000_promisc_disabled = 0,   /* all promisc modes disabled */
488	e1000_promisc_unicast = 1,    /* unicast promiscuous enabled */
489	e1000_promisc_multicast = 2,  /* multicast promiscuous enabled */
490	e1000_promisc_enabled = 3,    /* both uni and multicast promisc */
491	e1000_num_promisc_types
492};
493
494void e1000_vfta_set_vf(struct e1000_hw *, u16, bool);
495void e1000_rlpml_set_vf(struct e1000_hw *, u16);
496s32 e1000_promisc_set_vf(struct e1000_hw *, enum e1000_promisc_type type);
497void e1000_write_vfta_i350(struct e1000_hw *hw, u32 offset, u32 value);
498u16 e1000_rxpbs_adjust_82580(u32 data);
499s32 e1000_read_emi_reg(struct e1000_hw *hw, u16 addr, u16 *data);
500s32 e1000_set_eee_i350(struct e1000_hw *hw, bool adv1G, bool adv100M);
501s32 e1000_set_eee_i354(struct e1000_hw *hw, bool adv1G, bool adv100M);
502s32 e1000_get_eee_status_i354(struct e1000_hw *, bool *);
503s32 e1000_initialize_M88E1512_phy(struct e1000_hw *hw);
504s32 e1000_initialize_M88E1543_phy(struct e1000_hw *hw);
505
506/* I2C SDA and SCL timing parameters for standard mode */
507#define E1000_I2C_T_HD_STA	4
508#define E1000_I2C_T_LOW		5
509#define E1000_I2C_T_HIGH	4
510#define E1000_I2C_T_SU_STA	5
511#define E1000_I2C_T_HD_DATA	5
512#define E1000_I2C_T_SU_DATA	1
513#define E1000_I2C_T_RISE	1
514#define E1000_I2C_T_FALL	1
515#define E1000_I2C_T_SU_STO	4
516#define E1000_I2C_T_BUF		5
517
518s32 e1000_set_i2c_bb(struct e1000_hw *hw);
519s32 e1000_read_i2c_byte_generic(struct e1000_hw *hw, u8 byte_offset,
520				u8 dev_addr, u8 *data);
521s32 e1000_write_i2c_byte_generic(struct e1000_hw *hw, u8 byte_offset,
522				 u8 dev_addr, u8 data);
523void e1000_i2c_bus_clear(struct e1000_hw *hw);
524#endif /* _E1000_82575_H_ */
525