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