usb gadget stack: remove usb_ep_*_buffer(), part 2
[linux-2.6] / 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 <linux/timer.h>
34 #include <asm/atomic.h>
35 #include <asm/cache.h>
36 #include <asm/byteorder.h>
37
38 #include <linux/device.h>
39 #include <linux/percpu.h>
40 #include <linux/dmaengine.h>
41
42 struct vlan_group;
43 struct ethtool_ops;
44 struct netpoll_info;
45 /* 802.11 specific */
46 struct wireless_dev;
47                                         /* source back-compat hooks */
48 #define SET_ETHTOOL_OPS(netdev,ops) \
49         ( (netdev)->ethtool_ops = (ops) )
50
51 #define HAVE_ALLOC_NETDEV               /* feature macro: alloc_xxxdev
52                                            functions are available. */
53 #define HAVE_FREE_NETDEV                /* free_netdev() */
54 #define HAVE_NETDEV_PRIV                /* netdev_priv() */
55
56 #define NET_XMIT_SUCCESS        0
57 #define NET_XMIT_DROP           1       /* skb dropped                  */
58 #define NET_XMIT_CN             2       /* congestion notification      */
59 #define NET_XMIT_POLICED        3       /* skb is shot by police        */
60 #define NET_XMIT_BYPASS         4       /* packet does not leave via dequeue;
61                                            (TC use only - dev_queue_xmit
62                                            returns this as NET_XMIT_SUCCESS) */
63
64 /* Backlog congestion levels */
65 #define NET_RX_SUCCESS          0   /* keep 'em coming, baby */
66 #define NET_RX_DROP             1  /* packet dropped */
67 #define NET_RX_CN_LOW           2   /* storm alert, just in case */
68 #define NET_RX_CN_MOD           3   /* Storm on its way! */
69 #define NET_RX_CN_HIGH          4   /* The storm is here */
70 #define NET_RX_BAD              5  /* packet dropped due to kernel error */
71
72 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
73  * indicates that the device will soon be dropping packets, or already drops
74  * some packets of the same priority; prompting us to send less aggressively. */
75 #define net_xmit_eval(e)        ((e) == NET_XMIT_CN? 0 : (e))
76 #define net_xmit_errno(e)       ((e) != NET_XMIT_CN ? -ENOBUFS : 0)
77
78 #endif
79
80 #define MAX_ADDR_LEN    32              /* Largest hardware address length */
81
82 /* Driver transmit return codes */
83 #define NETDEV_TX_OK 0          /* driver took care of packet */
84 #define NETDEV_TX_BUSY 1        /* driver tx path was busy*/
85 #define NETDEV_TX_LOCKED -1     /* driver tx lock was already taken */
86
87 /*
88  *      Compute the worst case header length according to the protocols
89  *      used.
90  */
91  
92 #if !defined(CONFIG_AX25) && !defined(CONFIG_AX25_MODULE) && !defined(CONFIG_TR)
93 #define LL_MAX_HEADER   32
94 #else
95 #if defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
96 #define LL_MAX_HEADER   96
97 #else
98 #define LL_MAX_HEADER   48
99 #endif
100 #endif
101
102 #if !defined(CONFIG_NET_IPIP) && !defined(CONFIG_NET_IPIP_MODULE) && \
103     !defined(CONFIG_NET_IPGRE) &&  !defined(CONFIG_NET_IPGRE_MODULE) && \
104     !defined(CONFIG_IPV6_SIT) && !defined(CONFIG_IPV6_SIT_MODULE) && \
105     !defined(CONFIG_IPV6_TUNNEL) && !defined(CONFIG_IPV6_TUNNEL_MODULE)
106 #define MAX_HEADER LL_MAX_HEADER
107 #else
108 #define MAX_HEADER (LL_MAX_HEADER + 48)
109 #endif
110
111 struct net_device_subqueue
112 {
113         /* Give a control state for each queue.  This struct may contain
114          * per-queue locks in the future.
115          */
116         unsigned long   state;
117 };
118
119 /*
120  *      Network device statistics. Akin to the 2.0 ether stats but
121  *      with byte counters.
122  */
123  
124 struct net_device_stats
125 {
126         unsigned long   rx_packets;             /* total packets received       */
127         unsigned long   tx_packets;             /* total packets transmitted    */
128         unsigned long   rx_bytes;               /* total bytes received         */
129         unsigned long   tx_bytes;               /* total bytes transmitted      */
130         unsigned long   rx_errors;              /* bad packets received         */
131         unsigned long   tx_errors;              /* packet transmit problems     */
132         unsigned long   rx_dropped;             /* no space in linux buffers    */
133         unsigned long   tx_dropped;             /* no space available in linux  */
134         unsigned long   multicast;              /* multicast packets received   */
135         unsigned long   collisions;
136
137         /* detailed rx_errors: */
138         unsigned long   rx_length_errors;
139         unsigned long   rx_over_errors;         /* receiver ring buff overflow  */
140         unsigned long   rx_crc_errors;          /* recved pkt with crc error    */
141         unsigned long   rx_frame_errors;        /* recv'd frame alignment error */
142         unsigned long   rx_fifo_errors;         /* recv'r fifo overrun          */
143         unsigned long   rx_missed_errors;       /* receiver missed packet       */
144
145         /* detailed tx_errors */
146         unsigned long   tx_aborted_errors;
147         unsigned long   tx_carrier_errors;
148         unsigned long   tx_fifo_errors;
149         unsigned long   tx_heartbeat_errors;
150         unsigned long   tx_window_errors;
151         
152         /* for cslip etc */
153         unsigned long   rx_compressed;
154         unsigned long   tx_compressed;
155 };
156
157
158 /* Media selection options. */
159 enum {
160         IF_PORT_UNKNOWN = 0,
161         IF_PORT_10BASE2,
162         IF_PORT_10BASET,
163         IF_PORT_AUI,
164         IF_PORT_100BASET,
165         IF_PORT_100BASETX,
166         IF_PORT_100BASEFX
167 };
168
169 #ifdef __KERNEL__
170
171 #include <linux/cache.h>
172 #include <linux/skbuff.h>
173
174 struct neighbour;
175 struct neigh_parms;
176 struct sk_buff;
177
178 struct netif_rx_stats
179 {
180         unsigned total;
181         unsigned dropped;
182         unsigned time_squeeze;
183         unsigned cpu_collision;
184 };
185
186 DECLARE_PER_CPU(struct netif_rx_stats, netdev_rx_stat);
187
188 struct dev_addr_list
189 {
190         struct dev_addr_list    *next;
191         u8                      da_addr[MAX_ADDR_LEN];
192         u8                      da_addrlen;
193         int                     da_users;
194         int                     da_gusers;
195 };
196
197 /*
198  *      We tag multicasts with these structures.
199  */
200
201 #define dev_mc_list     dev_addr_list
202 #define dmi_addr        da_addr
203 #define dmi_addrlen     da_addrlen
204 #define dmi_users       da_users
205 #define dmi_gusers      da_gusers
206
207 struct hh_cache
208 {
209         struct hh_cache *hh_next;       /* Next entry                        */
210         atomic_t        hh_refcnt;      /* number of users                   */
211 /*
212  * We want hh_output, hh_len, hh_lock and hh_data be a in a separate
213  * cache line on SMP.
214  * They are mostly read, but hh_refcnt may be changed quite frequently,
215  * incurring cache line ping pongs.
216  */
217         __be16          hh_type ____cacheline_aligned_in_smp;
218                                         /* protocol identifier, f.e ETH_P_IP
219                                          *  NOTE:  For VLANs, this will be the
220                                          *  encapuslated type. --BLG
221                                          */
222         u16             hh_len;         /* length of header */
223         int             (*hh_output)(struct sk_buff *skb);
224         seqlock_t       hh_lock;
225
226         /* cached hardware header; allow for machine alignment needs.        */
227 #define HH_DATA_MOD     16
228 #define HH_DATA_OFF(__len) \
229         (HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
230 #define HH_DATA_ALIGN(__len) \
231         (((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
232         unsigned long   hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
233 };
234
235 /* Reserve HH_DATA_MOD byte aligned hard_header_len, but at least that much.
236  * Alternative is:
237  *   dev->hard_header_len ? (dev->hard_header_len +
238  *                           (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
239  *
240  * We could use other alignment values, but we must maintain the
241  * relationship HH alignment <= LL alignment.
242  */
243 #define LL_RESERVED_SPACE(dev) \
244         (((dev)->hard_header_len&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
245 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
246         ((((dev)->hard_header_len+extra)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
247
248 /* These flag bits are private to the generic network queueing
249  * layer, they may not be explicitly referenced by any other
250  * code.
251  */
252
253 enum netdev_state_t
254 {
255         __LINK_STATE_XOFF=0,
256         __LINK_STATE_START,
257         __LINK_STATE_PRESENT,
258         __LINK_STATE_SCHED,
259         __LINK_STATE_NOCARRIER,
260         __LINK_STATE_RX_SCHED,
261         __LINK_STATE_LINKWATCH_PENDING,
262         __LINK_STATE_DORMANT,
263         __LINK_STATE_QDISC_RUNNING,
264         /* Set by the netpoll NAPI code */
265         __LINK_STATE_POLL_LIST_FROZEN,
266 };
267
268
269 /*
270  * This structure holds at boot time configured netdevice settings. They
271  * are then used in the device probing. 
272  */
273 struct netdev_boot_setup {
274         char name[IFNAMSIZ];
275         struct ifmap map;
276 };
277 #define NETDEV_BOOT_SETUP_MAX 8
278
279 extern int __init netdev_boot_setup(char *str);
280
281 /*
282  *      The DEVICE structure.
283  *      Actually, this whole structure is a big mistake.  It mixes I/O
284  *      data with strictly "high-level" data, and it has to know about
285  *      almost every data structure used in the INET module.
286  *
287  *      FIXME: cleanup struct net_device such that network protocol info
288  *      moves out.
289  */
290
291 struct net_device
292 {
293
294         /*
295          * This is the first field of the "visible" part of this structure
296          * (i.e. as seen by users in the "Space.c" file).  It is the name
297          * the interface.
298          */
299         char                    name[IFNAMSIZ];
300         /* device name hash chain */
301         struct hlist_node       name_hlist;
302
303         /*
304          *      I/O specific fields
305          *      FIXME: Merge these and struct ifmap into one
306          */
307         unsigned long           mem_end;        /* shared mem end       */
308         unsigned long           mem_start;      /* shared mem start     */
309         unsigned long           base_addr;      /* device I/O address   */
310         unsigned int            irq;            /* device IRQ number    */
311
312         /*
313          *      Some hardware also needs these fields, but they are not
314          *      part of the usual set specified in Space.c.
315          */
316
317         unsigned char           if_port;        /* Selectable AUI, TP,..*/
318         unsigned char           dma;            /* DMA channel          */
319
320         unsigned long           state;
321
322         struct list_head        dev_list;
323         
324         /* The device initialization function. Called only once. */
325         int                     (*init)(struct net_device *dev);
326
327         /* ------- Fields preinitialized in Space.c finish here ------- */
328
329         /* Net device features */
330         unsigned long           features;
331 #define NETIF_F_SG              1       /* Scatter/gather IO. */
332 #define NETIF_F_IP_CSUM         2       /* Can checksum TCP/UDP over IPv4. */
333 #define NETIF_F_NO_CSUM         4       /* Does not require checksum. F.e. loopack. */
334 #define NETIF_F_HW_CSUM         8       /* Can checksum all the packets. */
335 #define NETIF_F_IPV6_CSUM       16      /* Can checksum TCP/UDP over IPV6 */
336 #define NETIF_F_HIGHDMA         32      /* Can DMA to high memory. */
337 #define NETIF_F_FRAGLIST        64      /* Scatter/gather IO. */
338 #define NETIF_F_HW_VLAN_TX      128     /* Transmit VLAN hw acceleration */
339 #define NETIF_F_HW_VLAN_RX      256     /* Receive VLAN hw acceleration */
340 #define NETIF_F_HW_VLAN_FILTER  512     /* Receive filtering on VLAN */
341 #define NETIF_F_VLAN_CHALLENGED 1024    /* Device cannot handle VLAN packets */
342 #define NETIF_F_GSO             2048    /* Enable software GSO. */
343 #define NETIF_F_LLTX            4096    /* LockLess TX */
344 #define NETIF_F_MULTI_QUEUE     16384   /* Has multiple TX/RX queues */
345
346         /* Segmentation offload features */
347 #define NETIF_F_GSO_SHIFT       16
348 #define NETIF_F_GSO_MASK        0xffff0000
349 #define NETIF_F_TSO             (SKB_GSO_TCPV4 << NETIF_F_GSO_SHIFT)
350 #define NETIF_F_UFO             (SKB_GSO_UDP << NETIF_F_GSO_SHIFT)
351 #define NETIF_F_GSO_ROBUST      (SKB_GSO_DODGY << NETIF_F_GSO_SHIFT)
352 #define NETIF_F_TSO_ECN         (SKB_GSO_TCP_ECN << NETIF_F_GSO_SHIFT)
353 #define NETIF_F_TSO6            (SKB_GSO_TCPV6 << NETIF_F_GSO_SHIFT)
354
355         /* List of features with software fallbacks. */
356 #define NETIF_F_GSO_SOFTWARE    (NETIF_F_TSO | NETIF_F_TSO_ECN | NETIF_F_TSO6)
357
358
359 #define NETIF_F_GEN_CSUM        (NETIF_F_NO_CSUM | NETIF_F_HW_CSUM)
360 #define NETIF_F_V4_CSUM         (NETIF_F_GEN_CSUM | NETIF_F_IP_CSUM)
361 #define NETIF_F_V6_CSUM         (NETIF_F_GEN_CSUM | NETIF_F_IPV6_CSUM)
362 #define NETIF_F_ALL_CSUM        (NETIF_F_V4_CSUM | NETIF_F_V6_CSUM)
363
364         struct net_device       *next_sched;
365
366         /* Interface index. Unique device identifier    */
367         int                     ifindex;
368         int                     iflink;
369
370
371         struct net_device_stats* (*get_stats)(struct net_device *dev);
372         struct net_device_stats stats;
373
374 #ifdef CONFIG_WIRELESS_EXT
375         /* List of functions to handle Wireless Extensions (instead of ioctl).
376          * See <net/iw_handler.h> for details. Jean II */
377         const struct iw_handler_def *   wireless_handlers;
378         /* Instance data managed by the core of Wireless Extensions. */
379         struct iw_public_data * wireless_data;
380 #endif
381         const struct ethtool_ops *ethtool_ops;
382
383         /*
384          * This marks the end of the "visible" part of the structure. All
385          * fields hereafter are internal to the system, and may change at
386          * will (read: may be cleaned up at will).
387          */
388
389
390         unsigned int            flags;  /* interface flags (a la BSD)   */
391         unsigned short          gflags;
392         unsigned short          priv_flags; /* Like 'flags' but invisible to userspace. */
393         unsigned short          padded; /* How much padding added by alloc_netdev() */
394
395         unsigned char           operstate; /* RFC2863 operstate */
396         unsigned char           link_mode; /* mapping policy to operstate */
397
398         unsigned                mtu;    /* interface MTU value          */
399         unsigned short          type;   /* interface hardware type      */
400         unsigned short          hard_header_len;        /* hardware hdr length  */
401
402         struct net_device       *master; /* Pointer to master device of a group,
403                                           * which this device is member of.
404                                           */
405
406         /* Interface address info. */
407         unsigned char           perm_addr[MAX_ADDR_LEN]; /* permanent hw address */
408         unsigned char           addr_len;       /* hardware address length      */
409         unsigned short          dev_id;         /* for shared network cards */
410
411         struct dev_addr_list    *uc_list;       /* Secondary unicast mac addresses */
412         int                     uc_count;       /* Number of installed ucasts   */
413         int                     uc_promisc;
414         struct dev_addr_list    *mc_list;       /* Multicast mac addresses      */
415         int                     mc_count;       /* Number of installed mcasts   */
416         int                     promiscuity;
417         int                     allmulti;
418
419
420         /* Protocol specific pointers */
421         
422         void                    *atalk_ptr;     /* AppleTalk link       */
423         void                    *ip_ptr;        /* IPv4 specific data   */  
424         void                    *dn_ptr;        /* DECnet specific data */
425         void                    *ip6_ptr;       /* IPv6 specific data */
426         void                    *ec_ptr;        /* Econet specific data */
427         void                    *ax25_ptr;      /* AX.25 specific data */
428         struct wireless_dev     *ieee80211_ptr; /* IEEE 802.11 specific data,
429                                                    assign before registering */
430
431 /*
432  * Cache line mostly used on receive path (including eth_type_trans())
433  */
434         struct list_head        poll_list ____cacheline_aligned_in_smp;
435                                         /* Link to poll list    */
436
437         int                     (*poll) (struct net_device *dev, int *quota);
438         int                     quota;
439         int                     weight;
440         unsigned long           last_rx;        /* Time of last Rx      */
441         /* Interface address info used in eth_type_trans() */
442         unsigned char           dev_addr[MAX_ADDR_LEN]; /* hw address, (before bcast 
443                                                         because most packets are unicast) */
444
445         unsigned char           broadcast[MAX_ADDR_LEN];        /* hw bcast add */
446
447 /*
448  * Cache line mostly used on queue transmit path (qdisc)
449  */
450         /* device queue lock */
451         spinlock_t              queue_lock ____cacheline_aligned_in_smp;
452         struct Qdisc            *qdisc;
453         struct Qdisc            *qdisc_sleeping;
454         struct list_head        qdisc_list;
455         unsigned long           tx_queue_len;   /* Max frames per queue allowed */
456
457         /* Partially transmitted GSO packet. */
458         struct sk_buff          *gso_skb;
459
460         /* ingress path synchronizer */
461         spinlock_t              ingress_lock;
462         struct Qdisc            *qdisc_ingress;
463
464 /*
465  * One part is mostly used on xmit path (device)
466  */
467         /* hard_start_xmit synchronizer */
468         spinlock_t              _xmit_lock ____cacheline_aligned_in_smp;
469         /* cpu id of processor entered to hard_start_xmit or -1,
470            if nobody entered there.
471          */
472         int                     xmit_lock_owner;
473         void                    *priv;  /* pointer to private data      */
474         int                     (*hard_start_xmit) (struct sk_buff *skb,
475                                                     struct net_device *dev);
476         /* These may be needed for future network-power-down code. */
477         unsigned long           trans_start;    /* Time (in jiffies) of last Tx */
478
479         int                     watchdog_timeo; /* used by dev_watchdog() */
480         struct timer_list       watchdog_timer;
481
482 /*
483  * refcnt is a very hot point, so align it on SMP
484  */
485         /* Number of references to this device */
486         atomic_t                refcnt ____cacheline_aligned_in_smp;
487
488         /* delayed register/unregister */
489         struct list_head        todo_list;
490         /* device index hash chain */
491         struct hlist_node       index_hlist;
492
493         struct net_device       *link_watch_next;
494
495         /* register/unregister state machine */
496         enum { NETREG_UNINITIALIZED=0,
497                NETREG_REGISTERED,       /* completed register_netdevice */
498                NETREG_UNREGISTERING,    /* called unregister_netdevice */
499                NETREG_UNREGISTERED,     /* completed unregister todo */
500                NETREG_RELEASED,         /* called free_netdev */
501         } reg_state;
502
503         /* Called after device is detached from network. */
504         void                    (*uninit)(struct net_device *dev);
505         /* Called after last user reference disappears. */
506         void                    (*destructor)(struct net_device *dev);
507
508         /* Pointers to interface service routines.      */
509         int                     (*open)(struct net_device *dev);
510         int                     (*stop)(struct net_device *dev);
511 #define HAVE_NETDEV_POLL
512         int                     (*hard_header) (struct sk_buff *skb,
513                                                 struct net_device *dev,
514                                                 unsigned short type,
515                                                 void *daddr,
516                                                 void *saddr,
517                                                 unsigned len);
518         int                     (*rebuild_header)(struct sk_buff *skb);
519 #define HAVE_SET_RX_MODE
520         void                    (*set_rx_mode)(struct net_device *dev);
521 #define HAVE_MULTICAST                   
522         void                    (*set_multicast_list)(struct net_device *dev);
523 #define HAVE_SET_MAC_ADDR                
524         int                     (*set_mac_address)(struct net_device *dev,
525                                                    void *addr);
526 #define HAVE_PRIVATE_IOCTL
527         int                     (*do_ioctl)(struct net_device *dev,
528                                             struct ifreq *ifr, int cmd);
529 #define HAVE_SET_CONFIG
530         int                     (*set_config)(struct net_device *dev,
531                                               struct ifmap *map);
532 #define HAVE_HEADER_CACHE
533         int                     (*hard_header_cache)(struct neighbour *neigh,
534                                                      struct hh_cache *hh);
535         void                    (*header_cache_update)(struct hh_cache *hh,
536                                                        struct net_device *dev,
537                                                        unsigned char *  haddr);
538 #define HAVE_CHANGE_MTU
539         int                     (*change_mtu)(struct net_device *dev, int new_mtu);
540
541 #define HAVE_TX_TIMEOUT
542         void                    (*tx_timeout) (struct net_device *dev);
543
544         void                    (*vlan_rx_register)(struct net_device *dev,
545                                                     struct vlan_group *grp);
546         void                    (*vlan_rx_add_vid)(struct net_device *dev,
547                                                    unsigned short vid);
548         void                    (*vlan_rx_kill_vid)(struct net_device *dev,
549                                                     unsigned short vid);
550
551         int                     (*hard_header_parse)(struct sk_buff *skb,
552                                                      unsigned char *haddr);
553         int                     (*neigh_setup)(struct net_device *dev, struct neigh_parms *);
554 #ifdef CONFIG_NETPOLL
555         struct netpoll_info     *npinfo;
556 #endif
557 #ifdef CONFIG_NET_POLL_CONTROLLER
558         void                    (*poll_controller)(struct net_device *dev);
559 #endif
560
561         /* bridge stuff */
562         struct net_bridge_port  *br_port;
563
564         /* class/net/name entry */
565         struct device           dev;
566         /* space for optional statistics and wireless sysfs groups */
567         struct attribute_group  *sysfs_groups[3];
568
569         /* rtnetlink link ops */
570         const struct rtnl_link_ops *rtnl_link_ops;
571
572         /* The TX queue control structures */
573         unsigned int                    egress_subqueue_count;
574         struct net_device_subqueue      egress_subqueue[0];
575 };
576 #define to_net_dev(d) container_of(d, struct net_device, dev)
577
578 #define NETDEV_ALIGN            32
579 #define NETDEV_ALIGN_CONST      (NETDEV_ALIGN - 1)
580
581 static inline void *netdev_priv(const struct net_device *dev)
582 {
583         return dev->priv;
584 }
585
586 #define SET_MODULE_OWNER(dev) do { } while (0)
587 /* Set the sysfs physical device reference for the network logical device
588  * if set prior to registration will cause a symlink during initialization.
589  */
590 #define SET_NETDEV_DEV(net, pdev)       ((net)->dev.parent = (pdev))
591
592 struct packet_type {
593         __be16                  type;   /* This is really htons(ether_type). */
594         struct net_device       *dev;   /* NULL is wildcarded here           */
595         int                     (*func) (struct sk_buff *,
596                                          struct net_device *,
597                                          struct packet_type *,
598                                          struct net_device *);
599         struct sk_buff          *(*gso_segment)(struct sk_buff *skb,
600                                                 int features);
601         int                     (*gso_send_check)(struct sk_buff *skb);
602         void                    *af_packet_priv;
603         struct list_head        list;
604 };
605
606 #include <linux/interrupt.h>
607 #include <linux/notifier.h>
608
609 extern struct net_device                loopback_dev;           /* The loopback */
610 extern struct list_head                 dev_base_head;          /* All devices */
611 extern rwlock_t                         dev_base_lock;          /* Device list lock */
612
613 #define for_each_netdev(d)              \
614                 list_for_each_entry(d, &dev_base_head, dev_list)
615 #define for_each_netdev_safe(d, n)      \
616                 list_for_each_entry_safe(d, n, &dev_base_head, dev_list)
617 #define for_each_netdev_continue(d)             \
618                 list_for_each_entry_continue(d, &dev_base_head, dev_list)
619 #define net_device_entry(lh)    list_entry(lh, struct net_device, dev_list)
620
621 static inline struct net_device *next_net_device(struct net_device *dev)
622 {
623         struct list_head *lh;
624
625         lh = dev->dev_list.next;
626         return lh == &dev_base_head ? NULL : net_device_entry(lh);
627 }
628
629 static inline struct net_device *first_net_device(void)
630 {
631         return list_empty(&dev_base_head) ? NULL :
632                 net_device_entry(dev_base_head.next);
633 }
634
635 extern int                      netdev_boot_setup_check(struct net_device *dev);
636 extern unsigned long            netdev_boot_base(const char *prefix, int unit);
637 extern struct net_device    *dev_getbyhwaddr(unsigned short type, char *hwaddr);
638 extern struct net_device *dev_getfirstbyhwtype(unsigned short type);
639 extern struct net_device *__dev_getfirstbyhwtype(unsigned short type);
640 extern void             dev_add_pack(struct packet_type *pt);
641 extern void             dev_remove_pack(struct packet_type *pt);
642 extern void             __dev_remove_pack(struct packet_type *pt);
643
644 extern struct net_device        *dev_get_by_flags(unsigned short flags,
645                                                   unsigned short mask);
646 extern struct net_device        *dev_get_by_name(const char *name);
647 extern struct net_device        *__dev_get_by_name(const char *name);
648 extern int              dev_alloc_name(struct net_device *dev, const char *name);
649 extern int              dev_open(struct net_device *dev);
650 extern int              dev_close(struct net_device *dev);
651 extern int              dev_queue_xmit(struct sk_buff *skb);
652 extern int              register_netdevice(struct net_device *dev);
653 extern void             unregister_netdevice(struct net_device *dev);
654 extern void             free_netdev(struct net_device *dev);
655 extern void             synchronize_net(void);
656 extern int              register_netdevice_notifier(struct notifier_block *nb);
657 extern int              unregister_netdevice_notifier(struct notifier_block *nb);
658 extern int              call_netdevice_notifiers(unsigned long val, void *v);
659 extern struct net_device        *dev_get_by_index(int ifindex);
660 extern struct net_device        *__dev_get_by_index(int ifindex);
661 extern int              dev_restart(struct net_device *dev);
662 #ifdef CONFIG_NETPOLL_TRAP
663 extern int              netpoll_trap(void);
664 #endif
665
666 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
667 extern int              register_gifconf(unsigned int family, gifconf_func_t * gifconf);
668 static inline int unregister_gifconf(unsigned int family)
669 {
670         return register_gifconf(family, NULL);
671 }
672
673 /*
674  * Incoming packets are placed on per-cpu queues so that
675  * no locking is needed.
676  */
677
678 struct softnet_data
679 {
680         struct net_device       *output_queue;
681         struct sk_buff_head     input_pkt_queue;
682         struct list_head        poll_list;
683         struct sk_buff          *completion_queue;
684
685         struct net_device       backlog_dev;    /* Sorry. 8) */
686 #ifdef CONFIG_NET_DMA
687         struct dma_chan         *net_dma;
688 #endif
689 };
690
691 DECLARE_PER_CPU(struct softnet_data,softnet_data);
692
693 #define HAVE_NETIF_QUEUE
694
695 extern void __netif_schedule(struct net_device *dev);
696
697 static inline void netif_schedule(struct net_device *dev)
698 {
699         if (!test_bit(__LINK_STATE_XOFF, &dev->state))
700                 __netif_schedule(dev);
701 }
702
703 static inline void netif_start_queue(struct net_device *dev)
704 {
705         clear_bit(__LINK_STATE_XOFF, &dev->state);
706 }
707
708 static inline void netif_wake_queue(struct net_device *dev)
709 {
710 #ifdef CONFIG_NETPOLL_TRAP
711         if (netpoll_trap()) {
712                 clear_bit(__LINK_STATE_XOFF, &dev->state);
713                 return;
714         }
715 #endif
716         if (test_and_clear_bit(__LINK_STATE_XOFF, &dev->state))
717                 __netif_schedule(dev);
718 }
719
720 static inline void netif_stop_queue(struct net_device *dev)
721 {
722         set_bit(__LINK_STATE_XOFF, &dev->state);
723 }
724
725 static inline int netif_queue_stopped(const struct net_device *dev)
726 {
727         return test_bit(__LINK_STATE_XOFF, &dev->state);
728 }
729
730 static inline int netif_running(const struct net_device *dev)
731 {
732         return test_bit(__LINK_STATE_START, &dev->state);
733 }
734
735 /*
736  * Routines to manage the subqueues on a device.  We only need start
737  * stop, and a check if it's stopped.  All other device management is
738  * done at the overall netdevice level.
739  * Also test the device if we're multiqueue.
740  */
741 static inline void netif_start_subqueue(struct net_device *dev, u16 queue_index)
742 {
743 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
744         clear_bit(__LINK_STATE_XOFF, &dev->egress_subqueue[queue_index].state);
745 #endif
746 }
747
748 static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
749 {
750 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
751 #ifdef CONFIG_NETPOLL_TRAP
752         if (netpoll_trap())
753                 return;
754 #endif
755         set_bit(__LINK_STATE_XOFF, &dev->egress_subqueue[queue_index].state);
756 #endif
757 }
758
759 static inline int netif_subqueue_stopped(const struct net_device *dev,
760                                          u16 queue_index)
761 {
762 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
763         return test_bit(__LINK_STATE_XOFF,
764                         &dev->egress_subqueue[queue_index].state);
765 #else
766         return 0;
767 #endif
768 }
769
770 static inline void netif_wake_subqueue(struct net_device *dev, u16 queue_index)
771 {
772 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
773 #ifdef CONFIG_NETPOLL_TRAP
774         if (netpoll_trap())
775                 return;
776 #endif
777         if (test_and_clear_bit(__LINK_STATE_XOFF,
778                                &dev->egress_subqueue[queue_index].state))
779                 __netif_schedule(dev);
780 #endif
781 }
782
783 static inline int netif_is_multiqueue(const struct net_device *dev)
784 {
785 #ifdef CONFIG_NETDEVICES_MULTIQUEUE
786         return (!!(NETIF_F_MULTI_QUEUE & dev->features));
787 #else
788         return 0;
789 #endif
790 }
791
792 /* Use this variant when it is known for sure that it
793  * is executing from interrupt context.
794  */
795 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
796 {
797         if (atomic_dec_and_test(&skb->users)) {
798                 struct softnet_data *sd;
799                 unsigned long flags;
800
801                 local_irq_save(flags);
802                 sd = &__get_cpu_var(softnet_data);
803                 skb->next = sd->completion_queue;
804                 sd->completion_queue = skb;
805                 raise_softirq_irqoff(NET_TX_SOFTIRQ);
806                 local_irq_restore(flags);
807         }
808 }
809
810 /* Use this variant in places where it could be invoked
811  * either from interrupt or non-interrupt context.
812  */
813 extern void dev_kfree_skb_any(struct sk_buff *skb);
814
815 #define HAVE_NETIF_RX 1
816 extern int              netif_rx(struct sk_buff *skb);
817 extern int              netif_rx_ni(struct sk_buff *skb);
818 #define HAVE_NETIF_RECEIVE_SKB 1
819 extern int              netif_receive_skb(struct sk_buff *skb);
820 extern int              dev_valid_name(const char *name);
821 extern int              dev_ioctl(unsigned int cmd, void __user *);
822 extern int              dev_ethtool(struct ifreq *);
823 extern unsigned         dev_get_flags(const struct net_device *);
824 extern int              dev_change_flags(struct net_device *, unsigned);
825 extern int              dev_change_name(struct net_device *, char *);
826 extern int              dev_set_mtu(struct net_device *, int);
827 extern int              dev_set_mac_address(struct net_device *,
828                                             struct sockaddr *);
829 extern int              dev_hard_start_xmit(struct sk_buff *skb,
830                                             struct net_device *dev);
831
832 extern void             dev_init(void);
833
834 extern int              netdev_budget;
835
836 /* Called by rtnetlink.c:rtnl_unlock() */
837 extern void netdev_run_todo(void);
838
839 static inline void dev_put(struct net_device *dev)
840 {
841         atomic_dec(&dev->refcnt);
842 }
843
844 static inline void dev_hold(struct net_device *dev)
845 {
846         atomic_inc(&dev->refcnt);
847 }
848
849 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
850  * and _off may be called from IRQ context, but it is caller
851  * who is responsible for serialization of these calls.
852  *
853  * The name carrier is inappropriate, these functions should really be
854  * called netif_lowerlayer_*() because they represent the state of any
855  * kind of lower layer not just hardware media.
856  */
857
858 extern void linkwatch_fire_event(struct net_device *dev);
859
860 static inline int netif_carrier_ok(const struct net_device *dev)
861 {
862         return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
863 }
864
865 extern void __netdev_watchdog_up(struct net_device *dev);
866
867 extern void netif_carrier_on(struct net_device *dev);
868
869 extern void netif_carrier_off(struct net_device *dev);
870
871 static inline void netif_dormant_on(struct net_device *dev)
872 {
873         if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
874                 linkwatch_fire_event(dev);
875 }
876
877 static inline void netif_dormant_off(struct net_device *dev)
878 {
879         if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
880                 linkwatch_fire_event(dev);
881 }
882
883 static inline int netif_dormant(const struct net_device *dev)
884 {
885         return test_bit(__LINK_STATE_DORMANT, &dev->state);
886 }
887
888
889 static inline int netif_oper_up(const struct net_device *dev) {
890         return (dev->operstate == IF_OPER_UP ||
891                 dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
892 }
893
894 /* Hot-plugging. */
895 static inline int netif_device_present(struct net_device *dev)
896 {
897         return test_bit(__LINK_STATE_PRESENT, &dev->state);
898 }
899
900 extern void netif_device_detach(struct net_device *dev);
901
902 extern void netif_device_attach(struct net_device *dev);
903
904 /*
905  * Network interface message level settings
906  */
907 #define HAVE_NETIF_MSG 1
908
909 enum {
910         NETIF_MSG_DRV           = 0x0001,
911         NETIF_MSG_PROBE         = 0x0002,
912         NETIF_MSG_LINK          = 0x0004,
913         NETIF_MSG_TIMER         = 0x0008,
914         NETIF_MSG_IFDOWN        = 0x0010,
915         NETIF_MSG_IFUP          = 0x0020,
916         NETIF_MSG_RX_ERR        = 0x0040,
917         NETIF_MSG_TX_ERR        = 0x0080,
918         NETIF_MSG_TX_QUEUED     = 0x0100,
919         NETIF_MSG_INTR          = 0x0200,
920         NETIF_MSG_TX_DONE       = 0x0400,
921         NETIF_MSG_RX_STATUS     = 0x0800,
922         NETIF_MSG_PKTDATA       = 0x1000,
923         NETIF_MSG_HW            = 0x2000,
924         NETIF_MSG_WOL           = 0x4000,
925 };
926
927 #define netif_msg_drv(p)        ((p)->msg_enable & NETIF_MSG_DRV)
928 #define netif_msg_probe(p)      ((p)->msg_enable & NETIF_MSG_PROBE)
929 #define netif_msg_link(p)       ((p)->msg_enable & NETIF_MSG_LINK)
930 #define netif_msg_timer(p)      ((p)->msg_enable & NETIF_MSG_TIMER)
931 #define netif_msg_ifdown(p)     ((p)->msg_enable & NETIF_MSG_IFDOWN)
932 #define netif_msg_ifup(p)       ((p)->msg_enable & NETIF_MSG_IFUP)
933 #define netif_msg_rx_err(p)     ((p)->msg_enable & NETIF_MSG_RX_ERR)
934 #define netif_msg_tx_err(p)     ((p)->msg_enable & NETIF_MSG_TX_ERR)
935 #define netif_msg_tx_queued(p)  ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
936 #define netif_msg_intr(p)       ((p)->msg_enable & NETIF_MSG_INTR)
937 #define netif_msg_tx_done(p)    ((p)->msg_enable & NETIF_MSG_TX_DONE)
938 #define netif_msg_rx_status(p)  ((p)->msg_enable & NETIF_MSG_RX_STATUS)
939 #define netif_msg_pktdata(p)    ((p)->msg_enable & NETIF_MSG_PKTDATA)
940 #define netif_msg_hw(p)         ((p)->msg_enable & NETIF_MSG_HW)
941 #define netif_msg_wol(p)        ((p)->msg_enable & NETIF_MSG_WOL)
942
943 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
944 {
945         /* use default */
946         if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
947                 return default_msg_enable_bits;
948         if (debug_value == 0)   /* no output */
949                 return 0;
950         /* set low N bits */
951         return (1 << debug_value) - 1;
952 }
953
954 /* Test if receive needs to be scheduled */
955 static inline int __netif_rx_schedule_prep(struct net_device *dev)
956 {
957         return !test_and_set_bit(__LINK_STATE_RX_SCHED, &dev->state);
958 }
959
960 /* Test if receive needs to be scheduled but only if up */
961 static inline int netif_rx_schedule_prep(struct net_device *dev)
962 {
963         return netif_running(dev) && __netif_rx_schedule_prep(dev);
964 }
965
966 /* Add interface to tail of rx poll list. This assumes that _prep has
967  * already been called and returned 1.
968  */
969
970 extern void __netif_rx_schedule(struct net_device *dev);
971
972 /* Try to reschedule poll. Called by irq handler. */
973
974 static inline void netif_rx_schedule(struct net_device *dev)
975 {
976         if (netif_rx_schedule_prep(dev))
977                 __netif_rx_schedule(dev);
978 }
979
980 /* Try to reschedule poll. Called by dev->poll() after netif_rx_complete().
981  * Do not inline this?
982  */
983 static inline int netif_rx_reschedule(struct net_device *dev, int undo)
984 {
985         if (netif_rx_schedule_prep(dev)) {
986                 unsigned long flags;
987
988                 dev->quota += undo;
989
990                 local_irq_save(flags);
991                 list_add_tail(&dev->poll_list, &__get_cpu_var(softnet_data).poll_list);
992                 __raise_softirq_irqoff(NET_RX_SOFTIRQ);
993                 local_irq_restore(flags);
994                 return 1;
995         }
996         return 0;
997 }
998
999 /* same as netif_rx_complete, except that local_irq_save(flags)
1000  * has already been issued
1001  */
1002 static inline void __netif_rx_complete(struct net_device *dev)
1003 {
1004         BUG_ON(!test_bit(__LINK_STATE_RX_SCHED, &dev->state));
1005         list_del(&dev->poll_list);
1006         smp_mb__before_clear_bit();
1007         clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
1008 }
1009
1010 /* Remove interface from poll list: it must be in the poll list
1011  * on current cpu. This primitive is called by dev->poll(), when
1012  * it completes the work. The device cannot be out of poll list at this
1013  * moment, it is BUG().
1014  */
1015 static inline void netif_rx_complete(struct net_device *dev)
1016 {
1017         unsigned long flags;
1018
1019 #ifdef CONFIG_NETPOLL
1020         /* Prevent race with netpoll - yes, this is a kludge.
1021          * But at least it doesn't penalize the non-netpoll
1022          * code path. */
1023         if (test_bit(__LINK_STATE_POLL_LIST_FROZEN, &dev->state))
1024                 return;
1025 #endif
1026
1027         local_irq_save(flags);
1028         __netif_rx_complete(dev);
1029         local_irq_restore(flags);
1030 }
1031
1032 static inline void netif_poll_disable(struct net_device *dev)
1033 {
1034         while (test_and_set_bit(__LINK_STATE_RX_SCHED, &dev->state))
1035                 /* No hurry. */
1036                 schedule_timeout_interruptible(1);
1037 }
1038
1039 static inline void netif_poll_enable(struct net_device *dev)
1040 {
1041         smp_mb__before_clear_bit();
1042         clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
1043 }
1044
1045 static inline void netif_tx_lock(struct net_device *dev)
1046 {
1047         spin_lock(&dev->_xmit_lock);
1048         dev->xmit_lock_owner = smp_processor_id();
1049 }
1050
1051 static inline void netif_tx_lock_bh(struct net_device *dev)
1052 {
1053         spin_lock_bh(&dev->_xmit_lock);
1054         dev->xmit_lock_owner = smp_processor_id();
1055 }
1056
1057 static inline int netif_tx_trylock(struct net_device *dev)
1058 {
1059         int ok = spin_trylock(&dev->_xmit_lock);
1060         if (likely(ok))
1061                 dev->xmit_lock_owner = smp_processor_id();
1062         return ok;
1063 }
1064
1065 static inline void netif_tx_unlock(struct net_device *dev)
1066 {
1067         dev->xmit_lock_owner = -1;
1068         spin_unlock(&dev->_xmit_lock);
1069 }
1070
1071 static inline void netif_tx_unlock_bh(struct net_device *dev)
1072 {
1073         dev->xmit_lock_owner = -1;
1074         spin_unlock_bh(&dev->_xmit_lock);
1075 }
1076
1077 static inline void netif_tx_disable(struct net_device *dev)
1078 {
1079         netif_tx_lock_bh(dev);
1080         netif_stop_queue(dev);
1081         netif_tx_unlock_bh(dev);
1082 }
1083
1084 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
1085
1086 extern void             ether_setup(struct net_device *dev);
1087
1088 /* Support for loadable net-drivers */
1089 extern struct net_device *alloc_netdev_mq(int sizeof_priv, const char *name,
1090                                        void (*setup)(struct net_device *),
1091                                        unsigned int queue_count);
1092 #define alloc_netdev(sizeof_priv, name, setup) \
1093         alloc_netdev_mq(sizeof_priv, name, setup, 1)
1094 extern int              register_netdev(struct net_device *dev);
1095 extern void             unregister_netdev(struct net_device *dev);
1096 /* Functions used for secondary unicast and multicast support */
1097 extern void             dev_set_rx_mode(struct net_device *dev);
1098 extern void             __dev_set_rx_mode(struct net_device *dev);
1099 extern int              dev_unicast_delete(struct net_device *dev, void *addr, int alen);
1100 extern int              dev_unicast_add(struct net_device *dev, void *addr, int alen);
1101 extern int              dev_mc_delete(struct net_device *dev, void *addr, int alen, int all);
1102 extern int              dev_mc_add(struct net_device *dev, void *addr, int alen, int newonly);
1103 extern void             dev_mc_discard(struct net_device *dev);
1104 extern int              __dev_addr_delete(struct dev_addr_list **list, int *count, void *addr, int alen, int all);
1105 extern int              __dev_addr_add(struct dev_addr_list **list, int *count, void *addr, int alen, int newonly);
1106 extern void             __dev_addr_discard(struct dev_addr_list **list);
1107 extern void             dev_set_promiscuity(struct net_device *dev, int inc);
1108 extern void             dev_set_allmulti(struct net_device *dev, int inc);
1109 extern void             netdev_state_change(struct net_device *dev);
1110 extern void             netdev_features_change(struct net_device *dev);
1111 /* Load a device via the kmod */
1112 extern void             dev_load(const char *name);
1113 extern void             dev_mcast_init(void);
1114 extern int              netdev_max_backlog;
1115 extern int              weight_p;
1116 extern int              netdev_set_master(struct net_device *dev, struct net_device *master);
1117 extern int skb_checksum_help(struct sk_buff *skb);
1118 extern struct sk_buff *skb_gso_segment(struct sk_buff *skb, int features);
1119 #ifdef CONFIG_BUG
1120 extern void netdev_rx_csum_fault(struct net_device *dev);
1121 #else
1122 static inline void netdev_rx_csum_fault(struct net_device *dev)
1123 {
1124 }
1125 #endif
1126 /* rx skb timestamps */
1127 extern void             net_enable_timestamp(void);
1128 extern void             net_disable_timestamp(void);
1129
1130 #ifdef CONFIG_PROC_FS
1131 extern void *dev_seq_start(struct seq_file *seq, loff_t *pos);
1132 extern void *dev_seq_next(struct seq_file *seq, void *v, loff_t *pos);
1133 extern void dev_seq_stop(struct seq_file *seq, void *v);
1134 #endif
1135
1136 extern void linkwatch_run_queue(void);
1137
1138 static inline int net_gso_ok(int features, int gso_type)
1139 {
1140         int feature = gso_type << NETIF_F_GSO_SHIFT;
1141         return (features & feature) == feature;
1142 }
1143
1144 static inline int skb_gso_ok(struct sk_buff *skb, int features)
1145 {
1146         return net_gso_ok(features, skb_shinfo(skb)->gso_type);
1147 }
1148
1149 static inline int netif_needs_gso(struct net_device *dev, struct sk_buff *skb)
1150 {
1151         return skb_is_gso(skb) &&
1152                (!skb_gso_ok(skb, dev->features) ||
1153                 unlikely(skb->ip_summed != CHECKSUM_PARTIAL));
1154 }
1155
1156 /* On bonding slaves other than the currently active slave, suppress
1157  * duplicates except for 802.3ad ETH_P_SLOW, alb non-mcast/bcast, and
1158  * ARP on active-backup slaves with arp_validate enabled.
1159  */
1160 static inline int skb_bond_should_drop(struct sk_buff *skb)
1161 {
1162         struct net_device *dev = skb->dev;
1163         struct net_device *master = dev->master;
1164
1165         if (master &&
1166             (dev->priv_flags & IFF_SLAVE_INACTIVE)) {
1167                 if ((dev->priv_flags & IFF_SLAVE_NEEDARP) &&
1168                     skb->protocol == __constant_htons(ETH_P_ARP))
1169                         return 0;
1170
1171                 if (master->priv_flags & IFF_MASTER_ALB) {
1172                         if (skb->pkt_type != PACKET_BROADCAST &&
1173                             skb->pkt_type != PACKET_MULTICAST)
1174                                 return 0;
1175                 }
1176                 if (master->priv_flags & IFF_MASTER_8023AD &&
1177                     skb->protocol == __constant_htons(ETH_P_SLOW))
1178                         return 0;
1179
1180                 return 1;
1181         }
1182         return 0;
1183 }
1184
1185 #endif /* __KERNEL__ */
1186
1187 #endif  /* _LINUX_DEV_H */