net/netvsc: allow setting Rx and Tx copy break
[dpdk.git] / drivers / net / netvsc / hn_var.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright (c) 2009-2018 Microsoft Corp.
3  * Copyright (c) 2016 Brocade Communications Systems, Inc.
4  * Copyright (c) 2012 NetApp Inc.
5  * Copyright (c) 2012 Citrix Inc.
6  * All rights reserved.
7  */
8
9 /*
10  * Tunable ethdev params
11  */
12 #define HN_MIN_RX_BUF_SIZE      1024
13 #define HN_MAX_XFER_LEN         2048
14 #define HN_MAX_MAC_ADDRS        1
15 #define HN_MAX_CHANNELS         64
16
17 /* Claimed to be 12232B */
18 #define HN_MTU_MAX              (9 * 1024)
19
20 /* Retry interval */
21 #define HN_CHAN_INTERVAL_US     100
22
23 /* Host monitor interval */
24 #define HN_CHAN_LATENCY_NS      50000
25
26 #define HN_TXCOPY_THRESHOLD     512
27 #define HN_RXCOPY_THRESHOLD     256
28
29 /* Buffers need to be aligned */
30 #ifndef PAGE_SIZE
31 #define PAGE_SIZE 4096
32 #endif
33
34 #ifndef PAGE_MASK
35 #define PAGE_MASK (PAGE_SIZE - 1)
36 #endif
37
38 struct hn_data;
39 struct hn_txdesc;
40
41 struct hn_stats {
42         uint64_t        packets;
43         uint64_t        bytes;
44         uint64_t        errors;
45         uint64_t        ring_full;
46         uint64_t        channel_full;
47         uint64_t        multicast;
48         uint64_t        broadcast;
49         /* Size bins in array as RFC 2819, undersized [0], 64 [1], etc */
50         uint64_t        size_bins[8];
51 };
52
53 struct hn_tx_queue {
54         struct hn_data  *hv;
55         struct vmbus_channel *chan;
56         uint16_t        port_id;
57         uint16_t        queue_id;
58         uint32_t        free_thresh;
59         struct rte_mempool *txdesc_pool;
60         const struct rte_memzone *tx_rndis_mz;
61         void            *tx_rndis;
62         rte_iova_t      tx_rndis_iova;
63
64         /* Applied packet transmission aggregation limits. */
65         uint32_t        agg_szmax;
66         uint32_t        agg_pktmax;
67         uint32_t        agg_align;
68
69         /* Packet transmission aggregation states */
70         struct hn_txdesc *agg_txd;
71         uint32_t        agg_pktleft;
72         uint32_t        agg_szleft;
73         struct rndis_packet_msg *agg_prevpkt;
74
75         struct hn_stats stats;
76 };
77
78 struct hn_rx_queue {
79         struct hn_data  *hv;
80         struct vmbus_channel *chan;
81         struct rte_mempool *mb_pool;
82         struct rte_ring *rx_ring;
83
84         rte_spinlock_t ring_lock;
85         uint32_t event_sz;
86         uint16_t port_id;
87         uint16_t queue_id;
88         struct hn_stats stats;
89
90         void *event_buf;
91         struct hn_rx_bufinfo *rxbuf_info;
92         rte_atomic32_t  rxbuf_outstanding;
93 };
94
95
96 /* multi-packet data from host */
97 struct hn_rx_bufinfo {
98         struct vmbus_channel *chan;
99         struct hn_rx_queue *rxq;
100         uint64_t        xactid;
101         struct rte_mbuf_ext_shared_info shinfo;
102 } __rte_cache_aligned;
103
104 #define HN_INVALID_PORT UINT16_MAX
105
106 struct hn_data {
107         struct rte_vmbus_device *vmbus;
108         struct hn_rx_queue *primary;
109         rte_rwlock_t    vf_lock;
110         uint16_t        port_id;
111         uint16_t        vf_port;
112
113         uint8_t         vf_present;
114         uint8_t         closed;
115         uint8_t         vlan_strip;
116
117         uint32_t        link_status;
118         uint32_t        link_speed;
119
120         struct rte_mem_resource *rxbuf_res;     /* UIO resource for Rx */
121         uint32_t        rxbuf_section_cnt;      /* # of Rx sections */
122         uint32_t        rx_copybreak;
123         uint16_t        max_queues;             /* Max available queues */
124         uint16_t        num_queues;
125         uint64_t        rss_offloads;
126
127         rte_spinlock_t  chim_lock;
128         struct rte_mem_resource *chim_res;      /* UIO resource for Tx */
129         struct rte_bitmap *chim_bmap;           /* Send buffer map */
130         void            *chim_bmem;
131         uint32_t        tx_copybreak;
132         uint32_t        chim_szmax;             /* Max size per buffer */
133         uint32_t        chim_cnt;               /* Max packets per buffer */
134
135         uint32_t        latency;
136         uint32_t        nvs_ver;
137         uint32_t        ndis_ver;
138         uint32_t        rndis_agg_size;
139         uint32_t        rndis_agg_pkts;
140         uint32_t        rndis_agg_align;
141
142         volatile uint32_t  rndis_pending;
143         rte_atomic32_t  rndis_req_id;
144         uint8_t         rndis_resp[256];
145
146         uint32_t        rss_hash;
147         uint8_t         rss_key[40];
148         uint16_t        rss_ind[128];
149
150         struct rte_eth_dev_owner owner;
151
152         struct vmbus_channel *channels[HN_MAX_CHANNELS];
153 };
154
155 static inline struct vmbus_channel *
156 hn_primary_chan(const struct hn_data *hv)
157 {
158         return hv->channels[0];
159 }
160
161 uint32_t hn_process_events(struct hn_data *hv, uint16_t queue_id,
162                        uint32_t tx_limit);
163
164 uint16_t hn_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
165                       uint16_t nb_pkts);
166 uint16_t hn_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
167                       uint16_t nb_pkts);
168
169 int     hn_chim_init(struct rte_eth_dev *dev);
170 void    hn_chim_uninit(struct rte_eth_dev *dev);
171 int     hn_dev_link_update(struct rte_eth_dev *dev, int wait);
172 int     hn_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t queue_idx,
173                               uint16_t nb_desc, unsigned int socket_id,
174                               const struct rte_eth_txconf *tx_conf);
175 void    hn_dev_tx_queue_release(void *arg);
176 void    hn_dev_tx_queue_info(struct rte_eth_dev *dev, uint16_t queue_idx,
177                              struct rte_eth_txq_info *qinfo);
178 int     hn_dev_tx_done_cleanup(void *arg, uint32_t free_cnt);
179 int     hn_dev_tx_descriptor_status(void *arg, uint16_t offset);
180
181 struct hn_rx_queue *hn_rx_queue_alloc(struct hn_data *hv,
182                                       uint16_t queue_id,
183                                       unsigned int socket_id);
184 int     hn_dev_rx_queue_setup(struct rte_eth_dev *dev,
185                               uint16_t queue_idx, uint16_t nb_desc,
186                               unsigned int socket_id,
187                               const struct rte_eth_rxconf *rx_conf,
188                               struct rte_mempool *mp);
189 void    hn_dev_rx_queue_info(struct rte_eth_dev *dev, uint16_t queue_id,
190                              struct rte_eth_rxq_info *qinfo);
191 void    hn_dev_rx_queue_release(void *arg);
192 uint32_t hn_dev_rx_queue_count(struct rte_eth_dev *dev, uint16_t queue_id);
193 int     hn_dev_rx_queue_status(void *rxq, uint16_t offset);
194 void    hn_dev_free_queues(struct rte_eth_dev *dev);
195
196 /* Check if VF is attached */
197 static inline bool
198 hn_vf_attached(const struct hn_data *hv)
199 {
200         return hv->vf_port != HN_INVALID_PORT;
201 }
202
203 /*
204  * Get VF device for existing netvsc device
205  * Assumes vf_lock is held.
206  */
207 static inline struct rte_eth_dev *
208 hn_get_vf_dev(const struct hn_data *hv)
209 {
210         uint16_t vf_port = hv->vf_port;
211
212         if (vf_port == HN_INVALID_PORT)
213                 return NULL;
214         else
215                 return &rte_eth_devices[vf_port];
216 }
217
218 int     hn_vf_info_get(struct hn_data *hv,
219                        struct rte_eth_dev_info *info);
220 int     hn_vf_add(struct rte_eth_dev *dev, struct hn_data *hv);
221 int     hn_vf_configure(struct rte_eth_dev *dev,
222                         const struct rte_eth_conf *dev_conf);
223 const uint32_t *hn_vf_supported_ptypes(struct rte_eth_dev *dev);
224 int     hn_vf_start(struct rte_eth_dev *dev);
225 void    hn_vf_reset(struct rte_eth_dev *dev);
226 int     hn_vf_close(struct rte_eth_dev *dev);
227 int     hn_vf_stop(struct rte_eth_dev *dev);
228
229 int     hn_vf_allmulticast_enable(struct rte_eth_dev *dev);
230 int     hn_vf_allmulticast_disable(struct rte_eth_dev *dev);
231 int     hn_vf_promiscuous_enable(struct rte_eth_dev *dev);
232 int     hn_vf_promiscuous_disable(struct rte_eth_dev *dev);
233 int     hn_vf_mc_addr_list(struct rte_eth_dev *dev,
234                            struct rte_ether_addr *mc_addr_set,
235                            uint32_t nb_mc_addr);
236
237 int     hn_vf_tx_queue_setup(struct rte_eth_dev *dev,
238                              uint16_t queue_idx, uint16_t nb_desc,
239                              unsigned int socket_id,
240                              const struct rte_eth_txconf *tx_conf);
241 void    hn_vf_tx_queue_release(struct hn_data *hv, uint16_t queue_id);
242 int     hn_vf_tx_queue_status(struct hn_data *hv, uint16_t queue_id, uint16_t offset);
243
244 int     hn_vf_rx_queue_setup(struct rte_eth_dev *dev,
245                              uint16_t queue_idx, uint16_t nb_desc,
246                              unsigned int socket_id,
247                              const struct rte_eth_rxconf *rx_conf,
248                              struct rte_mempool *mp);
249 void    hn_vf_rx_queue_release(struct hn_data *hv, uint16_t queue_id);
250
251 int     hn_vf_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
252 int     hn_vf_stats_reset(struct rte_eth_dev *dev);
253 int     hn_vf_xstats_get_names(struct rte_eth_dev *dev,
254                                struct rte_eth_xstat_name *xstats_names,
255                                unsigned int size);
256 int     hn_vf_xstats_get(struct rte_eth_dev *dev,
257                          struct rte_eth_xstat *xstats,
258                          unsigned int offset, unsigned int n);
259 int     hn_vf_xstats_reset(struct rte_eth_dev *dev);
260 int     hn_vf_rss_hash_update(struct rte_eth_dev *dev,
261                               struct rte_eth_rss_conf *rss_conf);
262 int     hn_vf_reta_hash_update(struct rte_eth_dev *dev,
263                                struct rte_eth_rss_reta_entry64 *reta_conf,
264                                uint16_t reta_size);