net/enic: support mbuf fast free offload
[dpdk.git] / drivers / net / enic / base / vnic_wq.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2008-2017 Cisco Systems, Inc.  All rights reserved.
3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
4  */
5
6 #ifndef _VNIC_WQ_H_
7 #define _VNIC_WQ_H_
8
9
10 #include "vnic_dev.h"
11 #include "vnic_cq.h"
12 #include <rte_memzone.h>
13
14 /* Work queue control */
15 struct vnic_wq_ctrl {
16         u64 ring_base;                  /* 0x00 */
17         u32 ring_size;                  /* 0x08 */
18         u32 pad0;
19         u32 posted_index;               /* 0x10 */
20         u32 pad1;
21         u32 cq_index;                   /* 0x18 */
22         u32 pad2;
23         u32 enable;                     /* 0x20 */
24         u32 pad3;
25         u32 running;                    /* 0x28 */
26         u32 pad4;
27         u32 fetch_index;                /* 0x30 */
28         u32 pad5;
29         u32 dca_value;                  /* 0x38 */
30         u32 pad6;
31         u32 error_interrupt_enable;     /* 0x40 */
32         u32 pad7;
33         u32 error_interrupt_offset;     /* 0x48 */
34         u32 pad8;
35         u32 error_status;               /* 0x50 */
36         u32 pad9;
37 };
38
39 struct vnic_wq {
40         unsigned int index;
41         uint64_t tx_offload_notsup_mask;
42         struct vnic_dev *vdev;
43         struct vnic_wq_ctrl __iomem *ctrl;              /* memory-mapped */
44         struct vnic_dev_ring ring;
45         struct rte_mbuf **bufs;
46         unsigned int head_idx;
47         unsigned int tail_idx;
48         unsigned int socket_id;
49         const struct rte_memzone *cqmsg_rz;
50         uint16_t last_completed_index;
51         uint64_t offloads;
52 };
53
54 static inline unsigned int vnic_wq_desc_avail(struct vnic_wq *wq)
55 {
56         /* how many does SW own? */
57         return wq->ring.desc_avail;
58 }
59
60 static inline unsigned int vnic_wq_desc_used(struct vnic_wq *wq)
61 {
62         /* how many does HW own? */
63         return wq->ring.desc_count - wq->ring.desc_avail - 1;
64 }
65
66 #define PI_LOG2_CACHE_LINE_SIZE        5
67 #define PI_INDEX_BITS            12
68 #define PI_INDEX_MASK ((1U << PI_INDEX_BITS) - 1)
69 #define PI_PREFETCH_LEN_MASK ((1U << PI_LOG2_CACHE_LINE_SIZE) - 1)
70 #define PI_PREFETCH_LEN_OFF 16
71 #define PI_PREFETCH_ADDR_BITS 43
72 #define PI_PREFETCH_ADDR_MASK ((1ULL << PI_PREFETCH_ADDR_BITS) - 1)
73 #define PI_PREFETCH_ADDR_OFF 21
74
75 /** How many cache lines are touched by buffer (addr, len). */
76 static inline unsigned int num_cache_lines_touched(dma_addr_t addr,
77                                                         unsigned int len)
78 {
79         const unsigned long mask = PI_PREFETCH_LEN_MASK;
80         const unsigned long laddr = (unsigned long)addr;
81         unsigned long lines, equiv_len;
82         /* A. If addr is aligned, our solution is just to round up len to the
83         next boundary.
84
85         e.g. addr = 0, len = 48
86         +--------------------+
87         |XXXXXXXXXXXXXXXXXXXX|    32-byte cacheline a
88         +--------------------+
89         |XXXXXXXXXX          |    cacheline b
90         +--------------------+
91
92         B. If addr is not aligned, however, we may use an extra
93         cacheline.  e.g. addr = 12, len = 22
94
95         +--------------------+
96         |       XXXXXXXXXXXXX|
97         +--------------------+
98         |XX                  |
99         +--------------------+
100
101         Our solution is to make the problem equivalent to case A
102         above by adding the empty space in the first cacheline to the length:
103         unsigned long len;
104
105         +--------------------+
106         |eeeeeeeXXXXXXXXXXXXX|    "e" is empty space, which we add to len
107         +--------------------+
108         |XX                  |
109         +--------------------+
110
111         */
112         equiv_len = len + (laddr & mask);
113
114         /* Now we can just round up this len to the next 32-byte boundary. */
115         lines = (equiv_len + mask) & (~mask);
116
117         /* Scale bytes -> cachelines. */
118         return lines >> PI_LOG2_CACHE_LINE_SIZE;
119 }
120
121 static inline u64 vnic_cached_posted_index(dma_addr_t addr, unsigned int len,
122                                                 unsigned int index)
123 {
124         unsigned int num_cache_lines = num_cache_lines_touched(addr, len);
125         /* Wish we could avoid a branch here.  We could have separate
126          * vnic_wq_post() and vinc_wq_post_inline(), the latter
127          * only supporting < 1k (2^5 * 2^5) sends, I suppose.  This would
128          * eliminate the if (eop) branch as well.
129          */
130         if (num_cache_lines > PI_PREFETCH_LEN_MASK)
131                 num_cache_lines = 0;
132         return (index & PI_INDEX_MASK) |
133         ((num_cache_lines & PI_PREFETCH_LEN_MASK) << PI_PREFETCH_LEN_OFF) |
134                 (((addr >> PI_LOG2_CACHE_LINE_SIZE) &
135         PI_PREFETCH_ADDR_MASK) << PI_PREFETCH_ADDR_OFF);
136 }
137
138 static inline uint32_t
139 buf_idx_incr(uint32_t n_descriptors, uint32_t idx)
140 {
141         idx++;
142         if (unlikely(idx == n_descriptors))
143                 idx = 0;
144         return idx;
145 }
146
147 void vnic_wq_free(struct vnic_wq *wq);
148 int vnic_wq_alloc(struct vnic_dev *vdev, struct vnic_wq *wq, unsigned int index,
149         unsigned int desc_count, unsigned int desc_size);
150 void vnic_wq_init_start(struct vnic_wq *wq, unsigned int cq_index,
151         unsigned int fetch_index, unsigned int posted_index,
152         unsigned int error_interrupt_enable,
153         unsigned int error_interrupt_offset);
154 void vnic_wq_init(struct vnic_wq *wq, unsigned int cq_index,
155         unsigned int error_interrupt_enable,
156         unsigned int error_interrupt_offset);
157 void vnic_wq_error_out(struct vnic_wq *wq, unsigned int error);
158 unsigned int vnic_wq_error_status(struct vnic_wq *wq);
159 void vnic_wq_enable(struct vnic_wq *wq);
160 int vnic_wq_disable(struct vnic_wq *wq);
161 void vnic_wq_clean(struct vnic_wq *wq,
162                    void (*buf_clean)(struct rte_mbuf **buf));
163 #endif /* _VNIC_WQ_H_ */