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