xref: /linux/drivers/net/ethernet/qlogic/qede/qede.h (revision e5c86679d5e864947a52fb31e45a425dea3e7fa9)
1 /* QLogic qede NIC Driver
2  * Copyright (c) 2015-2017  QLogic Corporation
3  *
4  * This software is available to you under a choice of one of two
5  * licenses.  You may choose to be licensed under the terms of the GNU
6  * General Public License (GPL) Version 2, available from the file
7  * COPYING in the main directory of this source tree, or the
8  * OpenIB.org BSD license below:
9  *
10  *     Redistribution and use in source and binary forms, with or
11  *     without modification, are permitted provided that the following
12  *     conditions are met:
13  *
14  *      - Redistributions of source code must retain the above
15  *        copyright notice, this list of conditions and the following
16  *        disclaimer.
17  *
18  *      - Redistributions in binary form must reproduce the above
19  *        copyright notice, this list of conditions and the following
20  *        disclaimer in the documentation and /or other materials
21  *        provided with the distribution.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30  * SOFTWARE.
31  */
32 #ifndef _QEDE_H_
33 #define _QEDE_H_
34 #include <linux/compiler.h>
35 #include <linux/version.h>
36 #include <linux/workqueue.h>
37 #include <linux/netdevice.h>
38 #include <linux/interrupt.h>
39 #include <linux/bitmap.h>
40 #include <linux/kernel.h>
41 #include <linux/mutex.h>
42 #include <linux/bpf.h>
43 #include <linux/io.h>
44 #include <linux/qed/common_hsi.h>
45 #include <linux/qed/eth_common.h>
46 #include <linux/qed/qed_if.h>
47 #include <linux/qed/qed_chain.h>
48 #include <linux/qed/qed_eth_if.h>
49 
50 #define QEDE_MAJOR_VERSION		8
51 #define QEDE_MINOR_VERSION		10
52 #define QEDE_REVISION_VERSION		10
53 #define QEDE_ENGINEERING_VERSION	20
54 #define DRV_MODULE_VERSION __stringify(QEDE_MAJOR_VERSION) "."	\
55 		__stringify(QEDE_MINOR_VERSION) "."		\
56 		__stringify(QEDE_REVISION_VERSION) "."		\
57 		__stringify(QEDE_ENGINEERING_VERSION)
58 
59 #define DRV_MODULE_SYM		qede
60 
61 struct qede_stats {
62 	u64 no_buff_discards;
63 	u64 packet_too_big_discard;
64 	u64 ttl0_discard;
65 	u64 rx_ucast_bytes;
66 	u64 rx_mcast_bytes;
67 	u64 rx_bcast_bytes;
68 	u64 rx_ucast_pkts;
69 	u64 rx_mcast_pkts;
70 	u64 rx_bcast_pkts;
71 	u64 mftag_filter_discards;
72 	u64 mac_filter_discards;
73 	u64 tx_ucast_bytes;
74 	u64 tx_mcast_bytes;
75 	u64 tx_bcast_bytes;
76 	u64 tx_ucast_pkts;
77 	u64 tx_mcast_pkts;
78 	u64 tx_bcast_pkts;
79 	u64 tx_err_drop_pkts;
80 	u64 coalesced_pkts;
81 	u64 coalesced_events;
82 	u64 coalesced_aborts_num;
83 	u64 non_coalesced_pkts;
84 	u64 coalesced_bytes;
85 
86 	/* port */
87 	u64 rx_64_byte_packets;
88 	u64 rx_65_to_127_byte_packets;
89 	u64 rx_128_to_255_byte_packets;
90 	u64 rx_256_to_511_byte_packets;
91 	u64 rx_512_to_1023_byte_packets;
92 	u64 rx_1024_to_1518_byte_packets;
93 	u64 rx_1519_to_1522_byte_packets;
94 	u64 rx_1519_to_2047_byte_packets;
95 	u64 rx_2048_to_4095_byte_packets;
96 	u64 rx_4096_to_9216_byte_packets;
97 	u64 rx_9217_to_16383_byte_packets;
98 	u64 rx_crc_errors;
99 	u64 rx_mac_crtl_frames;
100 	u64 rx_pause_frames;
101 	u64 rx_pfc_frames;
102 	u64 rx_align_errors;
103 	u64 rx_carrier_errors;
104 	u64 rx_oversize_packets;
105 	u64 rx_jabbers;
106 	u64 rx_undersize_packets;
107 	u64 rx_fragments;
108 	u64 tx_64_byte_packets;
109 	u64 tx_65_to_127_byte_packets;
110 	u64 tx_128_to_255_byte_packets;
111 	u64 tx_256_to_511_byte_packets;
112 	u64 tx_512_to_1023_byte_packets;
113 	u64 tx_1024_to_1518_byte_packets;
114 	u64 tx_1519_to_2047_byte_packets;
115 	u64 tx_2048_to_4095_byte_packets;
116 	u64 tx_4096_to_9216_byte_packets;
117 	u64 tx_9217_to_16383_byte_packets;
118 	u64 tx_pause_frames;
119 	u64 tx_pfc_frames;
120 	u64 tx_lpi_entry_count;
121 	u64 tx_total_collisions;
122 	u64 brb_truncates;
123 	u64 brb_discards;
124 	u64 tx_mac_ctrl_frames;
125 };
126 
127 struct qede_vlan {
128 	struct list_head list;
129 	u16 vid;
130 	bool configured;
131 };
132 
133 struct qede_rdma_dev {
134 	struct qedr_dev *qedr_dev;
135 	struct list_head entry;
136 	struct list_head roce_event_list;
137 	struct workqueue_struct *roce_wq;
138 };
139 
140 struct qede_ptp;
141 
142 struct qede_dev {
143 	struct qed_dev			*cdev;
144 	struct net_device		*ndev;
145 	struct pci_dev			*pdev;
146 
147 	u32				dp_module;
148 	u8				dp_level;
149 
150 	u32 flags;
151 #define QEDE_FLAG_IS_VF	BIT(0)
152 #define IS_VF(edev)	(!!((edev)->flags & QEDE_FLAG_IS_VF))
153 #define QEDE_TX_TIMESTAMPING_EN		BIT(1)
154 
155 	const struct qed_eth_ops	*ops;
156 	struct qede_ptp			*ptp;
157 
158 	struct qed_dev_eth_info dev_info;
159 #define QEDE_MAX_RSS_CNT(edev)	((edev)->dev_info.num_queues)
160 #define QEDE_MAX_TSS_CNT(edev)	((edev)->dev_info.num_queues)
161 
162 	struct qede_fastpath		*fp_array;
163 	u8				req_num_tx;
164 	u8				fp_num_tx;
165 	u8				req_num_rx;
166 	u8				fp_num_rx;
167 	u16				req_queues;
168 	u16				num_queues;
169 #define QEDE_QUEUE_CNT(edev)	((edev)->num_queues)
170 #define QEDE_RSS_COUNT(edev)	((edev)->num_queues - (edev)->fp_num_tx)
171 #define QEDE_RX_QUEUE_IDX(edev, i)	(i)
172 #define QEDE_TSS_COUNT(edev)	((edev)->num_queues - (edev)->fp_num_rx)
173 
174 	struct qed_int_info		int_info;
175 	unsigned char			primary_mac[ETH_ALEN];
176 
177 	/* Smaller private varaiant of the RTNL lock */
178 	struct mutex			qede_lock;
179 	u32				state; /* Protected by qede_lock */
180 	u16				rx_buf_size;
181 	u32				rx_copybreak;
182 
183 	/* L2 header size + 2*VLANs (8 bytes) + LLC SNAP (8 bytes) */
184 #define ETH_OVERHEAD			(ETH_HLEN + 8 + 8)
185 	/* Max supported alignment is 256 (8 shift)
186 	 * minimal alignment shift 6 is optimal for 57xxx HW performance
187 	 */
188 #define QEDE_RX_ALIGN_SHIFT		max(6, min(8, L1_CACHE_SHIFT))
189 	/* We assume skb_build() uses sizeof(struct skb_shared_info) bytes
190 	 * at the end of skb->data, to avoid wasting a full cache line.
191 	 * This reduces memory use (skb->truesize).
192 	 */
193 #define QEDE_FW_RX_ALIGN_END					\
194 	max_t(u64, 1UL << QEDE_RX_ALIGN_SHIFT,			\
195 	      SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
196 
197 	struct qede_stats		stats;
198 #define QEDE_RSS_INDIR_INITED	BIT(0)
199 #define QEDE_RSS_KEY_INITED	BIT(1)
200 #define QEDE_RSS_CAPS_INITED	BIT(2)
201 	u32 rss_params_inited; /* bit-field to track initialized rss params */
202 	u16 rss_ind_table[128];
203 	u32 rss_key[10];
204 	u8 rss_caps;
205 
206 	u16			q_num_rx_buffers; /* Must be a power of two */
207 	u16			q_num_tx_buffers; /* Must be a power of two */
208 
209 	bool gro_disable;
210 	struct list_head vlan_list;
211 	u16 configured_vlans;
212 	u16 non_configured_vlans;
213 	bool accept_any_vlan;
214 	struct delayed_work		sp_task;
215 	unsigned long			sp_flags;
216 	u16				vxlan_dst_port;
217 	u16				geneve_dst_port;
218 
219 	bool wol_enabled;
220 
221 	struct qede_rdma_dev		rdma_info;
222 
223 	struct bpf_prog *xdp_prog;
224 };
225 
226 enum QEDE_STATE {
227 	QEDE_STATE_CLOSED,
228 	QEDE_STATE_OPEN,
229 };
230 
231 #define HILO_U64(hi, lo)		((((u64)(hi)) << 32) + (lo))
232 
233 #define	MAX_NUM_TC	8
234 #define	MAX_NUM_PRI	8
235 
236 /* The driver supports the new build_skb() API:
237  * RX ring buffer contains pointer to kmalloc() data only,
238  * skb are built only after the frame was DMA-ed.
239  */
240 struct sw_rx_data {
241 	struct page *data;
242 	dma_addr_t mapping;
243 	unsigned int page_offset;
244 };
245 
246 enum qede_agg_state {
247 	QEDE_AGG_STATE_NONE  = 0,
248 	QEDE_AGG_STATE_START = 1,
249 	QEDE_AGG_STATE_ERROR = 2
250 };
251 
252 struct qede_agg_info {
253 	/* rx_buf is a data buffer that can be placed / consumed from rx bd
254 	 * chain. It has two purposes: We will preallocate the data buffer
255 	 * for each aggregation when we open the interface and will place this
256 	 * buffer on the rx-bd-ring when we receive TPA_START. We don't want
257 	 * to be in a state where allocation fails, as we can't reuse the
258 	 * consumer buffer in the rx-chain since FW may still be writing to it
259 	 * (since header needs to be modified for TPA).
260 	 * The second purpose is to keep a pointer to the bd buffer during
261 	 * aggregation.
262 	 */
263 	struct sw_rx_data buffer;
264 	dma_addr_t buffer_mapping;
265 
266 	struct sk_buff *skb;
267 
268 	/* We need some structs from the start cookie until termination */
269 	u16 vlan_tag;
270 	u16 start_cqe_bd_len;
271 	u8 start_cqe_placement_offset;
272 
273 	u8 state;
274 	u8 frag_id;
275 
276 	u8 tunnel_type;
277 };
278 
279 struct qede_rx_queue {
280 	__le16 *hw_cons_ptr;
281 	void __iomem *hw_rxq_prod_addr;
282 
283 	/* Required for the allocation of replacement buffers */
284 	struct device *dev;
285 
286 	struct bpf_prog *xdp_prog;
287 
288 	u16 sw_rx_cons;
289 	u16 sw_rx_prod;
290 
291 	u16 filled_buffers;
292 	u8 data_direction;
293 	u8 rxq_id;
294 
295 	u32 rx_buf_size;
296 	u32 rx_buf_seg_size;
297 
298 	u64 rcv_pkts;
299 
300 	struct sw_rx_data *sw_rx_ring;
301 	struct qed_chain rx_bd_ring;
302 	struct qed_chain rx_comp_ring ____cacheline_aligned;
303 
304 	/* Used once per each NAPI run */
305 	u16 num_rx_buffers;
306 
307 	/* GRO */
308 	struct qede_agg_info tpa_info[ETH_TPA_MAX_AGGS_NUM];
309 
310 	u64 rx_hw_errors;
311 	u64 rx_alloc_errors;
312 	u64 rx_ip_frags;
313 
314 	u64 xdp_no_pass;
315 
316 	void *handle;
317 };
318 
319 union db_prod {
320 	struct eth_db_data data;
321 	u32		raw;
322 };
323 
324 struct sw_tx_bd {
325 	struct sk_buff *skb;
326 	u8 flags;
327 /* Set on the first BD descriptor when there is a split BD */
328 #define QEDE_TSO_SPLIT_BD		BIT(0)
329 };
330 
331 struct qede_tx_queue {
332 	u8 is_xdp;
333 	bool is_legacy;
334 	u16 sw_tx_cons;
335 	u16 sw_tx_prod;
336 	u16 num_tx_buffers; /* Slowpath only */
337 
338 	u64 xmit_pkts;
339 	u64 stopped_cnt;
340 
341 	__le16 *hw_cons_ptr;
342 
343 	/* Needed for the mapping of packets */
344 	struct device *dev;
345 
346 	void __iomem *doorbell_addr;
347 	union db_prod tx_db;
348 	int index; /* Slowpath only */
349 #define QEDE_TXQ_XDP_TO_IDX(edev, txq)	((txq)->index - \
350 					 QEDE_MAX_TSS_CNT(edev))
351 #define QEDE_TXQ_IDX_TO_XDP(edev, idx)	((idx) + QEDE_MAX_TSS_CNT(edev))
352 
353 	/* Regular Tx requires skb + metadata for release purpose,
354 	 * while XDP requires only the pages themselves.
355 	 */
356 	union {
357 		struct sw_tx_bd *skbs;
358 		struct page **pages;
359 	} sw_tx_ring;
360 
361 	struct qed_chain tx_pbl;
362 
363 	/* Slowpath; Should be kept in end [unless missing padding] */
364 	void *handle;
365 };
366 
367 #define BD_UNMAP_ADDR(bd)		HILO_U64(le32_to_cpu((bd)->addr.hi), \
368 						 le32_to_cpu((bd)->addr.lo))
369 #define BD_SET_UNMAP_ADDR_LEN(bd, maddr, len)				\
370 	do {								\
371 		(bd)->addr.hi = cpu_to_le32(upper_32_bits(maddr));	\
372 		(bd)->addr.lo = cpu_to_le32(lower_32_bits(maddr));	\
373 		(bd)->nbytes = cpu_to_le16(len);			\
374 	} while (0)
375 #define BD_UNMAP_LEN(bd)		(le16_to_cpu((bd)->nbytes))
376 
377 struct qede_fastpath {
378 	struct qede_dev	*edev;
379 #define QEDE_FASTPATH_TX	BIT(0)
380 #define QEDE_FASTPATH_RX	BIT(1)
381 #define QEDE_FASTPATH_XDP	BIT(2)
382 #define QEDE_FASTPATH_COMBINED	(QEDE_FASTPATH_TX | QEDE_FASTPATH_RX)
383 	u8			type;
384 	u8			id;
385 	u8			xdp_xmit;
386 	struct napi_struct	napi;
387 	struct qed_sb_info	*sb_info;
388 	struct qede_rx_queue	*rxq;
389 	struct qede_tx_queue	*txq;
390 	struct qede_tx_queue	*xdp_tx;
391 
392 #define VEC_NAME_SIZE	(sizeof(((struct net_device *)0)->name) + 8)
393 	char	name[VEC_NAME_SIZE];
394 };
395 
396 /* Debug print definitions */
397 #define DP_NAME(edev) ((edev)->ndev->name)
398 
399 #define XMIT_PLAIN		0
400 #define XMIT_L4_CSUM		BIT(0)
401 #define XMIT_LSO		BIT(1)
402 #define XMIT_ENC		BIT(2)
403 #define XMIT_ENC_GSO_L4_CSUM	BIT(3)
404 
405 #define QEDE_CSUM_ERROR			BIT(0)
406 #define QEDE_CSUM_UNNECESSARY		BIT(1)
407 #define QEDE_TUNN_CSUM_UNNECESSARY	BIT(2)
408 
409 #define QEDE_SP_RX_MODE			1
410 #define QEDE_SP_VXLAN_PORT_CONFIG	2
411 #define QEDE_SP_GENEVE_PORT_CONFIG	3
412 
413 struct qede_reload_args {
414 	void (*func)(struct qede_dev *edev, struct qede_reload_args *args);
415 	union {
416 		netdev_features_t features;
417 		struct bpf_prog *new_prog;
418 		u16 mtu;
419 	} u;
420 };
421 
422 /* Datapath functions definition */
423 netdev_tx_t qede_start_xmit(struct sk_buff *skb, struct net_device *ndev);
424 netdev_features_t qede_features_check(struct sk_buff *skb,
425 				      struct net_device *dev,
426 				      netdev_features_t features);
427 void qede_tx_log_print(struct qede_dev *edev, struct qede_fastpath *fp);
428 int qede_alloc_rx_buffer(struct qede_rx_queue *rxq, bool allow_lazy);
429 int qede_free_tx_pkt(struct qede_dev *edev,
430 		     struct qede_tx_queue *txq, int *len);
431 int qede_poll(struct napi_struct *napi, int budget);
432 irqreturn_t qede_msix_fp_int(int irq, void *fp_cookie);
433 
434 /* Filtering function definitions */
435 void qede_force_mac(void *dev, u8 *mac, bool forced);
436 int qede_set_mac_addr(struct net_device *ndev, void *p);
437 
438 int qede_vlan_rx_add_vid(struct net_device *dev, __be16 proto, u16 vid);
439 int qede_vlan_rx_kill_vid(struct net_device *dev, __be16 proto, u16 vid);
440 void qede_vlan_mark_nonconfigured(struct qede_dev *edev);
441 int qede_configure_vlan_filters(struct qede_dev *edev);
442 
443 int qede_set_features(struct net_device *dev, netdev_features_t features);
444 void qede_set_rx_mode(struct net_device *ndev);
445 void qede_config_rx_mode(struct net_device *ndev);
446 void qede_fill_rss_params(struct qede_dev *edev,
447 			  struct qed_update_vport_rss_params *rss, u8 *update);
448 
449 void qede_udp_tunnel_add(struct net_device *dev, struct udp_tunnel_info *ti);
450 void qede_udp_tunnel_del(struct net_device *dev, struct udp_tunnel_info *ti);
451 
452 int qede_xdp(struct net_device *dev, struct netdev_xdp *xdp);
453 
454 #ifdef CONFIG_DCB
455 void qede_set_dcbnl_ops(struct net_device *ndev);
456 #endif
457 
458 void qede_config_debug(uint debug, u32 *p_dp_module, u8 *p_dp_level);
459 void qede_set_ethtool_ops(struct net_device *netdev);
460 void qede_reload(struct qede_dev *edev,
461 		 struct qede_reload_args *args, bool is_locked);
462 int qede_change_mtu(struct net_device *dev, int new_mtu);
463 void qede_fill_by_demand_stats(struct qede_dev *edev);
464 void __qede_lock(struct qede_dev *edev);
465 void __qede_unlock(struct qede_dev *edev);
466 bool qede_has_rx_work(struct qede_rx_queue *rxq);
467 int qede_txq_has_work(struct qede_tx_queue *txq);
468 void qede_recycle_rx_bd_ring(struct qede_rx_queue *rxq, u8 count);
469 void qede_update_rx_prod(struct qede_dev *edev, struct qede_rx_queue *rxq);
470 
471 #define RX_RING_SIZE_POW	13
472 #define RX_RING_SIZE		((u16)BIT(RX_RING_SIZE_POW))
473 #define NUM_RX_BDS_MAX		(RX_RING_SIZE - 1)
474 #define NUM_RX_BDS_MIN		128
475 #define NUM_RX_BDS_DEF		((u16)BIT(10) - 1)
476 
477 #define TX_RING_SIZE_POW	13
478 #define TX_RING_SIZE		((u16)BIT(TX_RING_SIZE_POW))
479 #define NUM_TX_BDS_MAX		(TX_RING_SIZE - 1)
480 #define NUM_TX_BDS_MIN		128
481 #define NUM_TX_BDS_DEF		NUM_TX_BDS_MAX
482 
483 #define QEDE_MIN_PKT_LEN		64
484 #define QEDE_RX_HDR_SIZE		256
485 #define QEDE_MAX_JUMBO_PACKET_SIZE	9600
486 #define	for_each_queue(i) for (i = 0; i < edev->num_queues; i++)
487 
488 #endif /* _QEDE_H_ */
489