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