1 /*****************************************************************************
2 *
3 * Filename: ksdazzle.c
4 * Version: 0.1.2
5 * 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/kref.h>
86 #include <linux/usb.h>
87 #include <linux/device.h>
88 #include <linux/crc32.h>
89
90 #include <asm/unaligned.h>
91 #include <asm/byteorder.h>
92 #include <asm/uaccess.h>
93
94 #include <net/irda/irda.h>
95 #include <net/irda/wrapper.h>
96 #include <net/irda/crc.h>
97
98 #define KSDAZZLE_VENDOR_ID 0x07d0
99 #define KSDAZZLE_PRODUCT_ID 0x4100
100
101 /* These are the currently known USB ids */
102 static struct usb_device_id dongles[] = {
103 /* KingSun Co,Ltd IrDA/USB Bridge */
104 {USB_DEVICE(KSDAZZLE_VENDOR_ID, KSDAZZLE_PRODUCT_ID)},
105 {}
106 };
107
108 MODULE_DEVICE_TABLE(usb, dongles);
109
110 #define KINGSUN_MTT 0x07
111 #define KINGSUN_REQ_RECV 0x01
112 #define KINGSUN_REQ_SEND 0x09
113
114 #define KINGSUN_SND_FIFO_SIZE 2048 /* Max packet we can send */
115 #define KINGSUN_RCV_MAX 2048 /* Max transfer we can receive */
116
117 struct ksdazzle_speedparams {
118 __le32 baudrate; /* baud rate, little endian */
119 __u8 flags;
120 __u8 reserved[3];
121 } __attribute__ ((packed));
122
123 #define KS_DATA_5_BITS 0x00
124 #define KS_DATA_6_BITS 0x01
125 #define KS_DATA_7_BITS 0x02
126 #define KS_DATA_8_BITS 0x03
127
128 #define KS_STOP_BITS_1 0x00
129 #define KS_STOP_BITS_2 0x08
130
131 #define KS_PAR_DISABLE 0x00
132 #define KS_PAR_EVEN 0x10
133 #define KS_PAR_ODD 0x30
134 #define KS_RESET 0x80
135
136 #define KINGSUN_EP_IN 0
137 #define KINGSUN_EP_OUT 1
138
139 struct ksdazzle_cb {
140 struct usb_device *usbdev; /* init: probe_irda */
141 struct net_device *netdev; /* network layer */
142 struct irlap_cb *irlap; /* The link layer we are binded to */
143
144 struct qos_info qos;
145
146 struct urb *tx_urb;
147 __u8 *tx_buf_clear;
148 unsigned int tx_buf_clear_used;
149 unsigned int tx_buf_clear_sent;
150 __u8 tx_payload[8];
151
152 struct urb *rx_urb;
153 __u8 *rx_buf;
154 iobuff_t rx_unwrap_buff;
155
156 struct usb_ctrlrequest *speed_setuprequest;
157 struct urb *speed_urb;
158 struct ksdazzle_speedparams speedparams;
159 unsigned int new_speed;
160
161 __u8 ep_in;
162 __u8 ep_out;
163
164 spinlock_t lock;
165 int receiving;
166 };
167
168 /* Callback transmission routine */
ksdazzle_speed_irq(struct urb * urb)169 static void ksdazzle_speed_irq(struct urb *urb)
170 {
171 /* unlink, shutdown, unplug, other nasties */
172 if (urb->status != 0) {
173 err("ksdazzle_speed_irq: urb asynchronously failed - %d",
174 urb->status);
175 }
176 }
177
178 /* Send a control request to change speed of the dongle */
ksdazzle_change_speed(struct ksdazzle_cb * kingsun,unsigned speed)179 static int ksdazzle_change_speed(struct ksdazzle_cb *kingsun, unsigned speed)
180 {
181 static unsigned int supported_speeds[] = { 2400, 9600, 19200, 38400,
182 57600, 115200, 576000, 1152000, 4000000, 0
183 };
184 int err;
185 unsigned int i;
186
187 if (kingsun->speed_setuprequest == NULL || kingsun->speed_urb == NULL)
188 return -ENOMEM;
189
190 /* Check that requested speed is among the supported ones */
191 for (i = 0; supported_speeds[i] && supported_speeds[i] != speed; i++) ;
192 if (supported_speeds[i] == 0)
193 return -EOPNOTSUPP;
194
195 memset(&(kingsun->speedparams), 0, sizeof(struct ksdazzle_speedparams));
196 kingsun->speedparams.baudrate = cpu_to_le32(speed);
197 kingsun->speedparams.flags = KS_DATA_8_BITS;
198
199 /* speed_setuprequest pre-filled in ksdazzle_probe */
200 usb_fill_control_urb(kingsun->speed_urb, kingsun->usbdev,
201 usb_sndctrlpipe(kingsun->usbdev, 0),
202 (unsigned char *)kingsun->speed_setuprequest,
203 &(kingsun->speedparams),
204 sizeof(struct ksdazzle_speedparams),
205 ksdazzle_speed_irq, kingsun);
206 kingsun->speed_urb->status = 0;
207 err = usb_submit_urb(kingsun->speed_urb, GFP_ATOMIC);
208
209 return err;
210 }
211
212 /* Submit one fragment of an IrDA frame to the dongle */
213 static void ksdazzle_send_irq(struct urb *urb);
ksdazzle_submit_tx_fragment(struct ksdazzle_cb * kingsun)214 static int ksdazzle_submit_tx_fragment(struct ksdazzle_cb *kingsun)
215 {
216 unsigned int wraplen;
217 int ret;
218
219 /* We can send at most 7 bytes of payload at a time */
220 wraplen = 7;
221 if (wraplen > kingsun->tx_buf_clear_used)
222 wraplen = kingsun->tx_buf_clear_used;
223
224 /* Prepare payload prefix with used length */
225 memset(kingsun->tx_payload, 0, 8);
226 kingsun->tx_payload[0] = (unsigned char)0xf8 + wraplen;
227 memcpy(kingsun->tx_payload + 1, kingsun->tx_buf_clear, wraplen);
228
229 usb_fill_int_urb(kingsun->tx_urb, kingsun->usbdev,
230 usb_sndintpipe(kingsun->usbdev, kingsun->ep_out),
231 kingsun->tx_payload, 8, ksdazzle_send_irq, kingsun, 1);
232 kingsun->tx_urb->status = 0;
233 ret = usb_submit_urb(kingsun->tx_urb, GFP_ATOMIC);
234
235 /* Remember how much data was sent, in order to update at callback */
236 kingsun->tx_buf_clear_sent = (ret == 0) ? wraplen : 0;
237 return ret;
238 }
239
240 /* Callback transmission routine */
ksdazzle_send_irq(struct urb * urb)241 static void ksdazzle_send_irq(struct urb *urb)
242 {
243 struct ksdazzle_cb *kingsun = urb->context;
244 struct net_device *netdev = kingsun->netdev;
245 int ret = 0;
246
247 /* in process of stopping, just drop data */
248 if (!netif_running(kingsun->netdev)) {
249 err("ksdazzle_send_irq: Network not running!");
250 return;
251 }
252
253 /* unlink, shutdown, unplug, other nasties */
254 if (urb->status != 0) {
255 err("ksdazzle_send_irq: urb asynchronously failed - %d",
256 urb->status);
257 return;
258 }
259
260 if (kingsun->tx_buf_clear_used > 0) {
261 /* Update data remaining to be sent */
262 if (kingsun->tx_buf_clear_sent < kingsun->tx_buf_clear_used) {
263 memmove(kingsun->tx_buf_clear,
264 kingsun->tx_buf_clear +
265 kingsun->tx_buf_clear_sent,
266 kingsun->tx_buf_clear_used -
267 kingsun->tx_buf_clear_sent);
268 }
269 kingsun->tx_buf_clear_used -= kingsun->tx_buf_clear_sent;
270 kingsun->tx_buf_clear_sent = 0;
271
272 if (kingsun->tx_buf_clear_used > 0) {
273 /* There is more data to be sent */
274 if ((ret = ksdazzle_submit_tx_fragment(kingsun)) != 0) {
275 err("ksdazzle_send_irq: failed tx_urb submit: %d", ret);
276 switch (ret) {
277 case -ENODEV:
278 case -EPIPE:
279 break;
280 default:
281 netdev->stats.tx_errors++;
282 netif_start_queue(netdev);
283 }
284 }
285 } else {
286 /* All data sent, send next speed && wake network queue */
287 if (kingsun->new_speed != -1 &&
288 cpu_to_le32(kingsun->new_speed) !=
289 kingsun->speedparams.baudrate)
290 ksdazzle_change_speed(kingsun,
291 kingsun->new_speed);
292
293 netif_wake_queue(netdev);
294 }
295 }
296 }
297
298 /*
299 * Called from net/core when new frame is available.
300 */
ksdazzle_hard_xmit(struct sk_buff * skb,struct net_device * netdev)301 static int ksdazzle_hard_xmit(struct sk_buff *skb, struct net_device *netdev)
302 {
303 struct ksdazzle_cb *kingsun;
304 unsigned int wraplen;
305 int ret = 0;
306
307 if (skb == NULL || netdev == NULL)
308 return -EINVAL;
309
310 netif_stop_queue(netdev);
311
312 /* the IRDA wrapping routines don't deal with non linear skb */
313 SKB_LINEAR_ASSERT(skb);
314
315 kingsun = netdev_priv(netdev);
316
317 spin_lock(&kingsun->lock);
318 kingsun->new_speed = irda_get_next_speed(skb);
319
320 /* Append data to the end of whatever data remains to be transmitted */
321 wraplen =
322 async_wrap_skb(skb, kingsun->tx_buf_clear, KINGSUN_SND_FIFO_SIZE);
323 kingsun->tx_buf_clear_used = wraplen;
324
325 if ((ret = ksdazzle_submit_tx_fragment(kingsun)) != 0) {
326 err("ksdazzle_hard_xmit: failed tx_urb submit: %d", ret);
327 switch (ret) {
328 case -ENODEV:
329 case -EPIPE:
330 break;
331 default:
332 netdev->stats.tx_errors++;
333 netif_start_queue(netdev);
334 }
335 } else {
336 netdev->stats.tx_packets++;
337 netdev->stats.tx_bytes += skb->len;
338
339 }
340
341 dev_kfree_skb(skb);
342 spin_unlock(&kingsun->lock);
343
344 return ret;
345 }
346
347 /* Receive callback function */
ksdazzle_rcv_irq(struct urb * urb)348 static void ksdazzle_rcv_irq(struct urb *urb)
349 {
350 struct ksdazzle_cb *kingsun = urb->context;
351 struct net_device *netdev = kingsun->netdev;
352
353 /* in process of stopping, just drop data */
354 if (!netif_running(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(netdev, &netdev->stats,
373 &kingsun->rx_unwrap_buff, bytes[i]);
374 }
375 kingsun->receiving =
376 (kingsun->rx_unwrap_buff.state != OUTSIDE_FRAME) ? 1 : 0;
377 }
378
379 /* This urb has already been filled in ksdazzle_net_open. It is assumed that
380 urb keeps the pointer to the payload buffer.
381 */
382 urb->status = 0;
383 usb_submit_urb(urb, GFP_ATOMIC);
384 }
385
386 /*
387 * Function ksdazzle_net_open (dev)
388 *
389 * Network device is taken up. Usually this is done by "ifconfig irda0 up"
390 */
ksdazzle_net_open(struct net_device * netdev)391 static int ksdazzle_net_open(struct net_device *netdev)
392 {
393 struct ksdazzle_cb *kingsun = netdev_priv(netdev);
394 int err = -ENOMEM;
395 char hwname[16];
396
397 /* At this point, urbs are NULL, and skb is NULL (see ksdazzle_probe) */
398 kingsun->receiving = 0;
399
400 /* Initialize for SIR to copy data directly into skb. */
401 kingsun->rx_unwrap_buff.in_frame = FALSE;
402 kingsun->rx_unwrap_buff.state = OUTSIDE_FRAME;
403 kingsun->rx_unwrap_buff.truesize = IRDA_SKB_MAX_MTU;
404 kingsun->rx_unwrap_buff.skb = dev_alloc_skb(IRDA_SKB_MAX_MTU);
405 if (!kingsun->rx_unwrap_buff.skb)
406 goto free_mem;
407
408 skb_reserve(kingsun->rx_unwrap_buff.skb, 1);
409 kingsun->rx_unwrap_buff.head = kingsun->rx_unwrap_buff.skb->data;
410
411 kingsun->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
412 if (!kingsun->rx_urb)
413 goto free_mem;
414
415 kingsun->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
416 if (!kingsun->tx_urb)
417 goto free_mem;
418
419 kingsun->speed_urb = usb_alloc_urb(0, GFP_KERNEL);
420 if (!kingsun->speed_urb)
421 goto free_mem;
422
423 /* Initialize speed for dongle */
424 kingsun->new_speed = 9600;
425 err = ksdazzle_change_speed(kingsun, 9600);
426 if (err < 0)
427 goto free_mem;
428
429 /*
430 * Now that everything should be initialized properly,
431 * Open new IrLAP layer instance to take care of us...
432 */
433 sprintf(hwname, "usb#%d", kingsun->usbdev->devnum);
434 kingsun->irlap = irlap_open(netdev, &kingsun->qos, hwname);
435 if (!kingsun->irlap) {
436 err("ksdazzle-sir: irlap_open failed");
437 goto free_mem;
438 }
439
440 /* Start reception. */
441 usb_fill_int_urb(kingsun->rx_urb, kingsun->usbdev,
442 usb_rcvintpipe(kingsun->usbdev, kingsun->ep_in),
443 kingsun->rx_buf, KINGSUN_RCV_MAX, ksdazzle_rcv_irq,
444 kingsun, 1);
445 kingsun->rx_urb->status = 0;
446 err = usb_submit_urb(kingsun->rx_urb, GFP_KERNEL);
447 if (err) {
448 err("ksdazzle-sir: first urb-submit failed: %d", err);
449 goto close_irlap;
450 }
451
452 netif_start_queue(netdev);
453
454 /* Situation at this point:
455 - all work buffers allocated
456 - urbs allocated and ready to fill
457 - max rx packet known (in max_rx)
458 - unwrap state machine initialized, in state outside of any frame
459 - receive request in progress
460 - IrLAP layer started, about to hand over packets to send
461 */
462
463 return 0;
464
465 close_irlap:
466 irlap_close(kingsun->irlap);
467 free_mem:
468 usb_free_urb(kingsun->speed_urb);
469 kingsun->speed_urb = NULL;
470 usb_free_urb(kingsun->tx_urb);
471 kingsun->tx_urb = NULL;
472 usb_free_urb(kingsun->rx_urb);
473 kingsun->rx_urb = NULL;
474 if (kingsun->rx_unwrap_buff.skb) {
475 kfree_skb(kingsun->rx_unwrap_buff.skb);
476 kingsun->rx_unwrap_buff.skb = NULL;
477 kingsun->rx_unwrap_buff.head = NULL;
478 }
479 return err;
480 }
481
482 /*
483 * Function ksdazzle_net_close (dev)
484 *
485 * Network device is taken down. Usually this is done by
486 * "ifconfig irda0 down"
487 */
ksdazzle_net_close(struct net_device * netdev)488 static int ksdazzle_net_close(struct net_device *netdev)
489 {
490 struct ksdazzle_cb *kingsun = netdev_priv(netdev);
491
492 /* Stop transmit processing */
493 netif_stop_queue(netdev);
494
495 /* Mop up receive && transmit urb's */
496 usb_kill_urb(kingsun->tx_urb);
497 usb_free_urb(kingsun->tx_urb);
498 kingsun->tx_urb = NULL;
499
500 usb_kill_urb(kingsun->speed_urb);
501 usb_free_urb(kingsun->speed_urb);
502 kingsun->speed_urb = NULL;
503
504 usb_kill_urb(kingsun->rx_urb);
505 usb_free_urb(kingsun->rx_urb);
506 kingsun->rx_urb = NULL;
507
508 kfree_skb(kingsun->rx_unwrap_buff.skb);
509 kingsun->rx_unwrap_buff.skb = NULL;
510 kingsun->rx_unwrap_buff.head = NULL;
511 kingsun->rx_unwrap_buff.in_frame = FALSE;
512 kingsun->rx_unwrap_buff.state = OUTSIDE_FRAME;
513 kingsun->receiving = 0;
514
515 /* Stop and remove instance of IrLAP */
516 irlap_close(kingsun->irlap);
517
518 kingsun->irlap = NULL;
519
520 return 0;
521 }
522
523 /*
524 * IOCTLs : Extra out-of-band network commands...
525 */
ksdazzle_net_ioctl(struct net_device * netdev,struct ifreq * rq,int cmd)526 static int ksdazzle_net_ioctl(struct net_device *netdev, struct ifreq *rq,
527 int cmd)
528 {
529 struct if_irda_req *irq = (struct if_irda_req *)rq;
530 struct ksdazzle_cb *kingsun = netdev_priv(netdev);
531 int ret = 0;
532
533 switch (cmd) {
534 case SIOCSBANDWIDTH: /* Set bandwidth */
535 if (!capable(CAP_NET_ADMIN))
536 return -EPERM;
537
538 /* Check if the device is still there */
539 if (netif_device_present(kingsun->netdev))
540 return ksdazzle_change_speed(kingsun,
541 irq->ifr_baudrate);
542 break;
543
544 case SIOCSMEDIABUSY: /* Set media busy */
545 if (!capable(CAP_NET_ADMIN))
546 return -EPERM;
547
548 /* Check if the IrDA stack is still there */
549 if (netif_running(kingsun->netdev))
550 irda_device_set_media_busy(kingsun->netdev, TRUE);
551 break;
552
553 case SIOCGRECEIVING:
554 /* Only approximately true */
555 irq->ifr_receiving = kingsun->receiving;
556 break;
557
558 default:
559 ret = -EOPNOTSUPP;
560 }
561
562 return ret;
563 }
564
565 /*
566 * This routine is called by the USB subsystem for each new device
567 * in the system. We need to check if the device is ours, and in
568 * this case start handling it.
569 */
ksdazzle_probe(struct usb_interface * intf,const struct usb_device_id * id)570 static int ksdazzle_probe(struct usb_interface *intf,
571 const struct usb_device_id *id)
572 {
573 struct usb_host_interface *interface;
574 struct usb_endpoint_descriptor *endpoint;
575
576 struct usb_device *dev = interface_to_usbdev(intf);
577 struct ksdazzle_cb *kingsun = NULL;
578 struct net_device *net = NULL;
579 int ret = -ENOMEM;
580 int pipe, maxp_in, maxp_out;
581 __u8 ep_in;
582 __u8 ep_out;
583
584 /* Check that there really are two interrupt endpoints. Check based on the
585 one in drivers/usb/input/usbmouse.c
586 */
587 interface = intf->cur_altsetting;
588 if (interface->desc.bNumEndpoints != 2) {
589 err("ksdazzle: expected 2 endpoints, found %d",
590 interface->desc.bNumEndpoints);
591 return -ENODEV;
592 }
593 endpoint = &interface->endpoint[KINGSUN_EP_IN].desc;
594 if (!usb_endpoint_is_int_in(endpoint)) {
595 err("ksdazzle: endpoint 0 is not interrupt IN");
596 return -ENODEV;
597 }
598
599 ep_in = endpoint->bEndpointAddress;
600 pipe = usb_rcvintpipe(dev, ep_in);
601 maxp_in = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
602 if (maxp_in > 255 || maxp_in <= 1) {
603 err("ksdazzle: endpoint 0 has max packet size %d not in range [2..255]", maxp_in);
604 return -ENODEV;
605 }
606
607 endpoint = &interface->endpoint[KINGSUN_EP_OUT].desc;
608 if (!usb_endpoint_is_int_out(endpoint)) {
609 err("ksdazzle: endpoint 1 is not interrupt OUT");
610 return -ENODEV;
611 }
612
613 ep_out = endpoint->bEndpointAddress;
614 pipe = usb_sndintpipe(dev, ep_out);
615 maxp_out = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
616
617 /* Allocate network device container. */
618 net = alloc_irdadev(sizeof(*kingsun));
619 if (!net)
620 goto err_out1;
621
622 SET_NETDEV_DEV(net, &intf->dev);
623 kingsun = netdev_priv(net);
624 kingsun->netdev = net;
625 kingsun->usbdev = dev;
626 kingsun->ep_in = ep_in;
627 kingsun->ep_out = ep_out;
628 kingsun->irlap = NULL;
629 kingsun->tx_urb = NULL;
630 kingsun->tx_buf_clear = NULL;
631 kingsun->tx_buf_clear_used = 0;
632 kingsun->tx_buf_clear_sent = 0;
633
634 kingsun->rx_urb = NULL;
635 kingsun->rx_buf = NULL;
636 kingsun->rx_unwrap_buff.in_frame = FALSE;
637 kingsun->rx_unwrap_buff.state = OUTSIDE_FRAME;
638 kingsun->rx_unwrap_buff.skb = NULL;
639 kingsun->receiving = 0;
640 spin_lock_init(&kingsun->lock);
641
642 kingsun->speed_setuprequest = NULL;
643 kingsun->speed_urb = NULL;
644 kingsun->speedparams.baudrate = 0;
645
646 /* Allocate input buffer */
647 kingsun->rx_buf = kmalloc(KINGSUN_RCV_MAX, GFP_KERNEL);
648 if (!kingsun->rx_buf)
649 goto free_mem;
650
651 /* Allocate output buffer */
652 kingsun->tx_buf_clear = kmalloc(KINGSUN_SND_FIFO_SIZE, GFP_KERNEL);
653 if (!kingsun->tx_buf_clear)
654 goto free_mem;
655
656 /* Allocate and initialize speed setup packet */
657 kingsun->speed_setuprequest =
658 kmalloc(sizeof(struct usb_ctrlrequest), GFP_KERNEL);
659 if (!kingsun->speed_setuprequest)
660 goto free_mem;
661 kingsun->speed_setuprequest->bRequestType =
662 USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
663 kingsun->speed_setuprequest->bRequest = KINGSUN_REQ_SEND;
664 kingsun->speed_setuprequest->wValue = cpu_to_le16(0x0200);
665 kingsun->speed_setuprequest->wIndex = cpu_to_le16(0x0001);
666 kingsun->speed_setuprequest->wLength =
667 cpu_to_le16(sizeof(struct ksdazzle_speedparams));
668
669 printk(KERN_INFO "KingSun/Dazzle IRDA/USB found at address %d, "
670 "Vendor: %x, Product: %x\n",
671 dev->devnum, le16_to_cpu(dev->descriptor.idVendor),
672 le16_to_cpu(dev->descriptor.idProduct));
673
674 /* Initialize QoS for this device */
675 irda_init_max_qos_capabilies(&kingsun->qos);
676
677 /* Baud rates known to be supported. Please uncomment if devices (other
678 than a SonyEriccson K300 phone) can be shown to support higher speeds
679 with this dongle.
680 */
681 kingsun->qos.baud_rate.bits =
682 IR_2400 | IR_9600 | IR_19200 | IR_38400 | IR_57600 | IR_115200;
683 kingsun->qos.min_turn_time.bits &= KINGSUN_MTT;
684 irda_qos_bits_to_value(&kingsun->qos);
685
686 /* Override the network functions we need to use */
687 net->hard_start_xmit = ksdazzle_hard_xmit;
688 net->open = ksdazzle_net_open;
689 net->stop = ksdazzle_net_close;
690 net->do_ioctl = ksdazzle_net_ioctl;
691
692 ret = register_netdev(net);
693 if (ret != 0)
694 goto free_mem;
695
696 dev_info(&net->dev, "IrDA: Registered KingSun/Dazzle device %s\n",
697 net->name);
698
699 usb_set_intfdata(intf, kingsun);
700
701 /* Situation at this point:
702 - all work buffers allocated
703 - setup requests pre-filled
704 - urbs not allocated, set to NULL
705 - max rx packet known (is KINGSUN_FIFO_SIZE)
706 - unwrap state machine (partially) initialized, but skb == NULL
707 */
708
709 return 0;
710
711 free_mem:
712 kfree(kingsun->speed_setuprequest);
713 kfree(kingsun->tx_buf_clear);
714 kfree(kingsun->rx_buf);
715 free_netdev(net);
716 err_out1:
717 return ret;
718 }
719
720 /*
721 * The current device is removed, the USB layer tell us to shut it down...
722 */
ksdazzle_disconnect(struct usb_interface * intf)723 static void ksdazzle_disconnect(struct usb_interface *intf)
724 {
725 struct ksdazzle_cb *kingsun = usb_get_intfdata(intf);
726
727 if (!kingsun)
728 return;
729
730 unregister_netdev(kingsun->netdev);
731
732 /* Mop up receive && transmit urb's */
733 usb_kill_urb(kingsun->speed_urb);
734 usb_free_urb(kingsun->speed_urb);
735 kingsun->speed_urb = NULL;
736
737 usb_kill_urb(kingsun->tx_urb);
738 usb_free_urb(kingsun->tx_urb);
739 kingsun->tx_urb = NULL;
740
741 usb_kill_urb(kingsun->rx_urb);
742 usb_free_urb(kingsun->rx_urb);
743 kingsun->rx_urb = NULL;
744
745 kfree(kingsun->speed_setuprequest);
746 kfree(kingsun->tx_buf_clear);
747 kfree(kingsun->rx_buf);
748 free_netdev(kingsun->netdev);
749
750 usb_set_intfdata(intf, NULL);
751 }
752
753 #ifdef CONFIG_PM
754 /* USB suspend, so power off the transmitter/receiver */
ksdazzle_suspend(struct usb_interface * intf,pm_message_t message)755 static int ksdazzle_suspend(struct usb_interface *intf, pm_message_t message)
756 {
757 struct ksdazzle_cb *kingsun = usb_get_intfdata(intf);
758
759 netif_device_detach(kingsun->netdev);
760 if (kingsun->speed_urb != NULL)
761 usb_kill_urb(kingsun->speed_urb);
762 if (kingsun->tx_urb != NULL)
763 usb_kill_urb(kingsun->tx_urb);
764 if (kingsun->rx_urb != NULL)
765 usb_kill_urb(kingsun->rx_urb);
766 return 0;
767 }
768
769 /* Coming out of suspend, so reset hardware */
ksdazzle_resume(struct usb_interface * intf)770 static int ksdazzle_resume(struct usb_interface *intf)
771 {
772 struct ksdazzle_cb *kingsun = usb_get_intfdata(intf);
773
774 if (kingsun->rx_urb != NULL) {
775 /* Setup request already filled in ksdazzle_probe */
776 usb_submit_urb(kingsun->rx_urb, GFP_KERNEL);
777 }
778 netif_device_attach(kingsun->netdev);
779
780 return 0;
781 }
782 #endif
783
784 /*
785 * USB device callbacks
786 */
787 static struct usb_driver irda_driver = {
788 .name = "ksdazzle-sir",
789 .probe = ksdazzle_probe,
790 .disconnect = ksdazzle_disconnect,
791 .id_table = dongles,
792 #ifdef CONFIG_PM
793 .suspend = ksdazzle_suspend,
794 .resume = ksdazzle_resume,
795 #endif
796 };
797
798 /*
799 * Module insertion
800 */
ksdazzle_init(void)801 static int __init ksdazzle_init(void)
802 {
803 return usb_register(&irda_driver);
804 }
805
806 module_init(ksdazzle_init);
807
808 /*
809 * Module removal
810 */
ksdazzle_cleanup(void)811 static void __exit ksdazzle_cleanup(void)
812 {
813 /* Deregister the driver and remove all pending instances */
814 usb_deregister(&irda_driver);
815 }
816
817 module_exit(ksdazzle_cleanup);
818
819 MODULE_AUTHOR("Alex Villacís Lasso <a_villacis@palosanto.com>");
820 MODULE_DESCRIPTION("IrDA-USB Dongle Driver for KingSun Dazzle");
821 MODULE_LICENSE("GPL");
822