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