xref: /netbsd-src/sys/dev/pci/if_bnxvar.h (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /*	$NetBSD: if_bnxvar.h,v 1.14 2020/07/14 15:37:40 jdolecek Exp $	*/
2 /*-
3  * Copyright (c) 2010 The NetBSD Foundation, Inc.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to The NetBSD Foundation
7  * by Jean-Yves Migeon <jym@NetBSD.org>
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * $FreeBSD: src/sys/dev/bce/if_bcereg.h,v 1.4 2006/05/04 00:34:07 mjacob Exp $
31  */
32 
33 #ifndef	_DEV_PCI_IF_BNXVAR_H_
34 #define _DEV_PCI_IF_BNXVAR_H_
35 
36 #ifdef _KERNEL_OPT
37 #include "opt_inet.h"
38 #endif
39 
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/sockio.h>
43 #include <sys/mbuf.h>
44 #include <sys/malloc.h>
45 #include <sys/kernel.h>
46 #include <sys/device.h>
47 #include <sys/socket.h>
48 #include <sys/sysctl.h>
49 #include <sys/workqueue.h>
50 
51 #include <net/if.h>
52 #include <net/if_dl.h>
53 #include <net/if_media.h>
54 #include <net/if_ether.h>
55 
56 #ifdef INET
57 #include <netinet/in.h>
58 #include <netinet/in_systm.h>
59 #include <netinet/in_var.h>
60 #include <netinet/ip.h>
61 #include <netinet/if_inarp.h>
62 #endif
63 
64 #include <net/if_vlanvar.h>
65 
66 #include <net/bpf.h>
67 
68 #include <dev/pci/pcireg.h>
69 #include <dev/pci/pcivar.h>
70 #include <dev/pci/pcidevs.h>
71 
72 #include <dev/mii/mii.h>
73 #include <dev/mii/miivar.h>
74 #include <dev/mii/miidevs.h>
75 #include <dev/mii/brgphyreg.h>
76 
77 /*
78  * PCI registers defined in the PCI 2.2 spec.
79  */
80 #define BNX_PCI_BAR0			0x10
81 #define BNX_PCI_PCIX_CMD		0x40
82 
83 /****************************************************************************/
84 /* Convenience definitions.                                                 */
85 /****************************************************************************/
86 #define REG_WR(sc, reg, val)		bus_space_write_4(sc->bnx_btag, sc->bnx_bhandle, reg, val)
87 #define REG_WR16(sc, reg, val)		bus_space_write_2(sc->bnx_btag, sc->bnx_bhandle, reg, val)
88 #define REG_RD(sc, reg)			bus_space_read_4(sc->bnx_btag, sc->bnx_bhandle, reg)
89 #define REG_RD_IND(sc, offset)		bnx_reg_rd_ind(sc, offset)
90 #define REG_WR_IND(sc, offset, val)	bnx_reg_wr_ind(sc, offset, val)
91 #define CTX_WR(sc, cid_addr, offset, val)	bnx_ctx_wr(sc, cid_addr, offset, val)
92 #define BNX_SETBIT(sc, reg, x)		REG_WR(sc, reg, (REG_RD(sc, reg) | (x)))
93 #define BNX_CLRBIT(sc, reg, x)		REG_WR(sc, reg, (REG_RD(sc, reg) & ~(x)))
94 #define	PCI_SETBIT(pc, tag, reg, x)	pci_conf_write(pc, tag, reg, (pci_conf_read(pc, tag, reg) | (x)))
95 #define PCI_CLRBIT(pc, tag, reg, x)	pci_conf_write(pc, tag, reg, (pci_conf_read(pc, tag, reg) & ~(x)))
96 
97 /****************************************************************************/
98 /* BNX Device State Data Structure                                          */
99 /****************************************************************************/
100 
101 #define BNX_STATUS_BLK_SZ		sizeof(struct status_block)
102 #define BNX_STATS_BLK_SZ		sizeof(struct statistics_block)
103 #define BNX_TX_CHAIN_PAGE_SZ	BCM_PAGE_SIZE
104 #define BNX_RX_CHAIN_PAGE_SZ	BCM_PAGE_SIZE
105 
106 struct bnx_pkt {
107 	TAILQ_ENTRY(bnx_pkt)     pkt_entry;
108 	bus_dmamap_t             pkt_dmamap;
109 	struct mbuf             *pkt_mbuf;
110 	uint16_t                pkt_end_desc;
111 };
112 
113 TAILQ_HEAD(bnx_pkt_list, bnx_pkt);
114 
115 struct bnx_softc
116 {
117 	device_t bnx_dev;
118 	struct ethercom			bnx_ec;
119 	struct pci_attach_args		bnx_pa;
120 
121 	struct ifmedia		bnx_ifmedia;		/* TBI media info */
122 
123 	bus_space_tag_t		bnx_btag;		/* Device bus tag */
124 	bus_space_handle_t	bnx_bhandle;		/* Device bus handle */
125 	bus_size_t		bnx_size;
126 
127 	pci_intr_handle_t	*bnx_ih;
128 	void			*bnx_intrhand;		/* Interrupt handler */
129 
130 	/* packet allocation workqueue */
131 	struct workqueue	*bnx_wq;
132 	struct work		bnx_wk;
133 
134 	/* ASIC Chip ID. */
135 	uint32_t		bnx_chipid;
136 
137 	/* General controller flags. */
138 	uint32_t		bnx_flags;
139 
140 	/* Controller capability flags. */
141 	uint32_t		bnx_cap_flags;
142 #define BNX_MSI_CAPABLE_FLAG			0x00000001
143 #define BNX_MSIX_CAPABLE_FLAG			0x00000002
144 #define BNX_PCIE_CAPABLE_FLAG			0x00000004
145 #define BNX_PCIX_CAPABLE_FLAG			0x00000008
146 
147 	/* PHY specific flags. */
148 	uint32_t		bnx_phy_flags;
149 
150 	/* Values that need to be shared with the PHY driver. */
151 	uint32_t		bnx_shared_hw_cfg;
152 	uint32_t		bnx_port_hw_cfg;
153 
154 	int			bnx_flowflags;
155 
156 	uint16_t		bus_speed_mhz;		/* PCI bus speed */
157 	uint16_t		link_width;		/* PCIe link width */
158 	uint16_t		link_speed;		/* PCIe link speed */
159 	struct flash_spec	*bnx_flash_info;     /* Flash NVRAM settings */
160 	uint32_t		bnx_flash_size;		/* Flash NVRAM size */
161 	uint32_t		bnx_shmem_base;/* Shared Memory base address */
162 	char *			bnx_name;		/* Name string */
163 
164 	/* Tracks the version of bootcode firmware. */
165 	char			bnx_bc_ver[32];
166 
167 	/* Tracks the version of management firmware. */
168 	char			bnx_mfw_ver[32];
169 
170 	/* Tracks the state of the firmware.  0 = Running while any     */
171 	/* other value indicates that the firmware is not responding.   */
172 	uint16_t		bnx_fw_timed_out;
173 
174 	/* An incrementing sequence used to coordinate messages passed   */
175 	/* from the driver to the firmware.                              */
176 	uint16_t		bnx_fw_wr_seq;
177 
178 	/* An incrementing sequence used to let the firmware know that   */
179 	/* the driver is still operating.  Without the pulse, management */
180 	/* firmware such as IPMI or UMP will operate in OS absent state. */
181 	uint16_t		bnx_fw_drv_pulse_wr_seq;
182 
183 	/* Ethernet MAC address. */
184 	u_char			eaddr[6];
185 
186 	/* These setting are used by the host coalescing (HC) block to   */
187 	/* to control how often the status block, statistics block and   */
188 	/* interrupts are generated.                                     */
189 	uint16_t		bnx_tx_quick_cons_trip_int;
190 	uint16_t		bnx_tx_quick_cons_trip;
191 	uint16_t		bnx_rx_quick_cons_trip_int;
192 	uint16_t		bnx_rx_quick_cons_trip;
193 	uint16_t		bnx_comp_prod_trip_int;
194 	uint16_t		bnx_comp_prod_trip;
195 	uint16_t		bnx_tx_ticks_int;
196 	uint16_t		bnx_tx_ticks;
197 	uint16_t		bnx_rx_ticks_int;
198 	uint16_t		bnx_rx_ticks;
199 	uint16_t		bnx_com_ticks_int;
200 	uint16_t		bnx_com_ticks;
201 	uint16_t		bnx_cmd_ticks_int;
202 	uint16_t		bnx_cmd_ticks;
203 	uint32_t		bnx_stats_ticks;
204 
205 	/* The address of the integrated PHY on the MII bus. */
206 	int			bnx_phy_addr;
207 
208 	/* The device handle for the MII bus child device. */
209 	struct mii_data		bnx_mii;
210 
211 	/* Driver maintained TX chain pointers and byte counter. */
212 	uint16_t		rx_prod;
213 	uint16_t		rx_cons;
214 	uint32_t		rx_prod_bseq;	/* Counts the bytes used.  */
215 	uint16_t		tx_prod;
216 	uint16_t		tx_cons;
217 	uint32_t		tx_prod_bseq;	/* Counts the bytes used.  */
218 
219 	int			bnx_link;
220 	struct callout		bnx_timeout;
221 	int			bnx_detaching;
222 
223 	/* Frame size and mbuf allocation size for RX frames. */
224 	uint32_t		max_frame_size;
225 	int			mbuf_alloc_size;
226 
227 	/* Receive mode settings (i.e promiscuous, multicast, etc.). */
228 	uint32_t		rx_mode;
229 
230 	/* Bus tag for the bnx controller. */
231 	bus_dma_tag_t		bnx_dmatag;
232 
233 	/* H/W maintained TX buffer descriptor chain structure. */
234 	bus_dma_segment_t	tx_bd_chain_seg[TX_PAGES];
235 	int			tx_bd_chain_rseg[TX_PAGES];
236 	bus_dmamap_t		tx_bd_chain_map[TX_PAGES];
237 	struct tx_bd		*tx_bd_chain[TX_PAGES];
238 	bus_addr_t		tx_bd_chain_paddr[TX_PAGES];
239 
240 	/* H/W maintained RX buffer descriptor chain structure. */
241 	bus_dma_segment_t	rx_bd_chain_seg[RX_PAGES];
242 	int			rx_bd_chain_rseg[RX_PAGES];
243 	bus_dmamap_t		rx_bd_chain_map[RX_PAGES];
244 	struct rx_bd		*rx_bd_chain[RX_PAGES];
245 	bus_addr_t		rx_bd_chain_paddr[RX_PAGES];
246 
247 	/* H/W maintained status block. */
248 	bus_dma_segment_t	status_seg;
249 	int			status_rseg;
250 	bus_dmamap_t		status_map;
251 	struct status_block	*status_block;		/* virtual address */
252 	bus_addr_t		status_block_paddr;	/* Physical address */
253 
254 	/* H/W maintained context block */
255 	int			ctx_pages;
256 	bus_dma_segment_t	ctx_segs[4];
257 	int			ctx_rsegs[4];
258 	bus_dmamap_t		ctx_map[4];
259 	void			*ctx_block[4];
260 
261 	/* Driver maintained status block values. */
262 	uint16_t		last_status_idx;
263 	uint16_t		hw_rx_cons;
264 	uint16_t		hw_tx_cons;
265 
266 	/* H/W maintained statistics block. */
267 	bus_dma_segment_t	stats_seg;
268 	int			stats_rseg;
269 	bus_dmamap_t		stats_map;
270 	struct statistics_block *stats_block;		/* Virtual address */
271 	bus_addr_t		stats_block_paddr;	/* Physical address */
272 
273 	/* Bus tag for RX/TX mbufs. */
274 	bus_dma_segment_t	rx_mbuf_seg;
275 	int			rx_mbuf_rseg;
276 	bus_dma_segment_t	tx_mbuf_seg;
277 	int			tx_mbuf_rseg;
278 
279 	/* S/W maintained mbuf TX chain structure. */
280 	kmutex_t		tx_pkt_mtx;
281 	uint			tx_pkt_count;
282 	struct bnx_pkt_list	tx_free_pkts;
283 	struct bnx_pkt_list	tx_used_pkts;
284 
285 	/* S/W maintained mbuf RX chain structure. */
286 	bus_dmamap_t		rx_mbuf_map[TOTAL_RX_BD];
287 	struct mbuf		*rx_mbuf_ptr[TOTAL_RX_BD];
288 
289 	/* Track the number of rx_bd and tx_bd's in use. */
290 	uint16_t 		free_rx_bd;
291 	uint16_t		max_rx_bd;
292 	uint16_t		used_tx_bd;
293 	uint16_t		max_tx_bd;
294 
295 	/* For interfacing with if_stats */
296 	uint64_t	if_stat_collisions;
297 	uint64_t	if_stat_ierrors;
298 	uint64_t	if_stat_oerrors;
299 
300 	/* Provides access to hardware statistics through sysctl. */
301 	uint64_t 	stat_IfHCInOctets;
302 	uint64_t 	stat_IfHCInBadOctets;
303 	uint64_t 	stat_IfHCOutOctets;
304 	uint64_t 	stat_IfHCOutBadOctets;
305 	uint64_t 	stat_IfHCInUcastPkts;
306 	uint64_t 	stat_IfHCInMulticastPkts;
307 	uint64_t 	stat_IfHCInBroadcastPkts;
308 	uint64_t 	stat_IfHCOutUcastPkts;
309 	uint64_t 	stat_IfHCOutMulticastPkts;
310 	uint64_t 	stat_IfHCOutBroadcastPkts;
311 
312 	uint32_t	stat_emac_tx_stat_dot3statsinternalmactransmiterrors;
313 	uint32_t	stat_Dot3StatsCarrierSenseErrors;
314 	uint32_t	stat_Dot3StatsFCSErrors;
315 	uint32_t	stat_Dot3StatsAlignmentErrors;
316 	uint32_t	stat_Dot3StatsSingleCollisionFrames;
317 	uint32_t	stat_Dot3StatsMultipleCollisionFrames;
318 	uint32_t	stat_Dot3StatsDeferredTransmissions;
319 	uint32_t	stat_Dot3StatsExcessiveCollisions;
320 	uint32_t	stat_Dot3StatsLateCollisions;
321 	uint32_t	stat_EtherStatsCollisions;
322 	uint32_t	stat_EtherStatsFragments;
323 	uint32_t	stat_EtherStatsJabbers;
324 	uint32_t	stat_EtherStatsUndersizePkts;
325 	uint32_t	stat_EtherStatsOverrsizePkts;
326 	uint32_t	stat_EtherStatsPktsRx64Octets;
327 	uint32_t	stat_EtherStatsPktsRx65Octetsto127Octets;
328 	uint32_t	stat_EtherStatsPktsRx128Octetsto255Octets;
329 	uint32_t	stat_EtherStatsPktsRx256Octetsto511Octets;
330 	uint32_t	stat_EtherStatsPktsRx512Octetsto1023Octets;
331 	uint32_t	stat_EtherStatsPktsRx1024Octetsto1522Octets;
332 	uint32_t	stat_EtherStatsPktsRx1523Octetsto9022Octets;
333 	uint32_t	stat_EtherStatsPktsTx64Octets;
334 	uint32_t	stat_EtherStatsPktsTx65Octetsto127Octets;
335 	uint32_t	stat_EtherStatsPktsTx128Octetsto255Octets;
336 	uint32_t	stat_EtherStatsPktsTx256Octetsto511Octets;
337 	uint32_t	stat_EtherStatsPktsTx512Octetsto1023Octets;
338 	uint32_t	stat_EtherStatsPktsTx1024Octetsto1522Octets;
339 	uint32_t	stat_EtherStatsPktsTx1523Octetsto9022Octets;
340 	uint32_t	stat_XonPauseFramesReceived;
341 	uint32_t	stat_XoffPauseFramesReceived;
342 	uint32_t	stat_OutXonSent;
343 	uint32_t	stat_OutXoffSent;
344 	uint32_t	stat_FlowControlDone;
345 	uint32_t	stat_MacControlFramesReceived;
346 	uint32_t	stat_XoffStateEntered;
347 	uint32_t	stat_IfInFramesL2FilterDiscards;
348 	uint32_t	stat_IfInRuleCheckerDiscards;
349 	uint32_t	stat_IfInFTQDiscards;
350 	uint32_t	stat_IfInMBUFDiscards;
351 	uint32_t	stat_IfInRuleCheckerP4Hit;
352 	uint32_t	stat_CatchupInRuleCheckerDiscards;
353 	uint32_t	stat_CatchupInFTQDiscards;
354 	uint32_t	stat_CatchupInMBUFDiscards;
355 	uint32_t	stat_CatchupInRuleCheckerP4Hit;
356 
357 	/* Mbuf allocation failure counter. */
358 	uint32_t		mbuf_alloc_failed;
359 
360 	/* TX DMA mapping failure counter. */
361 	uint32_t		tx_dma_map_failures;
362 
363 #ifdef BNX_DEBUG
364 	/* Track the number of enqueued mbufs. */
365 	int			tx_mbuf_alloc;
366 	int			rx_mbuf_alloc;
367 
368 	/* Track the distribution buffer segments. */
369 	uint32_t		rx_mbuf_segs[BNX_MAX_SEGMENTS+1];
370 
371 	/* Track how many and what type of interrupts are generated. */
372 	uint32_t		interrupts_generated;
373 	uint32_t		interrupts_handled;
374 	uint32_t		rx_interrupts;
375 	uint32_t		tx_interrupts;
376 
377 	uint32_t rx_low_watermark;	/* Lowest number of rx_bd's free. */
378 	uint32_t rx_empty_count;	/* Number of times the RX chain was empty. */
379 	uint32_t tx_hi_watermark;	/* Greatest number of tx_bd's used. */
380 	uint32_t tx_full_count;	/* Number of times the TX chain was full. */
381 	uint32_t mbuf_sim_alloc_failed;/* Mbuf simulated allocation failure counter. */
382 	uint32_t l2fhdr_status_errors;
383 	uint32_t unexpected_attentions;
384 	uint32_t lost_status_block_updates;
385 #endif
386 };
387 
388 struct bnx_firmware_header {
389 	int		bnx_COM_FwReleaseMajor;
390 	int		bnx_COM_FwReleaseMinor;
391 	int		bnx_COM_FwReleaseFix;
392 	uint32_t	bnx_COM_FwStartAddr;
393 	uint32_t	bnx_COM_FwTextAddr;
394 	int		bnx_COM_FwTextLen;
395 	uint32_t	bnx_COM_FwDataAddr;
396 	int		bnx_COM_FwDataLen;
397 	uint32_t	bnx_COM_FwRodataAddr;
398 	int		bnx_COM_FwRodataLen;
399 	uint32_t	bnx_COM_FwBssAddr;
400 	int		bnx_COM_FwBssLen;
401 	uint32_t	bnx_COM_FwSbssAddr;
402 	int		bnx_COM_FwSbssLen;
403 
404 	int		bnx_RXP_FwReleaseMajor;
405 	int		bnx_RXP_FwReleaseMinor;
406 	int		bnx_RXP_FwReleaseFix;
407 	uint32_t	bnx_RXP_FwStartAddr;
408 	uint32_t	bnx_RXP_FwTextAddr;
409 	int		bnx_RXP_FwTextLen;
410 	uint32_t	bnx_RXP_FwDataAddr;
411 	int		bnx_RXP_FwDataLen;
412 	uint32_t	bnx_RXP_FwRodataAddr;
413 	int		bnx_RXP_FwRodataLen;
414 	uint32_t	bnx_RXP_FwBssAddr;
415 	int		bnx_RXP_FwBssLen;
416 	uint32_t	bnx_RXP_FwSbssAddr;
417 	int		bnx_RXP_FwSbssLen;
418 
419 	int		bnx_TPAT_FwReleaseMajor;
420 	int		bnx_TPAT_FwReleaseMinor;
421 	int		bnx_TPAT_FwReleaseFix;
422 	uint32_t	bnx_TPAT_FwStartAddr;
423 	uint32_t	bnx_TPAT_FwTextAddr;
424 	int		bnx_TPAT_FwTextLen;
425 	uint32_t	bnx_TPAT_FwDataAddr;
426 	int		bnx_TPAT_FwDataLen;
427 	uint32_t	bnx_TPAT_FwRodataAddr;
428 	int		bnx_TPAT_FwRodataLen;
429 	uint32_t	bnx_TPAT_FwBssAddr;
430 	int		bnx_TPAT_FwBssLen;
431 	uint32_t	bnx_TPAT_FwSbssAddr;
432 	int		bnx_TPAT_FwSbssLen;
433 
434 	int		bnx_TXP_FwReleaseMajor;
435 	int		bnx_TXP_FwReleaseMinor;
436 	int		bnx_TXP_FwReleaseFix;
437 	uint32_t	bnx_TXP_FwStartAddr;
438 	uint32_t	bnx_TXP_FwTextAddr;
439 	int		bnx_TXP_FwTextLen;
440 	uint32_t	bnx_TXP_FwDataAddr;
441 	int		bnx_TXP_FwDataLen;
442 	uint32_t	bnx_TXP_FwRodataAddr;
443 	int		bnx_TXP_FwRodataLen;
444 	uint32_t	bnx_TXP_FwBssAddr;
445 	int		bnx_TXP_FwBssLen;
446 	uint32_t	bnx_TXP_FwSbssAddr;
447 	int		bnx_TXP_FwSbssLen;
448 
449 	/* Followed by blocks of data, each sized according to
450 	 * the (rather obvious) block length stated above.
451 	 *
452 	 * bnx_COM_FwText, bnx_COM_FwData, bnx_COM_FwRodata,
453 	 * bnx_COM_FwBss, bnx_COM_FwSbss,
454 	 *
455 	 * bnx_RXP_FwText, bnx_RXP_FwData, bnx_RXP_FwRodata,
456 	 * bnx_RXP_FwBss, bnx_RXP_FwSbss,
457 	 *
458 	 * bnx_TPAT_FwText, bnx_TPAT_FwData, bnx_TPAT_FwRodata,
459 	 * bnx_TPAT_FwBss, bnx_TPAT_FwSbss,
460 	 *
461 	 * bnx_TXP_FwText, bnx_TXP_FwData, bnx_TXP_FwRodata,
462 	 * bnx_TXP_FwBss, bnx_TXP_FwSbss,
463 	 */
464 };
465 
466 #endif /* _DEV_PCI_IF_BNXVAR_H_ */
467