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