?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
USB: omninet: fix write_room
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / usb / serial / garmin_gps.c
blob867d97b6c40cbe5f58e3ab0fc2e39779c8591190
1 /*
2 * Garmin GPS driver
3 *
4 * Copyright (C) 2006-2011 Hermann Kneissel herkne@gmx.de
5 *
6 * The latest version of the driver can be found at
7 * http://sourceforge.net/projects/garmin-gps/
8 *
9 * This driver has been derived from v2.1 of the visor driver.
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, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111 USA
24 */
25
26 #include <linux/kernel.h>
27 #include <linux/errno.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/timer.h>
31 #include <linux/tty.h>
32 #include <linux/tty_driver.h>
33 #include <linux/tty_flip.h>
34 #include <linux/module.h>
35 #include <linux/spinlock.h>
36 #include <linux/uaccess.h>
37 #include <asm/atomic.h>
38 #include <linux/usb.h>
39 #include <linux/usb/serial.h>
40
41 /* the mode to be set when the port ist opened */
42 static int initial_mode = 1;
43
44 /* debug flag */
45 static int debug;
46
47 #define GARMIN_VENDOR_ID 0x091E
48
49 /*
50 * Version Information
51 */
52
53 #define VERSION_MAJOR 0
54 #define VERSION_MINOR 36
55
56 #define _STR(s) #s
57 #define _DRIVER_VERSION(a, b) "v" _STR(a) "." _STR(b)
58 #define DRIVER_VERSION _DRIVER_VERSION(VERSION_MAJOR, VERSION_MINOR)
59 #define DRIVER_AUTHOR "hermann kneissel"
60 #define DRIVER_DESC "garmin gps driver"
61
62 /* error codes returned by the driver */
63 #define EINVPKT 1000 /* invalid packet structure */
64
65
66 /* size of the header of a packet using the usb protocol */
67 #define GARMIN_PKTHDR_LENGTH 12
68
69 /* max. possible size of a packet using the serial protocol */
70 #define MAX_SERIAL_PKT_SIZ (3 + 255 + 3)
71
72 /* max. possible size of a packet with worst case stuffing */
73 #define MAX_SERIAL_PKT_SIZ_STUFFED (MAX_SERIAL_PKT_SIZ + 256)
74
75 /* size of a buffer able to hold a complete (no stuffing) packet
76 * (the document protocol does not contain packets with a larger
77 * size, but in theory a packet may be 64k+12 bytes - if in
78 * later protocol versions larger packet sizes occur, this value
79 * should be increased accordingly, so the input buffer is always
80 * large enough the store a complete packet inclusive header) */
81 #define GPS_IN_BUFSIZ (GARMIN_PKTHDR_LENGTH+MAX_SERIAL_PKT_SIZ)
82
83 /* size of a buffer able to hold a complete (incl. stuffing) packet */
84 #define GPS_OUT_BUFSIZ (GARMIN_PKTHDR_LENGTH+MAX_SERIAL_PKT_SIZ_STUFFED)
85
86 /* where to place the packet id of a serial packet, so we can
87 * prepend the usb-packet header without the need to move the
88 * packets data */
89 #define GSP_INITIAL_OFFSET (GARMIN_PKTHDR_LENGTH-2)
90
91 /* max. size of incoming private packets (header+1 param) */
92 #define PRIVPKTSIZ (GARMIN_PKTHDR_LENGTH+4)
93
94 #define GARMIN_LAYERID_TRANSPORT 0
95 #define GARMIN_LAYERID_APPL 20
96 /* our own layer-id to use for some control mechanisms */
97 #define GARMIN_LAYERID_PRIVATE 0x01106E4B
98
99 #define GARMIN_PKTID_PVT_DATA 51
100 #define GARMIN_PKTID_L001_COMMAND_DATA 10
101
102 #define CMND_ABORT_TRANSFER 0
103
104 /* packet ids used in private layer */
105 #define PRIV_PKTID_SET_DEBUG 1
106 #define PRIV_PKTID_SET_MODE 2
107 #define PRIV_PKTID_INFO_REQ 3
108 #define PRIV_PKTID_INFO_RESP 4
109 #define PRIV_PKTID_RESET_REQ 5
110 #define PRIV_PKTID_SET_DEF_MODE 6
111
112
113 #define ETX 0x03
114 #define DLE 0x10
115 #define ACK 0x06
116 #define NAK 0x15
117
118 /* structure used to queue incoming packets */
119 struct garmin_packet {
120 struct list_head list;
121 int seq;
122 /* the real size of the data array, always > 0 */
123 int size;
124 __u8 data[1];
125 };
126
127 /* structure used to keep the current state of the driver */
128 struct garmin_data {
129 __u8 state;
130 __u16 flags;
131 __u8 mode;
132 __u8 count;
133 __u8 pkt_id;
134 __u32 serial_num;
135 struct timer_list timer;
136 struct usb_serial_port *port;
137 int seq_counter;
138 int insize;
139 int outsize;
140 __u8 inbuffer [GPS_IN_BUFSIZ]; /* tty -> usb */
141 __u8 outbuffer[GPS_OUT_BUFSIZ]; /* usb -> tty */
142 __u8 privpkt[4*6];
143 spinlock_t lock;
144 struct list_head pktlist;
145 };
146
147
148 #define STATE_NEW 0
149 #define STATE_INITIAL_DELAY 1
150 #define STATE_TIMEOUT 2
151 #define STATE_SESSION_REQ1 3
152 #define STATE_SESSION_REQ2 4
153 #define STATE_ACTIVE 5
154
155 #define STATE_RESET 8
156 #define STATE_DISCONNECTED 9
157 #define STATE_WAIT_TTY_ACK 10
158 #define STATE_GSP_WAIT_DATA 11
159
160 #define MODE_NATIVE 0
161 #define MODE_GARMIN_SERIAL 1
162
163 /* Flags used in garmin_data.flags: */
164 #define FLAGS_SESSION_REPLY_MASK 0x00C0
165 #define FLAGS_SESSION_REPLY1_SEEN 0x0080
166 #define FLAGS_SESSION_REPLY2_SEEN 0x0040
167 #define FLAGS_BULK_IN_ACTIVE 0x0020
168 #define FLAGS_BULK_IN_RESTART 0x0010
169 #define FLAGS_THROTTLED 0x0008
170 #define APP_REQ_SEEN 0x0004
171 #define APP_RESP_SEEN 0x0002
172 #define CLEAR_HALT_REQUIRED 0x0001
173
174 #define FLAGS_QUEUING 0x0100
175 #define FLAGS_DROP_DATA 0x0800
176
177 #define FLAGS_GSP_SKIP 0x1000
178 #define FLAGS_GSP_DLESEEN 0x2000
179
180
181
182
183
184
185 /* function prototypes */
186 static int gsp_next_packet(struct garmin_data *garmin_data_p);
187 static int garmin_write_bulk(struct usb_serial_port *port,
188 const unsigned char *buf, int count,
189 int dismiss_ack);
190
191 /* some special packets to be send or received */
192 static unsigned char const GARMIN_START_SESSION_REQ[]
193 = { 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0 };
194 static unsigned char const GARMIN_START_SESSION_REPLY[]
195 = { 0, 0, 0, 0, 6, 0, 0, 0, 4, 0, 0, 0 };
196 static unsigned char const GARMIN_BULK_IN_AVAIL_REPLY[]
197 = { 0, 0, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0 };
198 static unsigned char const GARMIN_APP_LAYER_REPLY[]
199 = { 0x14, 0, 0, 0 };
200 static unsigned char const GARMIN_START_PVT_REQ[]
201 = { 20, 0, 0, 0, 10, 0, 0, 0, 2, 0, 0, 0, 49, 0 };
202 static unsigned char const GARMIN_STOP_PVT_REQ[]
203 = { 20, 0, 0, 0, 10, 0, 0, 0, 2, 0, 0, 0, 50, 0 };
204 static unsigned char const GARMIN_STOP_TRANSFER_REQ[]
205 = { 20, 0, 0, 0, 10, 0, 0, 0, 2, 0, 0, 0, 0, 0 };
206 static unsigned char const GARMIN_STOP_TRANSFER_REQ_V2[]
207 = { 20, 0, 0, 0, 10, 0, 0, 0, 1, 0, 0, 0, 0 };
208 static unsigned char const PRIVATE_REQ[]
209 = { 0x4B, 0x6E, 0x10, 0x01, 0xFF, 0, 0, 0, 0xFF, 0, 0, 0 };
210
211
212
213 static struct usb_device_id id_table [] = {
214 /* the same device id seems to be used by all
215 usb enabled GPS devices */
216 { USB_DEVICE(GARMIN_VENDOR_ID, 3) },
217 { } /* Terminating entry */
218 };
219
220 MODULE_DEVICE_TABLE(usb, id_table);
221
222 static struct usb_driver garmin_driver = {
223 .name = "garmin_gps",
224 .probe = usb_serial_probe,
225 .disconnect = usb_serial_disconnect,
226 .id_table = id_table,
227 .no_dynamic_id = 1,
228 };
229
230
231 static inline int getLayerId(const __u8 *usbPacket)
232 {
233 return __le32_to_cpup((__le32 *)(usbPacket));
234 }
235
236 static inline int getPacketId(const __u8 *usbPacket)
237 {
238 return __le32_to_cpup((__le32 *)(usbPacket+4));
239 }
240
241 static inline int getDataLength(const __u8 *usbPacket)
242 {
243 return __le32_to_cpup((__le32 *)(usbPacket+8));
244 }
245
246
247 /*
248 * check if the usb-packet in buf contains an abort-transfer command.
249 * (if yes, all queued data will be dropped)
250 */
251 static inline int isAbortTrfCmnd(const unsigned char *buf)
252 {
253 if (0 == memcmp(buf, GARMIN_STOP_TRANSFER_REQ,
254 sizeof(GARMIN_STOP_TRANSFER_REQ)) ||
255 0 == memcmp(buf, GARMIN_STOP_TRANSFER_REQ_V2,
256 sizeof(GARMIN_STOP_TRANSFER_REQ_V2)))
257 return 1;
258 else
259 return 0;
260 }
261
262
263
264 static void send_to_tty(struct usb_serial_port *port,
265 char *data, unsigned int actual_length)
266 {
267 struct tty_struct *tty = tty_port_tty_get(&port->port);
268
269 if (tty && actual_length) {
270
271 usb_serial_debug_data(debug, &port->dev,
272 __func__, actual_length, data);
273
274 tty_buffer_request_room(tty, actual_length);
275 tty_insert_flip_string(tty, data, actual_length);
276 tty_flip_buffer_push(tty);
277 }
278 tty_kref_put(tty);
279 }
280
281
282 /******************************************************************************
283 * packet queue handling
284 ******************************************************************************/
285
286 /*
287 * queue a received (usb-)packet for later processing
288 */
289 static int pkt_add(struct garmin_data *garmin_data_p,
290 unsigned char *data, unsigned int data_length)
291 {
292 int state = 0;
293 int result = 0;
294 unsigned long flags;
295 struct garmin_packet *pkt;
296
297 /* process only packets containg data ... */
298 if (data_length) {
299 pkt = kmalloc(sizeof(struct garmin_packet)+data_length,
300 GFP_ATOMIC);
301 if (pkt == NULL) {
302 dev_err(&garmin_data_p->port->dev, "out of memory\n");
303 return 0;
304 }
305 pkt->size = data_length;
306 memcpy(pkt->data, data, data_length);
307
308 spin_lock_irqsave(&garmin_data_p->lock, flags);
309 garmin_data_p->flags |= FLAGS_QUEUING;
310 result = list_empty(&garmin_data_p->pktlist);
311 pkt->seq = garmin_data_p->seq_counter++;
312 list_add_tail(&pkt->list, &garmin_data_p->pktlist);
313 state = garmin_data_p->state;
314 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
315
316 dbg("%s - added: pkt: %d - %d bytes",
317 __func__, pkt->seq, data_length);
318
319 /* in serial mode, if someone is waiting for data from
320 the device, convert and send the next packet to tty. */
321 if (result && (state == STATE_GSP_WAIT_DATA))
322 gsp_next_packet(garmin_data_p);
323 }
324 return result;
325 }
326
327
328 /* get the next pending packet */
329 static struct garmin_packet *pkt_pop(struct garmin_data *garmin_data_p)
330 {
331 unsigned long flags;
332 struct garmin_packet *result = NULL;
333
334 spin_lock_irqsave(&garmin_data_p->lock, flags);
335 if (!list_empty(&garmin_data_p->pktlist)) {
336 result = (struct garmin_packet *)garmin_data_p->pktlist.next;
337 list_del(&result->list);
338 }
339 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
340 return result;
341 }
342
343
344 /* free up all queued data */
345 static void pkt_clear(struct garmin_data *garmin_data_p)
346 {
347 unsigned long flags;
348 struct garmin_packet *result = NULL;
349
350 dbg("%s", __func__);
351
352 spin_lock_irqsave(&garmin_data_p->lock, flags);
353 while (!list_empty(&garmin_data_p->pktlist)) {
354 result = (struct garmin_packet *)garmin_data_p->pktlist.next;
355 list_del(&result->list);
356 kfree(result);
357 }
358 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
359 }
360
361
362 /******************************************************************************
363 * garmin serial protocol handling handling
364 ******************************************************************************/
365
366 /* send an ack packet back to the tty */
367 static int gsp_send_ack(struct garmin_data *garmin_data_p, __u8 pkt_id)
368 {
369 __u8 pkt[10];
370 __u8 cksum = 0;
371 __u8 *ptr = pkt;
372 unsigned l = 0;
373
374 dbg("%s - pkt-id: 0x%X.", __func__, 0xFF & pkt_id);
375
376 *ptr++ = DLE;
377 *ptr++ = ACK;
378 cksum += ACK;
379
380 *ptr++ = 2;
381 cksum += 2;
382
383 *ptr++ = pkt_id;
384 cksum += pkt_id;
385
386 if (pkt_id == DLE)
387 *ptr++ = DLE;
388
389 *ptr++ = 0;
390 *ptr++ = 0xFF & (-cksum);
391 *ptr++ = DLE;
392 *ptr++ = ETX;
393
394 l = ptr-pkt;
395
396 send_to_tty(garmin_data_p->port, pkt, l);
397 return 0;
398 }
399
400
401
402 /*
403 * called for a complete packet received from tty layer
404 *
405 * the complete packet (pktid ... cksum) is in garmin_data_p->inbuf starting
406 * at GSP_INITIAL_OFFSET.
407 *
408 * count - number of bytes in the input buffer including space reserved for
409 * the usb header: GSP_INITIAL_OFFSET + number of bytes in packet
410 * (including pkt-id, data-length a. cksum)
411 */
412 static int gsp_rec_packet(struct garmin_data *garmin_data_p, int count)
413 {
414 unsigned long flags;
415 const __u8 *recpkt = garmin_data_p->inbuffer+GSP_INITIAL_OFFSET;
416 __le32 *usbdata = (__le32 *) garmin_data_p->inbuffer;
417
418 int cksum = 0;
419 int n = 0;
420 int pktid = recpkt[0];
421 int size = recpkt[1];
422
423 usb_serial_debug_data(debug, &garmin_data_p->port->dev,
424 __func__, count-GSP_INITIAL_OFFSET, recpkt);
425
426 if (size != (count-GSP_INITIAL_OFFSET-3)) {
427 dbg("%s - invalid size, expected %d bytes, got %d",
428 __func__, size, (count-GSP_INITIAL_OFFSET-3));
429 return -EINVPKT;
430 }
431
432 cksum += *recpkt++;
433 cksum += *recpkt++;
434
435 /* sanity check, remove after test ... */
436 if ((__u8 *)&(usbdata[3]) != recpkt) {
437 dbg("%s - ptr mismatch %p - %p",
438 __func__, &(usbdata[4]), recpkt);
439 return -EINVPKT;
440 }
441
442 while (n < size) {
443 cksum += *recpkt++;
444 n++;
445 }
446
447 if ((0xff & (cksum + *recpkt)) != 0) {
448 dbg("%s - invalid checksum, expected %02x, got %02x",
449 __func__, 0xff & -cksum, 0xff & *recpkt);
450 return -EINVPKT;
451 }
452
453 usbdata[0] = __cpu_to_le32(GARMIN_LAYERID_APPL);
454 usbdata[1] = __cpu_to_le32(pktid);
455 usbdata[2] = __cpu_to_le32(size);
456
457 garmin_write_bulk(garmin_data_p->port, garmin_data_p->inbuffer,
458 GARMIN_PKTHDR_LENGTH+size, 0);
459
460 /* if this was an abort-transfer command, flush all
461 queued data. */
462 if (isAbortTrfCmnd(garmin_data_p->inbuffer)) {
463 spin_lock_irqsave(&garmin_data_p->lock, flags);
464 garmin_data_p->flags |= FLAGS_DROP_DATA;
465 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
466 pkt_clear(garmin_data_p);
467 }
468
469 return count;
470 }
471
472
473
474 /*
475 * Called for data received from tty
476 *
477 * buf contains the data read, it may span more than one packet or even
478 * incomplete packets
479 *
480 * input record should be a serial-record, but it may not be complete.
481 * Copy it into our local buffer, until an etx is seen (or an error
482 * occurs).
483 * Once the record is complete, convert into a usb packet and send it
484 * to the bulk pipe, send an ack back to the tty.
485 *
486 * If the input is an ack, just send the last queued packet to the
487 * tty layer.
488 *
489 * if the input is an abort command, drop all queued data.
490 */
491
492 static int gsp_receive(struct garmin_data *garmin_data_p,
493 const unsigned char *buf, int count)
494 {
495 unsigned long flags;
496 int offs = 0;
497 int ack_or_nak_seen = 0;
498 __u8 *dest;
499 int size;
500 /* dleSeen: set if last byte read was a DLE */
501 int dleSeen;
502 /* skip: if set, skip incoming data until possible start of
503 * new packet
504 */
505 int skip;
506 __u8 data;
507
508 spin_lock_irqsave(&garmin_data_p->lock, flags);
509 dest = garmin_data_p->inbuffer;
510 size = garmin_data_p->insize;
511 dleSeen = garmin_data_p->flags & FLAGS_GSP_DLESEEN;
512 skip = garmin_data_p->flags & FLAGS_GSP_SKIP;
513 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
514
515 /* dbg("%s - dle=%d skip=%d size=%d count=%d",
516 __func__, dleSeen, skip, size, count); */
517
518 if (size == 0)
519 size = GSP_INITIAL_OFFSET;
520
521 while (offs < count) {
522
523 data = *(buf+offs);
524 offs++;
525
526 if (data == DLE) {
527 if (skip) { /* start of a new pkt */
528 skip = 0;
529 size = GSP_INITIAL_OFFSET;
530 dleSeen = 1;
531 } else if (dleSeen) {
532 dest[size++] = data;
533 dleSeen = 0;
534 } else {
535 dleSeen = 1;
536 }
537 } else if (data == ETX) {
538 if (dleSeen) {
539 /* packet complete */
540
541 data = dest[GSP_INITIAL_OFFSET];
542
543 if (data == ACK) {
544 ack_or_nak_seen = ACK;
545 dbg("ACK packet complete.");
546 } else if (data == NAK) {
547 ack_or_nak_seen = NAK;
548 dbg("NAK packet complete.");
549 } else {
550 dbg("packet complete - id=0x%X.",
551 0xFF & data);
552 gsp_rec_packet(garmin_data_p, size);
553 }
554
555 skip = 1;
556 size = GSP_INITIAL_OFFSET;
557 dleSeen = 0;
558 } else {
559 dest[size++] = data;
560 }
561 } else if (!skip) {
562
563 if (dleSeen) {
564 size = GSP_INITIAL_OFFSET;
565 dleSeen = 0;
566 }
567
568 dest[size++] = data;
569 }
570
571 if (size >= GPS_IN_BUFSIZ) {
572 dbg("%s - packet too large.", __func__);
573 skip = 1;
574 size = GSP_INITIAL_OFFSET;
575 dleSeen = 0;
576 }
577 }
578
579 spin_lock_irqsave(&garmin_data_p->lock, flags);
580
581 garmin_data_p->insize = size;
582
583 /* copy flags back to structure */
584 if (skip)
585 garmin_data_p->flags |= FLAGS_GSP_SKIP;
586 else
587 garmin_data_p->flags &= ~FLAGS_GSP_SKIP;
588
589 if (dleSeen)
590 garmin_data_p->flags |= FLAGS_GSP_DLESEEN;
591 else
592 garmin_data_p->flags &= ~FLAGS_GSP_DLESEEN;
593
594 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
595
596 if (ack_or_nak_seen) {
597 if (gsp_next_packet(garmin_data_p) > 0)
598 garmin_data_p->state = STATE_ACTIVE;
599 else
600 garmin_data_p->state = STATE_GSP_WAIT_DATA;
601 }
602 return count;
603 }
604
605
606
607 /*
608 * Sends a usb packet to the tty
609 *
610 * Assumes, that all packages and at an usb-packet boundary.
611 *
612 * return <0 on error, 0 if packet is incomplete or > 0 if packet was sent
613 */
614 static int gsp_send(struct garmin_data *garmin_data_p,
615 const unsigned char *buf, int count)
616 {
617 const unsigned char *src;
618 unsigned char *dst;
619 int pktid = 0;
620 int datalen = 0;
621 int cksum = 0;
622 int i = 0;
623 int k;
624
625 dbg("%s - state %d - %d bytes.", __func__,
626 garmin_data_p->state, count);
627
628 k = garmin_data_p->outsize;
629 if ((k+count) > GPS_OUT_BUFSIZ) {
630 dbg("packet too large");
631 garmin_data_p->outsize = 0;
632 return -4;
633 }
634
635 memcpy(garmin_data_p->outbuffer+k, buf, count);
636 k += count;
637 garmin_data_p->outsize = k;
638
639 if (k >= GARMIN_PKTHDR_LENGTH) {
640 pktid = getPacketId(garmin_data_p->outbuffer);
641 datalen = getDataLength(garmin_data_p->outbuffer);
642 i = GARMIN_PKTHDR_LENGTH + datalen;
643 if (k < i)
644 return 0;
645 } else {
646 return 0;
647 }
648
649 dbg("%s - %d bytes in buffer, %d bytes in pkt.", __func__, k, i);
650
651 /* garmin_data_p->outbuffer now contains a complete packet */
652
653 usb_serial_debug_data(debug, &garmin_data_p->port->dev,
654 __func__, k, garmin_data_p->outbuffer);
655
656 garmin_data_p->outsize = 0;
657
658 if (GARMIN_LAYERID_APPL != getLayerId(garmin_data_p->outbuffer)) {
659 dbg("not an application packet (%d)",
660 getLayerId(garmin_data_p->outbuffer));
661 return -1;
662 }
663
664 if (pktid > 255) {
665 dbg("packet-id %d too large", pktid);
666 return -2;
667 }
668
669 if (datalen > 255) {
670 dbg("packet-size %d too large", datalen);
671 return -3;
672 }
673
674 /* the serial protocol should be able to handle this packet */
675
676 k = 0;
677 src = garmin_data_p->outbuffer+GARMIN_PKTHDR_LENGTH;
678 for (i = 0; i < datalen; i++) {
679 if (*src++ == DLE)
680 k++;
681 }
682
683 src = garmin_data_p->outbuffer+GARMIN_PKTHDR_LENGTH;
684 if (k > (GARMIN_PKTHDR_LENGTH-2)) {
685 /* can't add stuffing DLEs in place, move data to end
686 of buffer ... */
687 dst = garmin_data_p->outbuffer+GPS_OUT_BUFSIZ-datalen;
688 memcpy(dst, src, datalen);
689 src = dst;
690 }
691
692 dst = garmin_data_p->outbuffer;
693
694 *dst++ = DLE;
695 *dst++ = pktid;
696 cksum += pktid;
697 *dst++ = datalen;
698 cksum += datalen;
699 if (datalen == DLE)
700 *dst++ = DLE;
701
702 for (i = 0; i < datalen; i++) {
703 __u8 c = *src++;
704 *dst++ = c;
705 cksum += c;
706 if (c == DLE)
707 *dst++ = DLE;
708 }
709
710 cksum = 0xFF & -cksum;
711 *dst++ = cksum;
712 if (cksum == DLE)
713 *dst++ = DLE;
714 *dst++ = DLE;
715 *dst++ = ETX;
716
717 i = dst-garmin_data_p->outbuffer;
718
719 send_to_tty(garmin_data_p->port, garmin_data_p->outbuffer, i);
720
721 garmin_data_p->pkt_id = pktid;
722 garmin_data_p->state = STATE_WAIT_TTY_ACK;
723
724 return i;
725 }
726
727
728 /*
729 * Process the next pending data packet - if there is one
730 */
731 static int gsp_next_packet(struct garmin_data *garmin_data_p)
732 {
733 int result = 0;
734 struct garmin_packet *pkt = NULL;
735
736 while ((pkt = pkt_pop(garmin_data_p)) != NULL) {
737 dbg("%s - next pkt: %d", __func__, pkt->seq);
738 result = gsp_send(garmin_data_p, pkt->data, pkt->size);
739 if (result > 0) {
740 kfree(pkt);
741 return result;
742 }
743 kfree(pkt);
744 }
745 return result;
746 }
747
748
749
750 /******************************************************************************
751 * garmin native mode
752 ******************************************************************************/
753
754
755 /*
756 * Called for data received from tty
757 *
758 * The input data is expected to be in garmin usb-packet format.
759 *
760 * buf contains the data read, it may span more than one packet
761 * or even incomplete packets
762 */
763 static int nat_receive(struct garmin_data *garmin_data_p,
764 const unsigned char *buf, int count)
765 {
766 unsigned long flags;
767 __u8 *dest;
768 int offs = 0;
769 int result = count;
770 int len;
771
772 while (offs < count) {
773 /* if buffer contains header, copy rest of data */
774 if (garmin_data_p->insize >= GARMIN_PKTHDR_LENGTH)
775 len = GARMIN_PKTHDR_LENGTH
776 +getDataLength(garmin_data_p->inbuffer);
777 else
778 len = GARMIN_PKTHDR_LENGTH;
779
780 if (len >= GPS_IN_BUFSIZ) {
781 /* seems to be an invalid packet, ignore rest
782 of input */
783 dbg("%s - packet size too large: %d", __func__, len);
784 garmin_data_p->insize = 0;
785 count = 0;
786 result = -EINVPKT;
787 } else {
788 len -= garmin_data_p->insize;
789 if (len > (count-offs))
790 len = (count-offs);
791 if (len > 0) {
792 dest = garmin_data_p->inbuffer
793 + garmin_data_p->insize;
794 memcpy(dest, buf+offs, len);
795 garmin_data_p->insize += len;
796 offs += len;
797 }
798 }
799
800 /* do we have a complete packet ? */
801 if (garmin_data_p->insize >= GARMIN_PKTHDR_LENGTH) {
802 len = GARMIN_PKTHDR_LENGTH+
803 getDataLength(garmin_data_p->inbuffer);
804 if (garmin_data_p->insize >= len) {
805 garmin_write_bulk(garmin_data_p->port,
806 garmin_data_p->inbuffer,
807 len, 0);
808 garmin_data_p->insize = 0;
809
810 /* if this was an abort-transfer command,
811 flush all queued data. */
812 if (isAbortTrfCmnd(garmin_data_p->inbuffer)) {
813 spin_lock_irqsave(&garmin_data_p->lock,
814 flags);
815 garmin_data_p->flags |= FLAGS_DROP_DATA;
816 spin_unlock_irqrestore(
817 &garmin_data_p->lock, flags);
818 pkt_clear(garmin_data_p);
819 }
820 }
821 }
822 }
823 return result;
824 }
825
826
827 /******************************************************************************
828 * private packets
829 ******************************************************************************/
830
831 static void priv_status_resp(struct usb_serial_port *port)
832 {
833 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
834 __le32 *pkt = (__le32 *)garmin_data_p->privpkt;
835
836 pkt[0] = __cpu_to_le32(GARMIN_LAYERID_PRIVATE);
837 pkt[1] = __cpu_to_le32(PRIV_PKTID_INFO_RESP);
838 pkt[2] = __cpu_to_le32(12);
839 pkt[3] = __cpu_to_le32(VERSION_MAJOR << 16 | VERSION_MINOR);
840 pkt[4] = __cpu_to_le32(garmin_data_p->mode);
841 pkt[5] = __cpu_to_le32(garmin_data_p->serial_num);
842
843 send_to_tty(port, (__u8 *)pkt, 6 * 4);
844 }
845
846
847 /******************************************************************************
848 * Garmin specific driver functions
849 ******************************************************************************/
850
851 static int process_resetdev_request(struct usb_serial_port *port)
852 {
853 unsigned long flags;
854 int status;
855 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
856
857 spin_lock_irqsave(&garmin_data_p->lock, flags);
858 garmin_data_p->flags &= ~(CLEAR_HALT_REQUIRED);
859 garmin_data_p->state = STATE_RESET;
860 garmin_data_p->serial_num = 0;
861 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
862
863 usb_kill_urb(port->interrupt_in_urb);
864 dbg("%s - usb_reset_device", __func__);
865 status = usb_reset_device(port->serial->dev);
866 if (status)
867 dbg("%s - usb_reset_device failed: %d",
868 __func__, status);
869 return status;
870 }
871
872
873
874 /*
875 * clear all cached data
876 */
877 static int garmin_clear(struct garmin_data *garmin_data_p)
878 {
879 unsigned long flags;
880 int status = 0;
881
882 /* flush all queued data */
883 pkt_clear(garmin_data_p);
884
885 spin_lock_irqsave(&garmin_data_p->lock, flags);
886 garmin_data_p->insize = 0;
887 garmin_data_p->outsize = 0;
888 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
889
890 return status;
891 }
892
893
894 static int garmin_init_session(struct usb_serial_port *port)
895 {
896 struct usb_serial *serial = port->serial;
897 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
898 int status = 0;
899 int i = 0;
900
901 if (status == 0) {
902 usb_kill_urb(port->interrupt_in_urb);
903
904 dbg("%s - adding interrupt input", __func__);
905 port->interrupt_in_urb->dev = serial->dev;
906 status = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
907 if (status)
908 dev_err(&serial->dev->dev,
909 "%s - failed submitting interrupt urb, error %d\n",
910 __func__, status);
911 }
912
913 /*
914 * using the initialization method from gpsbabel. See comments in
915 * gpsbabel/jeeps/gpslibusb.c gusb_reset_toggles()
916 */
917 if (status == 0) {
918 dbg("%s - starting session ...", __func__);
919 garmin_data_p->state = STATE_ACTIVE;
920
921 for (i = 0; i < 3; i++) {
922 status = garmin_write_bulk(port,
923 GARMIN_START_SESSION_REQ,
924 sizeof(GARMIN_START_SESSION_REQ), 0);
925
926 if (status < 0)
927 break;
928 }
929
930 if (status > 0)
931 status = 0;
932 }
933
934 return status;
935 }
936
937
938
939 static int garmin_open(struct tty_struct *tty, struct usb_serial_port *port)
940 {
941 unsigned long flags;
942 int status = 0;
943 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
944
945 dbg("%s - port %d", __func__, port->number);
946
947 spin_lock_irqsave(&garmin_data_p->lock, flags);
948 garmin_data_p->mode = initial_mode;
949 garmin_data_p->count = 0;
950 garmin_data_p->flags &= FLAGS_SESSION_REPLY1_SEEN;
951 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
952
953 /* shutdown any bulk reads that might be going on */
954 usb_kill_urb(port->write_urb);
955 usb_kill_urb(port->read_urb);
956
957 if (garmin_data_p->state == STATE_RESET)
958 status = garmin_init_session(port);
959
960 garmin_data_p->state = STATE_ACTIVE;
961 return status;
962 }
963
964
965 static void garmin_close(struct usb_serial_port *port)
966 {
967 struct usb_serial *serial = port->serial;
968 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
969
970 dbg("%s - port %d - mode=%d state=%d flags=0x%X", __func__,
971 port->number, garmin_data_p->mode,
972 garmin_data_p->state, garmin_data_p->flags);
973
974 if (!serial)
975 return;
976
977 mutex_lock(&port->serial->disc_mutex);
978
979 if (!port->serial->disconnected)
980 garmin_clear(garmin_data_p);
981
982 /* shutdown our urbs */
983 usb_kill_urb(port->read_urb);
984 usb_kill_urb(port->write_urb);
985
986 /* keep reset state so we know that we must start a new session */
987 if (garmin_data_p->state != STATE_RESET)
988 garmin_data_p->state = STATE_DISCONNECTED;
989
990 mutex_unlock(&port->serial->disc_mutex);
991 }
992
993
994 static void garmin_write_bulk_callback(struct urb *urb)
995 {
996 struct usb_serial_port *port = urb->context;
997
998 if (port) {
999 struct garmin_data *garmin_data_p =
1000 usb_get_serial_port_data(port);
1001
1002 dbg("%s - port %d", __func__, port->number);
1003
1004 if (GARMIN_LAYERID_APPL == getLayerId(urb->transfer_buffer)) {
1005
1006 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1007 gsp_send_ack(garmin_data_p,
1008 ((__u8 *)urb->transfer_buffer)[4]);
1009 }
1010 }
1011 usb_serial_port_softint(port);
1012 }
1013
1014 /* Ignore errors that resulted from garmin_write_bulk with
1015 dismiss_ack = 1 */
1016
1017 /* free up the transfer buffer, as usb_free_urb() does not do this */
1018 kfree(urb->transfer_buffer);
1019 }
1020
1021
1022 static int garmin_write_bulk(struct usb_serial_port *port,
1023 const unsigned char *buf, int count,
1024 int dismiss_ack)
1025 {
1026 unsigned long flags;
1027 struct usb_serial *serial = port->serial;
1028 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1029 struct urb *urb;
1030 unsigned char *buffer;
1031 int status;
1032
1033 dbg("%s - port %d, state %d", __func__, port->number,
1034 garmin_data_p->state);
1035
1036 spin_lock_irqsave(&garmin_data_p->lock, flags);
1037 garmin_data_p->flags &= ~FLAGS_DROP_DATA;
1038 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1039
1040 buffer = kmalloc(count, GFP_ATOMIC);
1041 if (!buffer) {
1042 dev_err(&port->dev, "out of memory\n");
1043 return -ENOMEM;
1044 }
1045
1046 urb = usb_alloc_urb(0, GFP_ATOMIC);
1047 if (!urb) {
1048 dev_err(&port->dev, "no more free urbs\n");
1049 kfree(buffer);
1050 return -ENOMEM;
1051 }
1052
1053 memcpy(buffer, buf, count);
1054
1055 usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
1056
1057 usb_fill_bulk_urb(urb, serial->dev,
1058 usb_sndbulkpipe(serial->dev,
1059 port->bulk_out_endpointAddress),
1060 buffer, count,
1061 garmin_write_bulk_callback,
1062 dismiss_ack ? NULL : port);
1063 urb->transfer_flags |= URB_ZERO_PACKET;
1064
1065 if (GARMIN_LAYERID_APPL == getLayerId(buffer)) {
1066
1067 spin_lock_irqsave(&garmin_data_p->lock, flags);
1068 garmin_data_p->flags |= APP_REQ_SEEN;
1069 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1070
1071 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1072 pkt_clear(garmin_data_p);
1073 garmin_data_p->state = STATE_GSP_WAIT_DATA;
1074 }
1075 }
1076
1077 /* send it down the pipe */
1078 status = usb_submit_urb(urb, GFP_ATOMIC);
1079 if (status) {
1080 dev_err(&port->dev,
1081 "%s - usb_submit_urb(write bulk) failed with status = %d\n",
1082 __func__, status);
1083 count = status;
1084 }
1085
1086 /* we are done with this urb, so let the host driver
1087 * really free it when it is finished with it */
1088 usb_free_urb(urb);
1089
1090 return count;
1091 }
1092
1093 static int garmin_write(struct tty_struct *tty, struct usb_serial_port *port,
1094 const unsigned char *buf, int count)
1095 {
1096 int pktid, pktsiz, len;
1097 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1098 __le32 *privpkt = (__le32 *)garmin_data_p->privpkt;
1099
1100 usb_serial_debug_data(debug, &port->dev, __func__, count, buf);
1101
1102 if (garmin_data_p->state == STATE_RESET)
1103 return -EIO;
1104
1105 /* check for our private packets */
1106 if (count >= GARMIN_PKTHDR_LENGTH) {
1107 len = PRIVPKTSIZ;
1108 if (count < len)
1109 len = count;
1110
1111 memcpy(garmin_data_p->privpkt, buf, len);
1112
1113 pktsiz = getDataLength(garmin_data_p->privpkt);
1114 pktid = getPacketId(garmin_data_p->privpkt);
1115
1116 if (count == (GARMIN_PKTHDR_LENGTH+pktsiz)
1117 && GARMIN_LAYERID_PRIVATE ==
1118 getLayerId(garmin_data_p->privpkt)) {
1119
1120 dbg("%s - processing private request %d",
1121 __func__, pktid);
1122
1123 /* drop all unfinished transfers */
1124 garmin_clear(garmin_data_p);
1125
1126 switch (pktid) {
1127
1128 case PRIV_PKTID_SET_DEBUG:
1129 if (pktsiz != 4)
1130 return -EINVPKT;
1131 debug = __le32_to_cpu(privpkt[3]);
1132 dbg("%s - debug level set to 0x%X",
1133 __func__, debug);
1134 break;
1135
1136 case PRIV_PKTID_SET_MODE:
1137 if (pktsiz != 4)
1138 return -EINVPKT;
1139 garmin_data_p->mode = __le32_to_cpu(privpkt[3]);
1140 dbg("%s - mode set to %d",
1141 __func__, garmin_data_p->mode);
1142 break;
1143
1144 case PRIV_PKTID_INFO_REQ:
1145 priv_status_resp(port);
1146 break;
1147
1148 case PRIV_PKTID_RESET_REQ:
1149 process_resetdev_request(port);
1150 break;
1151
1152 case PRIV_PKTID_SET_DEF_MODE:
1153 if (pktsiz != 4)
1154 return -EINVPKT;
1155 initial_mode = __le32_to_cpu(privpkt[3]);
1156 dbg("%s - initial_mode set to %d",
1157 __func__,
1158 garmin_data_p->mode);
1159 break;
1160 }
1161 return count;
1162 }
1163 }
1164
1165 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1166 return gsp_receive(garmin_data_p, buf, count);
1167 } else { /* MODE_NATIVE */
1168 return nat_receive(garmin_data_p, buf, count);
1169 }
1170 }
1171
1172
1173 static int garmin_write_room(struct tty_struct *tty)
1174 {
1175 struct usb_serial_port *port = tty->driver_data;
1176 /*
1177 * Report back the bytes currently available in the output buffer.
1178 */
1179 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1180 return GPS_OUT_BUFSIZ-garmin_data_p->outsize;
1181 }
1182
1183
1184 static void garmin_read_process(struct garmin_data *garmin_data_p,
1185 unsigned char *data, unsigned data_length,
1186 int bulk_data)
1187 {
1188 unsigned long flags;
1189
1190 if (garmin_data_p->flags & FLAGS_DROP_DATA) {
1191 /* abort-transfer cmd is actice */
1192 dbg("%s - pkt dropped", __func__);
1193 } else if (garmin_data_p->state != STATE_DISCONNECTED &&
1194 garmin_data_p->state != STATE_RESET) {
1195
1196 /* if throttling is active or postprecessing is required
1197 put the received data in the input queue, otherwise
1198 send it directly to the tty port */
1199 if (garmin_data_p->flags & FLAGS_QUEUING) {
1200 pkt_add(garmin_data_p, data, data_length);
1201 } else if (bulk_data ||
1202 getLayerId(data) == GARMIN_LAYERID_APPL) {
1203
1204 spin_lock_irqsave(&garmin_data_p->lock, flags);
1205 garmin_data_p->flags |= APP_RESP_SEEN;
1206 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1207
1208 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1209 pkt_add(garmin_data_p, data, data_length);
1210 } else {
1211 send_to_tty(garmin_data_p->port, data,
1212 data_length);
1213 }
1214 }
1215 /* ignore system layer packets ... */
1216 }
1217 }
1218
1219
1220 static void garmin_read_bulk_callback(struct urb *urb)
1221 {
1222 unsigned long flags;
1223 struct usb_serial_port *port = urb->context;
1224 struct usb_serial *serial = port->serial;
1225 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1226 unsigned char *data = urb->transfer_buffer;
1227 int status = urb->status;
1228 int retval;
1229
1230 dbg("%s - port %d", __func__, port->number);
1231
1232 if (!serial) {
1233 dbg("%s - bad serial pointer, exiting", __func__);
1234 return;
1235 }
1236
1237 if (status) {
1238 dbg("%s - nonzero read bulk status received: %d",
1239 __func__, status);
1240 return;
1241 }
1242
1243 usb_serial_debug_data(debug, &port->dev,
1244 __func__, urb->actual_length, data);
1245
1246 garmin_read_process(garmin_data_p, data, urb->actual_length, 1);
1247
1248 if (urb->actual_length == 0 &&
1249 0 != (garmin_data_p->flags & FLAGS_BULK_IN_RESTART)) {
1250 spin_lock_irqsave(&garmin_data_p->lock, flags);
1251 garmin_data_p->flags &= ~FLAGS_BULK_IN_RESTART;
1252 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1253 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1254 if (retval)
1255 dev_err(&port->dev,
1256 "%s - failed resubmitting read urb, error %d\n",
1257 __func__, retval);
1258 } else if (urb->actual_length > 0) {
1259 /* Continue trying to read until nothing more is received */
1260 if (0 == (garmin_data_p->flags & FLAGS_THROTTLED)) {
1261 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1262 if (retval)
1263 dev_err(&port->dev,
1264 "%s - failed resubmitting read urb, "
1265 "error %d\n", __func__, retval);
1266 }
1267 } else {
1268 dbg("%s - end of bulk data", __func__);
1269 spin_lock_irqsave(&garmin_data_p->lock, flags);
1270 garmin_data_p->flags &= ~FLAGS_BULK_IN_ACTIVE;
1271 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1272 }
1273 return;
1274 }
1275
1276
1277 static void garmin_read_int_callback(struct urb *urb)
1278 {
1279 unsigned long flags;
1280 int retval;
1281 struct usb_serial_port *port = urb->context;
1282 struct usb_serial *serial = port->serial;
1283 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1284 unsigned char *data = urb->transfer_buffer;
1285 int status = urb->status;
1286
1287 switch (status) {
1288 case 0:
1289 /* success */
1290 break;
1291 case -ECONNRESET:
1292 case -ENOENT:
1293 case -ESHUTDOWN:
1294 /* this urb is terminated, clean up */
1295 dbg("%s - urb shutting down with status: %d",
1296 __func__, status);
1297 return;
1298 default:
1299 dbg("%s - nonzero urb status received: %d",
1300 __func__, status);
1301 return;
1302 }
1303
1304 usb_serial_debug_data(debug, &port->dev, __func__,
1305 urb->actual_length, urb->transfer_buffer);
1306
1307 if (urb->actual_length == sizeof(GARMIN_BULK_IN_AVAIL_REPLY) &&
1308 0 == memcmp(data, GARMIN_BULK_IN_AVAIL_REPLY,
1309 sizeof(GARMIN_BULK_IN_AVAIL_REPLY))) {
1310
1311 dbg("%s - bulk data available.", __func__);
1312
1313 if (0 == (garmin_data_p->flags & FLAGS_BULK_IN_ACTIVE)) {
1314
1315 /* bulk data available */
1316 usb_fill_bulk_urb(port->read_urb, serial->dev,
1317 usb_rcvbulkpipe(serial->dev,
1318 port->bulk_in_endpointAddress),
1319 port->read_urb->transfer_buffer,
1320 port->read_urb->transfer_buffer_length,
1321 garmin_read_bulk_callback, port);
1322 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1323 if (retval) {
1324 dev_err(&port->dev,
1325 "%s - failed submitting read urb, error %d\n",
1326 __func__, retval);
1327 } else {
1328 spin_lock_irqsave(&garmin_data_p->lock, flags);
1329 garmin_data_p->flags |= FLAGS_BULK_IN_ACTIVE;
1330 spin_unlock_irqrestore(&garmin_data_p->lock,
1331 flags);
1332 }
1333 } else {
1334 /* bulk-in transfer still active */
1335 spin_lock_irqsave(&garmin_data_p->lock, flags);
1336 garmin_data_p->flags |= FLAGS_BULK_IN_RESTART;
1337 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1338 }
1339
1340 } else if (urb->actual_length == (4+sizeof(GARMIN_START_SESSION_REPLY))
1341 && 0 == memcmp(data, GARMIN_START_SESSION_REPLY,
1342 sizeof(GARMIN_START_SESSION_REPLY))) {
1343
1344 spin_lock_irqsave(&garmin_data_p->lock, flags);
1345 garmin_data_p->flags |= FLAGS_SESSION_REPLY1_SEEN;
1346 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1347
1348 /* save the serial number */
1349 garmin_data_p->serial_num = __le32_to_cpup(
1350 (__le32 *)(data+GARMIN_PKTHDR_LENGTH));
1351
1352 dbg("%s - start-of-session reply seen - serial %u.",
1353 __func__, garmin_data_p->serial_num);
1354 }
1355
1356 garmin_read_process(garmin_data_p, data, urb->actual_length, 0);
1357
1358 port->interrupt_in_urb->dev = port->serial->dev;
1359 retval = usb_submit_urb(urb, GFP_ATOMIC);
1360 if (retval)
1361 dev_err(&urb->dev->dev,
1362 "%s - Error %d submitting interrupt urb\n",
1363 __func__, retval);
1364 }
1365
1366
1367 /*
1368 * Sends the next queued packt to the tty port (garmin native mode only)
1369 * and then sets a timer to call itself again until all queued data
1370 * is sent.
1371 */
1372 static int garmin_flush_queue(struct garmin_data *garmin_data_p)
1373 {
1374 unsigned long flags;
1375 struct garmin_packet *pkt;
1376
1377 if ((garmin_data_p->flags & FLAGS_THROTTLED) == 0) {
1378 pkt = pkt_pop(garmin_data_p);
1379 if (pkt != NULL) {
1380 send_to_tty(garmin_data_p->port, pkt->data, pkt->size);
1381 kfree(pkt);
1382 mod_timer(&garmin_data_p->timer, (1)+jiffies);
1383
1384 } else {
1385 spin_lock_irqsave(&garmin_data_p->lock, flags);
1386 garmin_data_p->flags &= ~FLAGS_QUEUING;
1387 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1388 }
1389 }
1390 return 0;
1391 }
1392
1393
1394 static void garmin_throttle(struct tty_struct *tty)
1395 {
1396 struct usb_serial_port *port = tty->driver_data;
1397 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1398
1399 dbg("%s - port %d", __func__, port->number);
1400 /* set flag, data received will be put into a queue
1401 for later processing */
1402 spin_lock_irq(&garmin_data_p->lock);
1403 garmin_data_p->flags |= FLAGS_QUEUING|FLAGS_THROTTLED;
1404 spin_unlock_irq(&garmin_data_p->lock);
1405 }
1406
1407
1408 static void garmin_unthrottle(struct tty_struct *tty)
1409 {
1410 struct usb_serial_port *port = tty->driver_data;
1411 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1412 int status;
1413
1414 dbg("%s - port %d", __func__, port->number);
1415 spin_lock_irq(&garmin_data_p->lock);
1416 garmin_data_p->flags &= ~FLAGS_THROTTLED;
1417 spin_unlock_irq(&garmin_data_p->lock);
1418
1419 /* in native mode send queued data to tty, in
1420 serial mode nothing needs to be done here */
1421 if (garmin_data_p->mode == MODE_NATIVE)
1422 garmin_flush_queue(garmin_data_p);
1423
1424 if (0 != (garmin_data_p->flags & FLAGS_BULK_IN_ACTIVE)) {
1425 status = usb_submit_urb(port->read_urb, GFP_KERNEL);
1426 if (status)
1427 dev_err(&port->dev,
1428 "%s - failed resubmitting read urb, error %d\n",
1429 __func__, status);
1430 }
1431 }
1432
1433 /*
1434 * The timer is currently only used to send queued packets to
1435 * the tty in cases where the protocol provides no own handshaking
1436 * to initiate the transfer.
1437 */
1438 static void timeout_handler(unsigned long data)
1439 {
1440 struct garmin_data *garmin_data_p = (struct garmin_data *) data;
1441
1442 /* send the next queued packet to the tty port */
1443 if (garmin_data_p->mode == MODE_NATIVE)
1444 if (garmin_data_p->flags & FLAGS_QUEUING)
1445 garmin_flush_queue(garmin_data_p);
1446 }
1447
1448
1449
1450 static int garmin_attach(struct usb_serial *serial)
1451 {
1452 int status = 0;
1453 struct usb_serial_port *port = serial->port[0];
1454 struct garmin_data *garmin_data_p = NULL;
1455
1456 dbg("%s", __func__);
1457
1458 garmin_data_p = kzalloc(sizeof(struct garmin_data), GFP_KERNEL);
1459 if (garmin_data_p == NULL) {
1460 dev_err(&port->dev, "%s - Out of memory\n", __func__);
1461 return -ENOMEM;
1462 }
1463 init_timer(&garmin_data_p->timer);
1464 spin_lock_init(&garmin_data_p->lock);
1465 INIT_LIST_HEAD(&garmin_data_p->pktlist);
1466 /* garmin_data_p->timer.expires = jiffies + session_timeout; */
1467 garmin_data_p->timer.data = (unsigned long)garmin_data_p;
1468 garmin_data_p->timer.function = timeout_handler;
1469 garmin_data_p->port = port;
1470 garmin_data_p->state = 0;
1471 garmin_data_p->flags = 0;
1472 garmin_data_p->count = 0;
1473 usb_set_serial_port_data(port, garmin_data_p);
1474
1475 status = garmin_init_session(port);
1476
1477 return status;
1478 }
1479
1480
1481 static void garmin_disconnect(struct usb_serial *serial)
1482 {
1483 struct usb_serial_port *port = serial->port[0];
1484 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1485
1486 dbg("%s", __func__);
1487
1488 usb_kill_urb(port->interrupt_in_urb);
1489 del_timer_sync(&garmin_data_p->timer);
1490 }
1491
1492
1493 static void garmin_release(struct usb_serial *serial)
1494 {
1495 struct usb_serial_port *port = serial->port[0];
1496 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1497
1498 dbg("%s", __func__);
1499
1500 kfree(garmin_data_p);
1501 }
1502
1503
1504 /* All of the device info needed */
1505 static struct usb_serial_driver garmin_device = {
1506 .driver = {
1507 .owner = THIS_MODULE,
1508 .name = "garmin_gps",
1509 },
1510 .description = "Garmin GPS usb/tty",
1511 .usb_driver = &garmin_driver,
1512 .id_table = id_table,
1513 .num_ports = 1,
1514 .open = garmin_open,
1515 .close = garmin_close,
1516 .throttle = garmin_throttle,
1517 .unthrottle = garmin_unthrottle,
1518 .attach = garmin_attach,
1519 .disconnect = garmin_disconnect,
1520 .release = garmin_release,
1521 .write = garmin_write,
1522 .write_room = garmin_write_room,
1523 .write_bulk_callback = garmin_write_bulk_callback,
1524 .read_bulk_callback = garmin_read_bulk_callback,
1525 .read_int_callback = garmin_read_int_callback,
1526 };
1527
1528
1529
1530 static int __init garmin_init(void)
1531 {
1532 int retval;
1533
1534 retval = usb_serial_register(&garmin_device);
1535 if (retval)
1536 goto failed_garmin_register;
1537 retval = usb_register(&garmin_driver);
1538 if (retval)
1539 goto failed_usb_register;
1540 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1541 DRIVER_DESC "\n");
1542
1543 return 0;
1544 failed_usb_register:
1545 usb_serial_deregister(&garmin_device);
1546 failed_garmin_register:
1547 return retval;
1548 }
1549
1550
1551 static void __exit garmin_exit(void)
1552 {
1553 usb_deregister(&garmin_driver);
1554 usb_serial_deregister(&garmin_device);
1555 }
1556
1557
1558
1559
1560 module_init(garmin_init);
1561 module_exit(garmin_exit);
1562
1563 MODULE_AUTHOR(DRIVER_AUTHOR);
1564 MODULE_DESCRIPTION(DRIVER_DESC);
1565 MODULE_LICENSE("GPL");
1566
1567 module_param(debug, bool, S_IWUSR | S_IRUGO);
1568 MODULE_PARM_DESC(debug, "Debug enabled or not");
1569 module_param(initial_mode, int, S_IRUGO);
1570 MODULE_PARM_DESC(initial_mode, "Initial mode");
1571
Linux 2.6 ibm-acpi/thinkpad-acpi driver git tree