1 /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
2 /* Copyright (C) 2015-2018 Netronome Systems, Inc. */
3 
4 /* nfp_net_ctrl.h
5  * Netronome network device driver: Control BAR layout
6  * Authors: Jakub Kicinski <jakub.kicinski@netronome.com>
7  *          Jason McMullan <jason.mcmullan@netronome.com>
8  *          Rolf Neugebauer <rolf.neugebauer@netronome.com>
9  *          Brad Petrus <brad.petrus@netronome.com>
10  */
11 
12 #ifndef _NFP_NET_CTRL_H_
13 #define _NFP_NET_CTRL_H_
14 
15 #include <linux/types.h>
16 
17 /* 64-bit per app capabilities */
18 #define NFP_NET_APP_CAP_SP_INDIFF	BIT_ULL(0) /* indifferent to port speed */
19 
20 /* Configuration BAR size.
21  *
22  * The configuration BAR is 8K in size, but due to
23  * THB-350, 32k needs to be reserved.
24  */
25 #define NFP_NET_CFG_BAR_SZ		(32 * 1024)
26 
27 /* Offset in Freelist buffer where packet starts on RX */
28 #define NFP_NET_RX_OFFSET		32
29 
30 /* LSO parameters
31  * %NFP_NET_LSO_MAX_HDR_SZ:	Maximum header size supported for LSO frames
32  * %NFP_NET_LSO_MAX_SEGS:	Maximum number of segments LSO frame can produce
33  */
34 #define NFP_NET_LSO_MAX_HDR_SZ		255
35 #define NFP_NET_LSO_MAX_SEGS		64
36 
37 /* working with metadata vlan api (NFD version >= 2.0) */
38 #define NFP_NET_META_VLAN_STRIP			BIT(31)
39 #define NFP_NET_META_VLAN_TPID_MASK		GENMASK(19, 16)
40 #define NFP_NET_META_VLAN_TCI_MASK		GENMASK(15, 0)
41 
42 /* Prepend field types */
43 #define NFP_NET_META_FIELD_SIZE		4
44 #define NFP_NET_META_HASH		1 /* next field carries hash type */
45 #define NFP_NET_META_MARK		2
46 #define NFP_NET_META_VLAN		4 /* ctag or stag type */
47 #define NFP_NET_META_PORTID		5
48 #define NFP_NET_META_CSUM		6 /* checksum complete type */
49 #define NFP_NET_META_CONN_HANDLE	7
50 #define NFP_NET_META_RESYNC_INFO	8 /* RX resync info request */
51 
52 #define NFP_META_PORT_ID_CTRL		~0U
53 
54 /* Prepend field sizes */
55 #define NFP_NET_META_VLAN_SIZE			4
56 #define NFP_NET_META_PORTID_SIZE		4
57 #define NFP_NET_META_CONN_HANDLE_SIZE		8
58 /* Hash type pre-pended when a RSS hash was computed */
59 #define NFP_NET_RSS_NONE		0
60 #define NFP_NET_RSS_IPV4		1
61 #define NFP_NET_RSS_IPV6		2
62 #define NFP_NET_RSS_IPV6_EX		3
63 #define NFP_NET_RSS_IPV4_TCP		4
64 #define NFP_NET_RSS_IPV6_TCP		5
65 #define NFP_NET_RSS_IPV6_EX_TCP		6
66 #define NFP_NET_RSS_IPV4_UDP		7
67 #define NFP_NET_RSS_IPV6_UDP		8
68 #define NFP_NET_RSS_IPV6_EX_UDP		9
69 
70 /* Ring counts
71  * %NFP_NET_TXR_MAX:	     Maximum number of TX rings
72  * %NFP_NET_RXR_MAX:	     Maximum number of RX rings
73  */
74 #define NFP_NET_TXR_MAX			64
75 #define NFP_NET_RXR_MAX			64
76 
77 /* Read/Write config words (0x0000 - 0x002c)
78  * %NFP_NET_CFG_CTRL:	     Global control
79  * %NFP_NET_CFG_UPDATE:      Indicate which fields are updated
80  * %NFP_NET_CFG_TXRS_ENABLE: Bitmask of enabled TX rings
81  * %NFP_NET_CFG_RXRS_ENABLE: Bitmask of enabled RX rings
82  * %NFP_NET_CFG_MTU:	     Set MTU size
83  * %NFP_NET_CFG_FLBUFSZ:     Set freelist buffer size (must be larger than MTU)
84  * %NFP_NET_CFG_EXN:	     MSI-X table entry for exceptions
85  * %NFP_NET_CFG_LSC:	     MSI-X table entry for link state changes
86  * %NFP_NET_CFG_MACADDR:     MAC address
87  *
88  * TODO:
89  * - define Error details in UPDATE
90  */
91 #define NFP_NET_CFG_CTRL		0x0000
92 #define   NFP_NET_CFG_CTRL_ENABLE	  (0x1 <<  0) /* Global enable */
93 #define   NFP_NET_CFG_CTRL_PROMISC	  (0x1 <<  1) /* Enable Promisc mode */
94 #define   NFP_NET_CFG_CTRL_L2BC		  (0x1 <<  2) /* Allow L2 Broadcast */
95 #define   NFP_NET_CFG_CTRL_L2MC		  (0x1 <<  3) /* Allow L2 Multicast */
96 #define   NFP_NET_CFG_CTRL_RXCSUM	  (0x1 <<  4) /* Enable RX Checksum */
97 #define   NFP_NET_CFG_CTRL_TXCSUM	  (0x1 <<  5) /* Enable TX Checksum */
98 #define   NFP_NET_CFG_CTRL_RXVLAN	  (0x1 <<  6) /* Enable VLAN strip */
99 #define   NFP_NET_CFG_CTRL_TXVLAN	  (0x1 <<  7) /* Enable VLAN insert */
100 #define   NFP_NET_CFG_CTRL_SCATTER	  (0x1 <<  8) /* Scatter DMA */
101 #define   NFP_NET_CFG_CTRL_GATHER	  (0x1 <<  9) /* Gather DMA */
102 #define   NFP_NET_CFG_CTRL_LSO		  (0x1 << 10) /* LSO/TSO (version 1) */
103 #define   NFP_NET_CFG_CTRL_CTAG_FILTER	  (0x1 << 11) /* VLAN CTAG filtering */
104 #define   NFP_NET_CFG_CTRL_CMSG_DATA	  (0x1 << 12) /* RX cmsgs on data Qs */
105 #define   NFP_NET_CFG_CTRL_RXQINQ	  (0x1 << 13) /* Enable S-tag strip */
106 #define   NFP_NET_CFG_CTRL_RXVLAN_V2	  (0x1 << 15) /* Enable C-tag strip */
107 #define   NFP_NET_CFG_CTRL_RINGCFG	  (0x1 << 16) /* Ring runtime changes */
108 #define   NFP_NET_CFG_CTRL_RSS		  (0x1 << 17) /* RSS (version 1) */
109 #define   NFP_NET_CFG_CTRL_IRQMOD	  (0x1 << 18) /* Interrupt moderation */
110 #define   NFP_NET_CFG_CTRL_MSIXAUTO	  (0x1 << 20) /* MSI-X auto-masking */
111 #define   NFP_NET_CFG_CTRL_TXRWB	  (0x1 << 21) /* Write-back of TX ring*/
112 #define   NFP_NET_CFG_CTRL_VEPA		  (0x1 << 22) /* Enable VEPA mode */
113 #define   NFP_NET_CFG_CTRL_TXVLAN_V2	  (0x1 << 23) /* Enable VLAN C-tag insert*/
114 #define   NFP_NET_CFG_CTRL_VXLAN	  (0x1 << 24) /* VXLAN tunnel support */
115 #define   NFP_NET_CFG_CTRL_NVGRE	  (0x1 << 25) /* NVGRE tunnel support */
116 #define   NFP_NET_CFG_CTRL_BPF		  (0x1 << 27) /* BPF offload capable */
117 #define   NFP_NET_CFG_CTRL_LSO2		  (0x1 << 28) /* LSO/TSO (version 2) */
118 #define   NFP_NET_CFG_CTRL_RSS2		  (0x1 << 29) /* RSS (version 2) */
119 #define   NFP_NET_CFG_CTRL_CSUM_COMPLETE  (0x1 << 30) /* Checksum complete */
120 #define   NFP_NET_CFG_CTRL_LIVE_ADDR	  (0x1 << 31) /* live MAC addr change */
121 
122 #define NFP_NET_CFG_CTRL_LSO_ANY	(NFP_NET_CFG_CTRL_LSO | \
123 					 NFP_NET_CFG_CTRL_LSO2)
124 #define NFP_NET_CFG_CTRL_RSS_ANY	(NFP_NET_CFG_CTRL_RSS | \
125 					 NFP_NET_CFG_CTRL_RSS2)
126 #define NFP_NET_CFG_CTRL_RXCSUM_ANY	(NFP_NET_CFG_CTRL_RXCSUM | \
127 					 NFP_NET_CFG_CTRL_CSUM_COMPLETE)
128 #define NFP_NET_CFG_CTRL_CHAIN_META	(NFP_NET_CFG_CTRL_RSS2 | \
129 					 NFP_NET_CFG_CTRL_CSUM_COMPLETE)
130 #define NFP_NET_CFG_CTRL_RXVLAN_ANY	(NFP_NET_CFG_CTRL_RXVLAN | \
131 					 NFP_NET_CFG_CTRL_RXVLAN_V2)
132 #define NFP_NET_CFG_CTRL_TXVLAN_ANY	(NFP_NET_CFG_CTRL_TXVLAN | \
133 					 NFP_NET_CFG_CTRL_TXVLAN_V2)
134 
135 #define NFP_NET_CFG_UPDATE		0x0004
136 #define   NFP_NET_CFG_UPDATE_GEN	  (0x1 <<  0) /* General update */
137 #define   NFP_NET_CFG_UPDATE_RING	  (0x1 <<  1) /* Ring config change */
138 #define   NFP_NET_CFG_UPDATE_RSS	  (0x1 <<  2) /* RSS config change */
139 #define   NFP_NET_CFG_UPDATE_TXRPRIO	  (0x1 <<  3) /* TX Ring prio change */
140 #define   NFP_NET_CFG_UPDATE_RXRPRIO	  (0x1 <<  4) /* RX Ring prio change */
141 #define   NFP_NET_CFG_UPDATE_MSIX	  (0x1 <<  5) /* MSI-X change */
142 #define   NFP_NET_CFG_UPDATE_RESET	  (0x1 <<  7) /* Update due to FLR */
143 #define   NFP_NET_CFG_UPDATE_IRQMOD	  (0x1 <<  8) /* IRQ mod change */
144 #define   NFP_NET_CFG_UPDATE_VXLAN	  (0x1 <<  9) /* VXLAN port change */
145 #define   NFP_NET_CFG_UPDATE_BPF	  (0x1 << 10) /* BPF program load */
146 #define   NFP_NET_CFG_UPDATE_MACADDR	  (0x1 << 11) /* MAC address change */
147 #define   NFP_NET_CFG_UPDATE_MBOX	  (0x1 << 12) /* Mailbox update */
148 #define   NFP_NET_CFG_UPDATE_VF		  (0x1 << 13) /* VF settings change */
149 #define   NFP_NET_CFG_UPDATE_CRYPTO	  (0x1 << 14) /* Crypto on/off */
150 #define   NFP_NET_CFG_UPDATE_ERR	  (0x1 << 31) /* A error occurred */
151 #define NFP_NET_CFG_TXRS_ENABLE		0x0008
152 #define NFP_NET_CFG_RXRS_ENABLE		0x0010
153 #define NFP_NET_CFG_MTU			0x0018
154 #define NFP_NET_CFG_FLBUFSZ		0x001c
155 #define NFP_NET_CFG_EXN			0x001f
156 #define NFP_NET_CFG_LSC			0x0020
157 #define NFP_NET_CFG_MACADDR		0x0024
158 
159 /* Read-only words (0x0030 - 0x0050):
160  * %NFP_NET_CFG_VERSION:     Firmware version number
161  * %NFP_NET_CFG_STS:	     Status
162  * %NFP_NET_CFG_CAP:	     Capabilities (same bits as %NFP_NET_CFG_CTRL)
163  * %NFP_NET_CFG_MAX_TXRINGS: Maximum number of TX rings
164  * %NFP_NET_CFG_MAX_RXRINGS: Maximum number of RX rings
165  * %NFP_NET_CFG_MAX_MTU:     Maximum support MTU
166  * %NFP_NET_CFG_START_TXQ:   Start Queue Control Queue to use for TX (PF only)
167  * %NFP_NET_CFG_START_RXQ:   Start Queue Control Queue to use for RX (PF only)
168  *
169  * TODO:
170  * - define more STS bits
171  */
172 #define NFP_NET_CFG_VERSION		0x0030
173 #define   NFP_NET_CFG_VERSION_RESERVED_MASK	(0xfe << 24)
174 #define   NFP_NET_CFG_VERSION_DP_NFD3		0
175 #define   NFP_NET_CFG_VERSION_DP_NFDK		1
176 #define   NFP_NET_CFG_VERSION_DP_MASK		1
177 #define   NFP_NET_CFG_VERSION_CLASS_MASK  (0xff << 16)
178 #define   NFP_NET_CFG_VERSION_CLASS(x)	  (((x) & 0xff) << 16)
179 #define   NFP_NET_CFG_VERSION_CLASS_GENERIC	0
180 #define   NFP_NET_CFG_VERSION_MAJOR_MASK  (0xff <<  8)
181 #define   NFP_NET_CFG_VERSION_MAJOR(x)	  (((x) & 0xff) <<  8)
182 #define   NFP_NET_CFG_VERSION_MINOR_MASK  (0xff <<  0)
183 #define   NFP_NET_CFG_VERSION_MINOR(x)	  (((x) & 0xff) <<  0)
184 #define NFP_NET_CFG_STS			0x0034
185 #define   NFP_NET_CFG_STS_LINK		  (0x1 << 0) /* Link up or down */
186 /* Link rate */
187 #define   NFP_NET_CFG_STS_LINK_RATE_SHIFT 1
188 #define   NFP_NET_CFG_STS_LINK_RATE_MASK  0xF
189 #define   NFP_NET_CFG_STS_LINK_RATE	  \
190 	(NFP_NET_CFG_STS_LINK_RATE_MASK << NFP_NET_CFG_STS_LINK_RATE_SHIFT)
191 #define   NFP_NET_CFG_STS_LINK_RATE_UNSUPPORTED   0
192 #define   NFP_NET_CFG_STS_LINK_RATE_UNKNOWN	  1
193 #define   NFP_NET_CFG_STS_LINK_RATE_1G		  2
194 #define   NFP_NET_CFG_STS_LINK_RATE_10G		  3
195 #define   NFP_NET_CFG_STS_LINK_RATE_25G		  4
196 #define   NFP_NET_CFG_STS_LINK_RATE_40G		  5
197 #define   NFP_NET_CFG_STS_LINK_RATE_50G		  6
198 #define   NFP_NET_CFG_STS_LINK_RATE_100G	  7
199 /* NSP Link rate is a 16-bit word. It's determined by NSP and
200  * written to CFG BAR by NFP driver.
201  */
202 #define NFP_NET_CFG_STS_NSP_LINK_RATE	0x0036
203 #define NFP_NET_CFG_CAP			0x0038
204 #define NFP_NET_CFG_MAX_TXRINGS		0x003c
205 #define NFP_NET_CFG_MAX_RXRINGS		0x0040
206 #define NFP_NET_CFG_MAX_MTU		0x0044
207 /* Next two words are being used by VFs for solving THB350 issue */
208 #define NFP_NET_CFG_START_TXQ		0x0048
209 #define NFP_NET_CFG_START_RXQ		0x004c
210 
211 /* Prepend configuration
212  */
213 #define NFP_NET_CFG_RX_OFFSET		0x0050
214 #define NFP_NET_CFG_RX_OFFSET_DYNAMIC		0	/* Prepend mode */
215 
216 /* RSS capabilities
217  * %NFP_NET_CFG_RSS_CAP_HFUNC:	supported hash functions (same bits as
218  *				%NFP_NET_CFG_RSS_HFUNC)
219  */
220 #define NFP_NET_CFG_RSS_CAP		0x0054
221 #define   NFP_NET_CFG_RSS_CAP_HFUNC	  0xff000000
222 
223 /* TLV area start
224  * %NFP_NET_CFG_TLV_BASE:	start anchor of the TLV area
225  */
226 #define NFP_NET_CFG_TLV_BASE		0x0058
227 
228 /* VXLAN/UDP encap configuration
229  * %NFP_NET_CFG_VXLAN_PORT:	Base address of table of tunnels' UDP dst ports
230  * %NFP_NET_CFG_VXLAN_SZ:	Size of the UDP port table in bytes
231  */
232 #define NFP_NET_CFG_VXLAN_PORT		0x0060
233 #define NFP_NET_CFG_VXLAN_SZ		  0x0008
234 
235 /* BPF section
236  * %NFP_NET_CFG_BPF_ABI:	BPF ABI version
237  * %NFP_NET_CFG_BPF_CAP:	BPF capabilities
238  * %NFP_NET_CFG_BPF_MAX_LEN:	Maximum size of JITed BPF code in bytes
239  * %NFP_NET_CFG_BPF_START:	Offset at which BPF will be loaded
240  * %NFP_NET_CFG_BPF_DONE:	Offset to jump to on exit
241  * %NFP_NET_CFG_BPF_STACK_SZ:	Total size of stack area in 64B chunks
242  * %NFP_NET_CFG_BPF_INL_MTU:	Packet data split offset in 64B chunks
243  * %NFP_NET_CFG_BPF_SIZE:	Size of the JITed BPF code in instructions
244  * %NFP_NET_CFG_BPF_ADDR:	DMA address of the buffer with JITed BPF code
245  */
246 #define NFP_NET_CFG_BPF_ABI		0x0080
247 #define NFP_NET_CFG_BPF_CAP		0x0081
248 #define   NFP_NET_BPF_CAP_RELO		(1 << 0) /* seamless reload */
249 #define NFP_NET_CFG_BPF_MAX_LEN		0x0082
250 #define NFP_NET_CFG_BPF_START		0x0084
251 #define NFP_NET_CFG_BPF_DONE		0x0086
252 #define NFP_NET_CFG_BPF_STACK_SZ	0x0088
253 #define NFP_NET_CFG_BPF_INL_MTU		0x0089
254 #define NFP_NET_CFG_BPF_SIZE		0x008e
255 #define NFP_NET_CFG_BPF_ADDR		0x0090
256 #define   NFP_NET_CFG_BPF_CFG_8CTX	(1 << 0) /* 8ctx mode */
257 #define   NFP_NET_CFG_BPF_CFG_MASK	7ULL
258 #define   NFP_NET_CFG_BPF_ADDR_MASK	(~NFP_NET_CFG_BPF_CFG_MASK)
259 
260 /* 40B reserved for future use (0x0098 - 0x00c0)
261  */
262 #define NFP_NET_CFG_RESERVED		0x0098
263 #define NFP_NET_CFG_RESERVED_SZ		0x0028
264 
265 /* RSS configuration (0x0100 - 0x01ac):
266  * Used only when NFP_NET_CFG_CTRL_RSS is enabled
267  * %NFP_NET_CFG_RSS_CFG:     RSS configuration word
268  * %NFP_NET_CFG_RSS_KEY:     RSS "secret" key
269  * %NFP_NET_CFG_RSS_ITBL:    RSS indirection table
270  */
271 #define NFP_NET_CFG_RSS_BASE		0x0100
272 #define NFP_NET_CFG_RSS_CTRL		NFP_NET_CFG_RSS_BASE
273 #define   NFP_NET_CFG_RSS_MASK		  (0x7f)
274 #define   NFP_NET_CFG_RSS_MASK_of(_x)	  ((_x) & 0x7f)
275 #define   NFP_NET_CFG_RSS_IPV4		  (1 <<  8) /* RSS for IPv4 */
276 #define   NFP_NET_CFG_RSS_IPV6		  (1 <<  9) /* RSS for IPv6 */
277 #define   NFP_NET_CFG_RSS_IPV4_TCP	  (1 << 10) /* RSS for IPv4/TCP */
278 #define   NFP_NET_CFG_RSS_IPV4_UDP	  (1 << 11) /* RSS for IPv4/UDP */
279 #define   NFP_NET_CFG_RSS_IPV6_TCP	  (1 << 12) /* RSS for IPv6/TCP */
280 #define   NFP_NET_CFG_RSS_IPV6_UDP	  (1 << 13) /* RSS for IPv6/UDP */
281 #define   NFP_NET_CFG_RSS_HFUNC		  0xff000000
282 #define   NFP_NET_CFG_RSS_TOEPLITZ	  (1 << 24) /* Use Toeplitz hash */
283 #define   NFP_NET_CFG_RSS_XOR		  (1 << 25) /* Use XOR as hash */
284 #define   NFP_NET_CFG_RSS_CRC32		  (1 << 26) /* Use CRC32 as hash */
285 #define   NFP_NET_CFG_RSS_HFUNCS	  3
286 #define NFP_NET_CFG_RSS_KEY		(NFP_NET_CFG_RSS_BASE + 0x4)
287 #define NFP_NET_CFG_RSS_KEY_SZ		0x28
288 #define NFP_NET_CFG_RSS_ITBL		(NFP_NET_CFG_RSS_BASE + 0x4 + \
289 					 NFP_NET_CFG_RSS_KEY_SZ)
290 #define NFP_NET_CFG_RSS_ITBL_SZ		0x80
291 
292 /* TX ring configuration (0x200 - 0x800)
293  * %NFP_NET_CFG_TXR_BASE:    Base offset for TX ring configuration
294  * %NFP_NET_CFG_TXR_ADDR:    Per TX ring DMA address (8B entries)
295  * %NFP_NET_CFG_TXR_WB_ADDR: Per TX ring write back DMA address (8B entries)
296  * %NFP_NET_CFG_TXR_SZ:      Per TX ring ring size (1B entries)
297  * %NFP_NET_CFG_TXR_VEC:     Per TX ring MSI-X table entry (1B entries)
298  * %NFP_NET_CFG_TXR_PRIO:    Per TX ring priority (1B entries)
299  * %NFP_NET_CFG_TXR_IRQ_MOD: Per TX ring interrupt moderation packet
300  */
301 #define NFP_NET_CFG_TXR_BASE		0x0200
302 #define NFP_NET_CFG_TXR_ADDR(_x)	(NFP_NET_CFG_TXR_BASE + ((_x) * 0x8))
303 #define NFP_NET_CFG_TXR_WB_ADDR(_x)	(NFP_NET_CFG_TXR_BASE + 0x200 + \
304 					 ((_x) * 0x8))
305 #define NFP_NET_CFG_TXR_SZ(_x)		(NFP_NET_CFG_TXR_BASE + 0x400 + (_x))
306 #define NFP_NET_CFG_TXR_VEC(_x)		(NFP_NET_CFG_TXR_BASE + 0x440 + (_x))
307 #define NFP_NET_CFG_TXR_PRIO(_x)	(NFP_NET_CFG_TXR_BASE + 0x480 + (_x))
308 #define NFP_NET_CFG_TXR_IRQ_MOD(_x)	(NFP_NET_CFG_TXR_BASE + 0x500 + \
309 					 ((_x) * 0x4))
310 
311 /* RX ring configuration (0x0800 - 0x0c00)
312  * %NFP_NET_CFG_RXR_BASE:    Base offset for RX ring configuration
313  * %NFP_NET_CFG_RXR_ADDR:    Per RX ring DMA address (8B entries)
314  * %NFP_NET_CFG_RXR_SZ:      Per RX ring ring size (1B entries)
315  * %NFP_NET_CFG_RXR_VEC:     Per RX ring MSI-X table entry (1B entries)
316  * %NFP_NET_CFG_RXR_PRIO:    Per RX ring priority (1B entries)
317  * %NFP_NET_CFG_RXR_IRQ_MOD: Per RX ring interrupt moderation (4B entries)
318  */
319 #define NFP_NET_CFG_RXR_BASE		0x0800
320 #define NFP_NET_CFG_RXR_ADDR(_x)	(NFP_NET_CFG_RXR_BASE + ((_x) * 0x8))
321 #define NFP_NET_CFG_RXR_SZ(_x)		(NFP_NET_CFG_RXR_BASE + 0x200 + (_x))
322 #define NFP_NET_CFG_RXR_VEC(_x)		(NFP_NET_CFG_RXR_BASE + 0x240 + (_x))
323 #define NFP_NET_CFG_RXR_PRIO(_x)	(NFP_NET_CFG_RXR_BASE + 0x280 + (_x))
324 #define NFP_NET_CFG_RXR_IRQ_MOD(_x)	(NFP_NET_CFG_RXR_BASE + 0x300 + \
325 					 ((_x) * 0x4))
326 
327 /* Interrupt Control/Cause registers (0x0c00 - 0x0d00)
328  * These registers are only used when MSI-X auto-masking is not
329  * enabled (%NFP_NET_CFG_CTRL_MSIXAUTO not set).  The array is index
330  * by MSI-X entry and are 1B in size.  If an entry is zero, the
331  * corresponding entry is enabled.  If the FW generates an interrupt,
332  * it writes a cause into the corresponding field.  This also masks
333  * the MSI-X entry and the host driver must clear the register to
334  * re-enable the interrupt.
335  */
336 #define NFP_NET_CFG_ICR_BASE		0x0c00
337 #define NFP_NET_CFG_ICR(_x)		(NFP_NET_CFG_ICR_BASE + (_x))
338 #define   NFP_NET_CFG_ICR_UNMASKED	0x0
339 #define   NFP_NET_CFG_ICR_RXTX		0x1
340 #define   NFP_NET_CFG_ICR_LSC		0x2
341 
342 /* General device stats (0x0d00 - 0x0d90)
343  * all counters are 64bit.
344  */
345 #define NFP_NET_CFG_STATS_BASE		0x0d00
346 #define NFP_NET_CFG_STATS_RX_DISCARDS	(NFP_NET_CFG_STATS_BASE + 0x00)
347 #define NFP_NET_CFG_STATS_RX_ERRORS	(NFP_NET_CFG_STATS_BASE + 0x08)
348 #define NFP_NET_CFG_STATS_RX_OCTETS	(NFP_NET_CFG_STATS_BASE + 0x10)
349 #define NFP_NET_CFG_STATS_RX_UC_OCTETS	(NFP_NET_CFG_STATS_BASE + 0x18)
350 #define NFP_NET_CFG_STATS_RX_MC_OCTETS	(NFP_NET_CFG_STATS_BASE + 0x20)
351 #define NFP_NET_CFG_STATS_RX_BC_OCTETS	(NFP_NET_CFG_STATS_BASE + 0x28)
352 #define NFP_NET_CFG_STATS_RX_FRAMES	(NFP_NET_CFG_STATS_BASE + 0x30)
353 #define NFP_NET_CFG_STATS_RX_MC_FRAMES	(NFP_NET_CFG_STATS_BASE + 0x38)
354 #define NFP_NET_CFG_STATS_RX_BC_FRAMES	(NFP_NET_CFG_STATS_BASE + 0x40)
355 
356 #define NFP_NET_CFG_STATS_TX_DISCARDS	(NFP_NET_CFG_STATS_BASE + 0x48)
357 #define NFP_NET_CFG_STATS_TX_ERRORS	(NFP_NET_CFG_STATS_BASE + 0x50)
358 #define NFP_NET_CFG_STATS_TX_OCTETS	(NFP_NET_CFG_STATS_BASE + 0x58)
359 #define NFP_NET_CFG_STATS_TX_UC_OCTETS	(NFP_NET_CFG_STATS_BASE + 0x60)
360 #define NFP_NET_CFG_STATS_TX_MC_OCTETS	(NFP_NET_CFG_STATS_BASE + 0x68)
361 #define NFP_NET_CFG_STATS_TX_BC_OCTETS	(NFP_NET_CFG_STATS_BASE + 0x70)
362 #define NFP_NET_CFG_STATS_TX_FRAMES	(NFP_NET_CFG_STATS_BASE + 0x78)
363 #define NFP_NET_CFG_STATS_TX_MC_FRAMES	(NFP_NET_CFG_STATS_BASE + 0x80)
364 #define NFP_NET_CFG_STATS_TX_BC_FRAMES	(NFP_NET_CFG_STATS_BASE + 0x88)
365 
366 #define NFP_NET_CFG_STATS_APP0_FRAMES	(NFP_NET_CFG_STATS_BASE + 0x90)
367 #define NFP_NET_CFG_STATS_APP0_BYTES	(NFP_NET_CFG_STATS_BASE + 0x98)
368 #define NFP_NET_CFG_STATS_APP1_FRAMES	(NFP_NET_CFG_STATS_BASE + 0xa0)
369 #define NFP_NET_CFG_STATS_APP1_BYTES	(NFP_NET_CFG_STATS_BASE + 0xa8)
370 #define NFP_NET_CFG_STATS_APP2_FRAMES	(NFP_NET_CFG_STATS_BASE + 0xb0)
371 #define NFP_NET_CFG_STATS_APP2_BYTES	(NFP_NET_CFG_STATS_BASE + 0xb8)
372 #define NFP_NET_CFG_STATS_APP3_FRAMES	(NFP_NET_CFG_STATS_BASE + 0xc0)
373 #define NFP_NET_CFG_STATS_APP3_BYTES	(NFP_NET_CFG_STATS_BASE + 0xc8)
374 
375 /* Per ring stats (0x1000 - 0x1800)
376  * options, 64bit per entry
377  * %NFP_NET_CFG_TXR_STATS:   TX ring statistics (Packet and Byte count)
378  * %NFP_NET_CFG_RXR_STATS:   RX ring statistics (Packet and Byte count)
379  */
380 #define NFP_NET_CFG_TXR_STATS_BASE	0x1000
381 #define NFP_NET_CFG_TXR_STATS(_x)	(NFP_NET_CFG_TXR_STATS_BASE + \
382 					 ((_x) * 0x10))
383 #define NFP_NET_CFG_RXR_STATS_BASE	0x1400
384 #define NFP_NET_CFG_RXR_STATS(_x)	(NFP_NET_CFG_RXR_STATS_BASE + \
385 					 ((_x) * 0x10))
386 
387 /* General use mailbox area (0x1800 - 0x19ff)
388  * 4B used for update command and 4B return code
389  * followed by a max of 504B of variable length value
390  */
391 #define NFP_NET_CFG_MBOX_BASE		0x1800
392 #define NFP_NET_CFG_MBOX_VAL_MAX_SZ	0x1F8
393 
394 #define NFP_NET_CFG_MBOX_SIMPLE_CMD	0x0
395 #define NFP_NET_CFG_MBOX_SIMPLE_RET	0x4
396 #define NFP_NET_CFG_MBOX_SIMPLE_VAL	0x8
397 
398 #define NFP_NET_CFG_MBOX_CMD_CTAG_FILTER_ADD 1
399 #define NFP_NET_CFG_MBOX_CMD_CTAG_FILTER_KILL 2
400 
401 #define NFP_NET_CFG_MBOX_CMD_PCI_DSCP_PRIOMAP_SET	5
402 #define NFP_NET_CFG_MBOX_CMD_TLV_CMSG			6
403 
404 /* VLAN filtering using general use mailbox
405  * %NFP_NET_CFG_VLAN_FILTER:		Base address of VLAN filter mailbox
406  * %NFP_NET_CFG_VLAN_FILTER_VID:	VLAN ID to filter
407  * %NFP_NET_CFG_VLAN_FILTER_PROTO:	VLAN proto to filter
408  * %NFP_NET_CFG_VXLAN_SZ:		Size of the VLAN filter mailbox in bytes
409  */
410 #define NFP_NET_CFG_VLAN_FILTER		NFP_NET_CFG_MBOX_SIMPLE_VAL
411 #define  NFP_NET_CFG_VLAN_FILTER_VID	NFP_NET_CFG_VLAN_FILTER
412 #define  NFP_NET_CFG_VLAN_FILTER_PROTO	 (NFP_NET_CFG_VLAN_FILTER + 2)
413 #define NFP_NET_CFG_VLAN_FILTER_SZ	 0x0004
414 
415 /* TLV capabilities
416  * %NFP_NET_CFG_TLV_TYPE:	Offset of type within the TLV
417  * %NFP_NET_CFG_TLV_TYPE_REQUIRED: Driver must be able to parse the TLV
418  * %NFP_NET_CFG_TLV_LENGTH:	Offset of length within the TLV
419  * %NFP_NET_CFG_TLV_LENGTH_INC: TLV length increments
420  * %NFP_NET_CFG_TLV_VALUE:	Offset of value with the TLV
421  *
422  * List of simple TLV structures, first one starts at %NFP_NET_CFG_TLV_BASE.
423  * Last structure must be of type %NFP_NET_CFG_TLV_TYPE_END.  Presence of TLVs
424  * is indicated by %NFP_NET_CFG_TLV_BASE being non-zero.  TLV structures may
425  * fill the entire remainder of the BAR or be shorter.  FW must make sure TLVs
426  * don't conflict with other features which allocate space beyond
427  * %NFP_NET_CFG_TLV_BASE.  %NFP_NET_CFG_TLV_TYPE_RESERVED should be used to wrap
428  * space used by such features.
429  * Note that the 4 byte TLV header is not counted in %NFP_NET_CFG_TLV_LENGTH.
430  */
431 #define NFP_NET_CFG_TLV_TYPE		0x00
432 #define   NFP_NET_CFG_TLV_TYPE_REQUIRED   0x8000
433 #define NFP_NET_CFG_TLV_LENGTH		0x02
434 #define   NFP_NET_CFG_TLV_LENGTH_INC	  4
435 #define NFP_NET_CFG_TLV_VALUE		0x04
436 
437 #define NFP_NET_CFG_TLV_HEADER_REQUIRED 0x80000000
438 #define NFP_NET_CFG_TLV_HEADER_TYPE	0x7fff0000
439 #define NFP_NET_CFG_TLV_HEADER_LENGTH	0x0000ffff
440 
441 /* Capability TLV types
442  *
443  * %NFP_NET_CFG_TLV_TYPE_UNKNOWN:
444  * Special TLV type to catch bugs, should never be encountered.  Drivers should
445  * treat encountering this type as error and refuse to probe.
446  *
447  * %NFP_NET_CFG_TLV_TYPE_RESERVED:
448  * Reserved space, may contain legacy fixed-offset fields, or be used for
449  * padding.  The use of this type should be otherwise avoided.
450  *
451  * %NFP_NET_CFG_TLV_TYPE_END:
452  * Empty, end of TLV list.  Must be the last TLV.  Drivers will stop processing
453  * further TLVs when encountered.
454  *
455  * %NFP_NET_CFG_TLV_TYPE_ME_FREQ:
456  * Single word, ME frequency in MHz as used in calculation for
457  * %NFP_NET_CFG_RXR_IRQ_MOD and %NFP_NET_CFG_TXR_IRQ_MOD.
458  *
459  * %NFP_NET_CFG_TLV_TYPE_MBOX:
460  * Variable, mailbox area.  Overwrites the default location which is
461  * %NFP_NET_CFG_MBOX_BASE and length %NFP_NET_CFG_MBOX_VAL_MAX_SZ.
462  *
463  * %NFP_NET_CFG_TLV_TYPE_EXPERIMENTAL0:
464  * %NFP_NET_CFG_TLV_TYPE_EXPERIMENTAL1:
465  * Variable, experimental IDs.  IDs designated for internal development and
466  * experiments before a stable TLV ID has been allocated to a feature.  Should
467  * never be present in production firmware.
468  *
469  * %NFP_NET_CFG_TLV_TYPE_REPR_CAP:
470  * Single word, equivalent of %NFP_NET_CFG_CAP for representors, features which
471  * can be used on representors.
472  *
473  * %NFP_NET_CFG_TLV_TYPE_MBOX_CMSG_TYPES:
474  * Variable, bitmap of control message types supported by the mailbox handler.
475  * Bit 0 corresponds to message type 0, bit 1 to 1, etc.  Control messages are
476  * encapsulated into simple TLVs, with an end TLV and written to the Mailbox.
477  *
478  * %NFP_NET_CFG_TLV_TYPE_CRYPTO_OPS:
479  * 8 words, bitmaps of supported and enabled crypto operations.
480  * First 16B (4 words) contains a bitmap of supported crypto operations,
481  * and next 16B contain the enabled operations.
482  * This capability is made obsolete by ones with better sync methods.
483  *
484  * %NFP_NET_CFG_TLV_TYPE_VNIC_STATS:
485  * Variable, per-vNIC statistics, data should be 8B aligned (FW should insert
486  * zero-length RESERVED TLV to pad).
487  * TLV data has two sections.  First is an array of statistics' IDs (2B each).
488  * Second 8B statistics themselves.  Statistics are 8B aligned, meaning there
489  * may be a padding between sections.
490  * Number of statistics can be determined as floor(tlv.length / (2 + 8)).
491  * This TLV overwrites %NFP_NET_CFG_STATS_* values (statistics in this TLV
492  * duplicate the old ones, so driver should be careful not to unnecessarily
493  * render both).
494  *
495  * %NFP_NET_CFG_TLV_TYPE_CRYPTO_OPS_RX_SCAN:
496  * Same as %NFP_NET_CFG_TLV_TYPE_CRYPTO_OPS, but crypto TLS does stream scan
497  * RX sync, rather than kernel-assisted sync.
498  */
499 #define NFP_NET_CFG_TLV_TYPE_UNKNOWN		0
500 #define NFP_NET_CFG_TLV_TYPE_RESERVED		1
501 #define NFP_NET_CFG_TLV_TYPE_END		2
502 #define NFP_NET_CFG_TLV_TYPE_ME_FREQ		3
503 #define NFP_NET_CFG_TLV_TYPE_MBOX		4
504 #define NFP_NET_CFG_TLV_TYPE_EXPERIMENTAL0	5
505 #define NFP_NET_CFG_TLV_TYPE_EXPERIMENTAL1	6
506 #define NFP_NET_CFG_TLV_TYPE_REPR_CAP		7
507 #define NFP_NET_CFG_TLV_TYPE_MBOX_CMSG_TYPES	10
508 #define NFP_NET_CFG_TLV_TYPE_CRYPTO_OPS		11 /* see crypto/fw.h */
509 #define NFP_NET_CFG_TLV_TYPE_VNIC_STATS		12
510 #define NFP_NET_CFG_TLV_TYPE_CRYPTO_OPS_RX_SCAN	13
511 
512 struct device;
513 
514 /* struct nfp_net_tlv_caps - parsed control BAR TLV capabilities
515  * @me_freq_mhz:	ME clock_freq (MHz)
516  * @mbox_off:		vNIC mailbox area offset
517  * @mbox_len:		vNIC mailbox area length
518  * @repr_cap:		capabilities for representors
519  * @mbox_cmsg_types:	cmsgs which can be passed through the mailbox
520  * @crypto_ops:		supported crypto operations
521  * @crypto_enable_off:	offset of crypto ops enable region
522  * @vnic_stats_off:	offset of vNIC stats area
523  * @vnic_stats_cnt:	number of vNIC stats
524  * @tls_resync_ss:	TLS resync will be performed via stream scan
525  */
526 struct nfp_net_tlv_caps {
527 	u32 me_freq_mhz;
528 	unsigned int mbox_off;
529 	unsigned int mbox_len;
530 	u32 repr_cap;
531 	u32 mbox_cmsg_types;
532 	u32 crypto_ops;
533 	unsigned int crypto_enable_off;
534 	unsigned int vnic_stats_off;
535 	unsigned int vnic_stats_cnt;
536 	unsigned int tls_resync_ss:1;
537 };
538 
539 int nfp_net_tlv_caps_parse(struct device *dev, u8 __iomem *ctrl_mem,
540 			   struct nfp_net_tlv_caps *caps);
541 #endif /* _NFP_NET_CTRL_H_ */
542