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