sfxge.h revision 227569 
1/*-
2 * Copyright (c) 2010-2011 Solarflare Communications, Inc.
3 * All rights reserved.
4 *
5 * This software was developed in part by Philip Paeps under contract for
6 * Solarflare Communications, Inc.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: head/sys/dev/sfxge/sfxge.h 227569 2011-11-16 17:11:13Z philip $
30 */
31
32#ifndef _SFXGE_H
33#define _SFXGE_H
34
35#include <sys/param.h>
36#include <sys/kernel.h>
37#include <sys/condvar.h>
38#include <sys/socket.h>
39#include <sys/sysctl.h>
40#include <sys/sx.h>
41#include <vm/uma.h>
42
43#include <net/ethernet.h>
44#include <net/if.h>
45#include <net/if_media.h>
46#include <net/if_types.h>
47
48/*
49 * Backward-compatibility
50 */
51#ifndef CACHE_LINE_SIZE
52/* This should be right on most machines the driver will be used on, and
53 * we needn't care too much about wasting a few KB per interface.
54 */
55#define CACHE_LINE_SIZE 128
56#endif
57#ifndef IFCAP_LINKSTATE
58#define IFCAP_LINKSTATE 0
59#endif
60#ifndef IFCAP_VLAN_HWTSO
61#define IFCAP_VLAN_HWTSO 0
62#endif
63#ifndef IFM_10G_T
64#define IFM_10G_T IFM_UNKNOWN
65#endif
66#ifndef IFM_10G_KX4
67#define IFM_10G_KX4 IFM_10G_CX4
68#endif
69#if __FreeBSD_version >= 800054
70/* Networking core is multiqueue aware. We can manage our own TX
71 * queues and use m_pkthdr.flowid.
72 */
73#define SFXGE_HAVE_MQ
74#endif
75#if (__FreeBSD_version >= 800501 && __FreeBSD_version < 900000) || \
76	__FreeBSD_version >= 900003
77#define SFXGE_HAVE_DESCRIBE_INTR
78#endif
79#ifdef IFM_ETH_RXPAUSE
80#define SFXGE_HAVE_PAUSE_MEDIAOPTS
81#endif
82#ifndef CTLTYPE_U64
83#define CTLTYPE_U64 CTLTYPE_QUAD
84#endif
85
86#include "sfxge_rx.h"
87#include "sfxge_tx.h"
88
89#define SFXGE_IP_ALIGN 2
90
91#define SFXGE_ETHERTYPE_LOOPBACK        0x9000  /* Xerox loopback */
92
93enum sfxge_evq_state {
94	SFXGE_EVQ_UNINITIALIZED = 0,
95	SFXGE_EVQ_INITIALIZED,
96	SFXGE_EVQ_STARTING,
97	SFXGE_EVQ_STARTED
98};
99
100#define	SFXGE_EV_BATCH	16384
101
102struct sfxge_evq {
103	struct sfxge_softc	*sc  __aligned(CACHE_LINE_SIZE);
104	struct mtx		lock __aligned(CACHE_LINE_SIZE);
105
106	enum sfxge_evq_state	init_state;
107	unsigned int		index;
108	efsys_mem_t		mem;
109	unsigned int		buf_base_id;
110
111	boolean_t		exception;
112
113	efx_evq_t		*common;
114	unsigned int		read_ptr;
115	unsigned int		rx_done;
116	unsigned int		tx_done;
117
118	/* Linked list of TX queues with completions to process */
119	struct sfxge_txq	*txq;
120	struct sfxge_txq	**txqs;
121};
122
123#define	SFXGE_NEVS	4096
124#define	SFXGE_NDESCS	1024
125#define	SFXGE_MODERATION	30
126
127enum sfxge_intr_state {
128	SFXGE_INTR_UNINITIALIZED = 0,
129	SFXGE_INTR_INITIALIZED,
130	SFXGE_INTR_TESTING,
131	SFXGE_INTR_STARTED
132};
133
134struct sfxge_intr_hdl {
135	int                eih_rid;
136	void               *eih_tag;
137	struct resource    *eih_res;
138};
139
140struct sfxge_intr {
141	enum sfxge_intr_state	state;
142	struct resource		*msix_res;
143	struct sfxge_intr_hdl	*table;
144	int			n_alloc;
145	int			type;
146	efsys_mem_t		status;
147	uint64_t		mask;
148	uint32_t		zero_count;
149};
150
151enum sfxge_mcdi_state {
152	SFXGE_MCDI_UNINITIALIZED = 0,
153	SFXGE_MCDI_INITIALIZED,
154	SFXGE_MCDI_BUSY,
155	SFXGE_MCDI_COMPLETED
156};
157
158struct sfxge_mcdi {
159	struct mtx		lock;
160	struct cv		cv;
161	enum sfxge_mcdi_state	state;
162	efx_mcdi_transport_t	transport;
163};
164
165struct sfxge_hw_stats {
166	clock_t			update_time;
167	efsys_mem_t		dma_buf;
168	void			*decode_buf;
169};
170
171enum sfxge_port_state {
172	SFXGE_PORT_UNINITIALIZED = 0,
173	SFXGE_PORT_INITIALIZED,
174	SFXGE_PORT_STARTED
175};
176
177struct sfxge_port {
178	struct sfxge_softc	*sc;
179	struct mtx		lock;
180	enum sfxge_port_state	init_state;
181#ifndef SFXGE_HAVE_PAUSE_MEDIAOPTS
182	unsigned int		wanted_fc;
183#endif
184	struct sfxge_hw_stats	phy_stats;
185	struct sfxge_hw_stats	mac_stats;
186	efx_link_mode_t		link_mode;
187};
188
189enum sfxge_softc_state {
190	SFXGE_UNINITIALIZED = 0,
191	SFXGE_INITIALIZED,
192	SFXGE_REGISTERED,
193	SFXGE_STARTED
194};
195
196struct sfxge_softc {
197	device_t			dev;
198	struct sx			softc_lock;
199	enum sfxge_softc_state		init_state;
200	struct ifnet                    *ifnet;
201	unsigned int			if_flags;
202	struct sysctl_oid		*stats_node;
203
204	struct task			task_reset;
205
206	efx_family_t			family;
207	caddr_t				vpd_data;
208	size_t				vpd_size;
209	efx_nic_t			*enp;
210	struct mtx			enp_lock;
211
212	bus_dma_tag_t                   parent_dma_tag;
213	efsys_bar_t			bar;
214
215	struct sfxge_intr		intr;
216	struct sfxge_mcdi		mcdi;
217	struct sfxge_port		port;
218	uint32_t			buffer_table_next;
219
220	struct sfxge_evq		*evq[SFXGE_RX_SCALE_MAX];
221	unsigned int			ev_moderation;
222	clock_t				ev_stats_update_time;
223	uint64_t			ev_stats[EV_NQSTATS];
224
225	uma_zone_t			rxq_cache;
226	struct sfxge_rxq		*rxq[SFXGE_RX_SCALE_MAX];
227	unsigned int			rx_indir_table[SFXGE_RX_SCALE_MAX];
228
229#ifdef SFXGE_HAVE_MQ
230	struct sfxge_txq		*txq[SFXGE_TXQ_NTYPES + SFXGE_RX_SCALE_MAX];
231#else
232	struct sfxge_txq		*txq[SFXGE_TXQ_NTYPES];
233#endif
234
235	struct ifmedia			media;
236
237	size_t				rx_prefix_size;
238	size_t				rx_buffer_size;
239	uma_zone_t			rx_buffer_zone;
240
241#ifndef SFXGE_HAVE_MQ
242	struct mtx			tx_lock __aligned(CACHE_LINE_SIZE);
243#endif
244};
245
246#define SFXGE_LINK_UP(sc) ((sc)->port.link_mode != EFX_LINK_DOWN)
247#define SFXGE_RUNNING(sc) ((sc)->ifnet->if_drv_flags & IFF_DRV_RUNNING)
248
249/*
250 * From sfxge.c.
251 */
252extern void sfxge_schedule_reset(struct sfxge_softc *sc);
253extern void sfxge_sram_buf_tbl_alloc(struct sfxge_softc *sc, size_t n,
254				     uint32_t *idp);
255
256/*
257 * From sfxge_dma.c.
258 */
259extern int sfxge_dma_init(struct sfxge_softc *sc);
260extern void sfxge_dma_fini(struct sfxge_softc *sc);
261extern int sfxge_dma_alloc(struct sfxge_softc *sc, bus_size_t len,
262    efsys_mem_t *esmp);
263extern void sfxge_dma_free(efsys_mem_t *esmp);
264extern int sfxge_dma_map_sg_collapse(bus_dma_tag_t tag, bus_dmamap_t map,
265    struct mbuf **mp, bus_dma_segment_t *segs, int *nsegs, int maxsegs);
266
267/*
268 * From sfxge_ev.c.
269 */
270extern int sfxge_ev_init(struct sfxge_softc *sc);
271extern void sfxge_ev_fini(struct sfxge_softc *sc);
272extern int sfxge_ev_start(struct sfxge_softc *sc);
273extern void sfxge_ev_stop(struct sfxge_softc *sc);
274extern int sfxge_ev_qpoll(struct sfxge_softc *sc, unsigned int index);
275
276/*
277 * From sfxge_intr.c.
278 */
279extern int sfxge_intr_init(struct sfxge_softc *sc);
280extern void sfxge_intr_fini(struct sfxge_softc *sc);
281extern int sfxge_intr_start(struct sfxge_softc *sc);
282extern void sfxge_intr_stop(struct sfxge_softc *sc);
283
284/*
285 * From sfxge_mcdi.c.
286 */
287extern int sfxge_mcdi_init(struct sfxge_softc *sc);
288extern void sfxge_mcdi_fini(struct sfxge_softc *sc);
289
290/*
291 * From sfxge_port.c.
292 */
293extern int sfxge_port_init(struct sfxge_softc *sc);
294extern void sfxge_port_fini(struct sfxge_softc *sc);
295extern int sfxge_port_start(struct sfxge_softc *sc);
296extern void sfxge_port_stop(struct sfxge_softc *sc);
297extern void sfxge_mac_link_update(struct sfxge_softc *sc,
298    efx_link_mode_t mode);
299extern int sfxge_mac_filter_set(struct sfxge_softc *sc);
300extern int sfxge_port_ifmedia_init(struct sfxge_softc *sc);
301
302#define SFXGE_MAX_MTU (9 * 1024)
303
304#endif /* _SFXGE_H */
305