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.
6 * Definitions for the Interfaces handler.
8 * Version: @(#)dev.h 1.0.10 08/12/93
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 * Corey Minyard <wf-rch!minyard@relay.EU.net>
13 * Donald J. Becker, <becker@cesdis.gsfc.nasa.gov>
14 * Alan Cox, <Alan.Cox@linux.org>
15 * Bjorn Ekwall. <bj0rn@blox.se>
16 * Pekka Riikonen <priikone@poseidon.pspt.fi>
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.
23 * Moved to /usr/include/linux for NET3
25 #ifndef _LINUX_NETDEVICE_H
26 #define _LINUX_NETDEVICE_H
29 #include <linux/if_ether.h>
30 #include <linux/if_packet.h>
33 #include <linux/timer.h>
34 #include <linux/delay.h>
35 #include <asm/atomic.h>
36 #include <asm/cache.h>
37 #include <asm/byteorder.h>
39 #include <linux/device.h>
40 #include <linux/percpu.h>
41 #include <linux/dmaengine.h>
42 #include <linux/workqueue.h>
44 #include <net/net_namespace.h>
51 /* source back-compat hooks */
52 #define SET_ETHTOOL_OPS(netdev,ops) \
53 ( (netdev)->ethtool_ops = (ops) )
55 #define HAVE_ALLOC_NETDEV /* feature macro: alloc_xxxdev
56 functions are available. */
57 #define HAVE_FREE_NETDEV /* free_netdev() */
58 #define HAVE_NETDEV_PRIV /* netdev_priv() */
60 #define NET_XMIT_SUCCESS 0
61 #define NET_XMIT_DROP 1 /* skb dropped */
62 #define NET_XMIT_CN 2 /* congestion notification */
63 #define NET_XMIT_POLICED 3 /* skb is shot by police */
64 #define NET_XMIT_BYPASS 4 /* packet does not leave via dequeue;
65 (TC use only - dev_queue_xmit
66 returns this as NET_XMIT_SUCCESS) */
68 /* Backlog congestion levels */
69 #define NET_RX_SUCCESS 0 /* keep 'em coming, baby */
70 #define NET_RX_DROP 1 /* packet dropped */
71 #define NET_RX_CN_LOW 2 /* storm alert, just in case */
72 #define NET_RX_CN_MOD 3 /* Storm on its way! */
73 #define NET_RX_CN_HIGH 4 /* The storm is here */
74 #define NET_RX_BAD 5 /* packet dropped due to kernel error */
76 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
77 * indicates that the device will soon be dropping packets, or already drops
78 * some packets of the same priority; prompting us to send less aggressively. */
79 #define net_xmit_eval(e) ((e) == NET_XMIT_CN? 0 : (e))
80 #define net_xmit_errno(e) ((e) != NET_XMIT_CN ? -ENOBUFS : 0)
84 #define MAX_ADDR_LEN 32 /* Largest hardware address length */
86 /* Driver transmit return codes */
87 #define NETDEV_TX_OK 0 /* driver took care of packet */
88 #define NETDEV_TX_BUSY 1 /* driver tx path was busy*/
89 #define NETDEV_TX_LOCKED -1 /* driver tx lock was already taken */
92 * Compute the worst case header length according to the protocols
96 #if !defined(CONFIG_AX25) && !defined(CONFIG_AX25_MODULE) && !defined(CONFIG_TR)
97 #define LL_MAX_HEADER 32
99 #if defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
100 #define LL_MAX_HEADER 96
102 #define LL_MAX_HEADER 48
106 #if !defined(CONFIG_NET_IPIP) && !defined(CONFIG_NET_IPIP_MODULE) && \
107 !defined(CONFIG_NET_IPGRE) && !defined(CONFIG_NET_IPGRE_MODULE) && \
108 !defined(CONFIG_IPV6_SIT) && !defined(CONFIG_IPV6_SIT_MODULE) && \
109 !defined(CONFIG_IPV6_TUNNEL) && !defined(CONFIG_IPV6_TUNNEL_MODULE)
110 #define MAX_HEADER LL_MAX_HEADER
112 #define MAX_HEADER (LL_MAX_HEADER + 48)
115 struct net_device_subqueue
117 /* Give a control state for each queue. This struct may contain
118 * per-queue locks in the future.
124 * Network device statistics. Akin to the 2.0 ether stats but
125 * with byte counters.
128 struct net_device_stats
130 unsigned long rx_packets; /* total packets received */
131 unsigned long tx_packets; /* total packets transmitted */
132 unsigned long rx_bytes; /* total bytes received */
133 unsigned long tx_bytes; /* total bytes transmitted */
134 unsigned long rx_errors; /* bad packets received */
135 unsigned long tx_errors; /* packet transmit problems */
136 unsigned long rx_dropped; /* no space in linux buffers */
137 unsigned long tx_dropped; /* no space available in linux */
138 unsigned long multicast; /* multicast packets received */
139 unsigned long collisions;
141 /* detailed rx_errors: */
142 unsigned long rx_length_errors;
143 unsigned long rx_over_errors; /* receiver ring buff overflow */
144 unsigned long rx_crc_errors; /* recved pkt with crc error */
145 unsigned long rx_frame_errors; /* recv'd frame alignment error */
146 unsigned long rx_fifo_errors; /* recv'r fifo overrun */
147 unsigned long rx_missed_errors; /* receiver missed packet */
149 /* detailed tx_errors */
150 unsigned long tx_aborted_errors;
151 unsigned long tx_carrier_errors;
152 unsigned long tx_fifo_errors;
153 unsigned long tx_heartbeat_errors;
154 unsigned long tx_window_errors;
157 unsigned long rx_compressed;
158 unsigned long tx_compressed;
162 /* Media selection options. */
175 #include <linux/cache.h>
176 #include <linux/skbuff.h>
182 struct netif_rx_stats
186 unsigned time_squeeze;
187 unsigned cpu_collision;
190 DECLARE_PER_CPU(struct netif_rx_stats, netdev_rx_stat);
194 struct dev_addr_list *next;
195 u8 da_addr[MAX_ADDR_LEN];
203 * We tag multicasts with these structures.
206 #define dev_mc_list dev_addr_list
207 #define dmi_addr da_addr
208 #define dmi_addrlen da_addrlen
209 #define dmi_users da_users
210 #define dmi_gusers da_gusers
214 struct hh_cache *hh_next; /* Next entry */
215 atomic_t hh_refcnt; /* number of users */
217 * We want hh_output, hh_len, hh_lock and hh_data be a in a separate
219 * They are mostly read, but hh_refcnt may be changed quite frequently,
220 * incurring cache line ping pongs.
222 __be16 hh_type ____cacheline_aligned_in_smp;
223 /* protocol identifier, f.e ETH_P_IP
224 * NOTE: For VLANs, this will be the
225 * encapuslated type. --BLG
227 u16 hh_len; /* length of header */
228 int (*hh_output)(struct sk_buff *skb);
231 /* cached hardware header; allow for machine alignment needs. */
232 #define HH_DATA_MOD 16
233 #define HH_DATA_OFF(__len) \
234 (HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
235 #define HH_DATA_ALIGN(__len) \
236 (((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
237 unsigned long hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
240 /* Reserve HH_DATA_MOD byte aligned hard_header_len, but at least that much.
242 * dev->hard_header_len ? (dev->hard_header_len +
243 * (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
245 * We could use other alignment values, but we must maintain the
246 * relationship HH alignment <= LL alignment.
248 #define LL_RESERVED_SPACE(dev) \
249 (((dev)->hard_header_len&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
250 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
251 ((((dev)->hard_header_len+extra)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
254 int (*create) (struct sk_buff *skb, struct net_device *dev,
255 unsigned short type, const void *daddr,
256 const void *saddr, unsigned len);
257 int (*parse)(const struct sk_buff *skb, unsigned char *haddr);
258 int (*rebuild)(struct sk_buff *skb);
259 #define HAVE_HEADER_CACHE
260 int (*cache)(const struct neighbour *neigh, struct hh_cache *hh);
261 void (*cache_update)(struct hh_cache *hh,
262 const struct net_device *dev,
263 const unsigned char *haddr);
266 /* These flag bits are private to the generic network queueing
267 * layer, they may not be explicitly referenced by any other
275 __LINK_STATE_PRESENT,
277 __LINK_STATE_NOCARRIER,
278 __LINK_STATE_LINKWATCH_PENDING,
279 __LINK_STATE_DORMANT,
280 __LINK_STATE_QDISC_RUNNING,
285 * This structure holds at boot time configured netdevice settings. They
286 * are then used in the device probing.
288 struct netdev_boot_setup {
292 #define NETDEV_BOOT_SETUP_MAX 8
294 extern int __init netdev_boot_setup(char *str);
297 * Structure for NAPI scheduling similar to tasklet but with weighting
300 /* The poll_list must only be managed by the entity which
301 * changes the state of the NAPI_STATE_SCHED bit. This means
302 * whoever atomically sets that bit can add this napi_struct
303 * to the per-cpu poll_list, and whoever clears that bit
304 * can remove from the list right before clearing the bit.
306 struct list_head poll_list;
310 int (*poll)(struct napi_struct *, int);
311 #ifdef CONFIG_NETPOLL
312 spinlock_t poll_lock;
314 struct net_device *dev;
315 struct list_head dev_list;
321 NAPI_STATE_SCHED, /* Poll is scheduled */
324 extern void FASTCALL(__napi_schedule(struct napi_struct *n));
327 * napi_schedule_prep - check if napi can be scheduled
330 * Test if NAPI routine is already running, and if not mark
331 * it as running. This is used as a condition variable
332 * insure only one NAPI poll instance runs
334 static inline int napi_schedule_prep(struct napi_struct *n)
336 return !test_and_set_bit(NAPI_STATE_SCHED, &n->state);
340 * napi_schedule - schedule NAPI poll
343 * Schedule NAPI poll routine to be called if it is not already
346 static inline void napi_schedule(struct napi_struct *n)
348 if (napi_schedule_prep(n))
352 /* Try to reschedule poll. Called by dev->poll() after napi_complete(). */
353 static inline int napi_reschedule(struct napi_struct *napi)
355 if (napi_schedule_prep(napi)) {
356 __napi_schedule(napi);
363 * napi_complete - NAPI processing complete
366 * Mark NAPI processing as complete.
368 static inline void __napi_complete(struct napi_struct *n)
370 BUG_ON(!test_bit(NAPI_STATE_SCHED, &n->state));
371 list_del(&n->poll_list);
372 smp_mb__before_clear_bit();
373 clear_bit(NAPI_STATE_SCHED, &n->state);
376 static inline void napi_complete(struct napi_struct *n)
384 * napi_disable - prevent NAPI from scheduling
387 * Stop NAPI from being scheduled on this context.
388 * Waits till any outstanding processing completes.
390 static inline void napi_disable(struct napi_struct *n)
392 while (test_and_set_bit(NAPI_STATE_SCHED, &n->state))
393 msleep_interruptible(1);
397 * napi_enable - enable NAPI scheduling
400 * Resume NAPI from being scheduled on this context.
401 * Must be paired with napi_disable.
403 static inline void napi_enable(struct napi_struct *n)
405 BUG_ON(!test_bit(NAPI_STATE_SCHED, &n->state));
406 smp_mb__before_clear_bit();
407 clear_bit(NAPI_STATE_SCHED, &n->state);
411 * The DEVICE structure.
412 * Actually, this whole structure is a big mistake. It mixes I/O
413 * data with strictly "high-level" data, and it has to know about
414 * almost every data structure used in the INET module.
416 * FIXME: cleanup struct net_device such that network protocol info
424 * This is the first field of the "visible" part of this structure
425 * (i.e. as seen by users in the "Space.c" file). It is the name
429 /* device name hash chain */
430 struct hlist_node name_hlist;
433 * I/O specific fields
434 * FIXME: Merge these and struct ifmap into one
436 unsigned long mem_end; /* shared mem end */
437 unsigned long mem_start; /* shared mem start */
438 unsigned long base_addr; /* device I/O address */
439 unsigned int irq; /* device IRQ number */
442 * Some hardware also needs these fields, but they are not
443 * part of the usual set specified in Space.c.
446 unsigned char if_port; /* Selectable AUI, TP,..*/
447 unsigned char dma; /* DMA channel */
451 struct list_head dev_list;
452 #ifdef CONFIG_NETPOLL
453 struct list_head napi_list;
456 /* The device initialization function. Called only once. */
457 int (*init)(struct net_device *dev);
459 /* ------- Fields preinitialized in Space.c finish here ------- */
461 /* Net device features */
462 unsigned long features;
463 #define NETIF_F_SG 1 /* Scatter/gather IO. */
464 #define NETIF_F_IP_CSUM 2 /* Can checksum TCP/UDP over IPv4. */
465 #define NETIF_F_NO_CSUM 4 /* Does not require checksum. F.e. loopack. */
466 #define NETIF_F_HW_CSUM 8 /* Can checksum all the packets. */
467 #define NETIF_F_IPV6_CSUM 16 /* Can checksum TCP/UDP over IPV6 */
468 #define NETIF_F_HIGHDMA 32 /* Can DMA to high memory. */
469 #define NETIF_F_FRAGLIST 64 /* Scatter/gather IO. */
470 #define NETIF_F_HW_VLAN_TX 128 /* Transmit VLAN hw acceleration */
471 #define NETIF_F_HW_VLAN_RX 256 /* Receive VLAN hw acceleration */
472 #define NETIF_F_HW_VLAN_FILTER 512 /* Receive filtering on VLAN */
473 #define NETIF_F_VLAN_CHALLENGED 1024 /* Device cannot handle VLAN packets */
474 #define NETIF_F_GSO 2048 /* Enable software GSO. */
475 #define NETIF_F_LLTX 4096 /* LockLess TX - deprecated. Please */
476 /* do not use LLTX in new drivers */
477 #define NETIF_F_NETNS_LOCAL 8192 /* Does not change network namespaces */
478 #define NETIF_F_MULTI_QUEUE 16384 /* Has multiple TX/RX queues */
479 #define NETIF_F_LRO 32768 /* large receive offload */
481 /* Segmentation offload features */
482 #define NETIF_F_GSO_SHIFT 16
483 #define NETIF_F_GSO_MASK 0xffff0000
484 #define NETIF_F_TSO (SKB_GSO_TCPV4 << NETIF_F_GSO_SHIFT)
485 #define NETIF_F_UFO (SKB_GSO_UDP << NETIF_F_GSO_SHIFT)
486 #define NETIF_F_GSO_ROBUST (SKB_GSO_DODGY << NETIF_F_GSO_SHIFT)
487 #define NETIF_F_TSO_ECN (SKB_GSO_TCP_ECN << NETIF_F_GSO_SHIFT)
488 #define NETIF_F_TSO6 (SKB_GSO_TCPV6 << NETIF_F_GSO_SHIFT)
490 /* List of features with software fallbacks. */
491 #define NETIF_F_GSO_SOFTWARE (NETIF_F_TSO | NETIF_F_TSO_ECN | NETIF_F_TSO6)
494 #define NETIF_F_GEN_CSUM (NETIF_F_NO_CSUM | NETIF_F_HW_CSUM)
495 #define NETIF_F_V4_CSUM (NETIF_F_GEN_CSUM | NETIF_F_IP_CSUM)
496 #define NETIF_F_V6_CSUM (NETIF_F_GEN_CSUM | NETIF_F_IPV6_CSUM)
497 #define NETIF_F_ALL_CSUM (NETIF_F_V4_CSUM | NETIF_F_V6_CSUM)
499 struct net_device *next_sched;
501 /* Interface index. Unique device identifier */
506 struct net_device_stats* (*get_stats)(struct net_device *dev);
507 struct net_device_stats stats;
509 #ifdef CONFIG_WIRELESS_EXT
510 /* List of functions to handle Wireless Extensions (instead of ioctl).
511 * See <net/iw_handler.h> for details. Jean II */
512 const struct iw_handler_def * wireless_handlers;
513 /* Instance data managed by the core of Wireless Extensions. */
514 struct iw_public_data * wireless_data;
516 const struct ethtool_ops *ethtool_ops;
518 /* Hardware header description */
519 const struct header_ops *header_ops;
522 * This marks the end of the "visible" part of the structure. All
523 * fields hereafter are internal to the system, and may change at
524 * will (read: may be cleaned up at will).
528 unsigned int flags; /* interface flags (a la BSD) */
529 unsigned short gflags;
530 unsigned short priv_flags; /* Like 'flags' but invisible to userspace. */
531 unsigned short padded; /* How much padding added by alloc_netdev() */
533 unsigned char operstate; /* RFC2863 operstate */
534 unsigned char link_mode; /* mapping policy to operstate */
536 unsigned mtu; /* interface MTU value */
537 unsigned short type; /* interface hardware type */
538 unsigned short hard_header_len; /* hardware hdr length */
540 struct net_device *master; /* Pointer to master device of a group,
541 * which this device is member of.
544 /* Interface address info. */
545 unsigned char perm_addr[MAX_ADDR_LEN]; /* permanent hw address */
546 unsigned char addr_len; /* hardware address length */
547 unsigned short dev_id; /* for shared network cards */
549 struct dev_addr_list *uc_list; /* Secondary unicast mac addresses */
550 int uc_count; /* Number of installed ucasts */
552 struct dev_addr_list *mc_list; /* Multicast mac addresses */
553 int mc_count; /* Number of installed mcasts */
558 /* Protocol specific pointers */
560 void *atalk_ptr; /* AppleTalk link */
561 void *ip_ptr; /* IPv4 specific data */
562 void *dn_ptr; /* DECnet specific data */
563 void *ip6_ptr; /* IPv6 specific data */
564 void *ec_ptr; /* Econet specific data */
565 void *ax25_ptr; /* AX.25 specific data */
566 struct wireless_dev *ieee80211_ptr; /* IEEE 802.11 specific data,
567 assign before registering */
570 * Cache line mostly used on receive path (including eth_type_trans())
572 unsigned long last_rx; /* Time of last Rx */
573 /* Interface address info used in eth_type_trans() */
574 unsigned char dev_addr[MAX_ADDR_LEN]; /* hw address, (before bcast
575 because most packets are unicast) */
577 unsigned char broadcast[MAX_ADDR_LEN]; /* hw bcast add */
580 * Cache line mostly used on queue transmit path (qdisc)
582 /* device queue lock */
583 spinlock_t queue_lock ____cacheline_aligned_in_smp;
585 struct Qdisc *qdisc_sleeping;
586 struct list_head qdisc_list;
587 unsigned long tx_queue_len; /* Max frames per queue allowed */
589 /* Partially transmitted GSO packet. */
590 struct sk_buff *gso_skb;
592 /* ingress path synchronizer */
593 spinlock_t ingress_lock;
594 struct Qdisc *qdisc_ingress;
597 * One part is mostly used on xmit path (device)
599 /* hard_start_xmit synchronizer */
600 spinlock_t _xmit_lock ____cacheline_aligned_in_smp;
601 /* cpu id of processor entered to hard_start_xmit or -1,
602 if nobody entered there.
605 void *priv; /* pointer to private data */
606 int (*hard_start_xmit) (struct sk_buff *skb,
607 struct net_device *dev);
608 /* These may be needed for future network-power-down code. */
609 unsigned long trans_start; /* Time (in jiffies) of last Tx */
611 int watchdog_timeo; /* used by dev_watchdog() */
612 struct timer_list watchdog_timer;
615 * refcnt is a very hot point, so align it on SMP
617 /* Number of references to this device */
618 atomic_t refcnt ____cacheline_aligned_in_smp;
620 /* delayed register/unregister */
621 struct list_head todo_list;
622 /* device index hash chain */
623 struct hlist_node index_hlist;
625 struct net_device *link_watch_next;
627 /* register/unregister state machine */
628 enum { NETREG_UNINITIALIZED=0,
629 NETREG_REGISTERED, /* completed register_netdevice */
630 NETREG_UNREGISTERING, /* called unregister_netdevice */
631 NETREG_UNREGISTERED, /* completed unregister todo */
632 NETREG_RELEASED, /* called free_netdev */
635 /* Called after device is detached from network. */
636 void (*uninit)(struct net_device *dev);
637 /* Called after last user reference disappears. */
638 void (*destructor)(struct net_device *dev);
640 /* Pointers to interface service routines. */
641 int (*open)(struct net_device *dev);
642 int (*stop)(struct net_device *dev);
643 #define HAVE_NETDEV_POLL
644 #define HAVE_CHANGE_RX_FLAGS
645 void (*change_rx_flags)(struct net_device *dev,
647 #define HAVE_SET_RX_MODE
648 void (*set_rx_mode)(struct net_device *dev);
649 #define HAVE_MULTICAST
650 void (*set_multicast_list)(struct net_device *dev);
651 #define HAVE_SET_MAC_ADDR
652 int (*set_mac_address)(struct net_device *dev,
654 #define HAVE_PRIVATE_IOCTL
655 int (*do_ioctl)(struct net_device *dev,
656 struct ifreq *ifr, int cmd);
657 #define HAVE_SET_CONFIG
658 int (*set_config)(struct net_device *dev,
660 #define HAVE_CHANGE_MTU
661 int (*change_mtu)(struct net_device *dev, int new_mtu);
663 #define HAVE_TX_TIMEOUT
664 void (*tx_timeout) (struct net_device *dev);
666 void (*vlan_rx_register)(struct net_device *dev,
667 struct vlan_group *grp);
668 void (*vlan_rx_add_vid)(struct net_device *dev,
670 void (*vlan_rx_kill_vid)(struct net_device *dev,
673 int (*neigh_setup)(struct net_device *dev, struct neigh_parms *);
674 #ifdef CONFIG_NETPOLL
675 struct netpoll_info *npinfo;
677 #ifdef CONFIG_NET_POLL_CONTROLLER
678 void (*poll_controller)(struct net_device *dev);
681 /* Network namespace this network device is inside */
685 struct net_bridge_port *br_port;
687 struct macvlan_port *macvlan_port;
689 /* class/net/name entry */
691 /* space for optional statistics and wireless sysfs groups */
692 struct attribute_group *sysfs_groups[3];
694 /* rtnetlink link ops */
695 const struct rtnl_link_ops *rtnl_link_ops;
697 /* The TX queue control structures */
698 unsigned int egress_subqueue_count;
699 struct net_device_subqueue egress_subqueue[1];
701 #define to_net_dev(d) container_of(d, struct net_device, dev)
703 #define NETDEV_ALIGN 32
704 #define NETDEV_ALIGN_CONST (NETDEV_ALIGN - 1)
707 * netdev_priv - access network device private data
708 * @dev: network device
710 * Get network device private data
712 static inline void *netdev_priv(const struct net_device *dev)
717 /* Set the sysfs physical device reference for the network logical device
718 * if set prior to registration will cause a symlink during initialization.
720 #define SET_NETDEV_DEV(net, pdev) ((net)->dev.parent = (pdev))
722 static inline void netif_napi_add(struct net_device *dev,
723 struct napi_struct *napi,
724 int (*poll)(struct napi_struct *, int),
727 INIT_LIST_HEAD(&napi->poll_list);
729 napi->weight = weight;
730 #ifdef CONFIG_NETPOLL
732 list_add(&napi->dev_list, &dev->napi_list);
733 spin_lock_init(&napi->poll_lock);
734 napi->poll_owner = -1;
736 set_bit(NAPI_STATE_SCHED, &napi->state);
740 __be16 type; /* This is really htons(ether_type). */
741 struct net_device *dev; /* NULL is wildcarded here */
742 int (*func) (struct sk_buff *,
744 struct packet_type *,
745 struct net_device *);
746 struct sk_buff *(*gso_segment)(struct sk_buff *skb,
748 int (*gso_send_check)(struct sk_buff *skb);
749 void *af_packet_priv;
750 struct list_head list;
753 #include <linux/interrupt.h>
754 #include <linux/notifier.h>
756 extern rwlock_t dev_base_lock; /* Device list lock */
759 #define for_each_netdev(net, d) \
760 list_for_each_entry(d, &(net)->dev_base_head, dev_list)
761 #define for_each_netdev_safe(net, d, n) \
762 list_for_each_entry_safe(d, n, &(net)->dev_base_head, dev_list)
763 #define for_each_netdev_continue(net, d) \
764 list_for_each_entry_continue(d, &(net)->dev_base_head, dev_list)
765 #define net_device_entry(lh) list_entry(lh, struct net_device, dev_list)
767 static inline struct net_device *next_net_device(struct net_device *dev)
769 struct list_head *lh;
773 lh = dev->dev_list.next;
774 return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
777 static inline struct net_device *first_net_device(struct net *net)
779 return list_empty(&net->dev_base_head) ? NULL :
780 net_device_entry(net->dev_base_head.next);
783 extern int netdev_boot_setup_check(struct net_device *dev);
784 extern unsigned long netdev_boot_base(const char *prefix, int unit);
785 extern struct net_device *dev_getbyhwaddr(struct net *net, unsigned short type, char *hwaddr);
786 extern struct net_device *dev_getfirstbyhwtype(struct net *net, unsigned short type);
787 extern struct net_device *__dev_getfirstbyhwtype(struct net *net, unsigned short type);
788 extern void dev_add_pack(struct packet_type *pt);
789 extern void dev_remove_pack(struct packet_type *pt);
790 extern void __dev_remove_pack(struct packet_type *pt);
792 extern struct net_device *dev_get_by_flags(struct net *net, unsigned short flags,
793 unsigned short mask);
794 extern struct net_device *dev_get_by_name(struct net *net, const char *name);
795 extern struct net_device *__dev_get_by_name(struct net *net, const char *name);
796 extern int dev_alloc_name(struct net_device *dev, const char *name);
797 extern int dev_open(struct net_device *dev);
798 extern int dev_close(struct net_device *dev);
799 extern int dev_queue_xmit(struct sk_buff *skb);
800 extern int register_netdevice(struct net_device *dev);
801 extern void unregister_netdevice(struct net_device *dev);
802 extern void free_netdev(struct net_device *dev);
803 extern void synchronize_net(void);
804 extern int register_netdevice_notifier(struct notifier_block *nb);
805 extern int unregister_netdevice_notifier(struct notifier_block *nb);
806 extern int call_netdevice_notifiers(unsigned long val, struct net_device *dev);
807 extern struct net_device *dev_get_by_index(struct net *net, int ifindex);
808 extern struct net_device *__dev_get_by_index(struct net *net, int ifindex);
809 extern int dev_restart(struct net_device *dev);
810 #ifdef CONFIG_NETPOLL_TRAP
811 extern int netpoll_trap(void);
814 static inline int dev_hard_header(struct sk_buff *skb, struct net_device *dev,
816 const void *daddr, const void *saddr,
819 if (!dev->header_ops)
822 return dev->header_ops->create(skb, dev, type, daddr, saddr, len);
825 static inline int dev_parse_header(const struct sk_buff *skb,
826 unsigned char *haddr)
828 const struct net_device *dev = skb->dev;
830 if (!dev->header_ops->parse)
832 return dev->header_ops->parse(skb, haddr);
835 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
836 extern int register_gifconf(unsigned int family, gifconf_func_t * gifconf);
837 static inline int unregister_gifconf(unsigned int family)
839 return register_gifconf(family, NULL);
843 * Incoming packets are placed on per-cpu queues so that
844 * no locking is needed.
848 struct net_device *output_queue;
849 struct sk_buff_head input_pkt_queue;
850 struct list_head poll_list;
851 struct sk_buff *completion_queue;
853 struct napi_struct backlog;
854 #ifdef CONFIG_NET_DMA
855 struct dma_chan *net_dma;
859 DECLARE_PER_CPU(struct softnet_data,softnet_data);
861 #define HAVE_NETIF_QUEUE
863 extern void __netif_schedule(struct net_device *dev);
865 static inline void netif_schedule(struct net_device *dev)
867 if (!test_bit(__LINK_STATE_XOFF, &dev->state))
868 __netif_schedule(dev);
872 * netif_start_queue - allow transmit
873 * @dev: network device
875 * Allow upper layers to call the device hard_start_xmit routine.
877 static inline void netif_start_queue(struct net_device *dev)
879 clear_bit(__LINK_STATE_XOFF, &dev->state);
883 * netif_wake_queue - restart transmit
884 * @dev: network device
886 * Allow upper layers to call the device hard_start_xmit routine.
887 * Used for flow control when transmit resources are available.
889 static inline void netif_wake_queue(struct net_device *dev)
891 #ifdef CONFIG_NETPOLL_TRAP
892 if (netpoll_trap()) {
893 clear_bit(__LINK_STATE_XOFF, &dev->state);
897 if (test_and_clear_bit(__LINK_STATE_XOFF, &dev->state))
898 __netif_schedule(dev);
902 * netif_stop_queue - stop transmitted packets
903 * @dev: network device
905 * Stop upper layers calling the device hard_start_xmit routine.
906 * Used for flow control when transmit resources are unavailable.
908 static inline void netif_stop_queue(struct net_device *dev)
910 set_bit(__LINK_STATE_XOFF, &dev->state);
914 * netif_queue_stopped - test if transmit queue is flowblocked
915 * @dev: network device
917 * Test if transmit queue on device is currently unable to send.
919 static inline int netif_queue_stopped(const struct net_device *dev)
921 return test_bit(__LINK_STATE_XOFF, &dev->state);
925 * netif_running - test if up
926 * @dev: network device
928 * Test if the device has been brought up.
930 static inline int netif_running(const struct net_device *dev)
932 return test_bit(__LINK_STATE_START, &dev->state);
936 * Routines to manage the subqueues on a device. We only need start
937 * stop, and a check if it's stopped. All other device management is
938 * done at the overall netdevice level.
939 * Also test the device if we're multiqueue.
943 * netif_start_subqueue - allow sending packets on subqueue
944 * @dev: network device
945 * @queue_index: sub queue index
947 * Start individual transmit queue of a device with multiple transmit queues.
949 static inline void netif_start_subqueue(struct net_device *dev, u16 queue_index)
951 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
952 clear_bit(__LINK_STATE_XOFF, &dev->egress_subqueue[queue_index].state);
957 * netif_stop_subqueue - stop sending packets on subqueue
958 * @dev: network device
959 * @queue_index: sub queue index
961 * Stop individual transmit queue of a device with multiple transmit queues.
963 static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
965 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
966 #ifdef CONFIG_NETPOLL_TRAP
970 set_bit(__LINK_STATE_XOFF, &dev->egress_subqueue[queue_index].state);
975 * netif_subqueue_stopped - test status of subqueue
976 * @dev: network device
977 * @queue_index: sub queue index
979 * Check individual transmit queue of a device with multiple transmit queues.
981 static inline int netif_subqueue_stopped(const struct net_device *dev,
984 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
985 return test_bit(__LINK_STATE_XOFF,
986 &dev->egress_subqueue[queue_index].state);
994 * netif_wake_subqueue - allow sending packets on subqueue
995 * @dev: network device
996 * @queue_index: sub queue index
998 * Resume individual transmit queue of a device with multiple transmit queues.
1000 static inline void netif_wake_subqueue(struct net_device *dev, u16 queue_index)
1002 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
1003 #ifdef CONFIG_NETPOLL_TRAP
1007 if (test_and_clear_bit(__LINK_STATE_XOFF,
1008 &dev->egress_subqueue[queue_index].state))
1009 __netif_schedule(dev);
1014 * netif_is_multiqueue - test if device has multiple transmit queues
1015 * @dev: network device
1017 * Check if device has multiple transmit queues
1018 * Always falls if NETDEVICE_MULTIQUEUE is not configured
1020 static inline int netif_is_multiqueue(const struct net_device *dev)
1022 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
1023 return (!!(NETIF_F_MULTI_QUEUE & dev->features));
1029 /* Use this variant when it is known for sure that it
1030 * is executing from interrupt context.
1032 extern void dev_kfree_skb_irq(struct sk_buff *skb);
1034 /* Use this variant in places where it could be invoked
1035 * either from interrupt or non-interrupt context.
1037 extern void dev_kfree_skb_any(struct sk_buff *skb);
1039 #define HAVE_NETIF_RX 1
1040 extern int netif_rx(struct sk_buff *skb);
1041 extern int netif_rx_ni(struct sk_buff *skb);
1042 #define HAVE_NETIF_RECEIVE_SKB 1
1043 extern int netif_receive_skb(struct sk_buff *skb);
1044 extern int dev_valid_name(const char *name);
1045 extern int dev_ioctl(struct net *net, unsigned int cmd, void __user *);
1046 extern int dev_ethtool(struct net *net, struct ifreq *);
1047 extern unsigned dev_get_flags(const struct net_device *);
1048 extern int dev_change_flags(struct net_device *, unsigned);
1049 extern int dev_change_name(struct net_device *, char *);
1050 extern int dev_change_net_namespace(struct net_device *,
1051 struct net *, const char *);
1052 extern int dev_set_mtu(struct net_device *, int);
1053 extern int dev_set_mac_address(struct net_device *,
1055 extern int dev_hard_start_xmit(struct sk_buff *skb,
1056 struct net_device *dev);
1058 extern int netdev_budget;
1060 /* Called by rtnetlink.c:rtnl_unlock() */
1061 extern void netdev_run_todo(void);
1064 * dev_put - release reference to device
1065 * @dev: network device
1067 * Release reference to device to allow it to be freed.
1069 static inline void dev_put(struct net_device *dev)
1071 atomic_dec(&dev->refcnt);
1075 * dev_hold - get reference to device
1076 * @dev: network device
1078 * Hold reference to device to keep it from being freed.
1080 static inline void dev_hold(struct net_device *dev)
1082 atomic_inc(&dev->refcnt);
1085 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
1086 * and _off may be called from IRQ context, but it is caller
1087 * who is responsible for serialization of these calls.
1089 * The name carrier is inappropriate, these functions should really be
1090 * called netif_lowerlayer_*() because they represent the state of any
1091 * kind of lower layer not just hardware media.
1094 extern void linkwatch_fire_event(struct net_device *dev);
1097 * netif_carrier_ok - test if carrier present
1098 * @dev: network device
1100 * Check if carrier is present on device
1102 static inline int netif_carrier_ok(const struct net_device *dev)
1104 return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
1107 extern void __netdev_watchdog_up(struct net_device *dev);
1109 extern void netif_carrier_on(struct net_device *dev);
1111 extern void netif_carrier_off(struct net_device *dev);
1114 * netif_dormant_on - mark device as dormant.
1115 * @dev: network device
1117 * Mark device as dormant (as per RFC2863).
1119 * The dormant state indicates that the relevant interface is not
1120 * actually in a condition to pass packets (i.e., it is not 'up') but is
1121 * in a "pending" state, waiting for some external event. For "on-
1122 * demand" interfaces, this new state identifies the situation where the
1123 * interface is waiting for events to place it in the up state.
1126 static inline void netif_dormant_on(struct net_device *dev)
1128 if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
1129 linkwatch_fire_event(dev);
1133 * netif_dormant_off - set device as not dormant.
1134 * @dev: network device
1136 * Device is not in dormant state.
1138 static inline void netif_dormant_off(struct net_device *dev)
1140 if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
1141 linkwatch_fire_event(dev);
1145 * netif_dormant - test if carrier present
1146 * @dev: network device
1148 * Check if carrier is present on device
1150 static inline int netif_dormant(const struct net_device *dev)
1152 return test_bit(__LINK_STATE_DORMANT, &dev->state);
1157 * netif_oper_up - test if device is operational
1158 * @dev: network device
1160 * Check if carrier is operational
1162 static inline int netif_oper_up(const struct net_device *dev) {
1163 return (dev->operstate == IF_OPER_UP ||
1164 dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
1168 * netif_device_present - is device available or removed
1169 * @dev: network device
1171 * Check if device has not been removed from system.
1173 static inline int netif_device_present(struct net_device *dev)
1175 return test_bit(__LINK_STATE_PRESENT, &dev->state);
1178 extern void netif_device_detach(struct net_device *dev);
1180 extern void netif_device_attach(struct net_device *dev);
1183 * Network interface message level settings
1185 #define HAVE_NETIF_MSG 1
1188 NETIF_MSG_DRV = 0x0001,
1189 NETIF_MSG_PROBE = 0x0002,
1190 NETIF_MSG_LINK = 0x0004,
1191 NETIF_MSG_TIMER = 0x0008,
1192 NETIF_MSG_IFDOWN = 0x0010,
1193 NETIF_MSG_IFUP = 0x0020,
1194 NETIF_MSG_RX_ERR = 0x0040,
1195 NETIF_MSG_TX_ERR = 0x0080,
1196 NETIF_MSG_TX_QUEUED = 0x0100,
1197 NETIF_MSG_INTR = 0x0200,
1198 NETIF_MSG_TX_DONE = 0x0400,
1199 NETIF_MSG_RX_STATUS = 0x0800,
1200 NETIF_MSG_PKTDATA = 0x1000,
1201 NETIF_MSG_HW = 0x2000,
1202 NETIF_MSG_WOL = 0x4000,
1205 #define netif_msg_drv(p) ((p)->msg_enable & NETIF_MSG_DRV)
1206 #define netif_msg_probe(p) ((p)->msg_enable & NETIF_MSG_PROBE)
1207 #define netif_msg_link(p) ((p)->msg_enable & NETIF_MSG_LINK)
1208 #define netif_msg_timer(p) ((p)->msg_enable & NETIF_MSG_TIMER)
1209 #define netif_msg_ifdown(p) ((p)->msg_enable & NETIF_MSG_IFDOWN)
1210 #define netif_msg_ifup(p) ((p)->msg_enable & NETIF_MSG_IFUP)
1211 #define netif_msg_rx_err(p) ((p)->msg_enable & NETIF_MSG_RX_ERR)
1212 #define netif_msg_tx_err(p) ((p)->msg_enable & NETIF_MSG_TX_ERR)
1213 #define netif_msg_tx_queued(p) ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
1214 #define netif_msg_intr(p) ((p)->msg_enable & NETIF_MSG_INTR)
1215 #define netif_msg_tx_done(p) ((p)->msg_enable & NETIF_MSG_TX_DONE)
1216 #define netif_msg_rx_status(p) ((p)->msg_enable & NETIF_MSG_RX_STATUS)
1217 #define netif_msg_pktdata(p) ((p)->msg_enable & NETIF_MSG_PKTDATA)
1218 #define netif_msg_hw(p) ((p)->msg_enable & NETIF_MSG_HW)
1219 #define netif_msg_wol(p) ((p)->msg_enable & NETIF_MSG_WOL)
1221 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
1224 if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
1225 return default_msg_enable_bits;
1226 if (debug_value == 0) /* no output */
1228 /* set low N bits */
1229 return (1 << debug_value) - 1;
1232 /* Test if receive needs to be scheduled but only if up */
1233 static inline int netif_rx_schedule_prep(struct net_device *dev,
1234 struct napi_struct *napi)
1236 return netif_running(dev) && napi_schedule_prep(napi);
1239 /* Add interface to tail of rx poll list. This assumes that _prep has
1240 * already been called and returned 1.
1242 static inline void __netif_rx_schedule(struct net_device *dev,
1243 struct napi_struct *napi)
1246 __napi_schedule(napi);
1249 /* Try to reschedule poll. Called by irq handler. */
1251 static inline void netif_rx_schedule(struct net_device *dev,
1252 struct napi_struct *napi)
1254 if (netif_rx_schedule_prep(dev, napi))
1255 __netif_rx_schedule(dev, napi);
1258 /* Try to reschedule poll. Called by dev->poll() after netif_rx_complete(). */
1259 static inline int netif_rx_reschedule(struct net_device *dev,
1260 struct napi_struct *napi)
1262 if (napi_schedule_prep(napi)) {
1263 __netif_rx_schedule(dev, napi);
1269 /* same as netif_rx_complete, except that local_irq_save(flags)
1270 * has already been issued
1272 static inline void __netif_rx_complete(struct net_device *dev,
1273 struct napi_struct *napi)
1275 __napi_complete(napi);
1279 /* Remove interface from poll list: it must be in the poll list
1280 * on current cpu. This primitive is called by dev->poll(), when
1281 * it completes the work. The device cannot be out of poll list at this
1282 * moment, it is BUG().
1284 static inline void netif_rx_complete(struct net_device *dev,
1285 struct napi_struct *napi)
1287 unsigned long flags;
1289 local_irq_save(flags);
1290 __netif_rx_complete(dev, napi);
1291 local_irq_restore(flags);
1295 * netif_tx_lock - grab network device transmit lock
1296 * @dev: network device
1297 * @cpu: cpu number of lock owner
1299 * Get network device transmit lock
1301 static inline void __netif_tx_lock(struct net_device *dev, int cpu)
1303 spin_lock(&dev->_xmit_lock);
1304 dev->xmit_lock_owner = cpu;
1307 static inline void netif_tx_lock(struct net_device *dev)
1309 __netif_tx_lock(dev, smp_processor_id());
1312 static inline void netif_tx_lock_bh(struct net_device *dev)
1314 spin_lock_bh(&dev->_xmit_lock);
1315 dev->xmit_lock_owner = smp_processor_id();
1318 static inline int netif_tx_trylock(struct net_device *dev)
1320 int ok = spin_trylock(&dev->_xmit_lock);
1322 dev->xmit_lock_owner = smp_processor_id();
1326 static inline void netif_tx_unlock(struct net_device *dev)
1328 dev->xmit_lock_owner = -1;
1329 spin_unlock(&dev->_xmit_lock);
1332 static inline void netif_tx_unlock_bh(struct net_device *dev)
1334 dev->xmit_lock_owner = -1;
1335 spin_unlock_bh(&dev->_xmit_lock);
1338 #define HARD_TX_LOCK(dev, cpu) { \
1339 if ((dev->features & NETIF_F_LLTX) == 0) { \
1340 __netif_tx_lock(dev, cpu); \
1344 #define HARD_TX_UNLOCK(dev) { \
1345 if ((dev->features & NETIF_F_LLTX) == 0) { \
1346 netif_tx_unlock(dev); \
1350 static inline void netif_tx_disable(struct net_device *dev)
1352 netif_tx_lock_bh(dev);
1353 netif_stop_queue(dev);
1354 netif_tx_unlock_bh(dev);
1357 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
1359 extern void ether_setup(struct net_device *dev);
1361 /* Support for loadable net-drivers */
1362 extern struct net_device *alloc_netdev_mq(int sizeof_priv, const char *name,
1363 void (*setup)(struct net_device *),
1364 unsigned int queue_count);
1365 #define alloc_netdev(sizeof_priv, name, setup) \
1366 alloc_netdev_mq(sizeof_priv, name, setup, 1)
1367 extern int register_netdev(struct net_device *dev);
1368 extern void unregister_netdev(struct net_device *dev);
1369 /* Functions used for secondary unicast and multicast support */
1370 extern void dev_set_rx_mode(struct net_device *dev);
1371 extern void __dev_set_rx_mode(struct net_device *dev);
1372 extern int dev_unicast_delete(struct net_device *dev, void *addr, int alen);
1373 extern int dev_unicast_add(struct net_device *dev, void *addr, int alen);
1374 extern int dev_mc_delete(struct net_device *dev, void *addr, int alen, int all);
1375 extern int dev_mc_add(struct net_device *dev, void *addr, int alen, int newonly);
1376 extern int dev_mc_sync(struct net_device *to, struct net_device *from);
1377 extern void dev_mc_unsync(struct net_device *to, struct net_device *from);
1378 extern int __dev_addr_delete(struct dev_addr_list **list, int *count, void *addr, int alen, int all);
1379 extern int __dev_addr_add(struct dev_addr_list **list, int *count, void *addr, int alen, int newonly);
1380 extern void dev_set_promiscuity(struct net_device *dev, int inc);
1381 extern void dev_set_allmulti(struct net_device *dev, int inc);
1382 extern void netdev_state_change(struct net_device *dev);
1383 extern void netdev_features_change(struct net_device *dev);
1384 /* Load a device via the kmod */
1385 extern void dev_load(struct net *net, const char *name);
1386 extern void dev_mcast_init(void);
1387 extern int netdev_max_backlog;
1388 extern int weight_p;
1389 extern int netdev_set_master(struct net_device *dev, struct net_device *master);
1390 extern int skb_checksum_help(struct sk_buff *skb);
1391 extern struct sk_buff *skb_gso_segment(struct sk_buff *skb, int features);
1393 extern void netdev_rx_csum_fault(struct net_device *dev);
1395 static inline void netdev_rx_csum_fault(struct net_device *dev)
1399 /* rx skb timestamps */
1400 extern void net_enable_timestamp(void);
1401 extern void net_disable_timestamp(void);
1403 #ifdef CONFIG_PROC_FS
1404 extern void *dev_seq_start(struct seq_file *seq, loff_t *pos);
1405 extern void *dev_seq_next(struct seq_file *seq, void *v, loff_t *pos);
1406 extern void dev_seq_stop(struct seq_file *seq, void *v);
1409 extern void linkwatch_run_queue(void);
1411 extern int netdev_compute_features(unsigned long all, unsigned long one);
1413 static inline int net_gso_ok(int features, int gso_type)
1415 int feature = gso_type << NETIF_F_GSO_SHIFT;
1416 return (features & feature) == feature;
1419 static inline int skb_gso_ok(struct sk_buff *skb, int features)
1421 return net_gso_ok(features, skb_shinfo(skb)->gso_type);
1424 static inline int netif_needs_gso(struct net_device *dev, struct sk_buff *skb)
1426 return skb_is_gso(skb) &&
1427 (!skb_gso_ok(skb, dev->features) ||
1428 unlikely(skb->ip_summed != CHECKSUM_PARTIAL));
1431 /* On bonding slaves other than the currently active slave, suppress
1432 * duplicates except for 802.3ad ETH_P_SLOW, alb non-mcast/bcast, and
1433 * ARP on active-backup slaves with arp_validate enabled.
1435 static inline int skb_bond_should_drop(struct sk_buff *skb)
1437 struct net_device *dev = skb->dev;
1438 struct net_device *master = dev->master;
1441 (dev->priv_flags & IFF_SLAVE_INACTIVE)) {
1442 if ((dev->priv_flags & IFF_SLAVE_NEEDARP) &&
1443 skb->protocol == __constant_htons(ETH_P_ARP))
1446 if (master->priv_flags & IFF_MASTER_ALB) {
1447 if (skb->pkt_type != PACKET_BROADCAST &&
1448 skb->pkt_type != PACKET_MULTICAST)
1451 if (master->priv_flags & IFF_MASTER_8023AD &&
1452 skb->protocol == __constant_htons(ETH_P_SLOW))
1460 #endif /* __KERNEL__ */
1462 #endif /* _LINUX_DEV_H */