xref: /linux-6.15/include/linux/netdevice.h (revision 20dd026d)
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 };
235 
236 
237 /*
238  * This structure holds at boot time configured netdevice settings. They
239  * are then used in the device probing.
240  */
241 struct netdev_boot_setup {
242 	char name[IFNAMSIZ];
243 	struct ifmap map;
244 };
245 #define NETDEV_BOOT_SETUP_MAX 8
246 
247 extern int __init netdev_boot_setup(char *str);
248 
249 /*
250  *	The DEVICE structure.
251  *	Actually, this whole structure is a big mistake.  It mixes I/O
252  *	data with strictly "high-level" data, and it has to know about
253  *	almost every data structure used in the INET module.
254  *
255  *	FIXME: cleanup struct net_device such that network protocol info
256  *	moves out.
257  */
258 
259 struct net_device
260 {
261 
262 	/*
263 	 * This is the first field of the "visible" part of this structure
264 	 * (i.e. as seen by users in the "Space.c" file).  It is the name
265 	 * the interface.
266 	 */
267 	char			name[IFNAMSIZ];
268 
269 	/*
270 	 *	I/O specific fields
271 	 *	FIXME: Merge these and struct ifmap into one
272 	 */
273 	unsigned long		mem_end;	/* shared mem end	*/
274 	unsigned long		mem_start;	/* shared mem start	*/
275 	unsigned long		base_addr;	/* device I/O address	*/
276 	unsigned int		irq;		/* device IRQ number	*/
277 
278 	/*
279 	 *	Some hardware also needs these fields, but they are not
280 	 *	part of the usual set specified in Space.c.
281 	 */
282 
283 	unsigned char		if_port;	/* Selectable AUI, TP,..*/
284 	unsigned char		dma;		/* DMA channel		*/
285 
286 	unsigned long		state;
287 
288 	struct net_device	*next;
289 
290 	/* The device initialization function. Called only once. */
291 	int			(*init)(struct net_device *dev);
292 
293 	/* ------- Fields preinitialized in Space.c finish here ------- */
294 
295 	struct net_device	*next_sched;
296 
297 	/* Interface index. Unique device identifier	*/
298 	int			ifindex;
299 	int			iflink;
300 
301 
302 	struct net_device_stats* (*get_stats)(struct net_device *dev);
303 	struct iw_statistics*	(*get_wireless_stats)(struct net_device *dev);
304 
305 	/* List of functions to handle Wireless Extensions (instead of ioctl).
306 	 * See <net/iw_handler.h> for details. Jean II */
307 	const struct iw_handler_def *	wireless_handlers;
308 	/* Instance data managed by the core of Wireless Extensions. */
309 	struct iw_public_data *	wireless_data;
310 
311 	struct ethtool_ops *ethtool_ops;
312 
313 	/*
314 	 * This marks the end of the "visible" part of the structure. All
315 	 * fields hereafter are internal to the system, and may change at
316 	 * will (read: may be cleaned up at will).
317 	 */
318 
319 	/* These may be needed for future network-power-down code. */
320 	unsigned long		trans_start;	/* Time (in jiffies) of last Tx	*/
321 	unsigned long		last_rx;	/* Time of last Rx	*/
322 
323 	unsigned short		flags;	/* interface flags (a la BSD)	*/
324 	unsigned short		gflags;
325         unsigned short          priv_flags; /* Like 'flags' but invisible to userspace. */
326 	unsigned short		padded;	/* How much padding added by alloc_netdev() */
327 
328 	unsigned		mtu;	/* interface MTU value		*/
329 	unsigned short		type;	/* interface hardware type	*/
330 	unsigned short		hard_header_len;	/* hardware hdr length	*/
331 	void			*priv;	/* pointer to private data	*/
332 
333 	struct net_device	*master; /* Pointer to master device of a group,
334 					  * which this device is member of.
335 					  */
336 
337 	/* Interface address info. */
338 	unsigned char		broadcast[MAX_ADDR_LEN];	/* hw bcast add	*/
339 	unsigned char		dev_addr[MAX_ADDR_LEN];	/* hw address	*/
340 	unsigned char		perm_addr[MAX_ADDR_LEN]; /* permanent hw address */
341 	unsigned char		addr_len;	/* hardware address length	*/
342 	unsigned short          dev_id;		/* for shared network cards */
343 
344 	struct dev_mc_list	*mc_list;	/* Multicast mac addresses	*/
345 	int			mc_count;	/* Number of installed mcasts	*/
346 	int			promiscuity;
347 	int			allmulti;
348 
349 	int			watchdog_timeo;
350 	struct timer_list	watchdog_timer;
351 
352 	/* Protocol specific pointers */
353 
354 	void 			*atalk_ptr;	/* AppleTalk link 	*/
355 	void			*ip_ptr;	/* IPv4 specific data	*/
356 	void                    *dn_ptr;        /* DECnet specific data */
357 	void                    *ip6_ptr;       /* IPv6 specific data */
358 	void			*ec_ptr;	/* Econet specific data	*/
359 	void			*ax25_ptr;	/* AX.25 specific data */
360 
361 	struct list_head	poll_list;	/* Link to poll list	*/
362 	int			quota;
363 	int			weight;
364 
365 	struct Qdisc		*qdisc;
366 	struct Qdisc		*qdisc_sleeping;
367 	struct Qdisc		*qdisc_ingress;
368 	struct list_head	qdisc_list;
369 	unsigned long		tx_queue_len;	/* Max frames per queue allowed */
370 
371 	/* ingress path synchronizer */
372 	spinlock_t		ingress_lock;
373 	/* hard_start_xmit synchronizer */
374 	spinlock_t		xmit_lock;
375 	/* cpu id of processor entered to hard_start_xmit or -1,
376 	   if nobody entered there.
377 	 */
378 	int			xmit_lock_owner;
379 	/* device queue lock */
380 	spinlock_t		queue_lock;
381 	/* Number of references to this device */
382 	atomic_t		refcnt;
383 	/* delayed register/unregister */
384 	struct list_head	todo_list;
385 	/* device name hash chain */
386 	struct hlist_node	name_hlist;
387 	/* device index hash chain */
388 	struct hlist_node	index_hlist;
389 
390 	/* register/unregister state machine */
391 	enum { NETREG_UNINITIALIZED=0,
392 	       NETREG_REGISTERING,	/* called register_netdevice */
393 	       NETREG_REGISTERED,	/* completed register todo */
394 	       NETREG_UNREGISTERING,	/* called unregister_netdevice */
395 	       NETREG_UNREGISTERED,	/* completed unregister todo */
396 	       NETREG_RELEASED,		/* called free_netdev */
397 	} reg_state;
398 
399 	/* Net device features */
400 	unsigned long		features;
401 #define NETIF_F_SG		1	/* Scatter/gather IO. */
402 #define NETIF_F_IP_CSUM		2	/* Can checksum only TCP/UDP over IPv4. */
403 #define NETIF_F_NO_CSUM		4	/* Does not require checksum. F.e. loopack. */
404 #define NETIF_F_HW_CSUM		8	/* Can checksum all the packets. */
405 #define NETIF_F_HIGHDMA		32	/* Can DMA to high memory. */
406 #define NETIF_F_FRAGLIST	64	/* Scatter/gather IO. */
407 #define NETIF_F_HW_VLAN_TX	128	/* Transmit VLAN hw acceleration */
408 #define NETIF_F_HW_VLAN_RX	256	/* Receive VLAN hw acceleration */
409 #define NETIF_F_HW_VLAN_FILTER	512	/* Receive filtering on VLAN */
410 #define NETIF_F_VLAN_CHALLENGED	1024	/* Device cannot handle VLAN packets */
411 #define NETIF_F_TSO		2048	/* Can offload TCP/IP segmentation */
412 #define NETIF_F_LLTX		4096	/* LockLess TX */
413 
414 	/* Called after device is detached from network. */
415 	void			(*uninit)(struct net_device *dev);
416 	/* Called after last user reference disappears. */
417 	void			(*destructor)(struct net_device *dev);
418 
419 	/* Pointers to interface service routines.	*/
420 	int			(*open)(struct net_device *dev);
421 	int			(*stop)(struct net_device *dev);
422 	int			(*hard_start_xmit) (struct sk_buff *skb,
423 						    struct net_device *dev);
424 #define HAVE_NETDEV_POLL
425 	int			(*poll) (struct net_device *dev, int *quota);
426 	int			(*hard_header) (struct sk_buff *skb,
427 						struct net_device *dev,
428 						unsigned short type,
429 						void *daddr,
430 						void *saddr,
431 						unsigned len);
432 	int			(*rebuild_header)(struct sk_buff *skb);
433 #define HAVE_MULTICAST
434 	void			(*set_multicast_list)(struct net_device *dev);
435 #define HAVE_SET_MAC_ADDR
436 	int			(*set_mac_address)(struct net_device *dev,
437 						   void *addr);
438 #define HAVE_PRIVATE_IOCTL
439 	int			(*do_ioctl)(struct net_device *dev,
440 					    struct ifreq *ifr, int cmd);
441 #define HAVE_SET_CONFIG
442 	int			(*set_config)(struct net_device *dev,
443 					      struct ifmap *map);
444 #define HAVE_HEADER_CACHE
445 	int			(*hard_header_cache)(struct neighbour *neigh,
446 						     struct hh_cache *hh);
447 	void			(*header_cache_update)(struct hh_cache *hh,
448 						       struct net_device *dev,
449 						       unsigned char *  haddr);
450 #define HAVE_CHANGE_MTU
451 	int			(*change_mtu)(struct net_device *dev, int new_mtu);
452 
453 #define HAVE_TX_TIMEOUT
454 	void			(*tx_timeout) (struct net_device *dev);
455 
456 	void			(*vlan_rx_register)(struct net_device *dev,
457 						    struct vlan_group *grp);
458 	void			(*vlan_rx_add_vid)(struct net_device *dev,
459 						   unsigned short vid);
460 	void			(*vlan_rx_kill_vid)(struct net_device *dev,
461 						    unsigned short vid);
462 
463 	int			(*hard_header_parse)(struct sk_buff *skb,
464 						     unsigned char *haddr);
465 	int			(*neigh_setup)(struct net_device *dev, struct neigh_parms *);
466 #ifdef CONFIG_NETPOLL
467 	struct netpoll_info	*npinfo;
468 #endif
469 #ifdef CONFIG_NET_POLL_CONTROLLER
470 	void                    (*poll_controller)(struct net_device *dev);
471 #endif
472 
473 	/* bridge stuff */
474 	struct net_bridge_port	*br_port;
475 
476 #ifdef CONFIG_NET_DIVERT
477 	/* this will get initialized at each interface type init routine */
478 	struct divert_blk	*divert;
479 #endif /* CONFIG_NET_DIVERT */
480 
481 	/* class/net/name entry */
482 	struct class_device	class_dev;
483 };
484 
485 #define	NETDEV_ALIGN		32
486 #define	NETDEV_ALIGN_CONST	(NETDEV_ALIGN - 1)
487 
488 static inline void *netdev_priv(struct net_device *dev)
489 {
490 	return (char *)dev + ((sizeof(struct net_device)
491 					+ NETDEV_ALIGN_CONST)
492 				& ~NETDEV_ALIGN_CONST);
493 }
494 
495 #define SET_MODULE_OWNER(dev) do { } while (0)
496 /* Set the sysfs physical device reference for the network logical device
497  * if set prior to registration will cause a symlink during initialization.
498  */
499 #define SET_NETDEV_DEV(net, pdev)	((net)->class_dev.dev = (pdev))
500 
501 struct packet_type {
502 	__be16			type;	/* This is really htons(ether_type). */
503 	struct net_device	*dev;	/* NULL is wildcarded here	     */
504 	int			(*func) (struct sk_buff *,
505 					 struct net_device *,
506 					 struct packet_type *,
507 					 struct net_device *);
508 	void			*af_packet_priv;
509 	struct list_head	list;
510 };
511 
512 #include <linux/interrupt.h>
513 #include <linux/notifier.h>
514 
515 extern struct net_device		loopback_dev;		/* The loopback */
516 extern struct net_device		*dev_base;		/* All devices */
517 extern rwlock_t				dev_base_lock;		/* Device list lock */
518 
519 extern int 			netdev_boot_setup_check(struct net_device *dev);
520 extern unsigned long		netdev_boot_base(const char *prefix, int unit);
521 extern struct net_device    *dev_getbyhwaddr(unsigned short type, char *hwaddr);
522 extern struct net_device *dev_getfirstbyhwtype(unsigned short type);
523 extern void		dev_add_pack(struct packet_type *pt);
524 extern void		dev_remove_pack(struct packet_type *pt);
525 extern void		__dev_remove_pack(struct packet_type *pt);
526 
527 extern struct net_device	*dev_get_by_flags(unsigned short flags,
528 						  unsigned short mask);
529 extern struct net_device	*dev_get_by_name(const char *name);
530 extern struct net_device	*__dev_get_by_name(const char *name);
531 extern int		dev_alloc_name(struct net_device *dev, const char *name);
532 extern int		dev_open(struct net_device *dev);
533 extern int		dev_close(struct net_device *dev);
534 extern int		dev_queue_xmit(struct sk_buff *skb);
535 extern int		register_netdevice(struct net_device *dev);
536 extern int		unregister_netdevice(struct net_device *dev);
537 extern void		free_netdev(struct net_device *dev);
538 extern void		synchronize_net(void);
539 extern int 		register_netdevice_notifier(struct notifier_block *nb);
540 extern int		unregister_netdevice_notifier(struct notifier_block *nb);
541 extern int		call_netdevice_notifiers(unsigned long val, void *v);
542 extern struct net_device	*dev_get_by_index(int ifindex);
543 extern struct net_device	*__dev_get_by_index(int ifindex);
544 extern int		dev_restart(struct net_device *dev);
545 #ifdef CONFIG_NETPOLL_TRAP
546 extern int		netpoll_trap(void);
547 #endif
548 
549 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
550 extern int		register_gifconf(unsigned int family, gifconf_func_t * gifconf);
551 static inline int unregister_gifconf(unsigned int family)
552 {
553 	return register_gifconf(family, NULL);
554 }
555 
556 /*
557  * Incoming packets are placed on per-cpu queues so that
558  * no locking is needed.
559  */
560 
561 struct softnet_data
562 {
563 	struct net_device	*output_queue;
564 	struct sk_buff_head	input_pkt_queue;
565 	struct list_head	poll_list;
566 	struct sk_buff		*completion_queue;
567 
568 	struct net_device	backlog_dev;	/* Sorry. 8) */
569 };
570 
571 DECLARE_PER_CPU(struct softnet_data,softnet_data);
572 
573 #define HAVE_NETIF_QUEUE
574 
575 static inline void __netif_schedule(struct net_device *dev)
576 {
577 	if (!test_and_set_bit(__LINK_STATE_SCHED, &dev->state)) {
578 		unsigned long flags;
579 		struct softnet_data *sd;
580 
581 		local_irq_save(flags);
582 		sd = &__get_cpu_var(softnet_data);
583 		dev->next_sched = sd->output_queue;
584 		sd->output_queue = dev;
585 		raise_softirq_irqoff(NET_TX_SOFTIRQ);
586 		local_irq_restore(flags);
587 	}
588 }
589 
590 static inline void netif_schedule(struct net_device *dev)
591 {
592 	if (!test_bit(__LINK_STATE_XOFF, &dev->state))
593 		__netif_schedule(dev);
594 }
595 
596 static inline void netif_start_queue(struct net_device *dev)
597 {
598 	clear_bit(__LINK_STATE_XOFF, &dev->state);
599 }
600 
601 static inline void netif_wake_queue(struct net_device *dev)
602 {
603 #ifdef CONFIG_NETPOLL_TRAP
604 	if (netpoll_trap())
605 		return;
606 #endif
607 	if (test_and_clear_bit(__LINK_STATE_XOFF, &dev->state))
608 		__netif_schedule(dev);
609 }
610 
611 static inline void netif_stop_queue(struct net_device *dev)
612 {
613 #ifdef CONFIG_NETPOLL_TRAP
614 	if (netpoll_trap())
615 		return;
616 #endif
617 	set_bit(__LINK_STATE_XOFF, &dev->state);
618 }
619 
620 static inline int netif_queue_stopped(const struct net_device *dev)
621 {
622 	return test_bit(__LINK_STATE_XOFF, &dev->state);
623 }
624 
625 static inline int netif_running(const struct net_device *dev)
626 {
627 	return test_bit(__LINK_STATE_START, &dev->state);
628 }
629 
630 
631 /* Use this variant when it is known for sure that it
632  * is executing from interrupt context.
633  */
634 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
635 {
636 	if (atomic_dec_and_test(&skb->users)) {
637 		struct softnet_data *sd;
638 		unsigned long flags;
639 
640 		local_irq_save(flags);
641 		sd = &__get_cpu_var(softnet_data);
642 		skb->next = sd->completion_queue;
643 		sd->completion_queue = skb;
644 		raise_softirq_irqoff(NET_TX_SOFTIRQ);
645 		local_irq_restore(flags);
646 	}
647 }
648 
649 /* Use this variant in places where it could be invoked
650  * either from interrupt or non-interrupt context.
651  */
652 static inline void dev_kfree_skb_any(struct sk_buff *skb)
653 {
654 	if (in_irq() || irqs_disabled())
655 		dev_kfree_skb_irq(skb);
656 	else
657 		dev_kfree_skb(skb);
658 }
659 
660 #define HAVE_NETIF_RX 1
661 extern int		netif_rx(struct sk_buff *skb);
662 extern int		netif_rx_ni(struct sk_buff *skb);
663 #define HAVE_NETIF_RECEIVE_SKB 1
664 extern int		netif_receive_skb(struct sk_buff *skb);
665 extern int		dev_ioctl(unsigned int cmd, void __user *);
666 extern int		dev_ethtool(struct ifreq *);
667 extern unsigned		dev_get_flags(const struct net_device *);
668 extern int		dev_change_flags(struct net_device *, unsigned);
669 extern int		dev_change_name(struct net_device *, char *);
670 extern int		dev_set_mtu(struct net_device *, int);
671 extern int		dev_set_mac_address(struct net_device *,
672 					    struct sockaddr *);
673 extern void		dev_queue_xmit_nit(struct sk_buff *skb, struct net_device *dev);
674 
675 extern void		dev_init(void);
676 
677 extern int		netdev_nit;
678 extern int		netdev_budget;
679 
680 /* Called by rtnetlink.c:rtnl_unlock() */
681 extern void netdev_run_todo(void);
682 
683 static inline void dev_put(struct net_device *dev)
684 {
685 	atomic_dec(&dev->refcnt);
686 }
687 
688 #define __dev_put(dev) atomic_dec(&(dev)->refcnt)
689 #define dev_hold(dev) atomic_inc(&(dev)->refcnt)
690 
691 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
692  * and _off may be called from IRQ context, but it is caller
693  * who is responsible for serialization of these calls.
694  */
695 
696 extern void linkwatch_fire_event(struct net_device *dev);
697 
698 static inline int netif_carrier_ok(const struct net_device *dev)
699 {
700 	return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
701 }
702 
703 extern void __netdev_watchdog_up(struct net_device *dev);
704 
705 extern void netif_carrier_on(struct net_device *dev);
706 
707 extern void netif_carrier_off(struct net_device *dev);
708 
709 /* Hot-plugging. */
710 static inline int netif_device_present(struct net_device *dev)
711 {
712 	return test_bit(__LINK_STATE_PRESENT, &dev->state);
713 }
714 
715 static inline void netif_device_detach(struct net_device *dev)
716 {
717 	if (test_and_clear_bit(__LINK_STATE_PRESENT, &dev->state) &&
718 	    netif_running(dev)) {
719 		netif_stop_queue(dev);
720 	}
721 }
722 
723 static inline void netif_device_attach(struct net_device *dev)
724 {
725 	if (!test_and_set_bit(__LINK_STATE_PRESENT, &dev->state) &&
726 	    netif_running(dev)) {
727 		netif_wake_queue(dev);
728  		__netdev_watchdog_up(dev);
729 	}
730 }
731 
732 /*
733  * Network interface message level settings
734  */
735 #define HAVE_NETIF_MSG 1
736 
737 enum {
738 	NETIF_MSG_DRV		= 0x0001,
739 	NETIF_MSG_PROBE		= 0x0002,
740 	NETIF_MSG_LINK		= 0x0004,
741 	NETIF_MSG_TIMER		= 0x0008,
742 	NETIF_MSG_IFDOWN	= 0x0010,
743 	NETIF_MSG_IFUP		= 0x0020,
744 	NETIF_MSG_RX_ERR	= 0x0040,
745 	NETIF_MSG_TX_ERR	= 0x0080,
746 	NETIF_MSG_TX_QUEUED	= 0x0100,
747 	NETIF_MSG_INTR		= 0x0200,
748 	NETIF_MSG_TX_DONE	= 0x0400,
749 	NETIF_MSG_RX_STATUS	= 0x0800,
750 	NETIF_MSG_PKTDATA	= 0x1000,
751 	NETIF_MSG_HW		= 0x2000,
752 	NETIF_MSG_WOL		= 0x4000,
753 };
754 
755 #define netif_msg_drv(p)	((p)->msg_enable & NETIF_MSG_DRV)
756 #define netif_msg_probe(p)	((p)->msg_enable & NETIF_MSG_PROBE)
757 #define netif_msg_link(p)	((p)->msg_enable & NETIF_MSG_LINK)
758 #define netif_msg_timer(p)	((p)->msg_enable & NETIF_MSG_TIMER)
759 #define netif_msg_ifdown(p)	((p)->msg_enable & NETIF_MSG_IFDOWN)
760 #define netif_msg_ifup(p)	((p)->msg_enable & NETIF_MSG_IFUP)
761 #define netif_msg_rx_err(p)	((p)->msg_enable & NETIF_MSG_RX_ERR)
762 #define netif_msg_tx_err(p)	((p)->msg_enable & NETIF_MSG_TX_ERR)
763 #define netif_msg_tx_queued(p)	((p)->msg_enable & NETIF_MSG_TX_QUEUED)
764 #define netif_msg_intr(p)	((p)->msg_enable & NETIF_MSG_INTR)
765 #define netif_msg_tx_done(p)	((p)->msg_enable & NETIF_MSG_TX_DONE)
766 #define netif_msg_rx_status(p)	((p)->msg_enable & NETIF_MSG_RX_STATUS)
767 #define netif_msg_pktdata(p)	((p)->msg_enable & NETIF_MSG_PKTDATA)
768 #define netif_msg_hw(p)		((p)->msg_enable & NETIF_MSG_HW)
769 #define netif_msg_wol(p)	((p)->msg_enable & NETIF_MSG_WOL)
770 
771 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
772 {
773 	/* use default */
774 	if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
775 		return default_msg_enable_bits;
776 	if (debug_value == 0)	/* no output */
777 		return 0;
778 	/* set low N bits */
779 	return (1 << debug_value) - 1;
780 }
781 
782 /* Schedule rx intr now? */
783 
784 static inline int netif_rx_schedule_prep(struct net_device *dev)
785 {
786 	return netif_running(dev) &&
787 		!test_and_set_bit(__LINK_STATE_RX_SCHED, &dev->state);
788 }
789 
790 /* Add interface to tail of rx poll list. This assumes that _prep has
791  * already been called and returned 1.
792  */
793 
794 static inline void __netif_rx_schedule(struct net_device *dev)
795 {
796 	unsigned long flags;
797 
798 	local_irq_save(flags);
799 	dev_hold(dev);
800 	list_add_tail(&dev->poll_list, &__get_cpu_var(softnet_data).poll_list);
801 	if (dev->quota < 0)
802 		dev->quota += dev->weight;
803 	else
804 		dev->quota = dev->weight;
805 	__raise_softirq_irqoff(NET_RX_SOFTIRQ);
806 	local_irq_restore(flags);
807 }
808 
809 /* Try to reschedule poll. Called by irq handler. */
810 
811 static inline void netif_rx_schedule(struct net_device *dev)
812 {
813 	if (netif_rx_schedule_prep(dev))
814 		__netif_rx_schedule(dev);
815 }
816 
817 /* Try to reschedule poll. Called by dev->poll() after netif_rx_complete().
818  * Do not inline this?
819  */
820 static inline int netif_rx_reschedule(struct net_device *dev, int undo)
821 {
822 	if (netif_rx_schedule_prep(dev)) {
823 		unsigned long flags;
824 
825 		dev->quota += undo;
826 
827 		local_irq_save(flags);
828 		list_add_tail(&dev->poll_list, &__get_cpu_var(softnet_data).poll_list);
829 		__raise_softirq_irqoff(NET_RX_SOFTIRQ);
830 		local_irq_restore(flags);
831 		return 1;
832 	}
833 	return 0;
834 }
835 
836 /* Remove interface from poll list: it must be in the poll list
837  * on current cpu. This primitive is called by dev->poll(), when
838  * it completes the work. The device cannot be out of poll list at this
839  * moment, it is BUG().
840  */
841 static inline void netif_rx_complete(struct net_device *dev)
842 {
843 	unsigned long flags;
844 
845 	local_irq_save(flags);
846 	BUG_ON(!test_bit(__LINK_STATE_RX_SCHED, &dev->state));
847 	list_del(&dev->poll_list);
848 	smp_mb__before_clear_bit();
849 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
850 	local_irq_restore(flags);
851 }
852 
853 static inline void netif_poll_disable(struct net_device *dev)
854 {
855 	while (test_and_set_bit(__LINK_STATE_RX_SCHED, &dev->state)) {
856 		/* No hurry. */
857 		current->state = TASK_INTERRUPTIBLE;
858 		schedule_timeout(1);
859 	}
860 }
861 
862 static inline void netif_poll_enable(struct net_device *dev)
863 {
864 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
865 }
866 
867 /* same as netif_rx_complete, except that local_irq_save(flags)
868  * has already been issued
869  */
870 static inline void __netif_rx_complete(struct net_device *dev)
871 {
872 	BUG_ON(!test_bit(__LINK_STATE_RX_SCHED, &dev->state));
873 	list_del(&dev->poll_list);
874 	smp_mb__before_clear_bit();
875 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
876 }
877 
878 static inline void netif_tx_disable(struct net_device *dev)
879 {
880 	spin_lock_bh(&dev->xmit_lock);
881 	netif_stop_queue(dev);
882 	spin_unlock_bh(&dev->xmit_lock);
883 }
884 
885 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
886 
887 extern void		ether_setup(struct net_device *dev);
888 
889 /* Support for loadable net-drivers */
890 extern struct net_device *alloc_netdev(int sizeof_priv, const char *name,
891 				       void (*setup)(struct net_device *));
892 extern int		register_netdev(struct net_device *dev);
893 extern void		unregister_netdev(struct net_device *dev);
894 /* Functions used for multicast support */
895 extern void		dev_mc_upload(struct net_device *dev);
896 extern int 		dev_mc_delete(struct net_device *dev, void *addr, int alen, int all);
897 extern int		dev_mc_add(struct net_device *dev, void *addr, int alen, int newonly);
898 extern void		dev_mc_discard(struct net_device *dev);
899 extern void		dev_set_promiscuity(struct net_device *dev, int inc);
900 extern void		dev_set_allmulti(struct net_device *dev, int inc);
901 extern void		netdev_state_change(struct net_device *dev);
902 extern void		netdev_features_change(struct net_device *dev);
903 /* Load a device via the kmod */
904 extern void		dev_load(const char *name);
905 extern void		dev_mcast_init(void);
906 extern int		netdev_max_backlog;
907 extern int		weight_p;
908 extern int		netdev_set_master(struct net_device *dev, struct net_device *master);
909 extern int skb_checksum_help(struct sk_buff *skb, int inward);
910 /* rx skb timestamps */
911 extern void		net_enable_timestamp(void);
912 extern void		net_disable_timestamp(void);
913 
914 #ifdef CONFIG_PROC_FS
915 extern void *dev_seq_start(struct seq_file *seq, loff_t *pos);
916 extern void *dev_seq_next(struct seq_file *seq, void *v, loff_t *pos);
917 extern void dev_seq_stop(struct seq_file *seq, void *v);
918 #endif
919 
920 extern void linkwatch_run_queue(void);
921 
922 #endif /* __KERNEL__ */
923 
924 #endif	/* _LINUX_DEV_H */
925