2 * Driver for ST5481 USB ISDN modem
5 * Copyright 2001 by Frode Isaksen <fisaksen@bewan.com>
6 * 2001 by Kai Germaschewski <kai.germaschewski@gmx.de>
8 * This software may be used and distributed according to the terms
9 * of the GNU General Public License, incorporated herein by reference.
13 #include <linux/init.h>
14 #include <linux/usb.h>
15 #include <linux/slab.h>
18 /* ======================================================================
23 * Send the next endpoint 0 request stored in the FIFO.
24 * Called either by the completion or by usb_ctrl_msg.
26 static void usb_next_ctrl_msg(struct urb *urb,
27 struct st5481_adapter *adapter)
29 struct st5481_ctrl *ctrl = &adapter->ctrl;
32 if (test_and_set_bit(0, &ctrl->busy)) {
36 if ((r_index = fifo_remove(&ctrl->msg_fifo.f)) < 0) {
37 test_and_clear_bit(0,&ctrl->busy);
41 (unsigned char *)&ctrl->msg_fifo.data[r_index];
43 DBG(1,"request=0x%02x,value=0x%04x,index=%x",
44 ((struct ctrl_msg *)urb->setup_packet)->dr.bRequest,
45 ((struct ctrl_msg *)urb->setup_packet)->dr.wValue,
46 ((struct ctrl_msg *)urb->setup_packet)->dr.wIndex);
49 urb->dev = adapter->usb_dev;
51 SUBMIT_URB(urb, GFP_ATOMIC);
55 * Asynchronous endpoint 0 request (async version of usb_control_msg).
56 * The request will be queued up in a FIFO if the endpoint is busy.
58 void usb_ctrl_msg(struct st5481_adapter *adapter,
59 u8 request, u8 requesttype, u16 value, u16 index,
60 ctrl_complete_t complete, void *context)
62 struct st5481_ctrl *ctrl = &adapter->ctrl;
64 struct ctrl_msg *ctrl_msg;
66 if ((w_index = fifo_add(&ctrl->msg_fifo.f)) < 0) {
67 WARN("control msg FIFO full");
70 ctrl_msg = &ctrl->msg_fifo.data[w_index];
72 ctrl_msg->dr.bRequestType = requesttype;
73 ctrl_msg->dr.bRequest = request;
74 ctrl_msg->dr.wValue = cpu_to_le16p(&value);
75 ctrl_msg->dr.wIndex = cpu_to_le16p(&index);
76 ctrl_msg->dr.wLength = 0;
77 ctrl_msg->complete = complete;
78 ctrl_msg->context = context;
80 usb_next_ctrl_msg(ctrl->urb, adapter);
84 * Asynchronous endpoint 0 device request.
86 void st5481_usb_device_ctrl_msg(struct st5481_adapter *adapter,
87 u8 request, u16 value,
88 ctrl_complete_t complete, void *context)
90 usb_ctrl_msg(adapter, request,
91 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
92 value, 0, complete, context);
96 * Asynchronous pipe reset (async version of usb_clear_halt).
98 void st5481_usb_pipe_reset(struct st5481_adapter *adapter,
100 ctrl_complete_t complete, void *context)
102 DBG(1,"pipe=%02x",pipe);
104 usb_ctrl_msg(adapter,
105 USB_REQ_CLEAR_FEATURE, USB_DIR_OUT | USB_RECIP_ENDPOINT,
106 0, pipe, complete, context);
111 Physical level functions
114 void st5481_ph_command(struct st5481_adapter *adapter, unsigned int command)
116 DBG(8,"command=%s", ST5481_CMD_string(command));
118 st5481_usb_device_ctrl_msg(adapter, TXCI, command, NULL, NULL);
122 * The request on endpoint 0 has completed.
123 * Call the user provided completion routine and try
124 * to send the next request.
126 static void usb_ctrl_complete(struct urb *urb, struct pt_regs *regs)
128 struct st5481_adapter *adapter = urb->context;
129 struct st5481_ctrl *ctrl = &adapter->ctrl;
130 struct ctrl_msg *ctrl_msg;
132 if (unlikely(urb->status < 0)) {
133 if (urb->status != -ENOENT && urb->status != -ESHUTDOWN) {
134 WARN("urb status %d",urb->status);
141 ctrl_msg = (struct ctrl_msg *)urb->setup_packet;
143 if (ctrl_msg->dr.bRequest == USB_REQ_CLEAR_FEATURE) {
144 /* Special case handling for pipe reset */
145 le16_to_cpus(&ctrl_msg->dr.wIndex);
147 /* toggle is reset on clear */
148 usb_settoggle(adapter->usb_dev,
149 ctrl_msg->dr.wIndex & ~USB_DIR_IN,
150 (ctrl_msg->dr.wIndex & USB_DIR_IN) == 0,
156 if (ctrl_msg->complete)
157 ctrl_msg->complete(ctrl_msg->context);
159 clear_bit(0, &ctrl->busy);
161 // Try to send next control message
162 usb_next_ctrl_msg(urb, adapter);
166 /* ======================================================================
171 * The interrupt endpoint will be called when any
172 * of the 6 registers changes state (depending on masks).
173 * Decode the register values and schedule a private event.
174 * Called at interrupt.
176 static void usb_int_complete(struct urb *urb, struct pt_regs *regs)
178 u8 *data = urb->transfer_buffer;
180 struct st5481_adapter *adapter = urb->context;
184 switch (urb->status) {
191 /* this urb is terminated, clean up */
192 DBG(1, "urb shutting down with status: %d", urb->status);
195 WARN("nonzero urb status received: %d", urb->status);
200 DBG_PACKET(1, data, INT_PKT_SIZE);
202 if (urb->actual_length == 0) {
206 irqbyte = data[MPINT];
207 if (irqbyte & DEN_INT)
208 FsmEvent(&adapter->d_out.fsm, EV_DOUT_DEN, NULL);
210 if (irqbyte & DCOLL_INT)
211 FsmEvent(&adapter->d_out.fsm, EV_DOUT_COLL, NULL);
213 irqbyte = data[FFINT_D];
214 if (irqbyte & OUT_UNDERRUN)
215 FsmEvent(&adapter->d_out.fsm, EV_DOUT_UNDERRUN, NULL);
217 if (irqbyte & OUT_DOWN)
218 ;// printk("OUT_DOWN\n");
220 irqbyte = data[MPINT];
221 if (irqbyte & RXCI_INT)
222 FsmEvent(&adapter->l1m, data[CCIST] & 0x0f, NULL);
224 for (j = 0; j < 2; j++)
225 adapter->bcs[j].b_out.flow_event |= data[FFINT_B1 + j];
227 urb->actual_length = 0;
230 status = usb_submit_urb (urb, GFP_ATOMIC);
232 WARN("usb_submit_urb failed with result %d", status);
235 /* ======================================================================
239 int st5481_setup_usb(struct st5481_adapter *adapter)
241 struct usb_device *dev = adapter->usb_dev;
242 struct st5481_ctrl *ctrl = &adapter->ctrl;
243 struct st5481_intr *intr = &adapter->intr;
244 struct usb_interface *intf;
245 struct usb_host_interface *altsetting = NULL;
246 struct usb_host_endpoint *endpoint;
253 if ((status = usb_reset_configuration (dev)) < 0) {
254 WARN("reset_configuration failed,status=%d",status);
258 intf = usb_ifnum_to_if(dev, 0);
260 altsetting = usb_altnum_to_altsetting(intf, 3);
264 // Check if the config is sane
265 if ( altsetting->desc.bNumEndpoints != 7 ) {
266 WARN("expecting 7 got %d endpoints!", altsetting->desc.bNumEndpoints);
270 // The descriptor is wrong for some early samples of the ST5481 chip
271 altsetting->endpoint[3].desc.wMaxPacketSize = 32;
272 altsetting->endpoint[4].desc.wMaxPacketSize = 32;
274 // Use alternative setting 3 on interface 0 to have 2B+D
275 if ((status = usb_set_interface (dev, 0, 3)) < 0) {
276 WARN("usb_set_interface failed,status=%d",status);
280 // Allocate URB for control endpoint
281 urb = usb_alloc_urb(0, GFP_KERNEL);
287 // Fill the control URB
288 usb_fill_control_urb (urb, dev,
289 usb_sndctrlpipe(dev, 0),
290 NULL, NULL, 0, usb_ctrl_complete, adapter);
293 fifo_init(&ctrl->msg_fifo.f, ARRAY_SIZE(ctrl->msg_fifo.data));
295 // Allocate URBs and buffers for interrupt endpoint
296 urb = usb_alloc_urb(0, GFP_KERNEL);
302 buf = kmalloc(INT_PKT_SIZE, GFP_KERNEL);
307 endpoint = &altsetting->endpoint[EP_INT-1];
309 // Fill the interrupt URB
310 usb_fill_int_urb(urb, dev,
311 usb_rcvintpipe(dev, endpoint->desc.bEndpointAddress),
313 usb_int_complete, adapter,
314 endpoint->desc.bInterval);
320 * Release buffers and URBs for the interrupt and control
323 void st5481_release_usb(struct st5481_adapter *adapter)
325 struct st5481_intr *intr = &adapter->intr;
326 struct st5481_ctrl *ctrl = &adapter->ctrl;
330 // Stop and free Control and Interrupt URBs
331 usb_unlink_urb(ctrl->urb);
332 if (ctrl->urb->transfer_buffer)
333 kfree(ctrl->urb->transfer_buffer);
334 usb_free_urb(ctrl->urb);
336 usb_unlink_urb(intr->urb);
337 if (intr->urb->transfer_buffer)
338 kfree(intr->urb->transfer_buffer);
339 usb_free_urb(intr->urb);
343 * Initialize the adapter.
345 void st5481_start(struct st5481_adapter *adapter)
347 static const u8 init_cmd_table[]={
361 MPMSK,RXCI_INT+DEN_INT+DCOLL_INT,
364 struct st5481_intr *intr = &adapter->intr;
370 adapter->leds = RED_LED;
372 // Start receiving on the interrupt endpoint
373 SUBMIT_URB(intr->urb, GFP_KERNEL);
375 while ((request = init_cmd_table[i++])) {
376 value = init_cmd_table[i++];
377 st5481_usb_device_ctrl_msg(adapter, request, value, NULL, NULL);
379 st5481_ph_command(adapter, ST5481_CMD_PUP);
383 * Reset the adapter to default values.
385 void st5481_stop(struct st5481_adapter *adapter)
389 st5481_usb_device_ctrl_msg(adapter, SET_DEFAULT, 0, NULL, NULL);
392 /* ======================================================================
393 * isochronous USB helpers
397 fill_isoc_urb(struct urb *urb, struct usb_device *dev,
398 unsigned int pipe, void *buf, int num_packets,
399 int packet_size, usb_complete_t complete,
404 spin_lock_init(&urb->lock);
407 urb->transfer_buffer=buf;
408 urb->number_of_packets = num_packets;
409 urb->transfer_buffer_length=num_packets*packet_size;
410 urb->actual_length = 0;
411 urb->complete=complete;
412 urb->context=context;
413 urb->transfer_flags=URB_ISO_ASAP;
414 for (k = 0; k < num_packets; k++) {
415 urb->iso_frame_desc[k].offset = packet_size * k;
416 urb->iso_frame_desc[k].length = packet_size;
417 urb->iso_frame_desc[k].actual_length = 0;
422 st5481_setup_isocpipes(struct urb* urb[2], struct usb_device *dev,
423 unsigned int pipe, int num_packets,
424 int packet_size, int buf_size,
425 usb_complete_t complete, void *context)
430 for (j = 0; j < 2; j++) {
432 urb[j] = usb_alloc_urb(num_packets, GFP_KERNEL);
436 // Allocate memory for 2000bytes/sec (16Kb/s)
437 buf = kmalloc(buf_size, GFP_KERNEL);
441 // Fill the isochronous URB
442 fill_isoc_urb(urb[j], dev, pipe, buf,
443 num_packets, packet_size, complete,
449 for (j = 0; j < 2; j++) {
451 if (urb[j]->transfer_buffer)
452 kfree(urb[j]->transfer_buffer);
453 usb_free_urb(urb[j]);
459 void st5481_release_isocpipes(struct urb* urb[2])
463 for (j = 0; j < 2; j++) {
464 usb_unlink_urb(urb[j]);
465 if (urb[j]->transfer_buffer)
466 kfree(urb[j]->transfer_buffer);
467 usb_free_urb(urb[j]);
472 * Decode frames received on the B/D channel.
473 * Note that this function will be called continously
474 * with 64Kbit/s / 16Kbit/s of data and hence it will be
475 * called 50 times per second with 20 ISOC descriptors.
476 * Called at interrupt.
478 static void usb_in_complete(struct urb *urb, struct pt_regs *regs)
480 struct st5481_in *in = urb->context;
483 int len, count, status;
485 if (unlikely(urb->status < 0)) {
486 if (urb->status != -ENOENT && urb->status != -ESHUTDOWN) {
487 WARN("urb status %d",urb->status);
494 DBG_ISO_PACKET(0x80,urb);
496 len = st5481_isoc_flatten(urb);
497 ptr = urb->transfer_buffer;
499 if (in->mode == L1_MODE_TRANS) {
500 memcpy(in->rcvbuf, ptr, len);
504 status = isdnhdlc_decode(&in->hdlc_state, ptr, len, &count,
505 in->rcvbuf, in->bufsize);
511 // Good frame received
512 DBG(4,"count=%d",status);
513 DBG_PACKET(0x400, in->rcvbuf, status);
514 if (!(skb = dev_alloc_skb(status))) {
515 WARN("receive out of memory\n");
518 memcpy(skb_put(skb, status), in->rcvbuf, status);
519 in->hisax_if->l1l2(in->hisax_if, PH_DATA | INDICATION, skb);
520 } else if (status == -HDLC_CRC_ERROR) {
522 } else if (status == -HDLC_FRAMING_ERROR) {
523 INFO("framing error");
524 } else if (status == -HDLC_LENGTH_ERROR) {
525 INFO("length error");
529 // Prepare URB for next transfer
530 urb->dev = in->adapter->usb_dev;
531 urb->actual_length = 0;
533 SUBMIT_URB(urb, GFP_ATOMIC);
536 int st5481_setup_in(struct st5481_in *in)
538 struct usb_device *dev = in->adapter->usb_dev;
543 in->rcvbuf = kmalloc(in->bufsize, GFP_KERNEL);
548 retval = st5481_setup_isocpipes(in->urb, dev,
549 usb_rcvisocpipe(dev, in->ep),
550 in->num_packets, in->packet_size,
551 in->num_packets * in->packet_size,
552 usb_in_complete, in);
563 void st5481_release_in(struct st5481_in *in)
567 st5481_release_isocpipes(in->urb);
571 * Make the transfer_buffer contiguous by
572 * copying from the iso descriptors if necessary.
574 int st5481_isoc_flatten(struct urb *urb)
576 struct usb_iso_packet_descriptor *pipd,*pend;
577 unsigned char *src,*dst;
580 if (urb->status < 0) {
583 for (pipd = &urb->iso_frame_desc[0],
584 pend = &urb->iso_frame_desc[urb->number_of_packets],
585 dst = urb->transfer_buffer;
589 if (pipd->status < 0) {
590 return (pipd->status);
593 len = pipd->actual_length;
594 pipd->actual_length = 0;
595 src = urb->transfer_buffer+pipd->offset;
598 // Need to copy since isoc buffers not full
603 // No need to copy, just update destination buffer
607 // Return size of flattened buffer
608 return (dst - (unsigned char *)urb->transfer_buffer);
611 static void st5481_start_rcv(void *context)
613 struct st5481_in *in = context;
614 struct st5481_adapter *adapter = in->adapter;
618 in->urb[0]->dev = adapter->usb_dev;
619 SUBMIT_URB(in->urb[0], GFP_KERNEL);
621 in->urb[1]->dev = adapter->usb_dev;
622 SUBMIT_URB(in->urb[1], GFP_KERNEL);
625 void st5481_in_mode(struct st5481_in *in, int mode)
627 if (in->mode == mode)
632 usb_unlink_urb(in->urb[0]);
633 usb_unlink_urb(in->urb[1]);
635 if (in->mode != L1_MODE_NULL) {
636 if (in->mode != L1_MODE_TRANS)
637 isdnhdlc_rcv_init(&in->hdlc_state,
638 in->mode == L1_MODE_HDLC_56K);
640 st5481_usb_pipe_reset(in->adapter, in->ep, NULL, NULL);
641 st5481_usb_device_ctrl_msg(in->adapter, in->counter,
644 st5481_start_rcv(in);
646 st5481_usb_device_ctrl_msg(in->adapter, in->counter,