7f3266c451fb370c183c056073ff4e2b7417e696
[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
56         /* Applied packet transmission aggregation limits. */
57         uint32_t        agg_szmax;
58         uint32_t        agg_pktmax;
59         uint32_t        agg_align;
60
61         /* Packet transmission aggregation states */
62         struct hn_txdesc *agg_txd;
63         uint32_t        agg_pktleft;
64         uint32_t        agg_szleft;
65         struct rndis_packet_msg *agg_prevpkt;
66
67         struct hn_stats stats;
68 };
69
70 struct hn_rx_queue {
71         struct hn_data  *hv;
72         struct vmbus_channel *chan;
73         struct rte_mempool *mb_pool;
74         struct rte_ring *rx_ring;
75
76         rte_spinlock_t ring_lock;
77         uint32_t event_sz;
78         uint16_t port_id;
79         uint16_t queue_id;
80         struct hn_stats stats;
81
82         void *event_buf;
83 };
84
85
86 /* multi-packet data from host */
87 struct hn_rx_bufinfo {
88         struct vmbus_channel *chan;
89         struct hn_data *hv;
90         uint64_t        xactid;
91         struct rte_mbuf_ext_shared_info shinfo;
92 } __rte_cache_aligned;
93
94 struct hn_data {
95         struct rte_vmbus_device *vmbus;
96         struct hn_rx_queue *primary;
97         struct rte_eth_dev *vf_dev;             /* Subordinate device */
98         rte_spinlock_t  vf_lock;
99         uint16_t        port_id;
100         uint8_t         closed;
101         uint8_t         vf_present;
102         uint8_t         vlan_strip;
103         uint32_t        link_status;
104         uint32_t        link_speed;
105
106         struct rte_mem_resource *rxbuf_res;     /* UIO resource for Rx */
107         struct hn_rx_bufinfo *rxbuf_info;
108         uint32_t        rxbuf_section_cnt;      /* # of Rx sections */
109         volatile uint32_t rxbuf_outstanding;
110         uint16_t        max_queues;             /* Max available queues */
111         uint16_t        num_queues;
112         uint64_t        rss_offloads;
113
114         struct rte_mem_resource *chim_res;      /* UIO resource for Tx */
115         struct rte_mempool *tx_pool;            /* Tx descriptors */
116         uint32_t        chim_szmax;             /* Max size per buffer */
117         uint32_t        chim_cnt;               /* Max packets per buffer */
118
119         uint32_t        latency;
120         uint32_t        nvs_ver;
121         uint32_t        ndis_ver;
122         uint32_t        rndis_agg_size;
123         uint32_t        rndis_agg_pkts;
124         uint32_t        rndis_agg_align;
125
126         volatile uint32_t  rndis_pending;
127         rte_atomic32_t  rndis_req_id;
128         uint8_t         rndis_resp[256];
129
130         struct ether_addr mac_addr;
131
132         struct rte_eth_dev_owner owner;
133         struct rte_intr_handle vf_intr;
134
135         struct vmbus_channel *channels[HN_MAX_CHANNELS];
136 };
137
138 static inline struct vmbus_channel *
139 hn_primary_chan(const struct hn_data *hv)
140 {
141         return hv->channels[0];
142 }
143
144 uint32_t hn_process_events(struct hn_data *hv, uint16_t queue_id,
145                        uint32_t tx_limit);
146
147 uint16_t hn_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
148                       uint16_t nb_pkts);
149 uint16_t hn_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
150                       uint16_t nb_pkts);
151
152 int     hn_tx_pool_init(struct rte_eth_dev *dev);
153 void    hn_tx_pool_uninit(struct rte_eth_dev *dev);
154 int     hn_dev_link_update(struct rte_eth_dev *dev, int wait);
155 int     hn_dev_tx_queue_setup(struct rte_eth_dev *dev, uint16_t queue_idx,
156                               uint16_t nb_desc, unsigned int socket_id,
157                               const struct rte_eth_txconf *tx_conf);
158 void    hn_dev_tx_queue_release(void *arg);
159 void    hn_dev_tx_queue_info(struct rte_eth_dev *dev, uint16_t queue_idx,
160                              struct rte_eth_txq_info *qinfo);
161 int     hn_dev_tx_done_cleanup(void *arg, uint32_t free_cnt);
162
163 struct hn_rx_queue *hn_rx_queue_alloc(struct hn_data *hv,
164                                       uint16_t queue_id,
165                                       unsigned int socket_id);
166 int     hn_dev_rx_queue_setup(struct rte_eth_dev *dev,
167                               uint16_t queue_idx, uint16_t nb_desc,
168                               unsigned int socket_id,
169                               const struct rte_eth_rxconf *rx_conf,
170                               struct rte_mempool *mp);
171 void    hn_dev_rx_queue_release(void *arg);
172
173 void    hn_vf_info_get(struct hn_data *hv,
174                        struct rte_eth_dev_info *info);
175 int     hn_vf_add(struct rte_eth_dev *dev, struct hn_data *hv);
176 int     hn_vf_configure(struct rte_eth_dev *dev,
177                         const struct rte_eth_conf *dev_conf);
178 const uint32_t *hn_vf_supported_ptypes(struct rte_eth_dev *dev);
179 int     hn_vf_start(struct rte_eth_dev *dev);
180 void    hn_vf_reset(struct rte_eth_dev *dev);
181 void    hn_vf_stop(struct rte_eth_dev *dev);
182 void    hn_vf_close(struct rte_eth_dev *dev);
183
184 void    hn_vf_allmulticast_enable(struct rte_eth_dev *dev);
185 void    hn_vf_allmulticast_disable(struct rte_eth_dev *dev);
186 void    hn_vf_promiscuous_enable(struct rte_eth_dev *dev);
187 void    hn_vf_promiscuous_disable(struct rte_eth_dev *dev);
188 int     hn_vf_mc_addr_list(struct rte_eth_dev *dev,
189                            struct ether_addr *mc_addr_set,
190                            uint32_t nb_mc_addr);
191
192 int     hn_vf_link_update(struct rte_eth_dev *dev,
193                           int wait_to_complete);
194 int     hn_vf_tx_queue_setup(struct rte_eth_dev *dev,
195                              uint16_t queue_idx, uint16_t nb_desc,
196                              unsigned int socket_id,
197                              const struct rte_eth_txconf *tx_conf);
198 void    hn_vf_tx_queue_release(struct hn_data *hv, uint16_t queue_id);
199 int     hn_vf_rx_queue_setup(struct rte_eth_dev *dev,
200                              uint16_t queue_idx, uint16_t nb_desc,
201                              unsigned int socket_id,
202                              const struct rte_eth_rxconf *rx_conf,
203                              struct rte_mempool *mp);
204 void    hn_vf_rx_queue_release(struct hn_data *hv, uint16_t queue_id);
205
206 int     hn_vf_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
207 void    hn_vf_stats_reset(struct rte_eth_dev *dev);
208 int     hn_vf_xstats_get_names(struct rte_eth_dev *dev,
209                                struct rte_eth_xstat_name *xstats_names,
210                                unsigned int size);
211 int     hn_vf_xstats_get(struct rte_eth_dev *dev,
212                          struct rte_eth_xstat *xstats,
213                          unsigned int n);
214 void    hn_vf_xstats_reset(struct rte_eth_dev *dev);