xref: /linux-6.15/include/linux/netdevice.h (revision de2fe5e0)
1 /*
2  * INET		An implementation of the TCP/IP protocol suite for the LINUX
3  *		operating system.  INET is implemented using the  BSD Socket
4  *		interface as the means of communication with the user level.
5  *
6  *		Definitions for the Interfaces handler.
7  *
8  * Version:	@(#)dev.h	1.0.10	08/12/93
9  *
10  * Authors:	Ross Biro
11  *		Fred N. van Kempen, <[email protected]>
12  *		Corey Minyard <[email protected]>
13  *		Donald J. Becker, <[email protected]>
14  *		Alan Cox, <[email protected]>
15  *		Bjorn Ekwall. <[email protected]>
16  *              Pekka Riikonen <[email protected]>
17  *
18  *		This program is free software; you can redistribute it and/or
19  *		modify it under the terms of the GNU General Public License
20  *		as published by the Free Software Foundation; either version
21  *		2 of the License, or (at your option) any later version.
22  *
23  *		Moved to /usr/include/linux for NET3
24  */
25 #ifndef _LINUX_NETDEVICE_H
26 #define _LINUX_NETDEVICE_H
27 
28 #include <linux/if.h>
29 #include <linux/if_ether.h>
30 #include <linux/if_packet.h>
31 
32 #ifdef __KERNEL__
33 #include <asm/atomic.h>
34 #include <asm/cache.h>
35 #include <asm/byteorder.h>
36 
37 #include <linux/config.h>
38 #include <linux/device.h>
39 #include <linux/percpu.h>
40 
41 struct divert_blk;
42 struct vlan_group;
43 struct ethtool_ops;
44 struct netpoll_info;
45 					/* source back-compat hooks */
46 #define SET_ETHTOOL_OPS(netdev,ops) \
47 	( (netdev)->ethtool_ops = (ops) )
48 
49 #define HAVE_ALLOC_NETDEV		/* feature macro: alloc_xxxdev
50 					   functions are available. */
51 #define HAVE_FREE_NETDEV		/* free_netdev() */
52 #define HAVE_NETDEV_PRIV		/* netdev_priv() */
53 
54 #define NET_XMIT_SUCCESS	0
55 #define NET_XMIT_DROP		1	/* skb dropped			*/
56 #define NET_XMIT_CN		2	/* congestion notification	*/
57 #define NET_XMIT_POLICED	3	/* skb is shot by police	*/
58 #define NET_XMIT_BYPASS		4	/* packet does not leave via dequeue;
59 					   (TC use only - dev_queue_xmit
60 					   returns this as NET_XMIT_SUCCESS) */
61 
62 /* Backlog congestion levels */
63 #define NET_RX_SUCCESS		0   /* keep 'em coming, baby */
64 #define NET_RX_DROP		1  /* packet dropped */
65 #define NET_RX_CN_LOW		2   /* storm alert, just in case */
66 #define NET_RX_CN_MOD		3   /* Storm on its way! */
67 #define NET_RX_CN_HIGH		4   /* The storm is here */
68 #define NET_RX_BAD		5  /* packet dropped due to kernel error */
69 
70 #define net_xmit_errno(e)	((e) != NET_XMIT_CN ? -ENOBUFS : 0)
71 
72 #endif
73 
74 #define MAX_ADDR_LEN	32		/* Largest hardware address length */
75 
76 /* Driver transmit return codes */
77 #define NETDEV_TX_OK 0		/* driver took care of packet */
78 #define NETDEV_TX_BUSY 1	/* driver tx path was busy*/
79 #define NETDEV_TX_LOCKED -1	/* driver tx lock was already taken */
80 
81 /*
82  *	Compute the worst case header length according to the protocols
83  *	used.
84  */
85 
86 #if !defined(CONFIG_AX25) && !defined(CONFIG_AX25_MODULE) && !defined(CONFIG_TR)
87 #define LL_MAX_HEADER	32
88 #else
89 #if defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
90 #define LL_MAX_HEADER	96
91 #else
92 #define LL_MAX_HEADER	48
93 #endif
94 #endif
95 
96 #if !defined(CONFIG_NET_IPIP) && \
97     !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE)
98 #define MAX_HEADER LL_MAX_HEADER
99 #else
100 #define MAX_HEADER (LL_MAX_HEADER + 48)
101 #endif
102 
103 /*
104  *	Network device statistics. Akin to the 2.0 ether stats but
105  *	with byte counters.
106  */
107 
108 struct net_device_stats
109 {
110 	unsigned long	rx_packets;		/* total packets received	*/
111 	unsigned long	tx_packets;		/* total packets transmitted	*/
112 	unsigned long	rx_bytes;		/* total bytes received 	*/
113 	unsigned long	tx_bytes;		/* total bytes transmitted	*/
114 	unsigned long	rx_errors;		/* bad packets received		*/
115 	unsigned long	tx_errors;		/* packet transmit problems	*/
116 	unsigned long	rx_dropped;		/* no space in linux buffers	*/
117 	unsigned long	tx_dropped;		/* no space available in linux	*/
118 	unsigned long	multicast;		/* multicast packets received	*/
119 	unsigned long	collisions;
120 
121 	/* detailed rx_errors: */
122 	unsigned long	rx_length_errors;
123 	unsigned long	rx_over_errors;		/* receiver ring buff overflow	*/
124 	unsigned long	rx_crc_errors;		/* recved pkt with crc error	*/
125 	unsigned long	rx_frame_errors;	/* recv'd frame alignment error */
126 	unsigned long	rx_fifo_errors;		/* recv'r fifo overrun		*/
127 	unsigned long	rx_missed_errors;	/* receiver missed packet	*/
128 
129 	/* detailed tx_errors */
130 	unsigned long	tx_aborted_errors;
131 	unsigned long	tx_carrier_errors;
132 	unsigned long	tx_fifo_errors;
133 	unsigned long	tx_heartbeat_errors;
134 	unsigned long	tx_window_errors;
135 
136 	/* for cslip etc */
137 	unsigned long	rx_compressed;
138 	unsigned long	tx_compressed;
139 };
140 
141 
142 /* Media selection options. */
143 enum {
144         IF_PORT_UNKNOWN = 0,
145         IF_PORT_10BASE2,
146         IF_PORT_10BASET,
147         IF_PORT_AUI,
148         IF_PORT_100BASET,
149         IF_PORT_100BASETX,
150         IF_PORT_100BASEFX
151 };
152 
153 #ifdef __KERNEL__
154 
155 #include <linux/cache.h>
156 #include <linux/skbuff.h>
157 
158 struct neighbour;
159 struct neigh_parms;
160 struct sk_buff;
161 
162 struct netif_rx_stats
163 {
164 	unsigned total;
165 	unsigned dropped;
166 	unsigned time_squeeze;
167 	unsigned cpu_collision;
168 };
169 
170 DECLARE_PER_CPU(struct netif_rx_stats, netdev_rx_stat);
171 
172 
173 /*
174  *	We tag multicasts with these structures.
175  */
176 
177 struct dev_mc_list
178 {
179 	struct dev_mc_list	*next;
180 	__u8			dmi_addr[MAX_ADDR_LEN];
181 	unsigned char		dmi_addrlen;
182 	int			dmi_users;
183 	int			dmi_gusers;
184 };
185 
186 struct hh_cache
187 {
188 	struct hh_cache *hh_next;	/* Next entry			     */
189 	atomic_t	hh_refcnt;	/* number of users                   */
190 	unsigned short  hh_type;	/* protocol identifier, f.e ETH_P_IP
191                                          *  NOTE:  For VLANs, this will be the
192                                          *  encapuslated type. --BLG
193                                          */
194 	int		hh_len;		/* length of header */
195 	int		(*hh_output)(struct sk_buff *skb);
196 	rwlock_t	hh_lock;
197 
198 	/* cached hardware header; allow for machine alignment needs.        */
199 #define HH_DATA_MOD	16
200 #define HH_DATA_OFF(__len) \
201 	(HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
202 #define HH_DATA_ALIGN(__len) \
203 	(((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
204 	unsigned long	hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
205 };
206 
207 /* Reserve HH_DATA_MOD byte aligned hard_header_len, but at least that much.
208  * Alternative is:
209  *   dev->hard_header_len ? (dev->hard_header_len +
210  *                           (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
211  *
212  * We could use other alignment values, but we must maintain the
213  * relationship HH alignment <= LL alignment.
214  */
215 #define LL_RESERVED_SPACE(dev) \
216 	(((dev)->hard_header_len&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
217 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
218 	((((dev)->hard_header_len+extra)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
219 
220 /* These flag bits are private to the generic network queueing
221  * layer, they may not be explicitly referenced by any other
222  * code.
223  */
224 
225 enum netdev_state_t
226 {
227 	__LINK_STATE_XOFF=0,
228 	__LINK_STATE_START,
229 	__LINK_STATE_PRESENT,
230 	__LINK_STATE_SCHED,
231 	__LINK_STATE_NOCARRIER,
232 	__LINK_STATE_RX_SCHED,
233 	__LINK_STATE_LINKWATCH_PENDING,
234 	__LINK_STATE_DORMANT,
235 };
236 
237 
238 /*
239  * This structure holds at boot time configured netdevice settings. They
240  * are then used in the device probing.
241  */
242 struct netdev_boot_setup {
243 	char name[IFNAMSIZ];
244 	struct ifmap map;
245 };
246 #define NETDEV_BOOT_SETUP_MAX 8
247 
248 extern int __init netdev_boot_setup(char *str);
249 
250 /*
251  *	The DEVICE structure.
252  *	Actually, this whole structure is a big mistake.  It mixes I/O
253  *	data with strictly "high-level" data, and it has to know about
254  *	almost every data structure used in the INET module.
255  *
256  *	FIXME: cleanup struct net_device such that network protocol info
257  *	moves out.
258  */
259 
260 struct net_device
261 {
262 
263 	/*
264 	 * This is the first field of the "visible" part of this structure
265 	 * (i.e. as seen by users in the "Space.c" file).  It is the name
266 	 * the interface.
267 	 */
268 	char			name[IFNAMSIZ];
269 	/* device name hash chain */
270 	struct hlist_node	name_hlist;
271 
272 	/*
273 	 *	I/O specific fields
274 	 *	FIXME: Merge these and struct ifmap into one
275 	 */
276 	unsigned long		mem_end;	/* shared mem end	*/
277 	unsigned long		mem_start;	/* shared mem start	*/
278 	unsigned long		base_addr;	/* device I/O address	*/
279 	unsigned int		irq;		/* device IRQ number	*/
280 
281 	/*
282 	 *	Some hardware also needs these fields, but they are not
283 	 *	part of the usual set specified in Space.c.
284 	 */
285 
286 	unsigned char		if_port;	/* Selectable AUI, TP,..*/
287 	unsigned char		dma;		/* DMA channel		*/
288 
289 	unsigned long		state;
290 
291 	struct net_device	*next;
292 
293 	/* The device initialization function. Called only once. */
294 	int			(*init)(struct net_device *dev);
295 
296 	/* ------- Fields preinitialized in Space.c finish here ------- */
297 
298 	/* Net device features */
299 	unsigned long		features;
300 #define NETIF_F_SG		1	/* Scatter/gather IO. */
301 #define NETIF_F_IP_CSUM		2	/* Can checksum only TCP/UDP over IPv4. */
302 #define NETIF_F_NO_CSUM		4	/* Does not require checksum. F.e. loopack. */
303 #define NETIF_F_HW_CSUM		8	/* Can checksum all the packets. */
304 #define NETIF_F_HIGHDMA		32	/* Can DMA to high memory. */
305 #define NETIF_F_FRAGLIST	64	/* Scatter/gather IO. */
306 #define NETIF_F_HW_VLAN_TX	128	/* Transmit VLAN hw acceleration */
307 #define NETIF_F_HW_VLAN_RX	256	/* Receive VLAN hw acceleration */
308 #define NETIF_F_HW_VLAN_FILTER	512	/* Receive filtering on VLAN */
309 #define NETIF_F_VLAN_CHALLENGED	1024	/* Device cannot handle VLAN packets */
310 #define NETIF_F_TSO		2048	/* Can offload TCP/IP segmentation */
311 #define NETIF_F_LLTX		4096	/* LockLess TX */
312 #define NETIF_F_UFO             8192    /* Can offload UDP Large Send*/
313 
314 	struct net_device	*next_sched;
315 
316 	/* Interface index. Unique device identifier	*/
317 	int			ifindex;
318 	int			iflink;
319 
320 
321 	struct net_device_stats* (*get_stats)(struct net_device *dev);
322 	struct iw_statistics*	(*get_wireless_stats)(struct net_device *dev);
323 
324 	/* List of functions to handle Wireless Extensions (instead of ioctl).
325 	 * See <net/iw_handler.h> for details. Jean II */
326 	const struct iw_handler_def *	wireless_handlers;
327 	/* Instance data managed by the core of Wireless Extensions. */
328 	struct iw_public_data *	wireless_data;
329 
330 	struct ethtool_ops *ethtool_ops;
331 
332 	/*
333 	 * This marks the end of the "visible" part of the structure. All
334 	 * fields hereafter are internal to the system, and may change at
335 	 * will (read: may be cleaned up at will).
336 	 */
337 
338 
339 	unsigned int		flags;	/* interface flags (a la BSD)	*/
340 	unsigned short		gflags;
341         unsigned short          priv_flags; /* Like 'flags' but invisible to userspace. */
342 	unsigned short		padded;	/* How much padding added by alloc_netdev() */
343 
344 	unsigned char		operstate; /* RFC2863 operstate */
345 	unsigned char		link_mode; /* mapping policy to operstate */
346 
347 	unsigned		mtu;	/* interface MTU value		*/
348 	unsigned short		type;	/* interface hardware type	*/
349 	unsigned short		hard_header_len;	/* hardware hdr length	*/
350 
351 	struct net_device	*master; /* Pointer to master device of a group,
352 					  * which this device is member of.
353 					  */
354 
355 	/* Interface address info. */
356 	unsigned char		perm_addr[MAX_ADDR_LEN]; /* permanent hw address */
357 	unsigned char		addr_len;	/* hardware address length	*/
358 	unsigned short          dev_id;		/* for shared network cards */
359 
360 	struct dev_mc_list	*mc_list;	/* Multicast mac addresses	*/
361 	int			mc_count;	/* Number of installed mcasts	*/
362 	int			promiscuity;
363 	int			allmulti;
364 
365 
366 	/* Protocol specific pointers */
367 
368 	void 			*atalk_ptr;	/* AppleTalk link 	*/
369 	void			*ip_ptr;	/* IPv4 specific data	*/
370 	void                    *dn_ptr;        /* DECnet specific data */
371 	void                    *ip6_ptr;       /* IPv6 specific data */
372 	void			*ec_ptr;	/* Econet specific data	*/
373 	void			*ax25_ptr;	/* AX.25 specific data */
374 
375 /*
376  * Cache line mostly used on receive path (including eth_type_trans())
377  */
378 	struct list_head	poll_list ____cacheline_aligned_in_smp;
379 					/* Link to poll list	*/
380 
381 	int			(*poll) (struct net_device *dev, int *quota);
382 	int			quota;
383 	int			weight;
384 	unsigned long		last_rx;	/* Time of last Rx	*/
385 	/* Interface address info used in eth_type_trans() */
386 	unsigned char		dev_addr[MAX_ADDR_LEN];	/* hw address, (before bcast
387 							because most packets are unicast) */
388 
389 	unsigned char		broadcast[MAX_ADDR_LEN];	/* hw bcast add	*/
390 
391 /*
392  * Cache line mostly used on queue transmit path (qdisc)
393  */
394 	/* device queue lock */
395 	spinlock_t		queue_lock ____cacheline_aligned_in_smp;
396 	struct Qdisc		*qdisc;
397 	struct Qdisc		*qdisc_sleeping;
398 	struct list_head	qdisc_list;
399 	unsigned long		tx_queue_len;	/* Max frames per queue allowed */
400 
401 	/* ingress path synchronizer */
402 	spinlock_t		ingress_lock;
403 	struct Qdisc		*qdisc_ingress;
404 
405 /*
406  * One part is mostly used on xmit path (device)
407  */
408 	/* hard_start_xmit synchronizer */
409 	spinlock_t		xmit_lock ____cacheline_aligned_in_smp;
410 	/* cpu id of processor entered to hard_start_xmit or -1,
411 	   if nobody entered there.
412 	 */
413 	int			xmit_lock_owner;
414 	void			*priv;	/* pointer to private data	*/
415 	int			(*hard_start_xmit) (struct sk_buff *skb,
416 						    struct net_device *dev);
417 	/* These may be needed for future network-power-down code. */
418 	unsigned long		trans_start;	/* Time (in jiffies) of last Tx	*/
419 
420 	int			watchdog_timeo; /* used by dev_watchdog() */
421 	struct timer_list	watchdog_timer;
422 
423 /*
424  * refcnt is a very hot point, so align it on SMP
425  */
426 	/* Number of references to this device */
427 	atomic_t		refcnt ____cacheline_aligned_in_smp;
428 
429 	/* delayed register/unregister */
430 	struct list_head	todo_list;
431 	/* device index hash chain */
432 	struct hlist_node	index_hlist;
433 
434 	/* register/unregister state machine */
435 	enum { NETREG_UNINITIALIZED=0,
436 	       NETREG_REGISTERING,	/* called register_netdevice */
437 	       NETREG_REGISTERED,	/* completed register todo */
438 	       NETREG_UNREGISTERING,	/* called unregister_netdevice */
439 	       NETREG_UNREGISTERED,	/* completed unregister todo */
440 	       NETREG_RELEASED,		/* called free_netdev */
441 	} reg_state;
442 
443 	/* Called after device is detached from network. */
444 	void			(*uninit)(struct net_device *dev);
445 	/* Called after last user reference disappears. */
446 	void			(*destructor)(struct net_device *dev);
447 
448 	/* Pointers to interface service routines.	*/
449 	int			(*open)(struct net_device *dev);
450 	int			(*stop)(struct net_device *dev);
451 #define HAVE_NETDEV_POLL
452 	int			(*hard_header) (struct sk_buff *skb,
453 						struct net_device *dev,
454 						unsigned short type,
455 						void *daddr,
456 						void *saddr,
457 						unsigned len);
458 	int			(*rebuild_header)(struct sk_buff *skb);
459 #define HAVE_MULTICAST
460 	void			(*set_multicast_list)(struct net_device *dev);
461 #define HAVE_SET_MAC_ADDR
462 	int			(*set_mac_address)(struct net_device *dev,
463 						   void *addr);
464 #define HAVE_PRIVATE_IOCTL
465 	int			(*do_ioctl)(struct net_device *dev,
466 					    struct ifreq *ifr, int cmd);
467 #define HAVE_SET_CONFIG
468 	int			(*set_config)(struct net_device *dev,
469 					      struct ifmap *map);
470 #define HAVE_HEADER_CACHE
471 	int			(*hard_header_cache)(struct neighbour *neigh,
472 						     struct hh_cache *hh);
473 	void			(*header_cache_update)(struct hh_cache *hh,
474 						       struct net_device *dev,
475 						       unsigned char *  haddr);
476 #define HAVE_CHANGE_MTU
477 	int			(*change_mtu)(struct net_device *dev, int new_mtu);
478 
479 #define HAVE_TX_TIMEOUT
480 	void			(*tx_timeout) (struct net_device *dev);
481 
482 	void			(*vlan_rx_register)(struct net_device *dev,
483 						    struct vlan_group *grp);
484 	void			(*vlan_rx_add_vid)(struct net_device *dev,
485 						   unsigned short vid);
486 	void			(*vlan_rx_kill_vid)(struct net_device *dev,
487 						    unsigned short vid);
488 
489 	int			(*hard_header_parse)(struct sk_buff *skb,
490 						     unsigned char *haddr);
491 	int			(*neigh_setup)(struct net_device *dev, struct neigh_parms *);
492 #ifdef CONFIG_NETPOLL
493 	struct netpoll_info	*npinfo;
494 #endif
495 #ifdef CONFIG_NET_POLL_CONTROLLER
496 	void                    (*poll_controller)(struct net_device *dev);
497 #endif
498 
499 	/* bridge stuff */
500 	struct net_bridge_port	*br_port;
501 
502 #ifdef CONFIG_NET_DIVERT
503 	/* this will get initialized at each interface type init routine */
504 	struct divert_blk	*divert;
505 #endif /* CONFIG_NET_DIVERT */
506 
507 	/* class/net/name entry */
508 	struct class_device	class_dev;
509 };
510 
511 #define	NETDEV_ALIGN		32
512 #define	NETDEV_ALIGN_CONST	(NETDEV_ALIGN - 1)
513 
514 static inline void *netdev_priv(struct net_device *dev)
515 {
516 	return (char *)dev + ((sizeof(struct net_device)
517 					+ NETDEV_ALIGN_CONST)
518 				& ~NETDEV_ALIGN_CONST);
519 }
520 
521 #define SET_MODULE_OWNER(dev) do { } while (0)
522 /* Set the sysfs physical device reference for the network logical device
523  * if set prior to registration will cause a symlink during initialization.
524  */
525 #define SET_NETDEV_DEV(net, pdev)	((net)->class_dev.dev = (pdev))
526 
527 struct packet_type {
528 	__be16			type;	/* This is really htons(ether_type). */
529 	struct net_device	*dev;	/* NULL is wildcarded here	     */
530 	int			(*func) (struct sk_buff *,
531 					 struct net_device *,
532 					 struct packet_type *,
533 					 struct net_device *);
534 	void			*af_packet_priv;
535 	struct list_head	list;
536 };
537 
538 #include <linux/interrupt.h>
539 #include <linux/notifier.h>
540 
541 extern struct net_device		loopback_dev;		/* The loopback */
542 extern struct net_device		*dev_base;		/* All devices */
543 extern rwlock_t				dev_base_lock;		/* Device list lock */
544 
545 extern int 			netdev_boot_setup_check(struct net_device *dev);
546 extern unsigned long		netdev_boot_base(const char *prefix, int unit);
547 extern struct net_device    *dev_getbyhwaddr(unsigned short type, char *hwaddr);
548 extern struct net_device *dev_getfirstbyhwtype(unsigned short type);
549 extern void		dev_add_pack(struct packet_type *pt);
550 extern void		dev_remove_pack(struct packet_type *pt);
551 extern void		__dev_remove_pack(struct packet_type *pt);
552 
553 extern struct net_device	*dev_get_by_flags(unsigned short flags,
554 						  unsigned short mask);
555 extern struct net_device	*dev_get_by_name(const char *name);
556 extern struct net_device	*__dev_get_by_name(const char *name);
557 extern int		dev_alloc_name(struct net_device *dev, const char *name);
558 extern int		dev_open(struct net_device *dev);
559 extern int		dev_close(struct net_device *dev);
560 extern int		dev_queue_xmit(struct sk_buff *skb);
561 extern int		register_netdevice(struct net_device *dev);
562 extern int		unregister_netdevice(struct net_device *dev);
563 extern void		free_netdev(struct net_device *dev);
564 extern void		synchronize_net(void);
565 extern int 		register_netdevice_notifier(struct notifier_block *nb);
566 extern int		unregister_netdevice_notifier(struct notifier_block *nb);
567 extern int		call_netdevice_notifiers(unsigned long val, void *v);
568 extern struct net_device	*dev_get_by_index(int ifindex);
569 extern struct net_device	*__dev_get_by_index(int ifindex);
570 extern int		dev_restart(struct net_device *dev);
571 #ifdef CONFIG_NETPOLL_TRAP
572 extern int		netpoll_trap(void);
573 #endif
574 
575 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
576 extern int		register_gifconf(unsigned int family, gifconf_func_t * gifconf);
577 static inline int unregister_gifconf(unsigned int family)
578 {
579 	return register_gifconf(family, NULL);
580 }
581 
582 /*
583  * Incoming packets are placed on per-cpu queues so that
584  * no locking is needed.
585  */
586 
587 struct softnet_data
588 {
589 	struct net_device	*output_queue;
590 	struct sk_buff_head	input_pkt_queue;
591 	struct list_head	poll_list;
592 	struct sk_buff		*completion_queue;
593 
594 	struct net_device	backlog_dev;	/* Sorry. 8) */
595 };
596 
597 DECLARE_PER_CPU(struct softnet_data,softnet_data);
598 
599 #define HAVE_NETIF_QUEUE
600 
601 static inline void __netif_schedule(struct net_device *dev)
602 {
603 	if (!test_and_set_bit(__LINK_STATE_SCHED, &dev->state)) {
604 		unsigned long flags;
605 		struct softnet_data *sd;
606 
607 		local_irq_save(flags);
608 		sd = &__get_cpu_var(softnet_data);
609 		dev->next_sched = sd->output_queue;
610 		sd->output_queue = dev;
611 		raise_softirq_irqoff(NET_TX_SOFTIRQ);
612 		local_irq_restore(flags);
613 	}
614 }
615 
616 static inline void netif_schedule(struct net_device *dev)
617 {
618 	if (!test_bit(__LINK_STATE_XOFF, &dev->state))
619 		__netif_schedule(dev);
620 }
621 
622 static inline void netif_start_queue(struct net_device *dev)
623 {
624 	clear_bit(__LINK_STATE_XOFF, &dev->state);
625 }
626 
627 static inline void netif_wake_queue(struct net_device *dev)
628 {
629 #ifdef CONFIG_NETPOLL_TRAP
630 	if (netpoll_trap())
631 		return;
632 #endif
633 	if (test_and_clear_bit(__LINK_STATE_XOFF, &dev->state))
634 		__netif_schedule(dev);
635 }
636 
637 static inline void netif_stop_queue(struct net_device *dev)
638 {
639 #ifdef CONFIG_NETPOLL_TRAP
640 	if (netpoll_trap())
641 		return;
642 #endif
643 	set_bit(__LINK_STATE_XOFF, &dev->state);
644 }
645 
646 static inline int netif_queue_stopped(const struct net_device *dev)
647 {
648 	return test_bit(__LINK_STATE_XOFF, &dev->state);
649 }
650 
651 static inline int netif_running(const struct net_device *dev)
652 {
653 	return test_bit(__LINK_STATE_START, &dev->state);
654 }
655 
656 
657 /* Use this variant when it is known for sure that it
658  * is executing from interrupt context.
659  */
660 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
661 {
662 	if (atomic_dec_and_test(&skb->users)) {
663 		struct softnet_data *sd;
664 		unsigned long flags;
665 
666 		local_irq_save(flags);
667 		sd = &__get_cpu_var(softnet_data);
668 		skb->next = sd->completion_queue;
669 		sd->completion_queue = skb;
670 		raise_softirq_irqoff(NET_TX_SOFTIRQ);
671 		local_irq_restore(flags);
672 	}
673 }
674 
675 /* Use this variant in places where it could be invoked
676  * either from interrupt or non-interrupt context.
677  */
678 static inline void dev_kfree_skb_any(struct sk_buff *skb)
679 {
680 	if (in_irq() || irqs_disabled())
681 		dev_kfree_skb_irq(skb);
682 	else
683 		dev_kfree_skb(skb);
684 }
685 
686 #define HAVE_NETIF_RX 1
687 extern int		netif_rx(struct sk_buff *skb);
688 extern int		netif_rx_ni(struct sk_buff *skb);
689 #define HAVE_NETIF_RECEIVE_SKB 1
690 extern int		netif_receive_skb(struct sk_buff *skb);
691 extern int		dev_valid_name(const char *name);
692 extern int		dev_ioctl(unsigned int cmd, void __user *);
693 extern int		dev_ethtool(struct ifreq *);
694 extern unsigned		dev_get_flags(const struct net_device *);
695 extern int		dev_change_flags(struct net_device *, unsigned);
696 extern int		dev_change_name(struct net_device *, char *);
697 extern int		dev_set_mtu(struct net_device *, int);
698 extern int		dev_set_mac_address(struct net_device *,
699 					    struct sockaddr *);
700 extern void		dev_queue_xmit_nit(struct sk_buff *skb, struct net_device *dev);
701 
702 extern void		dev_init(void);
703 
704 extern int		netdev_nit;
705 extern int		netdev_budget;
706 
707 /* Called by rtnetlink.c:rtnl_unlock() */
708 extern void netdev_run_todo(void);
709 
710 static inline void dev_put(struct net_device *dev)
711 {
712 	atomic_dec(&dev->refcnt);
713 }
714 
715 static inline void dev_hold(struct net_device *dev)
716 {
717 	atomic_inc(&dev->refcnt);
718 }
719 
720 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
721  * and _off may be called from IRQ context, but it is caller
722  * who is responsible for serialization of these calls.
723  *
724  * The name carrier is inappropriate, these functions should really be
725  * called netif_lowerlayer_*() because they represent the state of any
726  * kind of lower layer not just hardware media.
727  */
728 
729 extern void linkwatch_fire_event(struct net_device *dev);
730 
731 static inline int netif_carrier_ok(const struct net_device *dev)
732 {
733 	return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
734 }
735 
736 extern void __netdev_watchdog_up(struct net_device *dev);
737 
738 extern void netif_carrier_on(struct net_device *dev);
739 
740 extern void netif_carrier_off(struct net_device *dev);
741 
742 static inline void netif_dormant_on(struct net_device *dev)
743 {
744 	if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
745 		linkwatch_fire_event(dev);
746 }
747 
748 static inline void netif_dormant_off(struct net_device *dev)
749 {
750 	if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
751 		linkwatch_fire_event(dev);
752 }
753 
754 static inline int netif_dormant(const struct net_device *dev)
755 {
756 	return test_bit(__LINK_STATE_DORMANT, &dev->state);
757 }
758 
759 
760 static inline int netif_oper_up(const struct net_device *dev) {
761 	return (dev->operstate == IF_OPER_UP ||
762 		dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
763 }
764 
765 /* Hot-plugging. */
766 static inline int netif_device_present(struct net_device *dev)
767 {
768 	return test_bit(__LINK_STATE_PRESENT, &dev->state);
769 }
770 
771 static inline void netif_device_detach(struct net_device *dev)
772 {
773 	if (test_and_clear_bit(__LINK_STATE_PRESENT, &dev->state) &&
774 	    netif_running(dev)) {
775 		netif_stop_queue(dev);
776 	}
777 }
778 
779 static inline void netif_device_attach(struct net_device *dev)
780 {
781 	if (!test_and_set_bit(__LINK_STATE_PRESENT, &dev->state) &&
782 	    netif_running(dev)) {
783 		netif_wake_queue(dev);
784  		__netdev_watchdog_up(dev);
785 	}
786 }
787 
788 /*
789  * Network interface message level settings
790  */
791 #define HAVE_NETIF_MSG 1
792 
793 enum {
794 	NETIF_MSG_DRV		= 0x0001,
795 	NETIF_MSG_PROBE		= 0x0002,
796 	NETIF_MSG_LINK		= 0x0004,
797 	NETIF_MSG_TIMER		= 0x0008,
798 	NETIF_MSG_IFDOWN	= 0x0010,
799 	NETIF_MSG_IFUP		= 0x0020,
800 	NETIF_MSG_RX_ERR	= 0x0040,
801 	NETIF_MSG_TX_ERR	= 0x0080,
802 	NETIF_MSG_TX_QUEUED	= 0x0100,
803 	NETIF_MSG_INTR		= 0x0200,
804 	NETIF_MSG_TX_DONE	= 0x0400,
805 	NETIF_MSG_RX_STATUS	= 0x0800,
806 	NETIF_MSG_PKTDATA	= 0x1000,
807 	NETIF_MSG_HW		= 0x2000,
808 	NETIF_MSG_WOL		= 0x4000,
809 };
810 
811 #define netif_msg_drv(p)	((p)->msg_enable & NETIF_MSG_DRV)
812 #define netif_msg_probe(p)	((p)->msg_enable & NETIF_MSG_PROBE)
813 #define netif_msg_link(p)	((p)->msg_enable & NETIF_MSG_LINK)
814 #define netif_msg_timer(p)	((p)->msg_enable & NETIF_MSG_TIMER)
815 #define netif_msg_ifdown(p)	((p)->msg_enable & NETIF_MSG_IFDOWN)
816 #define netif_msg_ifup(p)	((p)->msg_enable & NETIF_MSG_IFUP)
817 #define netif_msg_rx_err(p)	((p)->msg_enable & NETIF_MSG_RX_ERR)
818 #define netif_msg_tx_err(p)	((p)->msg_enable & NETIF_MSG_TX_ERR)
819 #define netif_msg_tx_queued(p)	((p)->msg_enable & NETIF_MSG_TX_QUEUED)
820 #define netif_msg_intr(p)	((p)->msg_enable & NETIF_MSG_INTR)
821 #define netif_msg_tx_done(p)	((p)->msg_enable & NETIF_MSG_TX_DONE)
822 #define netif_msg_rx_status(p)	((p)->msg_enable & NETIF_MSG_RX_STATUS)
823 #define netif_msg_pktdata(p)	((p)->msg_enable & NETIF_MSG_PKTDATA)
824 #define netif_msg_hw(p)		((p)->msg_enable & NETIF_MSG_HW)
825 #define netif_msg_wol(p)	((p)->msg_enable & NETIF_MSG_WOL)
826 
827 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
828 {
829 	/* use default */
830 	if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
831 		return default_msg_enable_bits;
832 	if (debug_value == 0)	/* no output */
833 		return 0;
834 	/* set low N bits */
835 	return (1 << debug_value) - 1;
836 }
837 
838 /* Test if receive needs to be scheduled */
839 static inline int __netif_rx_schedule_prep(struct net_device *dev)
840 {
841 	return !test_and_set_bit(__LINK_STATE_RX_SCHED, &dev->state);
842 }
843 
844 /* Test if receive needs to be scheduled but only if up */
845 static inline int netif_rx_schedule_prep(struct net_device *dev)
846 {
847 	return netif_running(dev) && __netif_rx_schedule_prep(dev);
848 }
849 
850 /* Add interface to tail of rx poll list. This assumes that _prep has
851  * already been called and returned 1.
852  */
853 
854 static inline void __netif_rx_schedule(struct net_device *dev)
855 {
856 	unsigned long flags;
857 
858 	local_irq_save(flags);
859 	dev_hold(dev);
860 	list_add_tail(&dev->poll_list, &__get_cpu_var(softnet_data).poll_list);
861 	if (dev->quota < 0)
862 		dev->quota += dev->weight;
863 	else
864 		dev->quota = dev->weight;
865 	__raise_softirq_irqoff(NET_RX_SOFTIRQ);
866 	local_irq_restore(flags);
867 }
868 
869 /* Try to reschedule poll. Called by irq handler. */
870 
871 static inline void netif_rx_schedule(struct net_device *dev)
872 {
873 	if (netif_rx_schedule_prep(dev))
874 		__netif_rx_schedule(dev);
875 }
876 
877 /* Try to reschedule poll. Called by dev->poll() after netif_rx_complete().
878  * Do not inline this?
879  */
880 static inline int netif_rx_reschedule(struct net_device *dev, int undo)
881 {
882 	if (netif_rx_schedule_prep(dev)) {
883 		unsigned long flags;
884 
885 		dev->quota += undo;
886 
887 		local_irq_save(flags);
888 		list_add_tail(&dev->poll_list, &__get_cpu_var(softnet_data).poll_list);
889 		__raise_softirq_irqoff(NET_RX_SOFTIRQ);
890 		local_irq_restore(flags);
891 		return 1;
892 	}
893 	return 0;
894 }
895 
896 /* Remove interface from poll list: it must be in the poll list
897  * on current cpu. This primitive is called by dev->poll(), when
898  * it completes the work. The device cannot be out of poll list at this
899  * moment, it is BUG().
900  */
901 static inline void netif_rx_complete(struct net_device *dev)
902 {
903 	unsigned long flags;
904 
905 	local_irq_save(flags);
906 	BUG_ON(!test_bit(__LINK_STATE_RX_SCHED, &dev->state));
907 	list_del(&dev->poll_list);
908 	smp_mb__before_clear_bit();
909 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
910 	local_irq_restore(flags);
911 }
912 
913 static inline void netif_poll_disable(struct net_device *dev)
914 {
915 	while (test_and_set_bit(__LINK_STATE_RX_SCHED, &dev->state))
916 		/* No hurry. */
917 		schedule_timeout_interruptible(1);
918 }
919 
920 static inline void netif_poll_enable(struct net_device *dev)
921 {
922 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
923 }
924 
925 /* same as netif_rx_complete, except that local_irq_save(flags)
926  * has already been issued
927  */
928 static inline void __netif_rx_complete(struct net_device *dev)
929 {
930 	BUG_ON(!test_bit(__LINK_STATE_RX_SCHED, &dev->state));
931 	list_del(&dev->poll_list);
932 	smp_mb__before_clear_bit();
933 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
934 }
935 
936 static inline void netif_tx_disable(struct net_device *dev)
937 {
938 	spin_lock_bh(&dev->xmit_lock);
939 	netif_stop_queue(dev);
940 	spin_unlock_bh(&dev->xmit_lock);
941 }
942 
943 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
944 
945 extern void		ether_setup(struct net_device *dev);
946 
947 /* Support for loadable net-drivers */
948 extern struct net_device *alloc_netdev(int sizeof_priv, const char *name,
949 				       void (*setup)(struct net_device *));
950 extern int		register_netdev(struct net_device *dev);
951 extern void		unregister_netdev(struct net_device *dev);
952 /* Functions used for multicast support */
953 extern void		dev_mc_upload(struct net_device *dev);
954 extern int 		dev_mc_delete(struct net_device *dev, void *addr, int alen, int all);
955 extern int		dev_mc_add(struct net_device *dev, void *addr, int alen, int newonly);
956 extern void		dev_mc_discard(struct net_device *dev);
957 extern void		dev_set_promiscuity(struct net_device *dev, int inc);
958 extern void		dev_set_allmulti(struct net_device *dev, int inc);
959 extern void		netdev_state_change(struct net_device *dev);
960 extern void		netdev_features_change(struct net_device *dev);
961 /* Load a device via the kmod */
962 extern void		dev_load(const char *name);
963 extern void		dev_mcast_init(void);
964 extern int		netdev_max_backlog;
965 extern int		weight_p;
966 extern int		netdev_set_master(struct net_device *dev, struct net_device *master);
967 extern int skb_checksum_help(struct sk_buff *skb, int inward);
968 #ifdef CONFIG_BUG
969 extern void netdev_rx_csum_fault(struct net_device *dev);
970 #else
971 static inline void netdev_rx_csum_fault(struct net_device *dev)
972 {
973 }
974 #endif
975 /* rx skb timestamps */
976 extern void		net_enable_timestamp(void);
977 extern void		net_disable_timestamp(void);
978 
979 #ifdef CONFIG_PROC_FS
980 extern void *dev_seq_start(struct seq_file *seq, loff_t *pos);
981 extern void *dev_seq_next(struct seq_file *seq, void *v, loff_t *pos);
982 extern void dev_seq_stop(struct seq_file *seq, void *v);
983 #endif
984 
985 extern void linkwatch_run_queue(void);
986 
987 #endif /* __KERNEL__ */
988 
989 #endif	/* _LINUX_DEV_H */
990