1 /******************************************************************************
2 * arch/xen/drivers/netif/backend/common.h
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:
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #ifndef __NETIF__BACKEND__COMMON_H__
30 #define __NETIF__BACKEND__COMMON_H__
32 #include <linux/version.h>
33 #include <linux/module.h>
34 #include <linux/interrupt.h>
35 #include <linux/slab.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>
44 #include <asm/pgalloc.h>
45 #include <xen/interface/grant_table.h>
46 #include <xen/gnttab.h>
47 #include <xen/driver_util.h>
48 #include <asm/hypercall.h>
50 #define DPRINTK(_f, _a...) \
51 pr_debug("(file=%s, line=%d) " _f, \
52 __FILE__ , __LINE__ , ## _a )
53 #define IPRINTK(fmt, args...) \
54 printk(KERN_INFO "xen_net: " fmt, ##args)
55 #define WPRINTK(fmt, args...) \
56 printk(KERN_WARNING "xen_net: " fmt, ##args)
58 typedef struct netif_st {
59 /* Unique identifier for this interface. */
65 /* Physical parameters of the comms window. */
66 grant_handle_t tx_shmem_handle;
67 grant_ref_t tx_shmem_ref;
68 grant_handle_t rx_shmem_handle;
69 grant_ref_t rx_shmem_ref;
73 /* The shared rings and indexes. */
74 netif_tx_back_ring_t tx;
75 netif_rx_back_ring_t rx;
76 struct vm_struct *tx_comms_area;
77 struct vm_struct *rx_comms_area;
79 /* Set of features that can be turned on in dev->features. */
82 /* Internal feature information. */
83 int can_queue:1; /* can queue packets for receiver? */
84 int copying_receiver:1; /* copy packets to receiver? */
86 /* Allow netif_be_start_xmit() to peek ahead in the rx request ring. */
87 RING_IDX rx_req_cons_peek;
89 /* Transmit shaping: allow 'credit_bytes' every 'credit_usec'. */
90 unsigned long credit_bytes;
91 unsigned long credit_usec;
92 unsigned long remaining_credit;
93 struct timer_list credit_timeout;
95 /* Miscellaneous private stuff. */
96 struct list_head list; /* scheduling list */
98 struct net_device *dev;
99 struct net_device_stats stats;
101 wait_queue_head_t waiting_to_free;
104 #define NET_TX_RING_SIZE __RING_SIZE((netif_tx_sring_t *)0, PAGE_SIZE)
105 #define NET_RX_RING_SIZE __RING_SIZE((netif_rx_sring_t *)0, PAGE_SIZE)
107 void netif_disconnect(netif_t *netif);
109 netif_t *netif_alloc(domid_t domid, unsigned int handle);
110 int netif_map(netif_t *netif, unsigned long tx_ring_ref,
111 unsigned long rx_ring_ref, unsigned int evtchn);
113 #define netif_get(_b) (atomic_inc(&(_b)->refcnt))
114 #define netif_put(_b) \
116 if ( atomic_dec_and_test(&(_b)->refcnt) ) \
117 wake_up(&(_b)->waiting_to_free); \
120 void netif_xenbus_init(void);
122 void netif_schedule_work(netif_t *netif);
123 void netif_deschedule_work(netif_t *netif);
125 int netif_be_start_xmit(struct sk_buff *skb, struct net_device *dev);
126 struct net_device_stats *netif_be_get_stats(struct net_device *dev);
127 irqreturn_t netif_be_int(int irq, void *dev_id, struct pt_regs *regs);
129 static inline int netbk_can_queue(struct net_device *dev)
131 netif_t *netif = netdev_priv(dev);
132 return netif->can_queue;
135 static inline int netbk_can_sg(struct net_device *dev)
137 netif_t *netif = netdev_priv(dev);
138 return netif->features & NETIF_F_SG;
141 #endif /* __NETIF__BACKEND__COMMON_H__ */