netdevice.h 59 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
3
4
5
6
7
8
9
/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Definitions for the Interfaces handler.
 *
 * Version:	@(#)dev.h	1.0.10	08/12/93
 *
10
 * Authors:	Ross Biro
Linus Torvalds's avatar
Linus Torvalds committed
11
12
13
 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 *		Corey Minyard <wf-rch!minyard@relay.EU.net>
 *		Donald J. Becker, <becker@cesdis.gsfc.nasa.gov>
14
 *		Alan Cox, <alan@lxorguk.ukuu.org.uk>
Linus Torvalds's avatar
Linus Torvalds committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 *		Bjorn Ekwall. <bj0rn@blox.se>
 *              Pekka Riikonen <priikone@poseidon.pspt.fi>
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 *
 *		Moved to /usr/include/linux for NET3
 */
#ifndef _LINUX_NETDEVICE_H
#define _LINUX_NETDEVICE_H

#include <linux/if.h>
#include <linux/if_ether.h>
#include <linux/if_packet.h>

#ifdef __KERNEL__
Al Viro's avatar
Al Viro committed
33
#include <linux/timer.h>
34
#include <linux/delay.h>
35
#include <linux/mm.h>
Linus Torvalds's avatar
Linus Torvalds committed
36
37
38
39
40
41
#include <asm/atomic.h>
#include <asm/cache.h>
#include <asm/byteorder.h>

#include <linux/device.h>
#include <linux/percpu.h>
42
#include <linux/rculist.h>
43
#include <linux/dmaengine.h>
44
#include <linux/workqueue.h>
Linus Torvalds's avatar
Linus Torvalds committed
45

46
#include <linux/ethtool.h>
47
#include <net/net_namespace.h>
48
#include <net/dsa.h>
Jeff Kirsher's avatar
Jeff Kirsher committed
49
#ifdef CONFIG_DCB
50
51
#include <net/dcbnl.h>
#endif
52

Linus Torvalds's avatar
Linus Torvalds committed
53
struct vlan_group;
54
struct netpoll_info;
55
56
/* 802.11 specific */
struct wireless_dev;
Linus Torvalds's avatar
Linus Torvalds committed
57
58
59
60
61
62
63
64
65
66
67
68
69
					/* source back-compat hooks */
#define SET_ETHTOOL_OPS(netdev,ops) \
	( (netdev)->ethtool_ops = (ops) )

#define HAVE_ALLOC_NETDEV		/* feature macro: alloc_xxxdev
					   functions are available. */
#define HAVE_FREE_NETDEV		/* free_netdev() */
#define HAVE_NETDEV_PRIV		/* netdev_priv() */

#define NET_XMIT_SUCCESS	0
#define NET_XMIT_DROP		1	/* skb dropped			*/
#define NET_XMIT_CN		2	/* congestion notification	*/
#define NET_XMIT_POLICED	3	/* skb is shot by police	*/
70
#define NET_XMIT_MASK		0xFFFF	/* qdisc flags in net/sch_generic.h */
Linus Torvalds's avatar
Linus Torvalds committed
71
72
73
74
75

/* Backlog congestion levels */
#define NET_RX_SUCCESS		0   /* keep 'em coming, baby */
#define NET_RX_DROP		1  /* packet dropped */

76
77
78
79
/* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
 * indicates that the device will soon be dropping packets, or already drops
 * some packets of the same priority; prompting us to send less aggressively. */
#define net_xmit_eval(e)	((e) == NET_XMIT_CN? 0 : (e))
Linus Torvalds's avatar
Linus Torvalds committed
80
81
#define net_xmit_errno(e)	((e) != NET_XMIT_CN ? -ENOBUFS : 0)

82
83
84
85
86
87
88
89
/* Driver transmit return codes */
enum netdev_tx {
	NETDEV_TX_OK = 0,	/* driver took care of packet */
	NETDEV_TX_BUSY,		/* driver tx path was busy*/
	NETDEV_TX_LOCKED = -1,	/* driver tx lock was already taken */
};
typedef enum netdev_tx netdev_tx_t;

Linus Torvalds's avatar
Linus Torvalds committed
90
91
92
93
#endif

#define MAX_ADDR_LEN	32		/* Largest hardware address length */

94
#ifdef  __KERNEL__
Linus Torvalds's avatar
Linus Torvalds committed
95
96
97
98
/*
 *	Compute the worst case header length according to the protocols
 *	used.
 */
Graf Yang's avatar
Graf Yang committed
99

100
101
102
103
104
105
#if defined(CONFIG_WLAN_80211) || defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
# if defined(CONFIG_MAC80211_MESH)
#  define LL_MAX_HEADER 128
# else
#  define LL_MAX_HEADER 96
# endif
106
#elif defined(CONFIG_TR) || defined(CONFIG_TR_MODULE)
107
# define LL_MAX_HEADER 48
Linus Torvalds's avatar
Linus Torvalds committed
108
#else
109
# define LL_MAX_HEADER 32
Linus Torvalds's avatar
Linus Torvalds committed
110
111
#endif

112
113
114
115
#if !defined(CONFIG_NET_IPIP) && !defined(CONFIG_NET_IPIP_MODULE) && \
    !defined(CONFIG_NET_IPGRE) &&  !defined(CONFIG_NET_IPGRE_MODULE) && \
    !defined(CONFIG_IPV6_SIT) && !defined(CONFIG_IPV6_SIT_MODULE) && \
    !defined(CONFIG_IPV6_TUNNEL) && !defined(CONFIG_IPV6_TUNNEL_MODULE)
Linus Torvalds's avatar
Linus Torvalds committed
116
117
118
119
120
#define MAX_HEADER LL_MAX_HEADER
#else
#define MAX_HEADER (LL_MAX_HEADER + 48)
#endif

121
122
#endif  /*  __KERNEL__  */

Linus Torvalds's avatar
Linus Torvalds committed
123
124
125
126
/*
 *	Network device statistics. Akin to the 2.0 ether stats but
 *	with byte counters.
 */
Graf Yang's avatar
Graf Yang committed
127

Linus Torvalds's avatar
Linus Torvalds committed
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
struct net_device_stats
{
	unsigned long	rx_packets;		/* total packets received	*/
	unsigned long	tx_packets;		/* total packets transmitted	*/
	unsigned long	rx_bytes;		/* total bytes received 	*/
	unsigned long	tx_bytes;		/* total bytes transmitted	*/
	unsigned long	rx_errors;		/* bad packets received		*/
	unsigned long	tx_errors;		/* packet transmit problems	*/
	unsigned long	rx_dropped;		/* no space in linux buffers	*/
	unsigned long	tx_dropped;		/* no space available in linux	*/
	unsigned long	multicast;		/* multicast packets received	*/
	unsigned long	collisions;

	/* detailed rx_errors: */
	unsigned long	rx_length_errors;
	unsigned long	rx_over_errors;		/* receiver ring buff overflow	*/
	unsigned long	rx_crc_errors;		/* recved pkt with crc error	*/
	unsigned long	rx_frame_errors;	/* recv'd frame alignment error */
	unsigned long	rx_fifo_errors;		/* recv'r fifo overrun		*/
	unsigned long	rx_missed_errors;	/* receiver missed packet	*/

	/* detailed tx_errors */
	unsigned long	tx_aborted_errors;
	unsigned long	tx_carrier_errors;
	unsigned long	tx_fifo_errors;
	unsigned long	tx_heartbeat_errors;
	unsigned long	tx_window_errors;
	
	/* for cslip etc */
	unsigned long	rx_compressed;
	unsigned long	tx_compressed;
};


/* Media selection options. */
enum {
        IF_PORT_UNKNOWN = 0,
        IF_PORT_10BASE2,
        IF_PORT_10BASET,
        IF_PORT_AUI,
        IF_PORT_100BASET,
        IF_PORT_100BASETX,
        IF_PORT_100BASEFX
};

#ifdef __KERNEL__

#include <linux/cache.h>
#include <linux/skbuff.h>

struct neighbour;
struct neigh_parms;
struct sk_buff;

struct netif_rx_stats
{
	unsigned total;
	unsigned dropped;
	unsigned time_squeeze;
	unsigned cpu_collision;
};

DECLARE_PER_CPU(struct netif_rx_stats, netdev_rx_stat);

192
193
194
195
196
struct dev_addr_list
{
	struct dev_addr_list	*next;
	u8			da_addr[MAX_ADDR_LEN];
	u8			da_addrlen;
197
	u8			da_synced;
198
199
200
	int			da_users;
	int			da_gusers;
};
Linus Torvalds's avatar
Linus Torvalds committed
201
202
203
204

/*
 *	We tag multicasts with these structures.
 */
205
206
207
208
209
210

#define dev_mc_list	dev_addr_list
#define dmi_addr	da_addr
#define dmi_addrlen	da_addrlen
#define dmi_users	da_users
#define dmi_gusers	da_gusers
Linus Torvalds's avatar
Linus Torvalds committed
211

212
213
214
215
struct netdev_hw_addr {
	struct list_head	list;
	unsigned char		addr[MAX_ADDR_LEN];
	unsigned char		type;
Jiri Pirko's avatar
Jiri Pirko committed
216
217
218
219
220
221
#define NETDEV_HW_ADDR_T_LAN		1
#define NETDEV_HW_ADDR_T_SAN		2
#define NETDEV_HW_ADDR_T_SLAVE		3
#define NETDEV_HW_ADDR_T_UNICAST	4
	int			refcount;
	bool			synced;
222
223
224
	struct rcu_head		rcu_head;
};

225
226
227
228
229
struct netdev_hw_addr_list {
	struct list_head	list;
	int			count;
};

Linus Torvalds's avatar
Linus Torvalds committed
230
231
232
233
struct hh_cache
{
	struct hh_cache *hh_next;	/* Next entry			     */
	atomic_t	hh_refcnt;	/* number of users                   */
234
235
236
237
238
239
240
241
/*
 * We want hh_output, hh_len, hh_lock and hh_data be a in a separate
 * cache line on SMP.
 * They are mostly read, but hh_refcnt may be changed quite frequently,
 * incurring cache line ping pongs.
 */
	__be16		hh_type ____cacheline_aligned_in_smp;
					/* protocol identifier, f.e ETH_P_IP
Linus Torvalds's avatar
Linus Torvalds committed
242
243
244
                                         *  NOTE:  For VLANs, this will be the
                                         *  encapuslated type. --BLG
                                         */
245
	u16		hh_len;		/* length of header */
Linus Torvalds's avatar
Linus Torvalds committed
246
	int		(*hh_output)(struct sk_buff *skb);
247
	seqlock_t	hh_lock;
Linus Torvalds's avatar
Linus Torvalds committed
248
249
250
251

	/* cached hardware header; allow for machine alignment needs.        */
#define HH_DATA_MOD	16
#define HH_DATA_OFF(__len) \
Jiri Benc's avatar
Jiri Benc committed
252
	(HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
Linus Torvalds's avatar
Linus Torvalds committed
253
254
255
256
257
258
259
260
261
262
263
264
#define HH_DATA_ALIGN(__len) \
	(((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
	unsigned long	hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
};

/* Reserve HH_DATA_MOD byte aligned hard_header_len, but at least that much.
 * Alternative is:
 *   dev->hard_header_len ? (dev->hard_header_len +
 *                           (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
 *
 * We could use other alignment values, but we must maintain the
 * relationship HH alignment <= LL alignment.
265
266
267
 *
 * LL_ALLOCATED_SPACE also takes into account the tailroom the device
 * may need.
Linus Torvalds's avatar
Linus Torvalds committed
268
269
 */
#define LL_RESERVED_SPACE(dev) \
270
	((((dev)->hard_header_len+(dev)->needed_headroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
Linus Torvalds's avatar
Linus Torvalds committed
271
#define LL_RESERVED_SPACE_EXTRA(dev,extra) \
272
273
274
	((((dev)->hard_header_len+(dev)->needed_headroom+(extra))&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
#define LL_ALLOCATED_SPACE(dev) \
	((((dev)->hard_header_len+(dev)->needed_headroom+(dev)->needed_tailroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
Linus Torvalds's avatar
Linus Torvalds committed
275

276
277
278
279
280
281
282
283
284
285
286
287
288
struct header_ops {
	int	(*create) (struct sk_buff *skb, struct net_device *dev,
			   unsigned short type, const void *daddr,
			   const void *saddr, unsigned len);
	int	(*parse)(const struct sk_buff *skb, unsigned char *haddr);
	int	(*rebuild)(struct sk_buff *skb);
#define HAVE_HEADER_CACHE
	int	(*cache)(const struct neighbour *neigh, struct hh_cache *hh);
	void	(*cache_update)(struct hh_cache *hh,
				const struct net_device *dev,
				const unsigned char *haddr);
};

Linus Torvalds's avatar
Linus Torvalds committed
289
290
291
292
293
294
295
296
297
298
/* These flag bits are private to the generic network queueing
 * layer, they may not be explicitly referenced by any other
 * code.
 */

enum netdev_state_t
{
	__LINK_STATE_START,
	__LINK_STATE_PRESENT,
	__LINK_STATE_NOCARRIER,
299
300
	__LINK_STATE_LINKWATCH_PENDING,
	__LINK_STATE_DORMANT,
Linus Torvalds's avatar
Linus Torvalds committed
301
302
303
304
305
};


/*
 * This structure holds at boot time configured netdevice settings. They
Graf Yang's avatar
Graf Yang committed
306
 * are then used in the device probing.
Linus Torvalds's avatar
Linus Torvalds committed
307
308
309
310
311
312
313
 */
struct netdev_boot_setup {
	char name[IFNAMSIZ];
	struct ifmap map;
};
#define NETDEV_BOOT_SETUP_MAX 8

314
extern int __init netdev_boot_setup(char *str);
Linus Torvalds's avatar
Linus Torvalds committed
315

316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
/*
 * Structure for NAPI scheduling similar to tasklet but with weighting
 */
struct napi_struct {
	/* The poll_list must only be managed by the entity which
	 * changes the state of the NAPI_STATE_SCHED bit.  This means
	 * whoever atomically sets that bit can add this napi_struct
	 * to the per-cpu poll_list, and whoever clears that bit
	 * can remove from the list right before clearing the bit.
	 */
	struct list_head	poll_list;

	unsigned long		state;
	int			weight;
	int			(*poll)(struct napi_struct *, int);
#ifdef CONFIG_NETPOLL
	spinlock_t		poll_lock;
	int			poll_owner;
#endif
335
336
337

	unsigned int		gro_count;

Herbert Xu's avatar
Herbert Xu committed
338
	struct net_device	*dev;
339
340
	struct list_head	dev_list;
	struct sk_buff		*gro_list;
Herbert Xu's avatar
Herbert Xu committed
341
	struct sk_buff		*skb;
342
343
344
345
346
};

enum
{
	NAPI_STATE_SCHED,	/* Poll is scheduled */
347
	NAPI_STATE_DISABLE,	/* Disable pending */
348
	NAPI_STATE_NPSVC,	/* Netpoll - don't dequeue from poll_list */
349
350
};

351
352
353
354
355
356
357
358
enum {
	GRO_MERGED,
	GRO_MERGED_FREE,
	GRO_HELD,
	GRO_NORMAL,
	GRO_DROP,
};

359
extern void __napi_schedule(struct napi_struct *n);
360

361
362
363
364
365
static inline int napi_disable_pending(struct napi_struct *n)
{
	return test_bit(NAPI_STATE_DISABLE, &n->state);
}

366
367
368
369
370
371
/**
 *	napi_schedule_prep - check if napi can be scheduled
 *	@n: napi context
 *
 * Test if NAPI routine is already running, and if not mark
 * it as running.  This is used as a condition variable
372
373
 * insure only one NAPI poll instance runs.  We also make
 * sure there is no pending NAPI disable.
374
375
376
 */
static inline int napi_schedule_prep(struct napi_struct *n)
{
377
378
	return !napi_disable_pending(n) &&
		!test_and_set_bit(NAPI_STATE_SCHED, &n->state);
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
}

/**
 *	napi_schedule - schedule NAPI poll
 *	@n: napi context
 *
 * Schedule NAPI poll routine to be called if it is not already
 * running.
 */
static inline void napi_schedule(struct napi_struct *n)
{
	if (napi_schedule_prep(n))
		__napi_schedule(n);
}

394
395
396
397
398
399
400
401
402
403
/* Try to reschedule poll. Called by dev->poll() after napi_complete().  */
static inline int napi_reschedule(struct napi_struct *napi)
{
	if (napi_schedule_prep(napi)) {
		__napi_schedule(napi);
		return 1;
	}
	return 0;
}

404
405
406
407
408
409
/**
 *	napi_complete - NAPI processing complete
 *	@n: napi context
 *
 * Mark NAPI processing as complete.
 */
410
411
extern void __napi_complete(struct napi_struct *n);
extern void napi_complete(struct napi_struct *n);
412
413
414
415
416
417
418
419
420
421

/**
 *	napi_disable - prevent NAPI from scheduling
 *	@n: napi context
 *
 * Stop NAPI from being scheduled on this context.
 * Waits till any outstanding processing completes.
 */
static inline void napi_disable(struct napi_struct *n)
{
422
	set_bit(NAPI_STATE_DISABLE, &n->state);
423
	while (test_and_set_bit(NAPI_STATE_SCHED, &n->state))
424
		msleep(1);
425
	clear_bit(NAPI_STATE_DISABLE, &n->state);
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
}

/**
 *	napi_enable - enable NAPI scheduling
 *	@n: napi context
 *
 * Resume NAPI from being scheduled on this context.
 * Must be paired with napi_disable.
 */
static inline void napi_enable(struct napi_struct *n)
{
	BUG_ON(!test_bit(NAPI_STATE_SCHED, &n->state));
	smp_mb__before_clear_bit();
	clear_bit(NAPI_STATE_SCHED, &n->state);
}

442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
#ifdef CONFIG_SMP
/**
 *	napi_synchronize - wait until NAPI is not running
 *	@n: napi context
 *
 * Wait until NAPI is done being scheduled on this context.
 * Waits till any outstanding processing completes but
 * does not disable future activations.
 */
static inline void napi_synchronize(const struct napi_struct *n)
{
	while (test_bit(NAPI_STATE_SCHED, &n->state))
		msleep(1);
}
#else
# define napi_synchronize(n)	barrier()
#endif

460
461
462
enum netdev_queue_state_t
{
	__QUEUE_STATE_XOFF,
463
	__QUEUE_STATE_FROZEN,
464
465
};

466
struct netdev_queue {
467
468
469
/*
 * read mostly part
 */
470
	struct net_device	*dev;
471
	struct Qdisc		*qdisc;
472
	unsigned long		state;
473
	struct Qdisc		*qdisc_sleeping;
474
475
476
477
478
/*
 * write mostly part
 */
	spinlock_t		_xmit_lock ____cacheline_aligned_in_smp;
	int			xmit_lock_owner;
479
480
481
482
	/*
	 * please use this field instead of dev->trans_start
	 */
	unsigned long		trans_start;
483
484
485
	unsigned long		tx_bytes;
	unsigned long		tx_packets;
	unsigned long		tx_dropped;
486
} ____cacheline_aligned_in_smp;
487

488
489
490

/*
 * This structure defines the management hooks for network devices.
491
492
 * The following hooks can be defined; unless noted otherwise, they are
 * optional and can be filled with a null pointer.
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 *
 * int (*ndo_init)(struct net_device *dev);
 *     This function is called once when network device is registered.
 *     The network device can use this to any late stage initializaton
 *     or semantic validattion. It can fail with an error code which will
 *     be propogated back to register_netdev
 *
 * void (*ndo_uninit)(struct net_device *dev);
 *     This function is called when device is unregistered or when registration
 *     fails. It is not called if init fails.
 *
 * int (*ndo_open)(struct net_device *dev);
 *     This function is called when network device transistions to the up
 *     state.
 *
 * int (*ndo_stop)(struct net_device *dev);
 *     This function is called when network device transistions to the down
 *     state.
 *
512
513
 * netdev_tx_t (*ndo_start_xmit)(struct sk_buff *skb,
 *                               struct net_device *dev);
514
 *	Called when a packet needs to be transmitted.
515
516
 *	Must return NETDEV_TX_OK , NETDEV_TX_BUSY.
 *        (can also return NETDEV_TX_LOCKED iff NETIF_F_LLTX)
517
518
519
520
521
522
 *	Required can not be NULL.
 *
 * u16 (*ndo_select_queue)(struct net_device *dev, struct sk_buff *skb);
 *	Called to decide which queue to when device supports multiple
 *	transmit queues.
 *
523
524
525
526
527
528
529
530
531
532
533
534
 * void (*ndo_change_rx_flags)(struct net_device *dev, int flags);
 *	This function is called to allow device receiver to make
 *	changes to configuration when multicast or promiscious is enabled.
 *
 * void (*ndo_set_rx_mode)(struct net_device *dev);
 *	This function is called device changes address list filtering.
 *
 * void (*ndo_set_multicast_list)(struct net_device *dev);
 *	This function is called when the multicast address list changes.
 *
 * int (*ndo_set_mac_address)(struct net_device *dev, void *addr);
 *	This function  is called when the Media Access Control address
535
 *	needs to be changed. If this interface is not defined, the
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 *	mac address can not be changed.
 *
 * int (*ndo_validate_addr)(struct net_device *dev);
 *	Test if Media Access Control address is valid for the device.
 *
 * int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);
 *	Called when a user request an ioctl which can't be handled by
 *	the generic interface code. If not defined ioctl's return
 *	not supported error code.
 *
 * int (*ndo_set_config)(struct net_device *dev, struct ifmap *map);
 *	Used to set network devices bus interface parameters. This interface
 *	is retained for legacy reason, new devices should use the bus
 *	interface (PCI) for low level management.
 *
 * int (*ndo_change_mtu)(struct net_device *dev, int new_mtu);
 *	Called when a user wants to change the Maximum Transfer Unit
 *	of a device. If not defined, any request to change MTU will
 *	will return an error.
 *
556
 * void (*ndo_tx_timeout)(struct net_device *dev);
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 *	Callback uses when the transmitter has not made any progress
 *	for dev->watchdog ticks.
 *
 * struct net_device_stats* (*get_stats)(struct net_device *dev);
 *	Called when a user wants to get the network device usage
 *	statistics. If not defined, the counters in dev->stats will
 *	be used.
 *
 * void (*ndo_vlan_rx_register)(struct net_device *dev, struct vlan_group *grp);
 *	If device support VLAN receive accleration
 *	(ie. dev->features & NETIF_F_HW_VLAN_RX), then this function is called
 *	when vlan groups for the device changes.  Note: grp is NULL
 *	if no vlan's groups are being used.
 *
 * void (*ndo_vlan_rx_add_vid)(struct net_device *dev, unsigned short vid);
 *	If device support VLAN filtering (dev->features & NETIF_F_HW_VLAN_FILTER)
 *	this function is called when a VLAN id is registered.
 *
 * void (*ndo_vlan_rx_kill_vid)(struct net_device *dev, unsigned short vid);
 *	If device support VLAN filtering (dev->features & NETIF_F_HW_VLAN_FILTER)
 *	this function is called when a VLAN id is unregistered.
 *
 * void (*ndo_poll_controller)(struct net_device *dev);
 */
581
#define HAVE_NET_DEVICE_OPS
582
583
584
585
586
struct net_device_ops {
	int			(*ndo_init)(struct net_device *dev);
	void			(*ndo_uninit)(struct net_device *dev);
	int			(*ndo_open)(struct net_device *dev);
	int			(*ndo_stop)(struct net_device *dev);
587
	netdev_tx_t		(*ndo_start_xmit) (struct sk_buff *skb,
588
589
590
						   struct net_device *dev);
	u16			(*ndo_select_queue)(struct net_device *dev,
						    struct sk_buff *skb);
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
#define HAVE_CHANGE_RX_FLAGS
	void			(*ndo_change_rx_flags)(struct net_device *dev,
						       int flags);
#define HAVE_SET_RX_MODE
	void			(*ndo_set_rx_mode)(struct net_device *dev);
#define HAVE_MULTICAST
	void			(*ndo_set_multicast_list)(struct net_device *dev);
#define HAVE_SET_MAC_ADDR
	int			(*ndo_set_mac_address)(struct net_device *dev,
						       void *addr);
#define HAVE_VALIDATE_ADDR
	int			(*ndo_validate_addr)(struct net_device *dev);
#define HAVE_PRIVATE_IOCTL
	int			(*ndo_do_ioctl)(struct net_device *dev,
					        struct ifreq *ifr, int cmd);
#define HAVE_SET_CONFIG
	int			(*ndo_set_config)(struct net_device *dev,
					          struct ifmap *map);
#define HAVE_CHANGE_MTU
610
611
612
613
	int			(*ndo_change_mtu)(struct net_device *dev,
						  int new_mtu);
	int			(*ndo_neigh_setup)(struct net_device *dev,
						   struct neigh_parms *);
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
#define HAVE_TX_TIMEOUT
	void			(*ndo_tx_timeout) (struct net_device *dev);

	struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);

	void			(*ndo_vlan_rx_register)(struct net_device *dev,
						        struct vlan_group *grp);
	void			(*ndo_vlan_rx_add_vid)(struct net_device *dev,
						       unsigned short vid);
	void			(*ndo_vlan_rx_kill_vid)(struct net_device *dev,
						        unsigned short vid);
#ifdef CONFIG_NET_POLL_CONTROLLER
#define HAVE_NETDEV_POLL
	void                    (*ndo_poll_controller)(struct net_device *dev);
#endif
629
630
631
632
633
634
635
636
#if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
	int			(*ndo_fcoe_ddp_setup)(struct net_device *dev,
						      u16 xid,
						      struct scatterlist *sgl,
						      unsigned int sgc);
	int			(*ndo_fcoe_ddp_done)(struct net_device *dev,
						     u16 xid);
#endif
637
638
};

Linus Torvalds's avatar
Linus Torvalds committed
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
/*
 *	The DEVICE structure.
 *	Actually, this whole structure is a big mistake.  It mixes I/O
 *	data with strictly "high-level" data, and it has to know about
 *	almost every data structure used in the INET module.
 *
 *	FIXME: cleanup struct net_device such that network protocol info
 *	moves out.
 */

struct net_device
{

	/*
	 * This is the first field of the "visible" part of this structure
	 * (i.e. as seen by users in the "Space.c" file).  It is the name
	 * the interface.
	 */
	char			name[IFNAMSIZ];
658
659
	/* device name hash chain */
	struct hlist_node	name_hlist;
660
661
	/* snmp alias */
	char 			*ifalias;
Linus Torvalds's avatar
Linus Torvalds committed
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681

	/*
	 *	I/O specific fields
	 *	FIXME: Merge these and struct ifmap into one
	 */
	unsigned long		mem_end;	/* shared mem end	*/
	unsigned long		mem_start;	/* shared mem start	*/
	unsigned long		base_addr;	/* device I/O address	*/
	unsigned int		irq;		/* device IRQ number	*/

	/*
	 *	Some hardware also needs these fields, but they are not
	 *	part of the usual set specified in Space.c.
	 */

	unsigned char		if_port;	/* Selectable AUI, TP,..*/
	unsigned char		dma;		/* DMA channel		*/

	unsigned long		state;

682
	struct list_head	dev_list;
683
	struct list_head	napi_list;
Linus Torvalds's avatar
Linus Torvalds committed
684

685
686
687
	/* Net device features */
	unsigned long		features;
#define NETIF_F_SG		1	/* Scatter/gather IO. */
688
#define NETIF_F_IP_CSUM		2	/* Can checksum TCP/UDP over IPv4. */
689
690
#define NETIF_F_NO_CSUM		4	/* Does not require checksum. F.e. loopack. */
#define NETIF_F_HW_CSUM		8	/* Can checksum all the packets. */
691
#define NETIF_F_IPV6_CSUM	16	/* Can checksum TCP/UDP over IPV6 */
692
693
694
695
696
697
#define NETIF_F_HIGHDMA		32	/* Can DMA to high memory. */
#define NETIF_F_FRAGLIST	64	/* Scatter/gather IO. */
#define NETIF_F_HW_VLAN_TX	128	/* Transmit VLAN hw acceleration */
#define NETIF_F_HW_VLAN_RX	256	/* Receive VLAN hw acceleration */
#define NETIF_F_HW_VLAN_FILTER	512	/* Receive filtering on VLAN */
#define NETIF_F_VLAN_CHALLENGED	1024	/* Device cannot handle VLAN packets */
Herbert Xu's avatar
Herbert Xu committed
698
#define NETIF_F_GSO		2048	/* Enable software GSO. */
699
700
#define NETIF_F_LLTX		4096	/* LockLess TX - deprecated. Please */
					/* do not use LLTX in new drivers */
701
#define NETIF_F_NETNS_LOCAL	8192	/* Does not change network namespaces */
702
#define NETIF_F_GRO		16384	/* Generic receive offload */
703
#define NETIF_F_LRO		32768	/* large receive offload */
704

705
/* the GSO_MASK reserves bits 16 through 23 */
706
#define NETIF_F_FCOE_CRC	(1 << 24) /* FCoE CRC32 */
707
#define NETIF_F_SCTP_CSUM	(1 << 25) /* SCTP checksum offload */
708
#define NETIF_F_FCOE_MTU	(1 << 26) /* Supports max FCoE MTU, 2158 bytes*/
709

710
	/* Segmentation offload features */
711
#define NETIF_F_GSO_SHIFT	16
712
#define NETIF_F_GSO_MASK	0x00ff0000
713
#define NETIF_F_TSO		(SKB_GSO_TCPV4 << NETIF_F_GSO_SHIFT)
714
#define NETIF_F_UFO		(SKB_GSO_UDP << NETIF_F_GSO_SHIFT)
715
#define NETIF_F_GSO_ROBUST	(SKB_GSO_DODGY << NETIF_F_GSO_SHIFT)
716
717
#define NETIF_F_TSO_ECN		(SKB_GSO_TCP_ECN << NETIF_F_GSO_SHIFT)
#define NETIF_F_TSO6		(SKB_GSO_TCPV6 << NETIF_F_GSO_SHIFT)
718
#define NETIF_F_FSO		(SKB_GSO_FCOE << NETIF_F_GSO_SHIFT)
719

720
721
722
	/* List of features with software fallbacks. */
#define NETIF_F_GSO_SOFTWARE	(NETIF_F_TSO | NETIF_F_TSO_ECN | NETIF_F_TSO6)

723

724
#define NETIF_F_GEN_CSUM	(NETIF_F_NO_CSUM | NETIF_F_HW_CSUM)
725
726
727
#define NETIF_F_V4_CSUM		(NETIF_F_GEN_CSUM | NETIF_F_IP_CSUM)
#define NETIF_F_V6_CSUM		(NETIF_F_GEN_CSUM | NETIF_F_IPV6_CSUM)
#define NETIF_F_ALL_CSUM	(NETIF_F_V4_CSUM | NETIF_F_V6_CSUM)
728

729
730
731
732
733
	/*
	 * If one device supports one of these features, then enable them
	 * for all in netdev_increment_features.
	 */
#define NETIF_F_ONE_FOR_ALL	(NETIF_F_GSO_SOFTWARE | NETIF_F_GSO_ROBUST | \
734
				 NETIF_F_SG | NETIF_F_HIGHDMA |		\
735
736
				 NETIF_F_FRAGLIST)

Linus Torvalds's avatar
Linus Torvalds committed
737
738
739
740
	/* Interface index. Unique device identifier	*/
	int			ifindex;
	int			iflink;

Rusty Russell's avatar
Rusty Russell committed
741
	struct net_device_stats	stats;
Linus Torvalds's avatar
Linus Torvalds committed
742

743
#ifdef CONFIG_WIRELESS_EXT
Linus Torvalds's avatar
Linus Torvalds committed
744
745
746
747
748
	/* List of functions to handle Wireless Extensions (instead of ioctl).
	 * See <net/iw_handler.h> for details. Jean II */
	const struct iw_handler_def *	wireless_handlers;
	/* Instance data managed by the core of Wireless Extensions. */
	struct iw_public_data *	wireless_data;
749
#endif
750
751
	/* Management operations */
	const struct net_device_ops *netdev_ops;
752
	const struct ethtool_ops *ethtool_ops;
Linus Torvalds's avatar
Linus Torvalds committed
753

754
755
756
	/* Hardware header description */
	const struct header_ops *header_ops;

757
	unsigned int		flags;	/* interface flags (a la BSD)	*/
Linus Torvalds's avatar
Linus Torvalds committed
758
759
760
761
	unsigned short		gflags;
        unsigned short          priv_flags; /* Like 'flags' but invisible to userspace. */
	unsigned short		padded;	/* How much padding added by alloc_netdev() */

762
763
764
	unsigned char		operstate; /* RFC2863 operstate */
	unsigned char		link_mode; /* mapping policy to operstate */

Linus Torvalds's avatar
Linus Torvalds committed
765
766
767
768
	unsigned		mtu;	/* interface MTU value		*/
	unsigned short		type;	/* interface hardware type	*/
	unsigned short		hard_header_len;	/* hardware hdr length	*/

769
770
771
772
773
774
775
	/* extra head- and tailroom the hardware may need, but not in all cases
	 * can this be guaranteed, especially tailroom. Some cases also use
	 * LL_MAX_HEADER instead to allocate the skb.
	 */
	unsigned short		needed_headroom;
	unsigned short		needed_tailroom;

Linus Torvalds's avatar
Linus Torvalds committed
776
777
778
779
780
	struct net_device	*master; /* Pointer to master device of a group,
					  * which this device is member of.
					  */

	/* Interface address info. */
781
	unsigned char		perm_addr[MAX_ADDR_LEN]; /* permanent hw address */
Linus Torvalds's avatar
Linus Torvalds committed
782
783
784
	unsigned char		addr_len;	/* hardware address length	*/
	unsigned short          dev_id;		/* for shared network cards */

785
786
	struct netdev_hw_addr_list	uc;	/* Secondary unicast
						   mac addresses */
787
	int			uc_promisc;
Jiri Pirko's avatar
Jiri Pirko committed
788
	spinlock_t		addr_list_lock;
789
	struct dev_addr_list	*mc_list;	/* Multicast mac addresses	*/
Linus Torvalds's avatar
Linus Torvalds committed
790
	int			mc_count;	/* Number of installed mcasts	*/
791
792
	unsigned int		promiscuity;
	unsigned int		allmulti;
Linus Torvalds's avatar
Linus Torvalds committed
793
794
795
796


	/* Protocol specific pointers */
	
797
798
799
#ifdef CONFIG_NET_DSA
	void			*dsa_ptr;	/* dsa specific data */
#endif
Linus Torvalds's avatar
Linus Torvalds committed
800
	void 			*atalk_ptr;	/* AppleTalk link 	*/
Graf Yang's avatar
Graf Yang committed
801
	void			*ip_ptr;	/* IPv4 specific data	*/
Linus Torvalds's avatar
Linus Torvalds committed
802
803
804
805
	void                    *dn_ptr;        /* DECnet specific data */
	void                    *ip6_ptr;       /* IPv6 specific data */
	void			*ec_ptr;	/* Econet specific data	*/
	void			*ax25_ptr;	/* AX.25 specific data */
806
807
	struct wireless_dev	*ieee80211_ptr;	/* IEEE 802.11 specific data,
						   assign before registering */
Linus Torvalds's avatar
Linus Torvalds committed
808

809
810
811
812
813
/*
 * Cache line mostly used on receive path (including eth_type_trans())
 */
	unsigned long		last_rx;	/* Time of last Rx	*/
	/* Interface address info used in eth_type_trans() */
814
815
816
817
	unsigned char		*dev_addr;	/* hw address, (before bcast
						   because most packets are
						   unicast) */

818
819
	struct netdev_hw_addr_list	dev_addrs; /* list of device
						      hw addresses */
820
821

	unsigned char		broadcast[MAX_ADDR_LEN];	/* hw bcast add	*/
Linus Torvalds's avatar
Linus Torvalds committed
822

823
	struct netdev_queue	rx_queue;
824
825

	struct netdev_queue	*_tx ____cacheline_aligned_in_smp;
826
827

	/* Number of TX queues allocated at alloc_netdev_mq() time  */
828
	unsigned int		num_tx_queues;
829
830
831
832

	/* Number of TX queues currently active in device  */
	unsigned int		real_num_tx_queues;

Linus Torvalds's avatar
Linus Torvalds committed
833
	unsigned long		tx_queue_len;	/* Max frames per queue allowed */
834
	spinlock_t		tx_global_lock;
835
836
837
838
/*
 * One part is mostly used on xmit path (device)
 */
	/* These may be needed for future network-power-down code. */
839
840
841
842
843

	/*
	 * trans_start here is expensive for high speed devices on SMP,
	 * please use netdev_queue->trans_start instead.
	 */
844
845
846
847
848
	unsigned long		trans_start;	/* Time (in jiffies) of last Tx	*/

	int			watchdog_timeo; /* used by dev_watchdog() */
	struct timer_list	watchdog_timer;

Linus Torvalds's avatar
Linus Torvalds committed
849
	/* Number of references to this device */
850
851
	atomic_t		refcnt ____cacheline_aligned_in_smp;

Linus Torvalds's avatar
Linus Torvalds committed
852
853
854
855
856
	/* delayed register/unregister */
	struct list_head	todo_list;
	/* device index hash chain */
	struct hlist_node	index_hlist;

857
858
	struct net_device	*link_watch_next;

Linus Torvalds's avatar
Linus Torvalds committed
859
860
	/* register/unregister state machine */
	enum { NETREG_UNINITIALIZED=0,
861
	       NETREG_REGISTERED,	/* completed register_netdevice */
Linus Torvalds's avatar
Linus Torvalds committed
862
863
864
	       NETREG_UNREGISTERING,	/* called unregister_netdevice */
	       NETREG_UNREGISTERED,	/* completed unregister todo */
	       NETREG_RELEASED,		/* called free_netdev */
865
	       NETREG_DUMMY,		/* dummy device for NAPI poll */
Linus Torvalds's avatar
Linus Torvalds committed
866
867
	} reg_state;

868
869
	/* Called from unregister, can be used to call free_netdev */
	void (*destructor)(struct net_device *dev);
Linus Torvalds's avatar
Linus Torvalds committed
870
871

#ifdef CONFIG_NETPOLL
872
	struct netpoll_info	*npinfo;
Linus Torvalds's avatar
Linus Torvalds committed
873
#endif
874

875
#ifdef CONFIG_NET_NS
876
877
	/* Network namespace this network device is inside */
	struct net		*nd_net;
878
#endif
879

David S. Miller's avatar
David S. Miller committed
880
881
882
	/* mid-layer private */
	void			*ml_priv;

Linus Torvalds's avatar
Linus Torvalds committed
883
884
	/* bridge stuff */
	struct net_bridge_port	*br_port;
Patrick McHardy's avatar
Patrick McHardy committed
885
886
	/* macvlan */
	struct macvlan_port	*macvlan_port;
887
888
	/* GARP */
	struct garp_port	*garp_port;
Linus Torvalds's avatar
Linus Torvalds committed
889
890

	/* class/net/name entry */
891
	struct device		dev;
892
893
	/* space for optional statistics and wireless sysfs groups */
	struct attribute_group  *sysfs_groups[3];
894
895
896

	/* rtnetlink link ops */
	const struct rtnl_link_ops *rtnl_link_ops;
897

898
899
900
	/* VLAN feature mask */
	unsigned long vlan_features;

901
902
903
	/* for setting kernel sock attribute on TCP connection setup */
#define GSO_MAX_SIZE		65536
	unsigned int		gso_max_size;
904

Jeff Kirsher's avatar
Jeff Kirsher committed
905
#ifdef CONFIG_DCB
906
907
908
909
	/* Data Center Bridging netlink ops */
	struct dcbnl_rtnl_ops *dcbnl_ops;
#endif

910
911
912
913
#if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
	/* max exchange id for FCoE LRO by ddp */
	unsigned int		fcoe_ddp_xid;
#endif
Linus Torvalds's avatar
Linus Torvalds committed
914
};
915
#define to_net_dev(d) container_of(d, struct net_device, dev)
Linus Torvalds's avatar
Linus Torvalds committed
916
917
918

#define	NETDEV_ALIGN		32

919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
static inline
struct netdev_queue *netdev_get_tx_queue(const struct net_device *dev,
					 unsigned int index)
{
	return &dev->_tx[index];
}

static inline void netdev_for_each_tx_queue(struct net_device *dev,
					    void (*f)(struct net_device *,
						      struct netdev_queue *,
						      void *),
					    void *arg)
{
	unsigned int i;

	for (i = 0; i < dev->num_tx_queues; i++)
		f(dev, &dev->_tx[i], arg);
}

938
939
940
941
942
943
944
945
946
947
948
949
950
951
/*
 * Net namespace inlines
 */
static inline
struct net *dev_net(const struct net_device *dev)
{
#ifdef CONFIG_NET_NS
	return dev->nd_net;
#else
	return &init_net;
#endif
}

static inline
952
void dev_net_set(struct net_device *dev, struct net *net)
953
954
{
#ifdef CONFIG_NET_NS
955
956
	release_net(dev->nd_net);
	dev->nd_net = hold_net(net);
957
958
959
#endif
}

960
961
962
963
964
965
966
967
968
969
static inline bool netdev_uses_dsa_tags(struct net_device *dev)
{
#ifdef CONFIG_NET_DSA_TAG_DSA
	if (dev->dsa_ptr != NULL)
		return dsa_uses_dsa_tags(dev->dsa_ptr);
#endif

	return 0;
}

970
971
972
973
974
975
976
977
978
979
static inline bool netdev_uses_trailer_tags(struct net_device *dev)
{
#ifdef CONFIG_NET_DSA_TAG_TRAILER
	if (dev->dsa_ptr != NULL)
		return dsa_uses_trailer_tags(dev->dsa_ptr);
#endif

	return 0;
}

980
981
982
983
984
985
/**
 *	netdev_priv - access network device private data
 *	@dev: network device
 *
 * Get network device private data
 */
986
static inline void *netdev_priv(const struct net_device *dev)
Linus Torvalds's avatar
Linus Torvalds committed
987
{
988
	return (char *)dev + ALIGN(sizeof(struct net_device), NETDEV_ALIGN);
Linus Torvalds's avatar
Linus Torvalds committed
989
990
991
992
993
}

/* Set the sysfs physical device reference for the network logical device
 * if set prior to registration will cause a symlink during initialization.
 */
994
#define SET_NETDEV_DEV(net, pdev)	((net)->dev.parent = (pdev))
Linus Torvalds's avatar
Linus Torvalds committed
995

996
997
998
999
1000
/**
 *	netif_napi_add - initialize a napi context
 *	@dev:  network device
 *	@napi: napi context
 *	@poll: polling function