1 /******************************************************************************
2 * usbatm.h - Generic USB xDSL driver core
4 * Copyright (C) 2001, Alcatel
5 * Copyright (C) 2003, Duncan Sands, SolNegro, Josep Comas
6 * Copyright (C) 2004, David Woodhouse
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the Free
10 * Software Foundation; either version 2 of the License, or (at your option)
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
18 * You should have received a copy of the GNU General Public License along with
19 * this program; if not, write to the Free Software Foundation, Inc., 59
20 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 ******************************************************************************/
27 #include <linux/config.h>
33 #include <asm/semaphore.h>
34 #include <linux/atm.h>
35 #include <linux/atmdev.h>
36 #include <linux/completion.h>
37 #include <linux/device.h>
38 #include <linux/kref.h>
39 #include <linux/list.h>
40 #include <linux/stringify.h>
41 #include <linux/usb.h>
44 #define UDSL_ASSERT(x) BUG_ON(!(x))
46 #define UDSL_ASSERT(x) do { if (!(x)) warn("failed assertion '%s' at line %d", __stringify(x), __LINE__); } while(0)
49 #define usb_err(instance, format, arg...) \
50 dev_err(&(instance)->usb_intf->dev , format , ## arg)
51 #define usb_info(instance, format, arg...) \
52 dev_info(&(instance)->usb_intf->dev , format , ## arg)
53 #define usb_warn(instance, format, arg...) \
54 dev_warn(&(instance)->usb_intf->dev , format , ## arg)
55 #define usb_dbg(instance, format, arg...) \
56 dev_dbg(&(instance)->usb_intf->dev , format , ## arg)
58 /* FIXME: move to dev_* once ATM is driver model aware */
59 #define atm_printk(level, instance, format, arg...) \
60 printk(level "ATM dev %d: " format , \
61 (instance)->atm_dev->number , ## arg)
63 #define atm_err(instance, format, arg...) \
64 atm_printk(KERN_ERR, instance , format , ## arg)
65 #define atm_info(instance, format, arg...) \
66 atm_printk(KERN_INFO, instance , format , ## arg)
67 #define atm_warn(instance, format, arg...) \
68 atm_printk(KERN_WARNING, instance , format , ## arg)
70 #define atm_dbg(instance, format, arg...) \
71 atm_printk(KERN_DEBUG, instance , format , ## arg)
73 #define atm_dbg(instance, format, arg...) \
83 * Assuming all methods exist and succeed, they are called in this order:
85 * bind, heavy_init, atm_start, ..., atm_stop, unbind
88 struct usbatm_driver {
91 const char *driver_name;
94 * init device ... can sleep, or cause probe() failure. Drivers with a heavy_init
95 * method can avoid having it called by setting need_heavy_init to zero.
97 int (*bind) (struct usbatm_data *, struct usb_interface *,
98 const struct usb_device_id *id, int *need_heavy_init);
100 /* additional device initialization that is too slow to be done in probe() */
101 int (*heavy_init) (struct usbatm_data *, struct usb_interface *);
103 /* cleanup device ... can sleep, but can't fail */
104 void (*unbind) (struct usbatm_data *, struct usb_interface *);
106 /* init ATM device ... can sleep, or cause ATM initialization failure */
107 int (*atm_start) (struct usbatm_data *, struct atm_dev *);
109 /* cleanup ATM device ... can sleep, but can't fail */
110 void (*atm_stop) (struct usbatm_data *, struct atm_dev *);
112 int in; /* rx endpoint */
113 int out; /* tx endpoint */
119 extern int usbatm_usb_probe(struct usb_interface *intf, const struct usb_device_id *id,
120 struct usbatm_driver *driver);
121 extern void usbatm_usb_disconnect(struct usb_interface *intf);
124 struct usbatm_channel {
125 int endpoint; /* usb pipe */
126 unsigned int stride; /* ATM cell size + padding */
127 unsigned int buf_size; /* urb buffer size */
129 struct list_head list;
130 struct tasklet_struct tasklet;
131 struct timer_list delay;
132 struct usbatm_data *usbatm;
135 /* main driver data */
143 struct usbatm_driver *driver;
145 char driver_name[16];
148 struct usb_device *usb_dev;
149 struct usb_interface *usb_intf;
150 char description[64];
153 struct atm_dev *atm_dev;
155 /********************************
156 * private fields - do not use *
157 ********************************/
159 struct kref refcount;
160 struct semaphore serialize;
164 struct completion thread_started;
165 struct completion thread_exited;
168 struct list_head vcc_list;
170 struct usbatm_channel rx_channel;
171 struct usbatm_channel tx_channel;
173 struct sk_buff_head sndqueue;
174 struct sk_buff *current_skb; /* being emptied */
179 #endif /* _USBATM_H_ */