blob: d01a28593ce27e7222b34dcbc74619690a68ba72 [file] [log] [blame]
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -07001/*****************************************************************************
2*
3* Filename: ksdazzle.c
Alex Villacís Lasso630e4992007-10-08 01:07:28 -07004* Version: 0.1.2
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -07005* Description: Irda KingSun Dazzle USB Dongle
6* Status: Experimental
7* Author: Alex Villacís Lasso <a_villacis@palosanto.com>
8*
9* Based on stir4200, mcs7780, kingsun-sir drivers.
10*
11* This program is free software; you can redistribute it and/or modify
12* it under the terms of the GNU General Public License as published by
13* the Free Software Foundation; either version 2 of the License.
14*
15* This program is distributed in the hope that it will be useful,
16* but WITHOUT ANY WARRANTY; without even the implied warranty of
17* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18* GNU General Public License for more details.
19*
20* You should have received a copy of the GNU General Public License
21* along with this program; if not, write to the Free Software
22* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23*
24*****************************************************************************/
25
26/*
27 * Following is my most current (2007-07-26) understanding of how the Kingsun
28 * 07D0:4100 dongle (sometimes known as the MA-660) is supposed to work. This
29 * information was deduced by examining the USB traffic captured with USBSnoopy
30 * from the WinXP driver. Feel free to update here as more of the dongle is
31 * known.
32 *
33 * General: This dongle exposes one interface with two interrupt endpoints, one
34 * IN and one OUT. In this regard, it is similar to what the Kingsun/Donshine
35 * dongle (07c0:4200) exposes. Traffic is raw and needs to be wrapped and
36 * unwrapped manually as in stir4200, kingsun-sir, and ks959-sir.
37 *
38 * Transmission: To transmit an IrDA frame, it is necessary to wrap it, then
39 * split it into multiple segments of up to 7 bytes each, and transmit each in
40 * sequence. It seems that sending a single big block (like kingsun-sir does)
41 * won't work with this dongle. Each segment needs to be prefixed with a value
42 * equal to (unsigned char)0xF8 + <number of bytes in segment>, inside a payload
43 * of exactly 8 bytes. For example, a segment of 1 byte gets prefixed by 0xF9,
44 * and one of 7 bytes gets prefixed by 0xFF. The bytes at the end of the
45 * payload, not considered by the prefix, are ignored (set to 0 by this
46 * implementation).
47 *
48 * Reception: To receive data, the driver must poll the dongle regularly (like
49 * kingsun-sir.c) with interrupt URBs. If data is available, it will be returned
50 * in payloads from 0 to 8 bytes long. When concatenated, these payloads form
51 * a raw IrDA stream that needs to be unwrapped as in stir4200 and kingsun-sir
52 *
53 * Speed change: To change the speed of the dongle, the driver prepares a
54 * control URB with the following as a setup packet:
55 * bRequestType USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE
56 * bRequest 0x09
57 * wValue 0x0200
58 * wIndex 0x0001
59 * wLength 0x0008 (length of the payload)
60 * The payload is a 8-byte record, apparently identical to the one used in
61 * drivers/usb/serial/cypress_m8.c to change speed:
62 * __u32 baudSpeed;
63 * unsigned int dataBits : 2; // 0 - 5 bits 3 - 8 bits
64 * unsigned int : 1;
65 * unsigned int stopBits : 1;
66 * unsigned int parityEnable : 1;
67 * unsigned int parityType : 1;
68 * unsigned int : 1;
69 * unsigned int reset : 1;
70 * unsigned char reserved[3]; // set to 0
71 *
72 * For now only SIR speeds have been observed with this dongle. Therefore,
73 * nothing is known on what changes (if any) must be done to frame wrapping /
74 * unwrapping for higher than SIR speeds. This driver assumes no change is
75 * necessary and announces support for all the way to 115200 bps.
76 */
77
78#include <linux/module.h>
79#include <linux/moduleparam.h>
80#include <linux/kernel.h>
81#include <linux/types.h>
82#include <linux/errno.h>
83#include <linux/init.h>
84#include <linux/slab.h>
85#include <linux/module.h>
86#include <linux/kref.h>
87#include <linux/usb.h>
88#include <linux/device.h>
89#include <linux/crc32.h>
90
91#include <asm/unaligned.h>
92#include <asm/byteorder.h>
93#include <asm/uaccess.h>
94
95#include <net/irda/irda.h>
96#include <net/irda/wrapper.h>
97#include <net/irda/crc.h>
98
99#define KSDAZZLE_VENDOR_ID 0x07d0
100#define KSDAZZLE_PRODUCT_ID 0x4100
101
102/* These are the currently known USB ids */
103static struct usb_device_id dongles[] = {
104 /* KingSun Co,Ltd IrDA/USB Bridge */
105 {USB_DEVICE(KSDAZZLE_VENDOR_ID, KSDAZZLE_PRODUCT_ID)},
106 {}
107};
108
109MODULE_DEVICE_TABLE(usb, dongles);
110
111#define KINGSUN_MTT 0x07
112#define KINGSUN_REQ_RECV 0x01
113#define KINGSUN_REQ_SEND 0x09
114
115#define KINGSUN_SND_FIFO_SIZE 2048 /* Max packet we can send */
Alex Villacís Lasso630e4992007-10-08 01:07:28 -0700116#define KINGSUN_RCV_MAX 2048 /* Max transfer we can receive */
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -0700117
118struct ksdazzle_speedparams {
119 __le32 baudrate; /* baud rate, little endian */
120 __u8 flags;
121 __u8 reserved[3];
122} __attribute__ ((packed));
123
124#define KS_DATA_5_BITS 0x00
125#define KS_DATA_6_BITS 0x01
126#define KS_DATA_7_BITS 0x02
127#define KS_DATA_8_BITS 0x03
128
129#define KS_STOP_BITS_1 0x00
130#define KS_STOP_BITS_2 0x08
131
132#define KS_PAR_DISABLE 0x00
133#define KS_PAR_EVEN 0x10
134#define KS_PAR_ODD 0x30
135#define KS_RESET 0x80
136
137#define KINGSUN_EP_IN 0
138#define KINGSUN_EP_OUT 1
139
140struct ksdazzle_cb {
141 struct usb_device *usbdev; /* init: probe_irda */
142 struct net_device *netdev; /* network layer */
143 struct irlap_cb *irlap; /* The link layer we are binded to */
144 struct net_device_stats stats; /* network statistics */
145 struct qos_info qos;
146
147 struct urb *tx_urb;
148 __u8 *tx_buf_clear;
149 unsigned int tx_buf_clear_used;
150 unsigned int tx_buf_clear_sent;
151 __u8 tx_payload[8];
152
153 struct urb *rx_urb;
Alex Villacís Lasso630e4992007-10-08 01:07:28 -0700154 __u8 *rx_buf;
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -0700155 iobuff_t rx_unwrap_buff;
156
157 struct usb_ctrlrequest *speed_setuprequest;
158 struct urb *speed_urb;
159 struct ksdazzle_speedparams speedparams;
160 unsigned int new_speed;
161
162 __u8 ep_in;
163 __u8 ep_out;
164
165 spinlock_t lock;
166 int receiving;
167};
168
169/* Callback transmission routine */
170static void ksdazzle_speed_irq(struct urb *urb)
171{
172 /* unlink, shutdown, unplug, other nasties */
173 if (urb->status != 0) {
174 err("ksdazzle_speed_irq: urb asynchronously failed - %d",
175 urb->status);
176 }
177}
178
179/* Send a control request to change speed of the dongle */
180static int ksdazzle_change_speed(struct ksdazzle_cb *kingsun, unsigned speed)
181{
182 static unsigned int supported_speeds[] = { 2400, 9600, 19200, 38400,
183 57600, 115200, 576000, 1152000, 4000000, 0
184 };
185 int err;
186 unsigned int i;
187
188 if (kingsun->speed_setuprequest == NULL || kingsun->speed_urb == NULL)
189 return -ENOMEM;
190
191 /* Check that requested speed is among the supported ones */
192 for (i = 0; supported_speeds[i] && supported_speeds[i] != speed; i++) ;
193 if (supported_speeds[i] == 0)
194 return -EOPNOTSUPP;
195
196 memset(&(kingsun->speedparams), 0, sizeof(struct ksdazzle_speedparams));
197 kingsun->speedparams.baudrate = cpu_to_le32(speed);
198 kingsun->speedparams.flags = KS_DATA_8_BITS;
199
200 /* speed_setuprequest pre-filled in ksdazzle_probe */
201 usb_fill_control_urb(kingsun->speed_urb, kingsun->usbdev,
202 usb_sndctrlpipe(kingsun->usbdev, 0),
203 (unsigned char *)kingsun->speed_setuprequest,
204 &(kingsun->speedparams),
205 sizeof(struct ksdazzle_speedparams),
206 ksdazzle_speed_irq, kingsun);
207 kingsun->speed_urb->status = 0;
208 err = usb_submit_urb(kingsun->speed_urb, GFP_ATOMIC);
209
210 return err;
211}
212
213/* Submit one fragment of an IrDA frame to the dongle */
214static void ksdazzle_send_irq(struct urb *urb);
215static int ksdazzle_submit_tx_fragment(struct ksdazzle_cb *kingsun)
216{
217 unsigned int wraplen;
218 int ret;
219
220 /* We can send at most 7 bytes of payload at a time */
221 wraplen = 7;
222 if (wraplen > kingsun->tx_buf_clear_used)
223 wraplen = kingsun->tx_buf_clear_used;
224
225 /* Prepare payload prefix with used length */
226 memset(kingsun->tx_payload, 0, 8);
227 kingsun->tx_payload[0] = (unsigned char)0xf8 + wraplen;
228 memcpy(kingsun->tx_payload + 1, kingsun->tx_buf_clear, wraplen);
229
230 usb_fill_int_urb(kingsun->tx_urb, kingsun->usbdev,
231 usb_sndintpipe(kingsun->usbdev, kingsun->ep_out),
232 kingsun->tx_payload, 8, ksdazzle_send_irq, kingsun, 1);
233 kingsun->tx_urb->status = 0;
234 ret = usb_submit_urb(kingsun->tx_urb, GFP_ATOMIC);
235
236 /* Remember how much data was sent, in order to update at callback */
237 kingsun->tx_buf_clear_sent = (ret == 0) ? wraplen : 0;
238 return ret;
239}
240
241/* Callback transmission routine */
242static void ksdazzle_send_irq(struct urb *urb)
243{
244 struct ksdazzle_cb *kingsun = urb->context;
245 struct net_device *netdev = kingsun->netdev;
246 int ret = 0;
247
248 /* in process of stopping, just drop data */
249 if (!netif_running(kingsun->netdev)) {
250 err("ksdazzle_send_irq: Network not running!");
251 return;
252 }
253
254 /* unlink, shutdown, unplug, other nasties */
255 if (urb->status != 0) {
256 err("ksdazzle_send_irq: urb asynchronously failed - %d",
257 urb->status);
258 return;
259 }
260
261 if (kingsun->tx_buf_clear_used > 0) {
262 /* Update data remaining to be sent */
263 if (kingsun->tx_buf_clear_sent < kingsun->tx_buf_clear_used) {
264 memmove(kingsun->tx_buf_clear,
265 kingsun->tx_buf_clear +
266 kingsun->tx_buf_clear_sent,
267 kingsun->tx_buf_clear_used -
268 kingsun->tx_buf_clear_sent);
269 }
270 kingsun->tx_buf_clear_used -= kingsun->tx_buf_clear_sent;
271 kingsun->tx_buf_clear_sent = 0;
272
273 if (kingsun->tx_buf_clear_used > 0) {
274 /* There is more data to be sent */
275 if ((ret = ksdazzle_submit_tx_fragment(kingsun)) != 0) {
276 err("ksdazzle_send_irq: failed tx_urb submit: %d", ret);
277 switch (ret) {
278 case -ENODEV:
279 case -EPIPE:
280 break;
281 default:
282 kingsun->stats.tx_errors++;
283 netif_start_queue(netdev);
284 }
285 }
286 } else {
287 /* All data sent, send next speed && wake network queue */
288 if (kingsun->new_speed != -1 &&
289 cpu_to_le32(kingsun->new_speed) !=
290 kingsun->speedparams.baudrate)
291 ksdazzle_change_speed(kingsun,
292 kingsun->new_speed);
293
294 netif_wake_queue(netdev);
295 }
296 }
297}
298
299/*
300 * Called from net/core when new frame is available.
301 */
302static int ksdazzle_hard_xmit(struct sk_buff *skb, struct net_device *netdev)
303{
304 struct ksdazzle_cb *kingsun;
305 unsigned int wraplen;
306 int ret = 0;
307
308 if (skb == NULL || netdev == NULL)
309 return -EINVAL;
310
311 netif_stop_queue(netdev);
312
313 /* the IRDA wrapping routines don't deal with non linear skb */
314 SKB_LINEAR_ASSERT(skb);
315
316 kingsun = netdev_priv(netdev);
317
318 spin_lock(&kingsun->lock);
319 kingsun->new_speed = irda_get_next_speed(skb);
320
321 /* Append data to the end of whatever data remains to be transmitted */
322 wraplen =
323 async_wrap_skb(skb, kingsun->tx_buf_clear, KINGSUN_SND_FIFO_SIZE);
324 kingsun->tx_buf_clear_used = wraplen;
325
326 if ((ret = ksdazzle_submit_tx_fragment(kingsun)) != 0) {
327 err("ksdazzle_hard_xmit: failed tx_urb submit: %d", ret);
328 switch (ret) {
329 case -ENODEV:
330 case -EPIPE:
331 break;
332 default:
333 kingsun->stats.tx_errors++;
334 netif_start_queue(netdev);
335 }
336 } else {
337 kingsun->stats.tx_packets++;
338 kingsun->stats.tx_bytes += skb->len;
339
340 }
341
342 dev_kfree_skb(skb);
343 spin_unlock(&kingsun->lock);
344
345 return ret;
346}
347
348/* Receive callback function */
349static void ksdazzle_rcv_irq(struct urb *urb)
350{
351 struct ksdazzle_cb *kingsun = urb->context;
352
353 /* in process of stopping, just drop data */
354 if (!netif_running(kingsun->netdev)) {
355 kingsun->receiving = 0;
356 return;
357 }
358
359 /* unlink, shutdown, unplug, other nasties */
360 if (urb->status != 0) {
361 err("ksdazzle_rcv_irq: urb asynchronously failed - %d",
362 urb->status);
363 kingsun->receiving = 0;
364 return;
365 }
366
367 if (urb->actual_length > 0) {
368 __u8 *bytes = urb->transfer_buffer;
369 unsigned int i;
370
371 for (i = 0; i < urb->actual_length; i++) {
372 async_unwrap_char(kingsun->netdev, &kingsun->stats,
373 &kingsun->rx_unwrap_buff, bytes[i]);
374 }
375 kingsun->netdev->last_rx = jiffies;
376 kingsun->receiving =
377 (kingsun->rx_unwrap_buff.state != OUTSIDE_FRAME) ? 1 : 0;
378 }
379
380 /* This urb has already been filled in ksdazzle_net_open. It is assumed that
381 urb keeps the pointer to the payload buffer.
382 */
383 urb->status = 0;
384 usb_submit_urb(urb, GFP_ATOMIC);
385}
386
387/*
388 * Function ksdazzle_net_open (dev)
389 *
390 * Network device is taken up. Usually this is done by "ifconfig irda0 up"
391 */
392static int ksdazzle_net_open(struct net_device *netdev)
393{
394 struct ksdazzle_cb *kingsun = netdev_priv(netdev);
395 int err = -ENOMEM;
396 char hwname[16];
397
398 /* At this point, urbs are NULL, and skb is NULL (see ksdazzle_probe) */
399 kingsun->receiving = 0;
400
401 /* Initialize for SIR to copy data directly into skb. */
402 kingsun->rx_unwrap_buff.in_frame = FALSE;
403 kingsun->rx_unwrap_buff.state = OUTSIDE_FRAME;
404 kingsun->rx_unwrap_buff.truesize = IRDA_SKB_MAX_MTU;
405 kingsun->rx_unwrap_buff.skb = dev_alloc_skb(IRDA_SKB_MAX_MTU);
406 if (!kingsun->rx_unwrap_buff.skb)
407 goto free_mem;
408
409 skb_reserve(kingsun->rx_unwrap_buff.skb, 1);
410 kingsun->rx_unwrap_buff.head = kingsun->rx_unwrap_buff.skb->data;
411
412 kingsun->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
413 if (!kingsun->rx_urb)
414 goto free_mem;
415
416 kingsun->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
417 if (!kingsun->tx_urb)
418 goto free_mem;
419
420 kingsun->speed_urb = usb_alloc_urb(0, GFP_KERNEL);
421 if (!kingsun->speed_urb)
422 goto free_mem;
423
424 /* Initialize speed for dongle */
425 kingsun->new_speed = 9600;
426 err = ksdazzle_change_speed(kingsun, 9600);
427 if (err < 0)
428 goto free_mem;
429
430 /*
431 * Now that everything should be initialized properly,
432 * Open new IrLAP layer instance to take care of us...
433 */
434 sprintf(hwname, "usb#%d", kingsun->usbdev->devnum);
435 kingsun->irlap = irlap_open(netdev, &kingsun->qos, hwname);
436 if (!kingsun->irlap) {
437 err("ksdazzle-sir: irlap_open failed");
438 goto free_mem;
439 }
440
441 /* Start reception. */
442 usb_fill_int_urb(kingsun->rx_urb, kingsun->usbdev,
443 usb_rcvintpipe(kingsun->usbdev, kingsun->ep_in),
Alex Villacís Lasso630e4992007-10-08 01:07:28 -0700444 kingsun->rx_buf, KINGSUN_RCV_MAX, ksdazzle_rcv_irq,
445 kingsun, 1);
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -0700446 kingsun->rx_urb->status = 0;
447 err = usb_submit_urb(kingsun->rx_urb, GFP_KERNEL);
448 if (err) {
449 err("ksdazzle-sir: first urb-submit failed: %d", err);
450 goto close_irlap;
451 }
452
453 netif_start_queue(netdev);
454
455 /* Situation at this point:
456 - all work buffers allocated
457 - urbs allocated and ready to fill
458 - max rx packet known (in max_rx)
459 - unwrap state machine initialized, in state outside of any frame
460 - receive request in progress
461 - IrLAP layer started, about to hand over packets to send
462 */
463
464 return 0;
465
466 close_irlap:
467 irlap_close(kingsun->irlap);
468 free_mem:
469 usb_free_urb(kingsun->speed_urb);
470 kingsun->speed_urb = NULL;
471 usb_free_urb(kingsun->tx_urb);
472 kingsun->tx_urb = NULL;
473 usb_free_urb(kingsun->rx_urb);
474 kingsun->rx_urb = NULL;
475 if (kingsun->rx_unwrap_buff.skb) {
476 kfree_skb(kingsun->rx_unwrap_buff.skb);
477 kingsun->rx_unwrap_buff.skb = NULL;
478 kingsun->rx_unwrap_buff.head = NULL;
479 }
480 return err;
481}
482
483/*
484 * Function ksdazzle_net_close (dev)
485 *
486 * Network device is taken down. Usually this is done by
487 * "ifconfig irda0 down"
488 */
489static int ksdazzle_net_close(struct net_device *netdev)
490{
491 struct ksdazzle_cb *kingsun = netdev_priv(netdev);
492
493 /* Stop transmit processing */
494 netif_stop_queue(netdev);
495
496 /* Mop up receive && transmit urb's */
497 usb_kill_urb(kingsun->tx_urb);
498 usb_free_urb(kingsun->tx_urb);
499 kingsun->tx_urb = NULL;
500
501 usb_kill_urb(kingsun->speed_urb);
502 usb_free_urb(kingsun->speed_urb);
503 kingsun->speed_urb = NULL;
504
505 usb_kill_urb(kingsun->rx_urb);
506 usb_free_urb(kingsun->rx_urb);
507 kingsun->rx_urb = NULL;
508
509 kfree_skb(kingsun->rx_unwrap_buff.skb);
510 kingsun->rx_unwrap_buff.skb = NULL;
511 kingsun->rx_unwrap_buff.head = NULL;
512 kingsun->rx_unwrap_buff.in_frame = FALSE;
513 kingsun->rx_unwrap_buff.state = OUTSIDE_FRAME;
514 kingsun->receiving = 0;
515
516 /* Stop and remove instance of IrLAP */
517 irlap_close(kingsun->irlap);
518
519 kingsun->irlap = NULL;
520
521 return 0;
522}
523
524/*
525 * IOCTLs : Extra out-of-band network commands...
526 */
527static int ksdazzle_net_ioctl(struct net_device *netdev, struct ifreq *rq,
528 int cmd)
529{
530 struct if_irda_req *irq = (struct if_irda_req *)rq;
531 struct ksdazzle_cb *kingsun = netdev_priv(netdev);
532 int ret = 0;
533
534 switch (cmd) {
535 case SIOCSBANDWIDTH: /* Set bandwidth */
536 if (!capable(CAP_NET_ADMIN))
537 return -EPERM;
538
539 /* Check if the device is still there */
540 if (netif_device_present(kingsun->netdev))
541 return ksdazzle_change_speed(kingsun,
542 irq->ifr_baudrate);
543 break;
544
545 case SIOCSMEDIABUSY: /* Set media busy */
546 if (!capable(CAP_NET_ADMIN))
547 return -EPERM;
548
549 /* Check if the IrDA stack is still there */
550 if (netif_running(kingsun->netdev))
551 irda_device_set_media_busy(kingsun->netdev, TRUE);
552 break;
553
554 case SIOCGRECEIVING:
555 /* Only approximately true */
556 irq->ifr_receiving = kingsun->receiving;
557 break;
558
559 default:
560 ret = -EOPNOTSUPP;
561 }
562
563 return ret;
564}
565
566/*
567 * Get device stats (for /proc/net/dev and ifconfig)
568 */
569static struct net_device_stats *ksdazzle_net_get_stats(struct net_device
570 *netdev)
571{
572 struct ksdazzle_cb *kingsun = netdev_priv(netdev);
573 return &kingsun->stats;
574}
575
576/*
577 * This routine is called by the USB subsystem for each new device
578 * in the system. We need to check if the device is ours, and in
579 * this case start handling it.
580 */
581static int ksdazzle_probe(struct usb_interface *intf,
582 const struct usb_device_id *id)
583{
584 struct usb_host_interface *interface;
585 struct usb_endpoint_descriptor *endpoint;
586
587 struct usb_device *dev = interface_to_usbdev(intf);
588 struct ksdazzle_cb *kingsun = NULL;
589 struct net_device *net = NULL;
590 int ret = -ENOMEM;
591 int pipe, maxp_in, maxp_out;
592 __u8 ep_in;
593 __u8 ep_out;
594
595 /* Check that there really are two interrupt endpoints. Check based on the
596 one in drivers/usb/input/usbmouse.c
597 */
598 interface = intf->cur_altsetting;
599 if (interface->desc.bNumEndpoints != 2) {
600 err("ksdazzle: expected 2 endpoints, found %d",
601 interface->desc.bNumEndpoints);
602 return -ENODEV;
603 }
604 endpoint = &interface->endpoint[KINGSUN_EP_IN].desc;
605 if (!usb_endpoint_is_int_in(endpoint)) {
606 err("ksdazzle: endpoint 0 is not interrupt IN");
607 return -ENODEV;
608 }
609
610 ep_in = endpoint->bEndpointAddress;
611 pipe = usb_rcvintpipe(dev, ep_in);
612 maxp_in = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
613 if (maxp_in > 255 || maxp_in <= 1) {
614 err("ksdazzle: endpoint 0 has max packet size %d not in range [2..255]", maxp_in);
615 return -ENODEV;
616 }
617
618 endpoint = &interface->endpoint[KINGSUN_EP_OUT].desc;
619 if (!usb_endpoint_is_int_out(endpoint)) {
620 err("ksdazzle: endpoint 1 is not interrupt OUT");
621 return -ENODEV;
622 }
623
624 ep_out = endpoint->bEndpointAddress;
625 pipe = usb_sndintpipe(dev, ep_out);
626 maxp_out = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
627
628 /* Allocate network device container. */
629 net = alloc_irdadev(sizeof(*kingsun));
630 if (!net)
631 goto err_out1;
632
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -0700633 SET_NETDEV_DEV(net, &intf->dev);
634 kingsun = netdev_priv(net);
635 kingsun->netdev = net;
636 kingsun->usbdev = dev;
637 kingsun->ep_in = ep_in;
638 kingsun->ep_out = ep_out;
639 kingsun->irlap = NULL;
640 kingsun->tx_urb = NULL;
641 kingsun->tx_buf_clear = NULL;
642 kingsun->tx_buf_clear_used = 0;
643 kingsun->tx_buf_clear_sent = 0;
644
645 kingsun->rx_urb = NULL;
Alex Villacís Lasso630e4992007-10-08 01:07:28 -0700646 kingsun->rx_buf = NULL;
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -0700647 kingsun->rx_unwrap_buff.in_frame = FALSE;
648 kingsun->rx_unwrap_buff.state = OUTSIDE_FRAME;
649 kingsun->rx_unwrap_buff.skb = NULL;
650 kingsun->receiving = 0;
651 spin_lock_init(&kingsun->lock);
652
653 kingsun->speed_setuprequest = NULL;
654 kingsun->speed_urb = NULL;
655 kingsun->speedparams.baudrate = 0;
656
Alex Villacís Lasso630e4992007-10-08 01:07:28 -0700657 /* Allocate input buffer */
658 kingsun->rx_buf = kmalloc(KINGSUN_RCV_MAX, GFP_KERNEL);
659 if (!kingsun->rx_buf)
660 goto free_mem;
661
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -0700662 /* Allocate output buffer */
663 kingsun->tx_buf_clear = kmalloc(KINGSUN_SND_FIFO_SIZE, GFP_KERNEL);
664 if (!kingsun->tx_buf_clear)
665 goto free_mem;
666
667 /* Allocate and initialize speed setup packet */
668 kingsun->speed_setuprequest =
669 kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
670 if (!kingsun->speed_setuprequest)
671 goto free_mem;
672 kingsun->speed_setuprequest->bRequestType =
673 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
674 kingsun->speed_setuprequest->bRequest = KINGSUN_REQ_SEND;
675 kingsun->speed_setuprequest->wValue = cpu_to_le16(0x0200);
676 kingsun->speed_setuprequest->wIndex = cpu_to_le16(0x0001);
677 kingsun->speed_setuprequest->wLength =
678 cpu_to_le16(sizeof(struct ksdazzle_speedparams));
679
680 printk(KERN_INFO "KingSun/Dazzle IRDA/USB found at address %d, "
681 "Vendor: %x, Product: %x\n",
682 dev->devnum, le16_to_cpu(dev->descriptor.idVendor),
683 le16_to_cpu(dev->descriptor.idProduct));
684
685 /* Initialize QoS for this device */
686 irda_init_max_qos_capabilies(&kingsun->qos);
687
688 /* Baud rates known to be supported. Please uncomment if devices (other
689 than a SonyEriccson K300 phone) can be shown to support higher speeds
690 with this dongle.
691 */
692 kingsun->qos.baud_rate.bits =
693 IR_2400 | IR_9600 | IR_19200 | IR_38400 | IR_57600 | IR_115200;
694 kingsun->qos.min_turn_time.bits &= KINGSUN_MTT;
695 irda_qos_bits_to_value(&kingsun->qos);
696
697 /* Override the network functions we need to use */
698 net->hard_start_xmit = ksdazzle_hard_xmit;
699 net->open = ksdazzle_net_open;
700 net->stop = ksdazzle_net_close;
701 net->get_stats = ksdazzle_net_get_stats;
702 net->do_ioctl = ksdazzle_net_ioctl;
703
704 ret = register_netdev(net);
705 if (ret != 0)
706 goto free_mem;
707
708 info("IrDA: Registered KingSun/Dazzle device %s", net->name);
709
710 usb_set_intfdata(intf, kingsun);
711
712 /* Situation at this point:
713 - all work buffers allocated
714 - setup requests pre-filled
715 - urbs not allocated, set to NULL
716 - max rx packet known (is KINGSUN_FIFO_SIZE)
717 - unwrap state machine (partially) initialized, but skb == NULL
718 */
719
720 return 0;
721
722 free_mem:
723 kfree(kingsun->speed_setuprequest);
724 kfree(kingsun->tx_buf_clear);
Alex Villacís Lasso630e4992007-10-08 01:07:28 -0700725 kfree(kingsun->rx_buf);
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -0700726 free_netdev(net);
727 err_out1:
728 return ret;
729}
730
731/*
732 * The current device is removed, the USB layer tell us to shut it down...
733 */
734static void ksdazzle_disconnect(struct usb_interface *intf)
735{
736 struct ksdazzle_cb *kingsun = usb_get_intfdata(intf);
737
738 if (!kingsun)
739 return;
740
741 unregister_netdev(kingsun->netdev);
742
743 /* Mop up receive && transmit urb's */
744 usb_kill_urb(kingsun->speed_urb);
745 usb_free_urb(kingsun->speed_urb);
746 kingsun->speed_urb = NULL;
747
748 usb_kill_urb(kingsun->tx_urb);
749 usb_free_urb(kingsun->tx_urb);
750 kingsun->tx_urb = NULL;
751
752 usb_kill_urb(kingsun->rx_urb);
753 usb_free_urb(kingsun->rx_urb);
754 kingsun->rx_urb = NULL;
755
756 kfree(kingsun->speed_setuprequest);
757 kfree(kingsun->tx_buf_clear);
Alex Villacís Lasso630e4992007-10-08 01:07:28 -0700758 kfree(kingsun->rx_buf);
Alex Villacís Lasso4a1d7c22007-08-28 15:57:50 -0700759 free_netdev(kingsun->netdev);
760
761 usb_set_intfdata(intf, NULL);
762}
763
764#ifdef CONFIG_PM
765/* USB suspend, so power off the transmitter/receiver */
766static int ksdazzle_suspend(struct usb_interface *intf, pm_message_t message)
767{
768 struct ksdazzle_cb *kingsun = usb_get_intfdata(intf);
769
770 netif_device_detach(kingsun->netdev);
771 if (kingsun->speed_urb != NULL)
772 usb_kill_urb(kingsun->speed_urb);
773 if (kingsun->tx_urb != NULL)
774 usb_kill_urb(kingsun->tx_urb);
775 if (kingsun->rx_urb != NULL)
776 usb_kill_urb(kingsun->rx_urb);
777 return 0;
778}
779
780/* Coming out of suspend, so reset hardware */
781static int ksdazzle_resume(struct usb_interface *intf)
782{
783 struct ksdazzle_cb *kingsun = usb_get_intfdata(intf);
784
785 if (kingsun->rx_urb != NULL) {
786 /* Setup request already filled in ksdazzle_probe */
787 usb_submit_urb(kingsun->rx_urb, GFP_KERNEL);
788 }
789 netif_device_attach(kingsun->netdev);
790
791 return 0;
792}
793#endif
794
795/*
796 * USB device callbacks
797 */
798static struct usb_driver irda_driver = {
799 .name = "ksdazzle-sir",
800 .probe = ksdazzle_probe,
801 .disconnect = ksdazzle_disconnect,
802 .id_table = dongles,
803#ifdef CONFIG_PM
804 .suspend = ksdazzle_suspend,
805 .resume = ksdazzle_resume,
806#endif
807};
808
809/*
810 * Module insertion
811 */
812static int __init ksdazzle_init(void)
813{
814 return usb_register(&irda_driver);
815}
816
817module_init(ksdazzle_init);
818
819/*
820 * Module removal
821 */
822static void __exit ksdazzle_cleanup(void)
823{
824 /* Deregister the driver and remove all pending instances */
825 usb_deregister(&irda_driver);
826}
827
828module_exit(ksdazzle_cleanup);
829
830MODULE_AUTHOR("Alex Villacís Lasso <a_villacis@palosanto.com>");
831MODULE_DESCRIPTION("IrDA-USB Dongle Driver for KingSun Dazzle");
832MODULE_LICENSE("GPL");