blob: 1cf4767007ded2f98e7461996da06b2df14eb756 [file] [log] [blame]
Duncan Sandsc59bba72005-05-11 20:24:03 +02001/******************************************************************************
2 * usbatm.h - Generic USB xDSL driver core
3 *
4 * Copyright (C) 2001, Alcatel
5 * Copyright (C) 2003, Duncan Sands, SolNegro, Josep Comas
6 * Copyright (C) 2004, David Woodhouse
7 *
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)
11 * any later version.
12 *
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
16 * more details.
17 *
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.
21 *
22 ******************************************************************************/
23
24#ifndef _USBATM_H_
25#define _USBATM_H_
26
Duncan Sandsc59bba72005-05-11 20:24:03 +020027#include <asm/semaphore.h>
28#include <linux/atm.h>
29#include <linux/atmdev.h>
30#include <linux/completion.h>
31#include <linux/device.h>
Duncan Sands0ec3c7e2006-01-17 11:15:13 +010032#include <linux/kernel.h>
Duncan Sandsc59bba72005-05-11 20:24:03 +020033#include <linux/kref.h>
34#include <linux/list.h>
35#include <linux/stringify.h>
36#include <linux/usb.h>
37
Duncan Sands0ec3c7e2006-01-17 11:15:13 +010038/*
39#define VERBOSE_DEBUG
40*/
41
Duncan Sandsc59bba72005-05-11 20:24:03 +020042#ifdef DEBUG
43#define UDSL_ASSERT(x) BUG_ON(!(x))
44#else
45#define UDSL_ASSERT(x) do { if (!(x)) warn("failed assertion '%s' at line %d", __stringify(x), __LINE__); } while(0)
46#endif
47
48#define usb_err(instance, format, arg...) \
49 dev_err(&(instance)->usb_intf->dev , format , ## arg)
50#define usb_info(instance, format, arg...) \
51 dev_info(&(instance)->usb_intf->dev , format , ## arg)
52#define usb_warn(instance, format, arg...) \
53 dev_warn(&(instance)->usb_intf->dev , format , ## arg)
Duncan Sands0ec3c7e2006-01-17 11:15:13 +010054#ifdef DEBUG
Duncan Sandsc59bba72005-05-11 20:24:03 +020055#define usb_dbg(instance, format, arg...) \
Duncan Sands0ec3c7e2006-01-17 11:15:13 +010056 dev_printk(KERN_DEBUG , &(instance)->usb_intf->dev , format , ## arg)
57#else
58#define usb_dbg(instance, format, arg...) \
59 do {} while (0)
60#endif
Duncan Sandsc59bba72005-05-11 20:24:03 +020061
62/* FIXME: move to dev_* once ATM is driver model aware */
63#define atm_printk(level, instance, format, arg...) \
Andrew Morton843c9442005-05-30 01:09:06 -070064 printk(level "ATM dev %d: " format , \
65 (instance)->atm_dev->number , ## arg)
Duncan Sandsc59bba72005-05-11 20:24:03 +020066
67#define atm_err(instance, format, arg...) \
68 atm_printk(KERN_ERR, instance , format , ## arg)
69#define atm_info(instance, format, arg...) \
70 atm_printk(KERN_INFO, instance , format , ## arg)
71#define atm_warn(instance, format, arg...) \
72 atm_printk(KERN_WARNING, instance , format , ## arg)
73#ifdef DEBUG
74#define atm_dbg(instance, format, arg...) \
75 atm_printk(KERN_DEBUG, instance , format , ## arg)
Duncan Sands0ec3c7e2006-01-17 11:15:13 +010076#define atm_rldbg(instance, format, arg...) \
77 if (printk_ratelimit()) \
78 atm_printk(KERN_DEBUG, instance , format , ## arg)
Duncan Sandsc59bba72005-05-11 20:24:03 +020079#else
80#define atm_dbg(instance, format, arg...) \
81 do {} while (0)
Duncan Sands0ec3c7e2006-01-17 11:15:13 +010082#define atm_rldbg(instance, format, arg...) \
83 do {} while (0)
Duncan Sandsc59bba72005-05-11 20:24:03 +020084#endif
85
86
Duncan Sands35644b02006-01-17 11:16:13 +010087/* flags, set by mini-driver in bind() */
88
89#define UDSL_SKIP_HEAVY_INIT (1<<0)
Duncan Sands80aae7a2006-01-13 10:59:23 +010090#define UDSL_USE_ISOC (1<<1)
Duncan Sandsa3673d32006-01-13 11:12:58 +010091#define UDSL_IGNORE_EILSEQ (1<<2)
Duncan Sands35644b02006-01-17 11:16:13 +010092
93
Duncan Sandsc59bba72005-05-11 20:24:03 +020094/* mini driver */
95
96struct usbatm_data;
97
98/*
99* Assuming all methods exist and succeed, they are called in this order:
100*
101* bind, heavy_init, atm_start, ..., atm_stop, unbind
102*/
103
104struct usbatm_driver {
Duncan Sandsc59bba72005-05-11 20:24:03 +0200105 const char *driver_name;
106
Duncan Sands35644b02006-01-17 11:16:13 +0100107 /* init device ... can sleep, or cause probe() failure */
Duncan Sandsc59bba72005-05-11 20:24:03 +0200108 int (*bind) (struct usbatm_data *, struct usb_interface *,
Duncan Sands35644b02006-01-17 11:16:13 +0100109 const struct usb_device_id *id);
Duncan Sandsc59bba72005-05-11 20:24:03 +0200110
111 /* additional device initialization that is too slow to be done in probe() */
112 int (*heavy_init) (struct usbatm_data *, struct usb_interface *);
113
114 /* cleanup device ... can sleep, but can't fail */
115 void (*unbind) (struct usbatm_data *, struct usb_interface *);
116
117 /* init ATM device ... can sleep, or cause ATM initialization failure */
118 int (*atm_start) (struct usbatm_data *, struct atm_dev *);
119
120 /* cleanup ATM device ... can sleep, but can't fail */
121 void (*atm_stop) (struct usbatm_data *, struct atm_dev *);
122
Duncan Sands80aae7a2006-01-13 10:59:23 +0100123 int bulk_in; /* bulk rx endpoint */
124 int isoc_in; /* isochronous rx endpoint */
125 int bulk_out; /* bulk tx endpoint */
Duncan Sandsc59bba72005-05-11 20:24:03 +0200126
127 unsigned rx_padding;
128 unsigned tx_padding;
129};
130
131extern int usbatm_usb_probe(struct usb_interface *intf, const struct usb_device_id *id,
132 struct usbatm_driver *driver);
133extern void usbatm_usb_disconnect(struct usb_interface *intf);
134
135
136struct usbatm_channel {
137 int endpoint; /* usb pipe */
138 unsigned int stride; /* ATM cell size + padding */
139 unsigned int buf_size; /* urb buffer size */
Duncan Sands80aae7a2006-01-13 10:59:23 +0100140 unsigned int packet_size; /* endpoint maxpacket */
Duncan Sandsc59bba72005-05-11 20:24:03 +0200141 spinlock_t lock;
142 struct list_head list;
143 struct tasklet_struct tasklet;
144 struct timer_list delay;
145 struct usbatm_data *usbatm;
146};
147
148/* main driver data */
149
150struct usbatm_data {
151 /******************
152 * public fields *
153 ******************/
154
155 /* mini driver */
156 struct usbatm_driver *driver;
157 void *driver_data;
158 char driver_name[16];
Duncan Sands35644b02006-01-17 11:16:13 +0100159 unsigned int flags; /* set by mini-driver in bind() */
Duncan Sandsc59bba72005-05-11 20:24:03 +0200160
161 /* USB device */
162 struct usb_device *usb_dev;
163 struct usb_interface *usb_intf;
164 char description[64];
165
166 /* ATM device */
167 struct atm_dev *atm_dev;
168
169 /********************************
170 * private fields - do not use *
171 ********************************/
172
173 struct kref refcount;
174 struct semaphore serialize;
Duncan Sands0e42a622006-01-13 10:05:15 +0100175 int disconnected;
Duncan Sandsc59bba72005-05-11 20:24:03 +0200176
177 /* heavy init */
178 int thread_pid;
179 struct completion thread_started;
180 struct completion thread_exited;
181
182 /* ATM device */
183 struct list_head vcc_list;
184
185 struct usbatm_channel rx_channel;
186 struct usbatm_channel tx_channel;
187
188 struct sk_buff_head sndqueue;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100189 struct sk_buff *current_skb; /* being emptied */
Duncan Sandsc59bba72005-05-11 20:24:03 +0200190
Duncan Sandse3fb2f62006-01-13 11:06:46 +0100191 struct usbatm_vcc_data *cached_vcc;
192 int cached_vci;
193 short cached_vpi;
194
195 unsigned char *cell_buf; /* holds partial rx cell */
196 unsigned int buf_usage;
197
Duncan Sandsc59bba72005-05-11 20:24:03 +0200198 struct urb *urbs[0];
199};
200
201#endif /* _USBATM_H_ */