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