drivers/xen/netback/common.h

   1 /******************************************************************************
   2  * arch/xen/drivers/netif/backend/common.h
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License version 2
   6  * as published by the Free Software Foundation; or, when distributed
   7  * separately from the Linux kernel or incorporated into other
   8  * software packages, subject to the following license:
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this source file (the "Software"), to deal in the Software without
  12  * restriction, including without limitation the rights to use, copy, modify,
  13  * merge, publish, distribute, sublicense, and/or sell copies of the Software,
  14  * and to permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  26  * IN THE SOFTWARE.
  27  */
  28
  29 #ifndef __NETIF__BACKEND__COMMON_H__
  30 #define __NETIF__BACKEND__COMMON_H__
  31
  32 #include <linux/version.h>
  33 #include <linux/module.h>
  34 #include <linux/interrupt.h>
  35 #include <linux/slab.h>
  36 #include <linux/ip.h>
  37 #include <linux/in.h>
  38 #include <linux/netdevice.h>
  39 #include <linux/etherdevice.h>
  40 #include <linux/wait.h>
  41 #include <xen/evtchn.h>
  42 #include <xen/interface/io/netif.h>
  43 #include <asm/io.h>
  44 #include <asm/pgalloc.h>
  45 #include <xen/interface/grant_table.h>
  46 #include <xen/gnttab.h>
  47 #include <xen/driver_util.h>
  48
  49 #define DPRINTK(_f, _a...)                      \
  50         pr_debug("(file=%s, line=%d) " _f,      \
  51                  __FILE__ , __LINE__ , ## _a )
  52 #define IPRINTK(fmt, args...)                           \
  53         printk(KERN_INFO "xen_net: " fmt, ##args)
  54 #define WPRINTK(fmt, args...)                           \
  55         printk(KERN_WARNING "xen_net: " fmt, ##args)
  56
  57 typedef struct netif_st {
  58         /* Unique identifier for this interface. */
  59         domid_t          domid;
  60         unsigned int     handle;
  61
  62         u8               fe_dev_addr[6];
  63
  64         /* Physical parameters of the comms window. */
  65         grant_handle_t   tx_shmem_handle;
  66         grant_ref_t      tx_shmem_ref;
  67         grant_handle_t   rx_shmem_handle;
  68         grant_ref_t      rx_shmem_ref;
  69         unsigned int     irq;
  70
  71         /* The shared rings and indexes. */
  72         netif_tx_back_ring_t tx;
  73         netif_rx_back_ring_t rx;
  74         struct vm_struct *tx_comms_area;
  75         struct vm_struct *rx_comms_area;
  76
  77         /* Set of features that can be turned on in dev->features. */
  78         int features;
  79
  80         /* Internal feature information. */
  81         int can_queue:1;        /* can queue packets for receiver? */
  82         int copying_receiver:1; /* copy packets to receiver?       */
  83
  84         /* Allow netif_be_start_xmit() to peek ahead in the rx request ring. */
  85         RING_IDX rx_req_cons_peek;
  86
  87         /* Transmit shaping: allow 'credit_bytes' every 'credit_usec'. */
  88         unsigned long   credit_bytes;
  89         unsigned long   credit_usec;
  90         unsigned long   remaining_credit;
  91         struct timer_list credit_timeout;
  92
  93         /* Enforce draining of the transmit queue. */
  94         struct timer_list tx_queue_timeout;
  95
  96         /* Miscellaneous private stuff. */
  97         struct list_head list;  /* scheduling list */
  98         atomic_t         refcnt;
  99         struct net_device *dev;
 100         struct net_device_stats stats;
 101
 102         unsigned int carrier;
 103
 104         wait_queue_head_t waiting_to_free;
 105 } netif_t;
 106
 107 /*
 108  * Implement our own carrier flag: the network stack's version causes delays
 109  * when the carrier is re-enabled (in particular, dev_activate() may not
 110  * immediately be called, which can cause packet loss; also the etherbridge
 111  * can be rather lazy in activating its port).
 112  */
 113 #define netback_carrier_on(netif)       ((netif)->carrier = 1)
 114 #define netback_carrier_off(netif)      ((netif)->carrier = 0)
 115 #define netback_carrier_ok(netif)       ((netif)->carrier)
 116
 117 #define NET_TX_RING_SIZE __RING_SIZE((netif_tx_sring_t *)0, PAGE_SIZE)
 118 #define NET_RX_RING_SIZE __RING_SIZE((netif_rx_sring_t *)0, PAGE_SIZE)
 119
 120 void netif_disconnect(netif_t *netif);
 121
 122 netif_t *netif_alloc(domid_t domid, unsigned int handle);
 123 int netif_map(netif_t *netif, unsigned long tx_ring_ref,
 124               unsigned long rx_ring_ref, unsigned int evtchn);
 125
 126 #define netif_get(_b) (atomic_inc(&(_b)->refcnt))
 127 #define netif_put(_b)                                           \
 128         do {                                                    \
 129                 if ( atomic_dec_and_test(&(_b)->refcnt) )       \
 130                         wake_up(&(_b)->waiting_to_free);        \
 131         } while (0)
 132
 133 void netif_xenbus_init(void);
 134
 135 #define netif_schedulable(netif)                                \
 136         (netif_running((netif)->dev) && netback_carrier_ok(netif))
 137
 138 void netif_schedule_work(netif_t *netif);
 139 void netif_deschedule_work(netif_t *netif);
 140
 141 int netif_be_start_xmit(struct sk_buff *skb, struct net_device *dev);
 142 struct net_device_stats *netif_be_get_stats(struct net_device *dev);
 143 irqreturn_t netif_be_int(int irq, void *dev_id);
 144
 145 static inline int netbk_can_queue(struct net_device *dev)
 146 {
 147         netif_t *netif = netdev_priv(dev);
 148         return netif->can_queue;
 149 }
 150
 151 static inline int netbk_can_sg(struct net_device *dev)
 152 {
 153         netif_t *netif = netdev_priv(dev);
 154         return netif->features & NETIF_F_SG;
 155 }
 156
 157 #endif /* __NETIF__BACKEND__COMMON_H__ */