net/ixgbe/base: remove X550em SFP iXFI setup
[dpdk.git] / drivers / net / nfp / nfp_net_pmd.h
1 /*
2  * Copyright (c) 2014, 2015 Netronome Systems, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *  this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *  notice, this list of conditions and the following disclaimer in the
13  *  documentation and/or other materials provided with the distribution
14  *
15  * 3. Neither the name of the copyright holder nor the names of its
16  *  contributors may be used to endorse or promote products derived from this
17  *  software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 /*
33  * vim:shiftwidth=8:noexpandtab
34  *
35  * @file dpdk/pmd/nfp_net_pmd.h
36  *
37  * Netronome NFP_NET PDM driver
38  */
39
40 #ifndef _NFP_NET_PMD_H_
41 #define _NFP_NET_PMD_H_
42
43 #define NFP_NET_PMD_VERSION "0.1"
44 #define PCI_VENDOR_ID_NETRONOME         0x19ee
45 #define PCI_DEVICE_ID_NFP6000_PF_NIC    0x6000
46 #define PCI_DEVICE_ID_NFP6000_VF_NIC    0x6003
47
48 /* Forward declaration */
49 struct nfp_net_adapter;
50
51 /*
52  * The maximum number of descriptors is limited by design as
53  * DPDK uses uint16_t variables for these values
54  */
55 #define NFP_NET_MAX_TX_DESC (32 * 1024)
56 #define NFP_NET_MIN_TX_DESC 64
57
58 #define NFP_NET_MAX_RX_DESC (32 * 1024)
59 #define NFP_NET_MIN_RX_DESC 64
60
61 /* Bar allocation */
62 #define NFP_NET_CRTL_BAR        0
63 #define NFP_NET_TX_BAR          2
64 #define NFP_NET_RX_BAR          2
65
66 /* Macros for accessing the Queue Controller Peripheral 'CSRs' */
67 #define NFP_QCP_QUEUE_OFF(_x)                 ((_x) * 0x800)
68 #define NFP_QCP_QUEUE_ADD_RPTR                  0x0000
69 #define NFP_QCP_QUEUE_ADD_WPTR                  0x0004
70 #define NFP_QCP_QUEUE_STS_LO                    0x0008
71 #define NFP_QCP_QUEUE_STS_LO_READPTR_mask     (0x3ffff)
72 #define NFP_QCP_QUEUE_STS_HI                    0x000c
73 #define NFP_QCP_QUEUE_STS_HI_WRITEPTR_mask    (0x3ffff)
74
75 /* Interrupt definitions */
76 #define NFP_NET_IRQ_LSC_IDX             0
77
78 /* Default values for RX/TX configuration */
79 #define DEFAULT_RX_FREE_THRESH  32
80 #define DEFAULT_RX_PTHRESH      8
81 #define DEFAULT_RX_HTHRESH      8
82 #define DEFAULT_RX_WTHRESH      0
83
84 #define DEFAULT_TX_RS_THRESH    32
85 #define DEFAULT_TX_FREE_THRESH  32
86 #define DEFAULT_TX_PTHRESH      32
87 #define DEFAULT_TX_HTHRESH      0
88 #define DEFAULT_TX_WTHRESH      0
89 #define DEFAULT_TX_RSBIT_THRESH 32
90
91 /* Alignment for dma zones */
92 #define NFP_MEMZONE_ALIGN       128
93
94 /*
95  * This is used by the reconfig protocol. It sets the maximum time waiting in
96  * milliseconds before a reconfig timeout happens.
97  */
98 #define NFP_NET_POLL_TIMEOUT    5000
99
100 #define NFP_QCP_QUEUE_ADDR_SZ   (0x800)
101
102 #define NFP_NET_LINK_DOWN_CHECK_TIMEOUT 4000 /* ms */
103 #define NFP_NET_LINK_UP_CHECK_TIMEOUT   1000 /* ms */
104
105 /* Version number helper defines */
106 #define NFD_CFG_CLASS_VER_msk       0xff
107 #define NFD_CFG_CLASS_VER_shf       24
108 #define NFD_CFG_CLASS_VER(x)        (((x) & 0xff) << 24)
109 #define NFD_CFG_CLASS_VER_of(x)     (((x) >> 24) & 0xff)
110 #define NFD_CFG_CLASS_TYPE_msk      0xff
111 #define NFD_CFG_CLASS_TYPE_shf      16
112 #define NFD_CFG_CLASS_TYPE(x)       (((x) & 0xff) << 16)
113 #define NFD_CFG_CLASS_TYPE_of(x)    (((x) >> 16) & 0xff)
114 #define NFD_CFG_MAJOR_VERSION_msk   0xff
115 #define NFD_CFG_MAJOR_VERSION_shf   8
116 #define NFD_CFG_MAJOR_VERSION(x)    (((x) & 0xff) << 8)
117 #define NFD_CFG_MAJOR_VERSION_of(x) (((x) >> 8) & 0xff)
118 #define NFD_CFG_MINOR_VERSION_msk   0xff
119 #define NFD_CFG_MINOR_VERSION_shf   0
120 #define NFD_CFG_MINOR_VERSION(x)    (((x) & 0xff) << 0)
121 #define NFD_CFG_MINOR_VERSION_of(x) (((x) >> 0) & 0xff)
122
123 #include <linux/types.h>
124 #include <rte_io.h>
125
126 static inline uint8_t nn_readb(volatile const void *addr)
127 {
128         return rte_read8(addr);
129 }
130
131 static inline void nn_writeb(uint8_t val, volatile void *addr)
132 {
133         rte_write8(val, addr);
134 }
135
136 static inline uint32_t nn_readl(volatile const void *addr)
137 {
138         return rte_read32(addr);
139 }
140
141 static inline void nn_writel(uint32_t val, volatile void *addr)
142 {
143         rte_write32(val, addr);
144 }
145
146 static inline uint64_t nn_readq(volatile void *addr)
147 {
148         const volatile uint32_t *p = addr;
149         uint32_t low, high;
150
151         high = nn_readl((volatile const void *)(p + 1));
152         low = nn_readl((volatile const void *)p);
153
154         return low + ((uint64_t)high << 32);
155 }
156
157 static inline void nn_writeq(uint64_t val, volatile void *addr)
158 {
159         nn_writel(val >> 32, (volatile char *)addr + 4);
160         nn_writel(val, addr);
161 }
162
163 /* TX descriptor format */
164 #define PCIE_DESC_TX_EOP                (1 << 7)
165 #define PCIE_DESC_TX_OFFSET_MASK        (0x7f)
166
167 /* Flags in the host TX descriptor */
168 #define PCIE_DESC_TX_CSUM               (1 << 7)
169 #define PCIE_DESC_TX_IP4_CSUM           (1 << 6)
170 #define PCIE_DESC_TX_TCP_CSUM           (1 << 5)
171 #define PCIE_DESC_TX_UDP_CSUM           (1 << 4)
172 #define PCIE_DESC_TX_VLAN               (1 << 3)
173 #define PCIE_DESC_TX_LSO                (1 << 2)
174 #define PCIE_DESC_TX_ENCAP_NONE         (0)
175 #define PCIE_DESC_TX_ENCAP_VXLAN        (1 << 1)
176 #define PCIE_DESC_TX_ENCAP_GRE          (1 << 0)
177
178 struct nfp_net_tx_desc {
179         union {
180                 struct {
181                         uint8_t dma_addr_hi;   /* High bits of host buf address */
182                         __le16 dma_len;     /* Length to DMA for this desc */
183                         uint8_t offset_eop;    /* Offset in buf where pkt starts +
184                                              * highest bit is eop flag.
185                                              */
186                         __le32 dma_addr_lo; /* Low 32bit of host buf addr */
187
188                         __le16 lso;         /* MSS to be used for LSO */
189                         uint8_t l4_offset;     /* LSO, where the L4 data starts */
190                         uint8_t flags;         /* TX Flags, see @PCIE_DESC_TX_* */
191
192                         __le16 vlan;        /* VLAN tag to add if indicated */
193                         __le16 data_len;    /* Length of frame + meta data */
194                 } __attribute__((__packed__));
195                 __le32 vals[4];
196         };
197 };
198
199 struct nfp_net_txq {
200         struct nfp_net_hw *hw; /* Backpointer to nfp_net structure */
201
202         /*
203          * Queue information: @qidx is the queue index from Linux's
204          * perspective.  @tx_qcidx is the index of the Queue
205          * Controller Peripheral queue relative to the TX queue BAR.
206          * @cnt is the size of the queue in number of
207          * descriptors. @qcp_q is a pointer to the base of the queue
208          * structure on the NFP
209          */
210         uint8_t *qcp_q;
211
212         /*
213          * Read and Write pointers.  @wr_p and @rd_p are host side pointer,
214          * they are free running and have little relation to the QCP pointers *
215          * @qcp_rd_p is a local copy queue controller peripheral read pointer
216          */
217
218         uint32_t wr_p;
219         uint32_t rd_p;
220
221         uint32_t tx_count;
222
223         uint32_t tx_free_thresh;
224
225         /*
226          * For each descriptor keep a reference to the mbuff and
227          * DMA address used until completion is signalled.
228          */
229         struct {
230                 struct rte_mbuf *mbuf;
231         } *txbufs;
232
233         /*
234          * Information about the host side queue location. @txds is
235          * the virtual address for the queue, @dma is the DMA address
236          * of the queue and @size is the size in bytes for the queue
237          * (needed for free)
238          */
239         struct nfp_net_tx_desc *txds;
240
241         /*
242          * At this point 48 bytes have been used for all the fields in the
243          * TX critical path. We have room for 8 bytes and still all placed
244          * in a cache line. We are not using the threshold values below nor
245          * the txq_flags but if we need to, we can add the most used in the
246          * remaining bytes.
247          */
248         uint32_t tx_rs_thresh; /* not used by now. Future? */
249         uint32_t tx_pthresh;   /* not used by now. Future? */
250         uint32_t tx_hthresh;   /* not used by now. Future? */
251         uint32_t tx_wthresh;   /* not used by now. Future? */
252         uint32_t txq_flags;    /* not used by now. Future? */
253         uint8_t  port_id;
254         int qidx;
255         int tx_qcidx;
256         __le64 dma;
257 } __attribute__ ((__aligned__(64)));
258
259 /* RX and freelist descriptor format */
260 #define PCIE_DESC_RX_DD                 (1 << 7)
261 #define PCIE_DESC_RX_META_LEN_MASK      (0x7f)
262
263 /* Flags in the RX descriptor */
264 #define PCIE_DESC_RX_RSS                (1 << 15)
265 #define PCIE_DESC_RX_I_IP4_CSUM         (1 << 14)
266 #define PCIE_DESC_RX_I_IP4_CSUM_OK      (1 << 13)
267 #define PCIE_DESC_RX_I_TCP_CSUM         (1 << 12)
268 #define PCIE_DESC_RX_I_TCP_CSUM_OK      (1 << 11)
269 #define PCIE_DESC_RX_I_UDP_CSUM         (1 << 10)
270 #define PCIE_DESC_RX_I_UDP_CSUM_OK      (1 <<  9)
271 #define PCIE_DESC_RX_SPARE              (1 <<  8)
272 #define PCIE_DESC_RX_EOP                (1 <<  7)
273 #define PCIE_DESC_RX_IP4_CSUM           (1 <<  6)
274 #define PCIE_DESC_RX_IP4_CSUM_OK        (1 <<  5)
275 #define PCIE_DESC_RX_TCP_CSUM           (1 <<  4)
276 #define PCIE_DESC_RX_TCP_CSUM_OK        (1 <<  3)
277 #define PCIE_DESC_RX_UDP_CSUM           (1 <<  2)
278 #define PCIE_DESC_RX_UDP_CSUM_OK        (1 <<  1)
279 #define PCIE_DESC_RX_VLAN               (1 <<  0)
280
281 struct nfp_net_rx_desc {
282         union {
283                 /* Freelist descriptor */
284                 struct {
285                         uint8_t dma_addr_hi;
286                         __le16 spare;
287                         uint8_t dd;
288
289                         __le32 dma_addr_lo;
290                 } __attribute__((__packed__)) fld;
291
292                 /* RX descriptor */
293                 struct {
294                         __le16 data_len;
295                         uint8_t reserved;
296                         uint8_t meta_len_dd;
297
298                         __le16 flags;
299                         __le16 vlan;
300                 } __attribute__((__packed__)) rxd;
301
302                 __le32 vals[2];
303         };
304 };
305
306 struct nfp_net_rx_buff {
307         struct rte_mbuf *mbuf;
308 };
309
310 struct nfp_net_rxq {
311         struct nfp_net_hw *hw;  /* Backpointer to nfp_net structure */
312
313          /*
314           * @qcp_fl and @qcp_rx are pointers to the base addresses of the
315           * freelist and RX queue controller peripheral queue structures on the
316           * NFP
317           */
318         uint8_t *qcp_fl;
319         uint8_t *qcp_rx;
320
321         /*
322          * Read and Write pointers.  @wr_p and @rd_p are host side
323          * pointer, they are free running and have little relation to
324          * the QCP pointers. @wr_p is where the driver adds new
325          * freelist descriptors and @rd_p is where the driver start
326          * reading descriptors for newly arrive packets from.
327          */
328         uint32_t rd_p;
329
330         /*
331          * For each buffer placed on the freelist, record the
332          * associated SKB
333          */
334         struct nfp_net_rx_buff *rxbufs;
335
336         /*
337          * Information about the host side queue location.  @rxds is
338          * the virtual address for the queue
339          */
340         struct nfp_net_rx_desc *rxds;
341
342         /*
343          * The mempool is created by the user specifying a mbuf size.
344          * We save here the reference of the mempool needed in the RX
345          * path and the mbuf size for checking received packets can be
346          * safely copied to the mbuf using the NFP_NET_RX_OFFSET
347          */
348         struct rte_mempool *mem_pool;
349         uint16_t mbuf_size;
350
351         /*
352          * Next two fields are used for giving more free descriptors
353          * to the NFP
354          */
355         uint16_t rx_free_thresh;
356         uint16_t nb_rx_hold;
357
358          /* the size of the queue in number of descriptors */
359         uint16_t rx_count;
360
361         /*
362          * Fields above this point fit in a single cache line and are all used
363          * in the RX critical path. Fields below this point are just used
364          * during queue configuration or not used at all (yet)
365          */
366
367         /* referencing dev->data->port_id */
368         uint16_t port_id;
369
370         uint8_t  crc_len; /* Not used by now */
371         uint8_t  drop_en; /* Not used by now */
372
373         /* DMA address of the queue */
374         __le64 dma;
375
376         /*
377          * Queue information: @qidx is the queue index from Linux's
378          * perspective.  @fl_qcidx is the index of the Queue
379          * Controller peripheral queue relative to the RX queue BAR
380          * used for the freelist and @rx_qcidx is the Queue Controller
381          * Peripheral index for the RX queue.
382          */
383         int qidx;
384         int fl_qcidx;
385         int rx_qcidx;
386 } __attribute__ ((__aligned__(64)));
387
388 struct nfp_net_hw {
389         /* Info from the firmware */
390         uint32_t ver;
391         uint32_t cap;
392         uint32_t max_mtu;
393         uint32_t mtu;
394         uint32_t rx_offset;
395
396         /* Current values for control */
397         uint32_t ctrl;
398
399         uint8_t *ctrl_bar;
400         uint8_t *tx_bar;
401         uint8_t *rx_bar;
402
403         int stride_rx;
404         int stride_tx;
405
406         uint8_t *qcp_cfg;
407         rte_spinlock_t reconfig_lock;
408
409         uint32_t max_tx_queues;
410         uint32_t max_rx_queues;
411         uint16_t flbufsz;
412         uint16_t device_id;
413         uint16_t vendor_id;
414         uint16_t subsystem_device_id;
415         uint16_t subsystem_vendor_id;
416 #if defined(DSTQ_SELECTION)
417 #if DSTQ_SELECTION
418         uint16_t device_function;
419 #endif
420 #endif
421
422         uint8_t mac_addr[ETHER_ADDR_LEN];
423
424         /* Records starting point for counters */
425         struct rte_eth_stats eth_stats_base;
426
427 #ifdef NFP_NET_LIBNFP
428         struct nfp_cpp *cpp;
429         struct nfp_cpp_area *ctrl_area;
430         struct nfp_cpp_area *tx_area;
431         struct nfp_cpp_area *rx_area;
432         struct nfp_cpp_area *msix_area;
433 #endif
434 };
435
436 struct nfp_net_adapter {
437         struct nfp_net_hw hw;
438 };
439
440 #define NFP_NET_DEV_PRIVATE_TO_HW(adapter)\
441         (&((struct nfp_net_adapter *)adapter)->hw)
442
443 #endif /* _NFP_NET_PMD_H_ */
444 /*
445  * Local variables:
446  * c-file-style: "Linux"
447  * indent-tabs-mode: t
448  * End:
449  */