1 /******************************************************************************
2 * usbatm.c - 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, Roman Kagan
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 ******************************************************************************/
25 * Written by Johan Verrept, Duncan Sands (duncan.sands@free.fr) and David Woodhouse
27 * 1.7+: - See the check-in logs
29 * 1.6: - No longer opens a connection if the firmware is not loaded
30 * - Added support for the speedtouch 330
31 * - Removed the limit on the number of devices
32 * - Module now autoloads on device plugin
33 * - Merged relevant parts of sarlib
34 * - Replaced the kernel thread with a tasklet
35 * - New packet transmission code
36 * - Changed proc file contents
37 * - Fixed all known SMP races
38 * - Many fixes and cleanups
39 * - Various fixes by Oliver Neukum (oliver@neukum.name)
41 * 1.5A: - Version for inclusion in 2.5 series kernel
42 * - Modifications by Richard Purdie (rpurdie@rpsys.net)
43 * - made compatible with kernel 2.5.6 onwards by changing
44 * usbatm_usb_send_data_context->urb to a pointer and adding code
45 * to alloc and free it
46 * - remove_wait_queue() added to usbatm_atm_processqueue_thread()
48 * 1.5: - fixed memory leak when atmsar_decode_aal5 returned NULL.
49 * (reported by stephen.robinson@zen.co.uk)
51 * 1.4: - changed the spin_lock() under interrupt to spin_lock_irqsave()
52 * - unlink all active send urbs of a vcc that is being closed.
54 * 1.3.1: - added the version number
56 * 1.3: - Added multiple send urb support
57 * - fixed memory leak and vcc->tx_inuse starvation bug
58 * when not enough memory left in vcc.
60 * 1.2: - Fixed race condition in usbatm_usb_send_data()
61 * 1.1: - Turned off packet debugging
67 #include <asm/uaccess.h>
68 #include <linux/crc32.h>
69 #include <linux/errno.h>
70 #include <linux/init.h>
71 #include <linux/interrupt.h>
72 #include <linux/kernel.h>
73 #include <linux/module.h>
74 #include <linux/moduleparam.h>
75 #include <linux/netdevice.h>
76 #include <linux/proc_fs.h>
77 #include <linux/sched.h>
78 #include <linux/signal.h>
79 #include <linux/slab.h>
80 #include <linux/smp_lock.h>
81 #include <linux/stat.h>
82 #include <linux/timer.h>
83 #include <linux/wait.h>
86 static int usbatm_print_packet(const unsigned char *data, int len);
87 #define PACKETDEBUG(arg...) usbatm_print_packet (arg)
88 #define vdbg(arg...) dbg (arg)
90 #define PACKETDEBUG(arg...)
94 #define DRIVER_AUTHOR "Johan Verrept, Duncan Sands <duncan.sands@free.fr>"
95 #define DRIVER_VERSION "1.10"
96 #define DRIVER_DESC "Generic USB ATM/DSL I/O, version " DRIVER_VERSION
98 static const char usbatm_driver_name[] = "usbatm";
100 #define UDSL_MAX_RCV_URBS 16
101 #define UDSL_MAX_SND_URBS 16
102 #define UDSL_MAX_BUF_SIZE 65536
103 #define UDSL_DEFAULT_RCV_URBS 4
104 #define UDSL_DEFAULT_SND_URBS 4
105 #define UDSL_DEFAULT_RCV_BUF_SIZE 3392 /* 64 * ATM_CELL_SIZE */
106 #define UDSL_DEFAULT_SND_BUF_SIZE 3392 /* 64 * ATM_CELL_SIZE */
108 #define ATM_CELL_HEADER (ATM_CELL_SIZE - ATM_CELL_PAYLOAD)
110 #define THROTTLE_MSECS 100 /* delay to recover processing after urb submission fails */
112 static unsigned int num_rcv_urbs = UDSL_DEFAULT_RCV_URBS;
113 static unsigned int num_snd_urbs = UDSL_DEFAULT_SND_URBS;
114 static unsigned int rcv_buf_bytes = UDSL_DEFAULT_RCV_BUF_SIZE;
115 static unsigned int snd_buf_bytes = UDSL_DEFAULT_SND_BUF_SIZE;
117 module_param(num_rcv_urbs, uint, S_IRUGO);
118 MODULE_PARM_DESC(num_rcv_urbs,
119 "Number of urbs used for reception (range: 0-"
120 __MODULE_STRING(UDSL_MAX_RCV_URBS) ", default: "
121 __MODULE_STRING(UDSL_DEFAULT_RCV_URBS) ")");
123 module_param(num_snd_urbs, uint, S_IRUGO);
124 MODULE_PARM_DESC(num_snd_urbs,
125 "Number of urbs used for transmission (range: 0-"
126 __MODULE_STRING(UDSL_MAX_SND_URBS) ", default: "
127 __MODULE_STRING(UDSL_DEFAULT_SND_URBS) ")");
129 module_param(rcv_buf_bytes, uint, S_IRUGO);
130 MODULE_PARM_DESC(rcv_buf_bytes,
131 "Size of the buffers used for reception, in bytes (range: 1-"
132 __MODULE_STRING(UDSL_MAX_BUF_SIZE) ", default: "
133 __MODULE_STRING(UDSL_DEFAULT_RCV_BUF_SIZE) ")");
135 module_param(snd_buf_bytes, uint, S_IRUGO);
136 MODULE_PARM_DESC(snd_buf_bytes,
137 "Size of the buffers used for transmission, in bytes (range: 1-"
138 __MODULE_STRING(UDSL_MAX_BUF_SIZE) ", default: "
139 __MODULE_STRING(UDSL_DEFAULT_SND_BUF_SIZE) ")");
144 struct usbatm_vcc_data {
146 struct list_head list;
151 /* raw cell reassembly */
152 struct sk_buff *sarb;
158 struct usbatm_control {
159 struct atm_skb_data atm;
164 #define UDSL_SKB(x) ((struct usbatm_control *)(x)->cb)
169 static void usbatm_atm_dev_close(struct atm_dev *atm_dev);
170 static int usbatm_atm_open(struct atm_vcc *vcc);
171 static void usbatm_atm_close(struct atm_vcc *vcc);
172 static int usbatm_atm_ioctl(struct atm_dev *atm_dev, unsigned int cmd, void __user * arg);
173 static int usbatm_atm_send(struct atm_vcc *vcc, struct sk_buff *skb);
174 static int usbatm_atm_proc_read(struct atm_dev *atm_dev, loff_t * pos, char *page);
176 static struct atmdev_ops usbatm_atm_devops = {
177 .dev_close = usbatm_atm_dev_close,
178 .open = usbatm_atm_open,
179 .close = usbatm_atm_close,
180 .ioctl = usbatm_atm_ioctl,
181 .send = usbatm_atm_send,
182 .proc_read = usbatm_atm_proc_read,
183 .owner = THIS_MODULE,
191 static inline unsigned int usbatm_pdu_length(unsigned int length)
193 length += ATM_CELL_PAYLOAD - 1 + ATM_AAL5_TRAILER;
194 return length - length % ATM_CELL_PAYLOAD;
197 static inline void usbatm_pop(struct atm_vcc *vcc, struct sk_buff *skb)
202 dev_kfree_skb_any(skb);
210 static struct urb *usbatm_pop_urb(struct usbatm_channel *channel)
214 spin_lock_irq(&channel->lock);
215 if (list_empty(&channel->list)) {
216 spin_unlock_irq(&channel->lock);
220 urb = list_entry(channel->list.next, struct urb, urb_list);
221 list_del(&urb->urb_list);
222 spin_unlock_irq(&channel->lock);
227 static int usbatm_submit_urb(struct urb *urb)
229 struct usbatm_channel *channel = urb->context;
232 vdbg("%s: submitting urb 0x%p, size %u",
233 __func__, urb, urb->transfer_buffer_length);
235 ret = usb_submit_urb(urb, GFP_ATOMIC);
237 if (printk_ratelimit())
238 atm_warn(channel->usbatm, "%s: urb 0x%p submission failed (%d)!\n",
241 /* consider all errors transient and return the buffer back to the queue */
242 urb->status = -EAGAIN;
243 spin_lock_irq(&channel->lock);
245 /* must add to the front when sending; doesn't matter when receiving */
246 list_add(&urb->urb_list, &channel->list);
248 spin_unlock_irq(&channel->lock);
250 /* make sure the channel doesn't stall */
251 mod_timer(&channel->delay, jiffies + msecs_to_jiffies(THROTTLE_MSECS));
257 static void usbatm_complete(struct urb *urb)
259 struct usbatm_channel *channel = urb->context;
262 vdbg("%s: urb 0x%p, status %d, actual_length %d",
263 __func__, urb, urb->status, urb->actual_length);
265 /* usually in_interrupt(), but not always */
266 spin_lock_irqsave(&channel->lock, flags);
268 /* must add to the back when receiving; doesn't matter when sending */
269 list_add_tail(&urb->urb_list, &channel->list);
271 spin_unlock_irqrestore(&channel->lock, flags);
273 if (unlikely(urb->status) &&
274 (!(channel->usbatm->flags & UDSL_IGNORE_EILSEQ) ||
275 urb->status != -EILSEQ ))
277 if (printk_ratelimit())
278 atm_warn(channel->usbatm, "%s: urb 0x%p failed (%d)!\n",
279 __func__, urb, urb->status);
280 /* throttle processing in case of an error */
281 mod_timer(&channel->delay, jiffies + msecs_to_jiffies(THROTTLE_MSECS));
283 tasklet_schedule(&channel->tasklet);
291 static inline struct usbatm_vcc_data *usbatm_find_vcc(struct usbatm_data *instance,
294 struct usbatm_vcc_data *vcc_data;
296 list_for_each_entry(vcc_data, &instance->vcc_list, list)
297 if ((vcc_data->vci == vci) && (vcc_data->vpi == vpi))
302 static void usbatm_extract_one_cell(struct usbatm_data *instance, unsigned char *source)
305 struct sk_buff *sarb;
306 short vpi = ((source[0] & 0x0f) << 4) | (source[1] >> 4);
307 int vci = ((source[1] & 0x0f) << 12) | (source[2] << 4) | (source[3] >> 4);
308 u8 pti = ((source[3] & 0xe) >> 1);
310 vdbg("%s: vpi %hd, vci %d, pti %d", __func__, vpi, vci, pti);
312 if ((vci != instance->cached_vci) || (vpi != instance->cached_vpi)) {
313 instance->cached_vpi = vpi;
314 instance->cached_vci = vci;
316 instance->cached_vcc = usbatm_find_vcc(instance, vpi, vci);
318 if (!instance->cached_vcc)
319 atm_rldbg(instance, "%s: unknown vpi/vci (%hd/%d)!\n", __func__, vpi, vci);
322 if (!instance->cached_vcc)
325 vcc = instance->cached_vcc->vcc;
327 /* OAM F5 end-to-end */
328 if (pti == ATM_PTI_E2EF5) {
329 if (printk_ratelimit())
330 atm_warn(instance, "%s: OAM not supported (vpi %d, vci %d)!\n",
332 atomic_inc(&vcc->stats->rx_err);
336 sarb = instance->cached_vcc->sarb;
338 if (sarb->tail + ATM_CELL_PAYLOAD > sarb->end) {
339 atm_rldbg(instance, "%s: buffer overrun (sarb->len %u, vcc: 0x%p)!\n",
340 __func__, sarb->len, vcc);
341 /* discard cells already received */
343 UDSL_ASSERT(sarb->tail + ATM_CELL_PAYLOAD <= sarb->end);
346 memcpy(skb_tail_pointer(sarb), source + ATM_CELL_HEADER, ATM_CELL_PAYLOAD);
347 __skb_put(sarb, ATM_CELL_PAYLOAD);
352 unsigned int pdu_length;
354 length = (source[ATM_CELL_SIZE - 6] << 8) + source[ATM_CELL_SIZE - 5];
356 /* guard against overflow */
357 if (length > ATM_MAX_AAL5_PDU) {
358 atm_rldbg(instance, "%s: bogus length %u (vcc: 0x%p)!\n",
359 __func__, length, vcc);
360 atomic_inc(&vcc->stats->rx_err);
364 pdu_length = usbatm_pdu_length(length);
366 if (sarb->len < pdu_length) {
367 atm_rldbg(instance, "%s: bogus pdu_length %u (sarb->len: %u, vcc: 0x%p)!\n",
368 __func__, pdu_length, sarb->len, vcc);
369 atomic_inc(&vcc->stats->rx_err);
373 if (crc32_be(~0, skb_tail_pointer(sarb) - pdu_length, pdu_length) != 0xc704dd7b) {
374 atm_rldbg(instance, "%s: packet failed crc check (vcc: 0x%p)!\n",
376 atomic_inc(&vcc->stats->rx_err);
380 vdbg("%s: got packet (length: %u, pdu_length: %u, vcc: 0x%p)", __func__, length, pdu_length, vcc);
382 if (!(skb = dev_alloc_skb(length))) {
383 if (printk_ratelimit())
384 atm_err(instance, "%s: no memory for skb (length: %u)!\n",
386 atomic_inc(&vcc->stats->rx_drop);
390 vdbg("%s: allocated new sk_buff (skb: 0x%p, skb->truesize: %u)", __func__, skb, skb->truesize);
392 if (!atm_charge(vcc, skb->truesize)) {
393 atm_rldbg(instance, "%s: failed atm_charge (skb->truesize: %u)!\n",
394 __func__, skb->truesize);
395 dev_kfree_skb_any(skb);
396 goto out; /* atm_charge increments rx_drop */
399 skb_copy_to_linear_data(skb,
400 skb_tail_pointer(sarb) - pdu_length,
402 __skb_put(skb, length);
404 vdbg("%s: sending skb 0x%p, skb->len %u, skb->truesize %u",
405 __func__, skb, skb->len, skb->truesize);
407 PACKETDEBUG(skb->data, skb->len);
411 atomic_inc(&vcc->stats->rx);
417 static void usbatm_extract_cells(struct usbatm_data *instance,
418 unsigned char *source, unsigned int avail_data)
420 unsigned int stride = instance->rx_channel.stride;
421 unsigned int buf_usage = instance->buf_usage;
423 /* extract cells from incoming data, taking into account that
424 * the length of avail data may not be a multiple of stride */
427 /* we have a partially received atm cell */
428 unsigned char *cell_buf = instance->cell_buf;
429 unsigned int space_left = stride - buf_usage;
431 UDSL_ASSERT(buf_usage <= stride);
433 if (avail_data >= space_left) {
434 /* add new data and process cell */
435 memcpy(cell_buf + buf_usage, source, space_left);
436 source += space_left;
437 avail_data -= space_left;
438 usbatm_extract_one_cell(instance, cell_buf);
439 instance->buf_usage = 0;
441 /* not enough data to fill the cell */
442 memcpy(cell_buf + buf_usage, source, avail_data);
443 instance->buf_usage = buf_usage + avail_data;
448 for (; avail_data >= stride; avail_data -= stride, source += stride)
449 usbatm_extract_one_cell(instance, source);
451 if (avail_data > 0) {
452 /* length was not a multiple of stride -
453 * save remaining data for next call */
454 memcpy(instance->cell_buf, source, avail_data);
455 instance->buf_usage = avail_data;
464 static unsigned int usbatm_write_cells(struct usbatm_data *instance,
466 u8 *target, unsigned int avail_space)
468 struct usbatm_control *ctrl = UDSL_SKB(skb);
469 struct atm_vcc *vcc = ctrl->atm.vcc;
470 unsigned int bytes_written;
471 unsigned int stride = instance->tx_channel.stride;
473 vdbg("%s: skb->len=%d, avail_space=%u", __func__, skb->len, avail_space);
474 UDSL_ASSERT(!(avail_space % stride));
476 for (bytes_written = 0; bytes_written < avail_space && ctrl->len;
477 bytes_written += stride, target += stride) {
478 unsigned int data_len = min_t(unsigned int, skb->len, ATM_CELL_PAYLOAD);
479 unsigned int left = ATM_CELL_PAYLOAD - data_len;
482 ptr[0] = vcc->vpi >> 4;
483 ptr[1] = (vcc->vpi << 4) | (vcc->vci >> 12);
484 ptr[2] = vcc->vci >> 4;
485 ptr[3] = vcc->vci << 4;
487 ptr += ATM_CELL_HEADER;
489 skb_copy_from_linear_data(skb, ptr, data_len);
491 __skb_pull(skb, data_len);
496 memset(ptr, 0, left);
498 if (left >= ATM_AAL5_TRAILER) { /* trailer will go in this cell */
499 u8 *trailer = target + ATM_CELL_SIZE - ATM_AAL5_TRAILER;
500 /* trailer[0] = 0; UU = 0 */
501 /* trailer[1] = 0; CPI = 0 */
502 trailer[2] = ctrl->len >> 8;
503 trailer[3] = ctrl->len;
505 ctrl->crc = ~ crc32_be(ctrl->crc, ptr, left - 4);
507 trailer[4] = ctrl->crc >> 24;
508 trailer[5] = ctrl->crc >> 16;
509 trailer[6] = ctrl->crc >> 8;
510 trailer[7] = ctrl->crc;
512 target[3] |= 0x2; /* adjust PTI */
514 ctrl->len = 0; /* tag this skb finished */
517 ctrl->crc = crc32_be(ctrl->crc, ptr, left);
520 return bytes_written;
528 static void usbatm_rx_process(unsigned long data)
530 struct usbatm_data *instance = (struct usbatm_data *)data;
533 while ((urb = usbatm_pop_urb(&instance->rx_channel))) {
534 vdbg("%s: processing urb 0x%p", __func__, urb);
536 if (usb_pipeisoc(urb->pipe)) {
537 unsigned char *merge_start = NULL;
538 unsigned int merge_length = 0;
539 const unsigned int packet_size = instance->rx_channel.packet_size;
542 for (i = 0; i < urb->number_of_packets; i++) {
543 if (!urb->iso_frame_desc[i].status) {
544 unsigned int actual_length = urb->iso_frame_desc[i].actual_length;
546 UDSL_ASSERT(actual_length <= packet_size);
549 merge_start = (unsigned char *)urb->transfer_buffer + urb->iso_frame_desc[i].offset;
550 merge_length += actual_length;
551 if (merge_length && (actual_length < packet_size)) {
552 usbatm_extract_cells(instance, merge_start, merge_length);
556 atm_rldbg(instance, "%s: status %d in frame %d!\n", __func__, urb->status, i);
558 usbatm_extract_cells(instance, merge_start, merge_length);
560 instance->buf_usage = 0;
565 usbatm_extract_cells(instance, merge_start, merge_length);
568 usbatm_extract_cells(instance, urb->transfer_buffer, urb->actual_length);
570 instance->buf_usage = 0;
572 if (usbatm_submit_urb(urb))
582 static void usbatm_tx_process(unsigned long data)
584 struct usbatm_data *instance = (struct usbatm_data *)data;
585 struct sk_buff *skb = instance->current_skb;
586 struct urb *urb = NULL;
587 const unsigned int buf_size = instance->tx_channel.buf_size;
588 unsigned int bytes_written = 0;
592 skb = skb_dequeue(&instance->sndqueue);
596 urb = usbatm_pop_urb(&instance->tx_channel);
598 break; /* no more senders */
599 buffer = urb->transfer_buffer;
600 bytes_written = (urb->status == -EAGAIN) ?
601 urb->transfer_buffer_length : 0;
604 bytes_written += usbatm_write_cells(instance, skb,
605 buffer + bytes_written,
606 buf_size - bytes_written);
608 vdbg("%s: wrote %u bytes from skb 0x%p to urb 0x%p",
609 __func__, bytes_written, skb, urb);
611 if (!UDSL_SKB(skb)->len) {
612 struct atm_vcc *vcc = UDSL_SKB(skb)->atm.vcc;
614 usbatm_pop(vcc, skb);
615 atomic_inc(&vcc->stats->tx);
617 skb = skb_dequeue(&instance->sndqueue);
620 if (bytes_written == buf_size || (!skb && bytes_written)) {
621 urb->transfer_buffer_length = bytes_written;
623 if (usbatm_submit_urb(urb))
629 instance->current_skb = skb;
632 static void usbatm_cancel_send(struct usbatm_data *instance,
635 struct sk_buff *skb, *n;
637 atm_dbg(instance, "%s entered\n", __func__);
638 spin_lock_irq(&instance->sndqueue.lock);
639 for (skb = instance->sndqueue.next, n = skb->next;
640 skb != (struct sk_buff *)&instance->sndqueue;
641 skb = n, n = skb->next)
642 if (UDSL_SKB(skb)->atm.vcc == vcc) {
643 atm_dbg(instance, "%s: popping skb 0x%p\n", __func__, skb);
644 __skb_unlink(skb, &instance->sndqueue);
645 usbatm_pop(vcc, skb);
647 spin_unlock_irq(&instance->sndqueue.lock);
649 tasklet_disable(&instance->tx_channel.tasklet);
650 if ((skb = instance->current_skb) && (UDSL_SKB(skb)->atm.vcc == vcc)) {
651 atm_dbg(instance, "%s: popping current skb (0x%p)\n", __func__, skb);
652 instance->current_skb = NULL;
653 usbatm_pop(vcc, skb);
655 tasklet_enable(&instance->tx_channel.tasklet);
656 atm_dbg(instance, "%s done\n", __func__);
659 static int usbatm_atm_send(struct atm_vcc *vcc, struct sk_buff *skb)
661 struct usbatm_data *instance = vcc->dev->dev_data;
662 struct usbatm_control *ctrl = UDSL_SKB(skb);
665 vdbg("%s called (skb 0x%p, len %u)", __func__, skb, skb->len);
667 /* racy disconnection check - fine */
668 if (!instance || instance->disconnected) {
670 if (printk_ratelimit())
671 printk(KERN_DEBUG "%s: %s!\n", __func__, instance ? "disconnected" : "NULL instance");
677 if (vcc->qos.aal != ATM_AAL5) {
678 atm_rldbg(instance, "%s: unsupported ATM type %d!\n", __func__, vcc->qos.aal);
683 if (skb->len > ATM_MAX_AAL5_PDU) {
684 atm_rldbg(instance, "%s: packet too long (%d vs %d)!\n",
685 __func__, skb->len, ATM_MAX_AAL5_PDU);
690 PACKETDEBUG(skb->data, skb->len);
692 /* initialize the control block */
694 ctrl->len = skb->len;
695 ctrl->crc = crc32_be(~0, skb->data, skb->len);
697 skb_queue_tail(&instance->sndqueue, skb);
698 tasklet_schedule(&instance->tx_channel.tasklet);
703 usbatm_pop(vcc, skb);
708 /********************
710 ********************/
712 static void usbatm_destroy_instance(struct kref *kref)
714 struct usbatm_data *instance = container_of(kref, struct usbatm_data, refcount);
718 tasklet_kill(&instance->rx_channel.tasklet);
719 tasklet_kill(&instance->tx_channel.tasklet);
720 usb_put_dev(instance->usb_dev);
724 static void usbatm_get_instance(struct usbatm_data *instance)
728 kref_get(&instance->refcount);
731 static void usbatm_put_instance(struct usbatm_data *instance)
735 kref_put(&instance->refcount, usbatm_destroy_instance);
743 static void usbatm_atm_dev_close(struct atm_dev *atm_dev)
745 struct usbatm_data *instance = atm_dev->dev_data;
752 atm_dev->dev_data = NULL; /* catch bugs */
753 usbatm_put_instance(instance); /* taken in usbatm_atm_init */
756 static int usbatm_atm_proc_read(struct atm_dev *atm_dev, loff_t * pos, char *page)
758 struct usbatm_data *instance = atm_dev->dev_data;
762 dbg("%s: NULL instance!", __func__);
767 return sprintf(page, "%s\n", instance->description);
770 return sprintf(page, "MAC: %02x:%02x:%02x:%02x:%02x:%02x\n",
771 atm_dev->esi[0], atm_dev->esi[1],
772 atm_dev->esi[2], atm_dev->esi[3],
773 atm_dev->esi[4], atm_dev->esi[5]);
777 "AAL5: tx %d ( %d err ), rx %d ( %d err, %d drop )\n",
778 atomic_read(&atm_dev->stats.aal5.tx),
779 atomic_read(&atm_dev->stats.aal5.tx_err),
780 atomic_read(&atm_dev->stats.aal5.rx),
781 atomic_read(&atm_dev->stats.aal5.rx_err),
782 atomic_read(&atm_dev->stats.aal5.rx_drop));
785 if (instance->disconnected)
786 return sprintf(page, "Disconnected\n");
788 switch (atm_dev->signal) {
789 case ATM_PHY_SIG_FOUND:
790 return sprintf(page, "Line up\n");
791 case ATM_PHY_SIG_LOST:
792 return sprintf(page, "Line down\n");
794 return sprintf(page, "Line state unknown\n");
801 static int usbatm_atm_open(struct atm_vcc *vcc)
803 struct usbatm_data *instance = vcc->dev->dev_data;
804 struct usbatm_vcc_data *new = NULL;
807 short vpi = vcc->vpi;
810 dbg("%s: NULL data!", __func__);
814 atm_dbg(instance, "%s: vpi %hd, vci %d\n", __func__, vpi, vci);
816 /* only support AAL5 */
817 if ((vcc->qos.aal != ATM_AAL5)) {
818 atm_warn(instance, "%s: unsupported ATM type %d!\n", __func__, vcc->qos.aal);
823 if ((vcc->qos.rxtp.max_sdu < 0) || (vcc->qos.rxtp.max_sdu > ATM_MAX_AAL5_PDU)) {
824 atm_dbg(instance, "%s: max_sdu %d out of range!\n", __func__, vcc->qos.rxtp.max_sdu);
828 mutex_lock(&instance->serialize); /* vs self, usbatm_atm_close, usbatm_usb_disconnect */
830 if (instance->disconnected) {
831 atm_dbg(instance, "%s: disconnected!\n", __func__);
836 if (usbatm_find_vcc(instance, vpi, vci)) {
837 atm_dbg(instance, "%s: %hd/%d already in use!\n", __func__, vpi, vci);
842 if (!(new = kzalloc(sizeof(struct usbatm_vcc_data), GFP_KERNEL))) {
843 atm_err(instance, "%s: no memory for vcc_data!\n", __func__);
852 new->sarb = alloc_skb(usbatm_pdu_length(vcc->qos.rxtp.max_sdu), GFP_KERNEL);
854 atm_err(instance, "%s: no memory for SAR buffer!\n", __func__);
861 tasklet_disable(&instance->rx_channel.tasklet);
862 instance->cached_vcc = new;
863 instance->cached_vpi = vpi;
864 instance->cached_vci = vci;
865 list_add(&new->list, &instance->vcc_list);
866 tasklet_enable(&instance->rx_channel.tasklet);
868 set_bit(ATM_VF_ADDR, &vcc->flags);
869 set_bit(ATM_VF_PARTIAL, &vcc->flags);
870 set_bit(ATM_VF_READY, &vcc->flags);
872 mutex_unlock(&instance->serialize);
874 atm_dbg(instance, "%s: allocated vcc data 0x%p\n", __func__, new);
880 mutex_unlock(&instance->serialize);
884 static void usbatm_atm_close(struct atm_vcc *vcc)
886 struct usbatm_data *instance = vcc->dev->dev_data;
887 struct usbatm_vcc_data *vcc_data = vcc->dev_data;
889 if (!instance || !vcc_data) {
890 dbg("%s: NULL data!", __func__);
894 atm_dbg(instance, "%s entered\n", __func__);
896 atm_dbg(instance, "%s: deallocating vcc 0x%p with vpi %d vci %d\n",
897 __func__, vcc_data, vcc_data->vpi, vcc_data->vci);
899 usbatm_cancel_send(instance, vcc);
901 mutex_lock(&instance->serialize); /* vs self, usbatm_atm_open, usbatm_usb_disconnect */
903 tasklet_disable(&instance->rx_channel.tasklet);
904 if (instance->cached_vcc == vcc_data) {
905 instance->cached_vcc = NULL;
906 instance->cached_vpi = ATM_VPI_UNSPEC;
907 instance->cached_vci = ATM_VCI_UNSPEC;
909 list_del(&vcc_data->list);
910 tasklet_enable(&instance->rx_channel.tasklet);
912 kfree_skb(vcc_data->sarb);
913 vcc_data->sarb = NULL;
916 vcc->dev_data = NULL;
918 vcc->vpi = ATM_VPI_UNSPEC;
919 vcc->vci = ATM_VCI_UNSPEC;
920 clear_bit(ATM_VF_READY, &vcc->flags);
921 clear_bit(ATM_VF_PARTIAL, &vcc->flags);
922 clear_bit(ATM_VF_ADDR, &vcc->flags);
924 mutex_unlock(&instance->serialize);
926 atm_dbg(instance, "%s successful\n", __func__);
929 static int usbatm_atm_ioctl(struct atm_dev *atm_dev, unsigned int cmd,
932 struct usbatm_data *instance = atm_dev->dev_data;
934 if (!instance || instance->disconnected) {
935 dbg("%s: %s!", __func__, instance ? "disconnected" : "NULL instance");
941 return put_user(ATM_LM_NONE, (int __user *)arg) ? -EFAULT : 0;
947 static int usbatm_atm_init(struct usbatm_data *instance)
949 struct atm_dev *atm_dev;
952 /* ATM init. The ATM initialization scheme suffers from an intrinsic race
953 * condition: callbacks we register can be executed at once, before we have
954 * initialized the struct atm_dev. To protect against this, all callbacks
955 * abort if atm_dev->dev_data is NULL. */
956 atm_dev = atm_dev_register(instance->driver_name, &usbatm_atm_devops, -1, NULL);
958 usb_err(instance, "%s: failed to register ATM device!\n", __func__);
962 instance->atm_dev = atm_dev;
964 atm_dev->ci_range.vpi_bits = ATM_CI_MAX;
965 atm_dev->ci_range.vci_bits = ATM_CI_MAX;
966 atm_dev->signal = ATM_PHY_SIG_UNKNOWN;
968 /* temp init ATM device, set to 128kbit */
969 atm_dev->link_rate = 128 * 1000 / 424;
971 if (instance->driver->atm_start && ((ret = instance->driver->atm_start(instance, atm_dev)) < 0)) {
972 atm_err(instance, "%s: atm_start failed: %d!\n", __func__, ret);
976 usbatm_get_instance(instance); /* dropped in usbatm_atm_dev_close */
978 /* ready for ATM callbacks */
980 atm_dev->dev_data = instance;
982 /* submit all rx URBs */
983 for (i = 0; i < num_rcv_urbs; i++)
984 usbatm_submit_urb(instance->urbs[i]);
989 instance->atm_dev = NULL;
990 atm_dev_deregister(atm_dev); /* usbatm_atm_dev_close will eventually be called */
999 static int usbatm_do_heavy_init(void *arg)
1001 struct usbatm_data *instance = arg;
1004 daemonize(instance->driver->driver_name);
1005 allow_signal(SIGTERM);
1006 instance->thread_pid = current->pid;
1008 complete(&instance->thread_started);
1010 ret = instance->driver->heavy_init(instance, instance->usb_intf);
1013 ret = usbatm_atm_init(instance);
1015 mutex_lock(&instance->serialize);
1016 instance->thread_pid = -1;
1017 mutex_unlock(&instance->serialize);
1019 complete_and_exit(&instance->thread_exited, ret);
1022 static int usbatm_heavy_init(struct usbatm_data *instance)
1024 int ret = kernel_thread(usbatm_do_heavy_init, instance, CLONE_KERNEL);
1027 usb_err(instance, "%s: failed to create kernel_thread (%d)!\n", __func__, ret);
1031 wait_for_completion(&instance->thread_started);
1036 static void usbatm_tasklet_schedule(unsigned long data)
1038 tasklet_schedule((struct tasklet_struct *) data);
1041 static void usbatm_init_channel(struct usbatm_channel *channel)
1043 spin_lock_init(&channel->lock);
1044 INIT_LIST_HEAD(&channel->list);
1045 channel->delay.function = usbatm_tasklet_schedule;
1046 channel->delay.data = (unsigned long) &channel->tasklet;
1047 init_timer(&channel->delay);
1050 int usbatm_usb_probe(struct usb_interface *intf, const struct usb_device_id *id,
1051 struct usbatm_driver *driver)
1053 struct device *dev = &intf->dev;
1054 struct usb_device *usb_dev = interface_to_usbdev(intf);
1055 struct usbatm_data *instance;
1057 int error = -ENOMEM;
1059 unsigned int maxpacket, num_packets;
1061 dev_dbg(dev, "%s: trying driver %s with vendor=%04x, product=%04x, ifnum %2d\n",
1062 __func__, driver->driver_name,
1063 le16_to_cpu(usb_dev->descriptor.idVendor),
1064 le16_to_cpu(usb_dev->descriptor.idProduct),
1065 intf->altsetting->desc.bInterfaceNumber);
1068 instance = kzalloc(sizeof(*instance) + sizeof(struct urb *) * (num_rcv_urbs + num_snd_urbs), GFP_KERNEL);
1070 dev_err(dev, "%s: no memory for instance data!\n", __func__);
1076 instance->driver = driver;
1077 snprintf(instance->driver_name, sizeof(instance->driver_name), driver->driver_name);
1079 instance->usb_dev = usb_dev;
1080 instance->usb_intf = intf;
1082 buf = instance->description;
1083 length = sizeof(instance->description);
1085 if ((i = usb_string(usb_dev, usb_dev->descriptor.iProduct, buf, length)) < 0)
1091 i = scnprintf(buf, length, " (");
1095 if (length <= 0 || (i = usb_make_path(usb_dev, buf, length)) < 0)
1101 snprintf(buf, length, ")");
1104 if (driver->bind && (error = driver->bind(instance, intf, id)) < 0) {
1105 dev_err(dev, "%s: bind failed: %d!\n", __func__, error);
1109 /* private fields */
1111 kref_init(&instance->refcount); /* dropped in usbatm_usb_disconnect */
1112 mutex_init(&instance->serialize);
1114 instance->thread_pid = -1;
1115 init_completion(&instance->thread_started);
1116 init_completion(&instance->thread_exited);
1118 INIT_LIST_HEAD(&instance->vcc_list);
1119 skb_queue_head_init(&instance->sndqueue);
1121 usbatm_init_channel(&instance->rx_channel);
1122 usbatm_init_channel(&instance->tx_channel);
1123 tasklet_init(&instance->rx_channel.tasklet, usbatm_rx_process, (unsigned long)instance);
1124 tasklet_init(&instance->tx_channel.tasklet, usbatm_tx_process, (unsigned long)instance);
1125 instance->rx_channel.stride = ATM_CELL_SIZE + driver->rx_padding;
1126 instance->tx_channel.stride = ATM_CELL_SIZE + driver->tx_padding;
1127 instance->rx_channel.usbatm = instance->tx_channel.usbatm = instance;
1129 if ((instance->flags & UDSL_USE_ISOC) && driver->isoc_in)
1130 instance->rx_channel.endpoint = usb_rcvisocpipe(usb_dev, driver->isoc_in);
1132 instance->rx_channel.endpoint = usb_rcvbulkpipe(usb_dev, driver->bulk_in);
1134 instance->tx_channel.endpoint = usb_sndbulkpipe(usb_dev, driver->bulk_out);
1136 /* tx buffer size must be a positive multiple of the stride */
1137 instance->tx_channel.buf_size = max (instance->tx_channel.stride,
1138 snd_buf_bytes - (snd_buf_bytes % instance->tx_channel.stride));
1140 /* rx buffer size must be a positive multiple of the endpoint maxpacket */
1141 maxpacket = usb_maxpacket(usb_dev, instance->rx_channel.endpoint, 0);
1143 if ((maxpacket < 1) || (maxpacket > UDSL_MAX_BUF_SIZE)) {
1144 dev_err(dev, "%s: invalid endpoint %02x!\n", __func__,
1145 usb_pipeendpoint(instance->rx_channel.endpoint));
1150 num_packets = max (1U, (rcv_buf_bytes + maxpacket / 2) / maxpacket); /* round */
1152 if (num_packets * maxpacket > UDSL_MAX_BUF_SIZE)
1155 instance->rx_channel.buf_size = num_packets * maxpacket;
1156 instance->rx_channel.packet_size = maxpacket;
1159 for (i = 0; i < 2; i++) {
1160 struct usbatm_channel *channel = i ?
1161 &instance->tx_channel : &instance->rx_channel;
1163 dev_dbg(dev, "%s: using %d byte buffer for %s channel 0x%p\n", __func__, channel->buf_size, i ? "tx" : "rx", channel);
1167 /* initialize urbs */
1169 for (i = 0; i < num_rcv_urbs + num_snd_urbs; i++) {
1171 struct usbatm_channel *channel = i < num_rcv_urbs ?
1172 &instance->rx_channel : &instance->tx_channel;
1174 unsigned int iso_packets = usb_pipeisoc(channel->endpoint) ? channel->buf_size / channel->packet_size : 0;
1176 UDSL_ASSERT(!usb_pipeisoc(channel->endpoint) || usb_pipein(channel->endpoint));
1178 urb = usb_alloc_urb(iso_packets, GFP_KERNEL);
1180 dev_err(dev, "%s: no memory for urb %d!\n", __func__, i);
1185 instance->urbs[i] = urb;
1187 /* zero the tx padding to avoid leaking information */
1188 buffer = kzalloc(channel->buf_size, GFP_KERNEL);
1190 dev_err(dev, "%s: no memory for buffer %d!\n", __func__, i);
1195 usb_fill_bulk_urb(urb, instance->usb_dev, channel->endpoint,
1196 buffer, channel->buf_size, usbatm_complete, channel);
1200 urb->transfer_flags = URB_ISO_ASAP;
1201 urb->number_of_packets = iso_packets;
1202 for (j = 0; j < iso_packets; j++) {
1203 urb->iso_frame_desc[j].offset = channel->packet_size * j;
1204 urb->iso_frame_desc[j].length = channel->packet_size;
1208 /* put all tx URBs on the list of spares */
1209 if (i >= num_rcv_urbs)
1210 list_add_tail(&urb->urb_list, &channel->list);
1212 vdbg("%s: alloced buffer 0x%p buf size %u urb 0x%p",
1213 __func__, urb->transfer_buffer, urb->transfer_buffer_length, urb);
1216 instance->cached_vpi = ATM_VPI_UNSPEC;
1217 instance->cached_vci = ATM_VCI_UNSPEC;
1218 instance->cell_buf = kmalloc(instance->rx_channel.stride, GFP_KERNEL);
1220 if (!instance->cell_buf) {
1221 dev_err(dev, "%s: no memory for cell buffer!\n", __func__);
1226 if (!(instance->flags & UDSL_SKIP_HEAVY_INIT) && driver->heavy_init) {
1227 error = usbatm_heavy_init(instance);
1229 complete(&instance->thread_exited); /* pretend that heavy_init was run */
1230 error = usbatm_atm_init(instance);
1236 usb_get_dev(usb_dev);
1237 usb_set_intfdata(intf, instance);
1242 if (instance->driver->unbind)
1243 instance->driver->unbind(instance, intf);
1245 kfree(instance->cell_buf);
1247 for (i = 0; i < num_rcv_urbs + num_snd_urbs; i++) {
1248 if (instance->urbs[i])
1249 kfree(instance->urbs[i]->transfer_buffer);
1250 usb_free_urb(instance->urbs[i]);
1257 EXPORT_SYMBOL_GPL(usbatm_usb_probe);
1259 void usbatm_usb_disconnect(struct usb_interface *intf)
1261 struct device *dev = &intf->dev;
1262 struct usbatm_data *instance = usb_get_intfdata(intf);
1263 struct usbatm_vcc_data *vcc_data;
1266 dev_dbg(dev, "%s entered\n", __func__);
1269 dev_dbg(dev, "%s: NULL instance!\n", __func__);
1273 usb_set_intfdata(intf, NULL);
1275 mutex_lock(&instance->serialize);
1276 instance->disconnected = 1;
1277 if (instance->thread_pid >= 0)
1278 kill_proc(instance->thread_pid, SIGTERM, 1);
1279 mutex_unlock(&instance->serialize);
1281 wait_for_completion(&instance->thread_exited);
1283 mutex_lock(&instance->serialize);
1284 list_for_each_entry(vcc_data, &instance->vcc_list, list)
1285 vcc_release_async(vcc_data->vcc, -EPIPE);
1286 mutex_unlock(&instance->serialize);
1288 tasklet_disable(&instance->rx_channel.tasklet);
1289 tasklet_disable(&instance->tx_channel.tasklet);
1291 for (i = 0; i < num_rcv_urbs + num_snd_urbs; i++)
1292 usb_kill_urb(instance->urbs[i]);
1294 del_timer_sync(&instance->rx_channel.delay);
1295 del_timer_sync(&instance->tx_channel.delay);
1297 /* turn usbatm_[rt]x_process into something close to a no-op */
1298 /* no need to take the spinlock */
1299 INIT_LIST_HEAD(&instance->rx_channel.list);
1300 INIT_LIST_HEAD(&instance->tx_channel.list);
1302 tasklet_enable(&instance->rx_channel.tasklet);
1303 tasklet_enable(&instance->tx_channel.tasklet);
1305 if (instance->atm_dev && instance->driver->atm_stop)
1306 instance->driver->atm_stop(instance, instance->atm_dev);
1308 if (instance->driver->unbind)
1309 instance->driver->unbind(instance, intf);
1311 instance->driver_data = NULL;
1313 for (i = 0; i < num_rcv_urbs + num_snd_urbs; i++) {
1314 kfree(instance->urbs[i]->transfer_buffer);
1315 usb_free_urb(instance->urbs[i]);
1318 kfree(instance->cell_buf);
1321 if (instance->atm_dev)
1322 atm_dev_deregister(instance->atm_dev);
1324 usbatm_put_instance(instance); /* taken in usbatm_usb_probe */
1326 EXPORT_SYMBOL_GPL(usbatm_usb_disconnect);
1333 static int __init usbatm_usb_init(void)
1335 dbg("%s: driver version %s", __func__, DRIVER_VERSION);
1337 if (sizeof(struct usbatm_control) > sizeof(((struct sk_buff *) 0)->cb)) {
1338 printk(KERN_ERR "%s unusable with this kernel!\n", usbatm_driver_name);
1342 if ((num_rcv_urbs > UDSL_MAX_RCV_URBS)
1343 || (num_snd_urbs > UDSL_MAX_SND_URBS)
1344 || (rcv_buf_bytes < 1)
1345 || (rcv_buf_bytes > UDSL_MAX_BUF_SIZE)
1346 || (snd_buf_bytes < 1)
1347 || (snd_buf_bytes > UDSL_MAX_BUF_SIZE))
1352 module_init(usbatm_usb_init);
1354 static void __exit usbatm_usb_exit(void)
1356 dbg("%s", __func__);
1358 module_exit(usbatm_usb_exit);
1360 MODULE_AUTHOR(DRIVER_AUTHOR);
1361 MODULE_DESCRIPTION(DRIVER_DESC);
1362 MODULE_LICENSE("GPL");
1363 MODULE_VERSION(DRIVER_VERSION);
1369 #ifdef VERBOSE_DEBUG
1370 static int usbatm_print_packet(const unsigned char *data, int len)
1372 unsigned char buffer[256];
1375 for (i = 0; i < len;) {
1377 sprintf(buffer, "%.3d :", i);
1378 for (j = 0; (j < 16) && (i < len); j++, i++) {
1379 sprintf(buffer, "%s %2.2x", buffer, data[i]);