4 * Copyright (C) 2006-2011 Hermann Kneissel herkne@gmx.de
6 * The latest version of the driver can be found at
7 * http://sourceforge.net/projects/garmin-gps/
9 * This driver has been derived from v2.1 of the visor driver.
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.
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.
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
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>
41 /* the mode to be set when the port ist opened */
42 static int initial_mode = 1;
47 #define GARMIN_VENDOR_ID 0x091E
53 #define VERSION_MAJOR 0
54 #define VERSION_MINOR 36
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"
62 /* error codes returned by the driver */
63 #define EINVPKT 1000 /* invalid packet structure */
66 /* size of the header of a packet using the usb protocol */
67 #define GARMIN_PKTHDR_LENGTH 12
69 /* max. possible size of a packet using the serial protocol */
70 #define MAX_SERIAL_PKT_SIZ (3 + 255 + 3)
72 /* max. possible size of a packet with worst case stuffing */
73 #define MAX_SERIAL_PKT_SIZ_STUFFED (MAX_SERIAL_PKT_SIZ + 256)
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)
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)
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
89 #define GSP_INITIAL_OFFSET (GARMIN_PKTHDR_LENGTH-2)
91 /* max. size of incoming private packets (header+1 param) */
92 #define PRIVPKTSIZ (GARMIN_PKTHDR_LENGTH+4)
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
99 #define GARMIN_PKTID_PVT_DATA 51
100 #define GARMIN_PKTID_L001_COMMAND_DATA 10
102 #define CMND_ABORT_TRANSFER 0
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
118 /* structure used to queue incoming packets */
119 struct garmin_packet {
120 struct list_head list;
122 /* the real size of the data array, always > 0 */
127 /* structure used to keep the current state of the driver */
135 struct timer_list timer;
136 struct usb_serial_port *port;
140 __u8 inbuffer [GPS_IN_BUFSIZ]; /* tty -> usb */
141 __u8 outbuffer[GPS_OUT_BUFSIZ]; /* usb -> tty */
144 struct list_head pktlist;
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
155 #define STATE_RESET 8
156 #define STATE_DISCONNECTED 9
157 #define STATE_WAIT_TTY_ACK 10
158 #define STATE_GSP_WAIT_DATA 11
160 #define MODE_NATIVE 0
161 #define MODE_GARMIN_SERIAL 1
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
174 #define FLAGS_QUEUING 0x0100
175 #define FLAGS_DROP_DATA 0x0800
177 #define FLAGS_GSP_SKIP 0x1000
178 #define FLAGS_GSP_DLESEEN 0x2000
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,
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[]
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 };
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 */
220 MODULE_DEVICE_TABLE(usb, id_table);
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,
230 static inline int getLayerId(const __u8 *usbPacket)
232 return __le32_to_cpup((__le32 *)(usbPacket));
235 static inline int getPacketId(const __u8 *usbPacket)
237 return __le32_to_cpup((__le32 *)(usbPacket+4));
240 static inline int getDataLength(const __u8 *usbPacket)
242 return __le32_to_cpup((__le32 *)(usbPacket+8));
247 * check if the usb-packet in buf contains an abort-transfer command.
248 * (if yes, all queued data will be dropped)
250 static inline int isAbortTrfCmnd(const unsigned char *buf)
252 if (0 == memcmp(buf, GARMIN_STOP_TRANSFER_REQ,
253 sizeof(GARMIN_STOP_TRANSFER_REQ)) ||
254 0 == memcmp(buf, GARMIN_STOP_TRANSFER_REQ_V2,
255 sizeof(GARMIN_STOP_TRANSFER_REQ_V2)))
263 static void send_to_tty(struct usb_serial_port *port,
264 char *data, unsigned int actual_length)
266 struct tty_struct *tty = tty_port_tty_get(&port->port);
268 if (tty && actual_length) {
270 usb_serial_debug_data(debug, &port->dev,
271 __func__, actual_length, data);
273 tty_insert_flip_string(tty, data, actual_length);
274 tty_flip_buffer_push(tty);
280 /******************************************************************************
281 * packet queue handling
282 ******************************************************************************/
285 * queue a received (usb-)packet for later processing
287 static int pkt_add(struct garmin_data *garmin_data_p,
288 unsigned char *data, unsigned int data_length)
293 struct garmin_packet *pkt;
295 /* process only packets containg data ... */
297 pkt = kmalloc(sizeof(struct garmin_packet)+data_length,
300 dev_err(&garmin_data_p->port->dev, "out of memory\n");
303 pkt->size = data_length;
304 memcpy(pkt->data, data, data_length);
306 spin_lock_irqsave(&garmin_data_p->lock, flags);
307 garmin_data_p->flags |= FLAGS_QUEUING;
308 result = list_empty(&garmin_data_p->pktlist);
309 pkt->seq = garmin_data_p->seq_counter++;
310 list_add_tail(&pkt->list, &garmin_data_p->pktlist);
311 state = garmin_data_p->state;
312 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
314 dbg("%s - added: pkt: %d - %d bytes",
315 __func__, pkt->seq, data_length);
317 /* in serial mode, if someone is waiting for data from
318 the device, convert and send the next packet to tty. */
319 if (result && (state == STATE_GSP_WAIT_DATA))
320 gsp_next_packet(garmin_data_p);
326 /* get the next pending packet */
327 static struct garmin_packet *pkt_pop(struct garmin_data *garmin_data_p)
330 struct garmin_packet *result = NULL;
332 spin_lock_irqsave(&garmin_data_p->lock, flags);
333 if (!list_empty(&garmin_data_p->pktlist)) {
334 result = (struct garmin_packet *)garmin_data_p->pktlist.next;
335 list_del(&result->list);
337 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
342 /* free up all queued data */
343 static void pkt_clear(struct garmin_data *garmin_data_p)
346 struct garmin_packet *result = NULL;
350 spin_lock_irqsave(&garmin_data_p->lock, flags);
351 while (!list_empty(&garmin_data_p->pktlist)) {
352 result = (struct garmin_packet *)garmin_data_p->pktlist.next;
353 list_del(&result->list);
356 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
360 /******************************************************************************
361 * garmin serial protocol handling handling
362 ******************************************************************************/
364 /* send an ack packet back to the tty */
365 static int gsp_send_ack(struct garmin_data *garmin_data_p, __u8 pkt_id)
372 dbg("%s - pkt-id: 0x%X.", __func__, 0xFF & pkt_id);
388 *ptr++ = 0xFF & (-cksum);
394 send_to_tty(garmin_data_p->port, pkt, l);
401 * called for a complete packet received from tty layer
403 * the complete packet (pktid ... cksum) is in garmin_data_p->inbuf starting
404 * at GSP_INITIAL_OFFSET.
406 * count - number of bytes in the input buffer including space reserved for
407 * the usb header: GSP_INITIAL_OFFSET + number of bytes in packet
408 * (including pkt-id, data-length a. cksum)
410 static int gsp_rec_packet(struct garmin_data *garmin_data_p, int count)
413 const __u8 *recpkt = garmin_data_p->inbuffer+GSP_INITIAL_OFFSET;
414 __le32 *usbdata = (__le32 *) garmin_data_p->inbuffer;
418 int pktid = recpkt[0];
419 int size = recpkt[1];
421 usb_serial_debug_data(debug, &garmin_data_p->port->dev,
422 __func__, count-GSP_INITIAL_OFFSET, recpkt);
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));
433 /* sanity check, remove after test ... */
434 if ((__u8 *)&(usbdata[3]) != recpkt) {
435 dbg("%s - ptr mismatch %p - %p",
436 __func__, &(usbdata[4]), recpkt);
445 if ((0xff & (cksum + *recpkt)) != 0) {
446 dbg("%s - invalid checksum, expected %02x, got %02x",
447 __func__, 0xff & -cksum, 0xff & *recpkt);
451 usbdata[0] = __cpu_to_le32(GARMIN_LAYERID_APPL);
452 usbdata[1] = __cpu_to_le32(pktid);
453 usbdata[2] = __cpu_to_le32(size);
455 garmin_write_bulk(garmin_data_p->port, garmin_data_p->inbuffer,
456 GARMIN_PKTHDR_LENGTH+size, 0);
458 /* if this was an abort-transfer command, flush all
460 if (isAbortTrfCmnd(garmin_data_p->inbuffer)) {
461 spin_lock_irqsave(&garmin_data_p->lock, flags);
462 garmin_data_p->flags |= FLAGS_DROP_DATA;
463 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
464 pkt_clear(garmin_data_p);
473 * Called for data received from tty
475 * buf contains the data read, it may span more than one packet or even
478 * input record should be a serial-record, but it may not be complete.
479 * Copy it into our local buffer, until an etx is seen (or an error
481 * Once the record is complete, convert into a usb packet and send it
482 * to the bulk pipe, send an ack back to the tty.
484 * If the input is an ack, just send the last queued packet to the
487 * if the input is an abort command, drop all queued data.
490 static int gsp_receive(struct garmin_data *garmin_data_p,
491 const unsigned char *buf, int count)
495 int ack_or_nak_seen = 0;
498 /* dleSeen: set if last byte read was a DLE */
500 /* skip: if set, skip incoming data until possible start of
506 spin_lock_irqsave(&garmin_data_p->lock, flags);
507 dest = garmin_data_p->inbuffer;
508 size = garmin_data_p->insize;
509 dleSeen = garmin_data_p->flags & FLAGS_GSP_DLESEEN;
510 skip = garmin_data_p->flags & FLAGS_GSP_SKIP;
511 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
513 /* dbg("%s - dle=%d skip=%d size=%d count=%d",
514 __func__, dleSeen, skip, size, count); */
517 size = GSP_INITIAL_OFFSET;
519 while (offs < count) {
525 if (skip) { /* start of a new pkt */
527 size = GSP_INITIAL_OFFSET;
529 } else if (dleSeen) {
535 } else if (data == ETX) {
537 /* packet complete */
539 data = dest[GSP_INITIAL_OFFSET];
542 ack_or_nak_seen = ACK;
543 dbg("ACK packet complete.");
544 } else if (data == NAK) {
545 ack_or_nak_seen = NAK;
546 dbg("NAK packet complete.");
548 dbg("packet complete - id=0x%X.",
550 gsp_rec_packet(garmin_data_p, size);
554 size = GSP_INITIAL_OFFSET;
562 size = GSP_INITIAL_OFFSET;
569 if (size >= GPS_IN_BUFSIZ) {
570 dbg("%s - packet too large.", __func__);
572 size = GSP_INITIAL_OFFSET;
577 spin_lock_irqsave(&garmin_data_p->lock, flags);
579 garmin_data_p->insize = size;
581 /* copy flags back to structure */
583 garmin_data_p->flags |= FLAGS_GSP_SKIP;
585 garmin_data_p->flags &= ~FLAGS_GSP_SKIP;
588 garmin_data_p->flags |= FLAGS_GSP_DLESEEN;
590 garmin_data_p->flags &= ~FLAGS_GSP_DLESEEN;
592 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
594 if (ack_or_nak_seen) {
595 if (gsp_next_packet(garmin_data_p) > 0)
596 garmin_data_p->state = STATE_ACTIVE;
598 garmin_data_p->state = STATE_GSP_WAIT_DATA;
606 * Sends a usb packet to the tty
608 * Assumes, that all packages and at an usb-packet boundary.
610 * return <0 on error, 0 if packet is incomplete or > 0 if packet was sent
612 static int gsp_send(struct garmin_data *garmin_data_p,
613 const unsigned char *buf, int count)
615 const unsigned char *src;
623 dbg("%s - state %d - %d bytes.", __func__,
624 garmin_data_p->state, count);
626 k = garmin_data_p->outsize;
627 if ((k+count) > GPS_OUT_BUFSIZ) {
628 dbg("packet too large");
629 garmin_data_p->outsize = 0;
633 memcpy(garmin_data_p->outbuffer+k, buf, count);
635 garmin_data_p->outsize = k;
637 if (k >= GARMIN_PKTHDR_LENGTH) {
638 pktid = getPacketId(garmin_data_p->outbuffer);
639 datalen = getDataLength(garmin_data_p->outbuffer);
640 i = GARMIN_PKTHDR_LENGTH + datalen;
647 dbg("%s - %d bytes in buffer, %d bytes in pkt.", __func__, k, i);
649 /* garmin_data_p->outbuffer now contains a complete packet */
651 usb_serial_debug_data(debug, &garmin_data_p->port->dev,
652 __func__, k, garmin_data_p->outbuffer);
654 garmin_data_p->outsize = 0;
656 if (GARMIN_LAYERID_APPL != getLayerId(garmin_data_p->outbuffer)) {
657 dbg("not an application packet (%d)",
658 getLayerId(garmin_data_p->outbuffer));
663 dbg("packet-id %d too large", pktid);
668 dbg("packet-size %d too large", datalen);
672 /* the serial protocol should be able to handle this packet */
675 src = garmin_data_p->outbuffer+GARMIN_PKTHDR_LENGTH;
676 for (i = 0; i < datalen; i++) {
681 src = garmin_data_p->outbuffer+GARMIN_PKTHDR_LENGTH;
682 if (k > (GARMIN_PKTHDR_LENGTH-2)) {
683 /* can't add stuffing DLEs in place, move data to end
685 dst = garmin_data_p->outbuffer+GPS_OUT_BUFSIZ-datalen;
686 memcpy(dst, src, datalen);
690 dst = garmin_data_p->outbuffer;
700 for (i = 0; i < datalen; i++) {
708 cksum = 0xFF & -cksum;
715 i = dst-garmin_data_p->outbuffer;
717 send_to_tty(garmin_data_p->port, garmin_data_p->outbuffer, i);
719 garmin_data_p->pkt_id = pktid;
720 garmin_data_p->state = STATE_WAIT_TTY_ACK;
727 * Process the next pending data packet - if there is one
729 static int gsp_next_packet(struct garmin_data *garmin_data_p)
732 struct garmin_packet *pkt = NULL;
734 while ((pkt = pkt_pop(garmin_data_p)) != NULL) {
735 dbg("%s - next pkt: %d", __func__, pkt->seq);
736 result = gsp_send(garmin_data_p, pkt->data, pkt->size);
748 /******************************************************************************
750 ******************************************************************************/
754 * Called for data received from tty
756 * The input data is expected to be in garmin usb-packet format.
758 * buf contains the data read, it may span more than one packet
759 * or even incomplete packets
761 static int nat_receive(struct garmin_data *garmin_data_p,
762 const unsigned char *buf, int count)
770 while (offs < count) {
771 /* if buffer contains header, copy rest of data */
772 if (garmin_data_p->insize >= GARMIN_PKTHDR_LENGTH)
773 len = GARMIN_PKTHDR_LENGTH
774 +getDataLength(garmin_data_p->inbuffer);
776 len = GARMIN_PKTHDR_LENGTH;
778 if (len >= GPS_IN_BUFSIZ) {
779 /* seems to be an invalid packet, ignore rest
781 dbg("%s - packet size too large: %d", __func__, len);
782 garmin_data_p->insize = 0;
786 len -= garmin_data_p->insize;
787 if (len > (count-offs))
790 dest = garmin_data_p->inbuffer
791 + garmin_data_p->insize;
792 memcpy(dest, buf+offs, len);
793 garmin_data_p->insize += len;
798 /* do we have a complete packet ? */
799 if (garmin_data_p->insize >= GARMIN_PKTHDR_LENGTH) {
800 len = GARMIN_PKTHDR_LENGTH+
801 getDataLength(garmin_data_p->inbuffer);
802 if (garmin_data_p->insize >= len) {
803 garmin_write_bulk(garmin_data_p->port,
804 garmin_data_p->inbuffer,
806 garmin_data_p->insize = 0;
808 /* if this was an abort-transfer command,
809 flush all queued data. */
810 if (isAbortTrfCmnd(garmin_data_p->inbuffer)) {
811 spin_lock_irqsave(&garmin_data_p->lock,
813 garmin_data_p->flags |= FLAGS_DROP_DATA;
814 spin_unlock_irqrestore(
815 &garmin_data_p->lock, flags);
816 pkt_clear(garmin_data_p);
825 /******************************************************************************
827 ******************************************************************************/
829 static void priv_status_resp(struct usb_serial_port *port)
831 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
832 __le32 *pkt = (__le32 *)garmin_data_p->privpkt;
834 pkt[0] = __cpu_to_le32(GARMIN_LAYERID_PRIVATE);
835 pkt[1] = __cpu_to_le32(PRIV_PKTID_INFO_RESP);
836 pkt[2] = __cpu_to_le32(12);
837 pkt[3] = __cpu_to_le32(VERSION_MAJOR << 16 | VERSION_MINOR);
838 pkt[4] = __cpu_to_le32(garmin_data_p->mode);
839 pkt[5] = __cpu_to_le32(garmin_data_p->serial_num);
841 send_to_tty(port, (__u8 *)pkt, 6 * 4);
845 /******************************************************************************
846 * Garmin specific driver functions
847 ******************************************************************************/
849 static int process_resetdev_request(struct usb_serial_port *port)
853 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
855 spin_lock_irqsave(&garmin_data_p->lock, flags);
856 garmin_data_p->flags &= ~(CLEAR_HALT_REQUIRED);
857 garmin_data_p->state = STATE_RESET;
858 garmin_data_p->serial_num = 0;
859 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
861 usb_kill_urb(port->interrupt_in_urb);
862 dbg("%s - usb_reset_device", __func__);
863 status = usb_reset_device(port->serial->dev);
865 dbg("%s - usb_reset_device failed: %d",
873 * clear all cached data
875 static int garmin_clear(struct garmin_data *garmin_data_p)
880 /* flush all queued data */
881 pkt_clear(garmin_data_p);
883 spin_lock_irqsave(&garmin_data_p->lock, flags);
884 garmin_data_p->insize = 0;
885 garmin_data_p->outsize = 0;
886 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
892 static int garmin_init_session(struct usb_serial_port *port)
894 struct usb_serial *serial = port->serial;
895 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
900 usb_kill_urb(port->interrupt_in_urb);
902 dbg("%s - adding interrupt input", __func__);
903 status = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
905 dev_err(&serial->dev->dev,
906 "%s - failed submitting interrupt urb, error %d\n",
911 * using the initialization method from gpsbabel. See comments in
912 * gpsbabel/jeeps/gpslibusb.c gusb_reset_toggles()
915 dbg("%s - starting session ...", __func__);
916 garmin_data_p->state = STATE_ACTIVE;
918 for (i = 0; i < 3; i++) {
919 status = garmin_write_bulk(port,
920 GARMIN_START_SESSION_REQ,
921 sizeof(GARMIN_START_SESSION_REQ), 0);
936 static int garmin_open(struct tty_struct *tty, struct usb_serial_port *port)
940 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
942 dbg("%s - port %d", __func__, port->number);
944 spin_lock_irqsave(&garmin_data_p->lock, flags);
945 garmin_data_p->mode = initial_mode;
946 garmin_data_p->count = 0;
947 garmin_data_p->flags &= FLAGS_SESSION_REPLY1_SEEN;
948 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
950 /* shutdown any bulk reads that might be going on */
951 usb_kill_urb(port->write_urb);
952 usb_kill_urb(port->read_urb);
954 if (garmin_data_p->state == STATE_RESET)
955 status = garmin_init_session(port);
957 garmin_data_p->state = STATE_ACTIVE;
962 static void garmin_close(struct usb_serial_port *port)
964 struct usb_serial *serial = port->serial;
965 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
967 dbg("%s - port %d - mode=%d state=%d flags=0x%X", __func__,
968 port->number, garmin_data_p->mode,
969 garmin_data_p->state, garmin_data_p->flags);
974 mutex_lock(&port->serial->disc_mutex);
976 if (!port->serial->disconnected)
977 garmin_clear(garmin_data_p);
979 /* shutdown our urbs */
980 usb_kill_urb(port->read_urb);
981 usb_kill_urb(port->write_urb);
983 /* keep reset state so we know that we must start a new session */
984 if (garmin_data_p->state != STATE_RESET)
985 garmin_data_p->state = STATE_DISCONNECTED;
987 mutex_unlock(&port->serial->disc_mutex);
991 static void garmin_write_bulk_callback(struct urb *urb)
993 struct usb_serial_port *port = urb->context;
996 struct garmin_data *garmin_data_p =
997 usb_get_serial_port_data(port);
999 dbg("%s - port %d", __func__, port->number);
1001 if (GARMIN_LAYERID_APPL == getLayerId(urb->transfer_buffer)) {
1003 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1004 gsp_send_ack(garmin_data_p,
1005 ((__u8 *)urb->transfer_buffer)[4]);
1008 usb_serial_port_softint(port);
1011 /* Ignore errors that resulted from garmin_write_bulk with
1014 /* free up the transfer buffer, as usb_free_urb() does not do this */
1015 kfree(urb->transfer_buffer);
1019 static int garmin_write_bulk(struct usb_serial_port *port,
1020 const unsigned char *buf, int count,
1023 unsigned long flags;
1024 struct usb_serial *serial = port->serial;
1025 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1027 unsigned char *buffer;
1030 dbg("%s - port %d, state %d", __func__, port->number,
1031 garmin_data_p->state);
1033 spin_lock_irqsave(&garmin_data_p->lock, flags);
1034 garmin_data_p->flags &= ~FLAGS_DROP_DATA;
1035 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1037 buffer = kmalloc(count, GFP_ATOMIC);
1039 dev_err(&port->dev, "out of memory\n");
1043 urb = usb_alloc_urb(0, GFP_ATOMIC);
1045 dev_err(&port->dev, "no more free urbs\n");
1050 memcpy(buffer, buf, count);
1052 usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
1054 usb_fill_bulk_urb(urb, serial->dev,
1055 usb_sndbulkpipe(serial->dev,
1056 port->bulk_out_endpointAddress),
1058 garmin_write_bulk_callback,
1059 dismiss_ack ? NULL : port);
1060 urb->transfer_flags |= URB_ZERO_PACKET;
1062 if (GARMIN_LAYERID_APPL == getLayerId(buffer)) {
1064 spin_lock_irqsave(&garmin_data_p->lock, flags);
1065 garmin_data_p->flags |= APP_REQ_SEEN;
1066 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1068 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1069 pkt_clear(garmin_data_p);
1070 garmin_data_p->state = STATE_GSP_WAIT_DATA;
1074 /* send it down the pipe */
1075 status = usb_submit_urb(urb, GFP_ATOMIC);
1078 "%s - usb_submit_urb(write bulk) failed with status = %d\n",
1083 /* we are done with this urb, so let the host driver
1084 * really free it when it is finished with it */
1090 static int garmin_write(struct tty_struct *tty, struct usb_serial_port *port,
1091 const unsigned char *buf, int count)
1093 int pktid, pktsiz, len;
1094 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1095 __le32 *privpkt = (__le32 *)garmin_data_p->privpkt;
1097 usb_serial_debug_data(debug, &port->dev, __func__, count, buf);
1099 if (garmin_data_p->state == STATE_RESET)
1102 /* check for our private packets */
1103 if (count >= GARMIN_PKTHDR_LENGTH) {
1108 memcpy(garmin_data_p->privpkt, buf, len);
1110 pktsiz = getDataLength(garmin_data_p->privpkt);
1111 pktid = getPacketId(garmin_data_p->privpkt);
1113 if (count == (GARMIN_PKTHDR_LENGTH+pktsiz)
1114 && GARMIN_LAYERID_PRIVATE ==
1115 getLayerId(garmin_data_p->privpkt)) {
1117 dbg("%s - processing private request %d",
1120 /* drop all unfinished transfers */
1121 garmin_clear(garmin_data_p);
1125 case PRIV_PKTID_SET_DEBUG:
1128 debug = __le32_to_cpu(privpkt[3]);
1129 dbg("%s - debug level set to 0x%X",
1133 case PRIV_PKTID_SET_MODE:
1136 garmin_data_p->mode = __le32_to_cpu(privpkt[3]);
1137 dbg("%s - mode set to %d",
1138 __func__, garmin_data_p->mode);
1141 case PRIV_PKTID_INFO_REQ:
1142 priv_status_resp(port);
1145 case PRIV_PKTID_RESET_REQ:
1146 process_resetdev_request(port);
1149 case PRIV_PKTID_SET_DEF_MODE:
1152 initial_mode = __le32_to_cpu(privpkt[3]);
1153 dbg("%s - initial_mode set to %d",
1155 garmin_data_p->mode);
1162 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1163 return gsp_receive(garmin_data_p, buf, count);
1164 } else { /* MODE_NATIVE */
1165 return nat_receive(garmin_data_p, buf, count);
1170 static int garmin_write_room(struct tty_struct *tty)
1172 struct usb_serial_port *port = tty->driver_data;
1174 * Report back the bytes currently available in the output buffer.
1176 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1177 return GPS_OUT_BUFSIZ-garmin_data_p->outsize;
1181 static void garmin_read_process(struct garmin_data *garmin_data_p,
1182 unsigned char *data, unsigned data_length,
1185 unsigned long flags;
1187 if (garmin_data_p->flags & FLAGS_DROP_DATA) {
1188 /* abort-transfer cmd is actice */
1189 dbg("%s - pkt dropped", __func__);
1190 } else if (garmin_data_p->state != STATE_DISCONNECTED &&
1191 garmin_data_p->state != STATE_RESET) {
1193 /* if throttling is active or postprecessing is required
1194 put the received data in the input queue, otherwise
1195 send it directly to the tty port */
1196 if (garmin_data_p->flags & FLAGS_QUEUING) {
1197 pkt_add(garmin_data_p, data, data_length);
1198 } else if (bulk_data ||
1199 getLayerId(data) == GARMIN_LAYERID_APPL) {
1201 spin_lock_irqsave(&garmin_data_p->lock, flags);
1202 garmin_data_p->flags |= APP_RESP_SEEN;
1203 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1205 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1206 pkt_add(garmin_data_p, data, data_length);
1208 send_to_tty(garmin_data_p->port, data,
1212 /* ignore system layer packets ... */
1217 static void garmin_read_bulk_callback(struct urb *urb)
1219 unsigned long flags;
1220 struct usb_serial_port *port = urb->context;
1221 struct usb_serial *serial = port->serial;
1222 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1223 unsigned char *data = urb->transfer_buffer;
1224 int status = urb->status;
1227 dbg("%s - port %d", __func__, port->number);
1230 dbg("%s - bad serial pointer, exiting", __func__);
1235 dbg("%s - nonzero read bulk status received: %d",
1240 usb_serial_debug_data(debug, &port->dev,
1241 __func__, urb->actual_length, data);
1243 garmin_read_process(garmin_data_p, data, urb->actual_length, 1);
1245 if (urb->actual_length == 0 &&
1246 0 != (garmin_data_p->flags & FLAGS_BULK_IN_RESTART)) {
1247 spin_lock_irqsave(&garmin_data_p->lock, flags);
1248 garmin_data_p->flags &= ~FLAGS_BULK_IN_RESTART;
1249 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1250 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1253 "%s - failed resubmitting read urb, error %d\n",
1255 } else if (urb->actual_length > 0) {
1256 /* Continue trying to read until nothing more is received */
1257 if (0 == (garmin_data_p->flags & FLAGS_THROTTLED)) {
1258 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1261 "%s - failed resubmitting read urb, "
1262 "error %d\n", __func__, retval);
1265 dbg("%s - end of bulk data", __func__);
1266 spin_lock_irqsave(&garmin_data_p->lock, flags);
1267 garmin_data_p->flags &= ~FLAGS_BULK_IN_ACTIVE;
1268 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1273 static void garmin_read_int_callback(struct urb *urb)
1275 unsigned long flags;
1277 struct usb_serial_port *port = urb->context;
1278 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1279 unsigned char *data = urb->transfer_buffer;
1280 int status = urb->status;
1289 /* this urb is terminated, clean up */
1290 dbg("%s - urb shutting down with status: %d",
1294 dbg("%s - nonzero urb status received: %d",
1299 usb_serial_debug_data(debug, &port->dev, __func__,
1300 urb->actual_length, urb->transfer_buffer);
1302 if (urb->actual_length == sizeof(GARMIN_BULK_IN_AVAIL_REPLY) &&
1303 0 == memcmp(data, GARMIN_BULK_IN_AVAIL_REPLY,
1304 sizeof(GARMIN_BULK_IN_AVAIL_REPLY))) {
1306 dbg("%s - bulk data available.", __func__);
1308 if (0 == (garmin_data_p->flags & FLAGS_BULK_IN_ACTIVE)) {
1310 /* bulk data available */
1311 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1314 "%s - failed submitting read urb, error %d\n",
1317 spin_lock_irqsave(&garmin_data_p->lock, flags);
1318 garmin_data_p->flags |= FLAGS_BULK_IN_ACTIVE;
1319 spin_unlock_irqrestore(&garmin_data_p->lock,
1323 /* bulk-in transfer still active */
1324 spin_lock_irqsave(&garmin_data_p->lock, flags);
1325 garmin_data_p->flags |= FLAGS_BULK_IN_RESTART;
1326 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1329 } else if (urb->actual_length == (4+sizeof(GARMIN_START_SESSION_REPLY))
1330 && 0 == memcmp(data, GARMIN_START_SESSION_REPLY,
1331 sizeof(GARMIN_START_SESSION_REPLY))) {
1333 spin_lock_irqsave(&garmin_data_p->lock, flags);
1334 garmin_data_p->flags |= FLAGS_SESSION_REPLY1_SEEN;
1335 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1337 /* save the serial number */
1338 garmin_data_p->serial_num = __le32_to_cpup(
1339 (__le32 *)(data+GARMIN_PKTHDR_LENGTH));
1341 dbg("%s - start-of-session reply seen - serial %u.",
1342 __func__, garmin_data_p->serial_num);
1345 garmin_read_process(garmin_data_p, data, urb->actual_length, 0);
1347 retval = usb_submit_urb(urb, GFP_ATOMIC);
1349 dev_err(&urb->dev->dev,
1350 "%s - Error %d submitting interrupt urb\n",
1356 * Sends the next queued packt to the tty port (garmin native mode only)
1357 * and then sets a timer to call itself again until all queued data
1360 static int garmin_flush_queue(struct garmin_data *garmin_data_p)
1362 unsigned long flags;
1363 struct garmin_packet *pkt;
1365 if ((garmin_data_p->flags & FLAGS_THROTTLED) == 0) {
1366 pkt = pkt_pop(garmin_data_p);
1368 send_to_tty(garmin_data_p->port, pkt->data, pkt->size);
1370 mod_timer(&garmin_data_p->timer, (1)+jiffies);
1373 spin_lock_irqsave(&garmin_data_p->lock, flags);
1374 garmin_data_p->flags &= ~FLAGS_QUEUING;
1375 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1382 static void garmin_throttle(struct tty_struct *tty)
1384 struct usb_serial_port *port = tty->driver_data;
1385 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1387 dbg("%s - port %d", __func__, port->number);
1388 /* set flag, data received will be put into a queue
1389 for later processing */
1390 spin_lock_irq(&garmin_data_p->lock);
1391 garmin_data_p->flags |= FLAGS_QUEUING|FLAGS_THROTTLED;
1392 spin_unlock_irq(&garmin_data_p->lock);
1396 static void garmin_unthrottle(struct tty_struct *tty)
1398 struct usb_serial_port *port = tty->driver_data;
1399 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1402 dbg("%s - port %d", __func__, port->number);
1403 spin_lock_irq(&garmin_data_p->lock);
1404 garmin_data_p->flags &= ~FLAGS_THROTTLED;
1405 spin_unlock_irq(&garmin_data_p->lock);
1407 /* in native mode send queued data to tty, in
1408 serial mode nothing needs to be done here */
1409 if (garmin_data_p->mode == MODE_NATIVE)
1410 garmin_flush_queue(garmin_data_p);
1412 if (0 != (garmin_data_p->flags & FLAGS_BULK_IN_ACTIVE)) {
1413 status = usb_submit_urb(port->read_urb, GFP_KERNEL);
1416 "%s - failed resubmitting read urb, error %d\n",
1422 * The timer is currently only used to send queued packets to
1423 * the tty in cases where the protocol provides no own handshaking
1424 * to initiate the transfer.
1426 static void timeout_handler(unsigned long data)
1428 struct garmin_data *garmin_data_p = (struct garmin_data *) data;
1430 /* send the next queued packet to the tty port */
1431 if (garmin_data_p->mode == MODE_NATIVE)
1432 if (garmin_data_p->flags & FLAGS_QUEUING)
1433 garmin_flush_queue(garmin_data_p);
1438 static int garmin_attach(struct usb_serial *serial)
1441 struct usb_serial_port *port = serial->port[0];
1442 struct garmin_data *garmin_data_p = NULL;
1444 dbg("%s", __func__);
1446 garmin_data_p = kzalloc(sizeof(struct garmin_data), GFP_KERNEL);
1447 if (garmin_data_p == NULL) {
1448 dev_err(&port->dev, "%s - Out of memory\n", __func__);
1451 init_timer(&garmin_data_p->timer);
1452 spin_lock_init(&garmin_data_p->lock);
1453 INIT_LIST_HEAD(&garmin_data_p->pktlist);
1454 /* garmin_data_p->timer.expires = jiffies + session_timeout; */
1455 garmin_data_p->timer.data = (unsigned long)garmin_data_p;
1456 garmin_data_p->timer.function = timeout_handler;
1457 garmin_data_p->port = port;
1458 garmin_data_p->state = 0;
1459 garmin_data_p->flags = 0;
1460 garmin_data_p->count = 0;
1461 usb_set_serial_port_data(port, garmin_data_p);
1463 status = garmin_init_session(port);
1469 static void garmin_disconnect(struct usb_serial *serial)
1471 struct usb_serial_port *port = serial->port[0];
1472 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1474 dbg("%s", __func__);
1476 usb_kill_urb(port->interrupt_in_urb);
1477 del_timer_sync(&garmin_data_p->timer);
1481 static void garmin_release(struct usb_serial *serial)
1483 struct usb_serial_port *port = serial->port[0];
1484 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1486 dbg("%s", __func__);
1488 kfree(garmin_data_p);
1492 /* All of the device info needed */
1493 static struct usb_serial_driver garmin_device = {
1495 .owner = THIS_MODULE,
1496 .name = "garmin_gps",
1498 .description = "Garmin GPS usb/tty",
1499 .id_table = id_table,
1501 .open = garmin_open,
1502 .close = garmin_close,
1503 .throttle = garmin_throttle,
1504 .unthrottle = garmin_unthrottle,
1505 .attach = garmin_attach,
1506 .disconnect = garmin_disconnect,
1507 .release = garmin_release,
1508 .write = garmin_write,
1509 .write_room = garmin_write_room,
1510 .write_bulk_callback = garmin_write_bulk_callback,
1511 .read_bulk_callback = garmin_read_bulk_callback,
1512 .read_int_callback = garmin_read_int_callback,
1515 static struct usb_serial_driver * const serial_drivers[] = {
1516 &garmin_device, NULL
1519 module_usb_serial_driver(garmin_driver, serial_drivers);
1521 MODULE_AUTHOR(DRIVER_AUTHOR);
1522 MODULE_DESCRIPTION(DRIVER_DESC);
1523 MODULE_LICENSE("GPL");
1525 module_param(debug, bool, S_IWUSR | S_IRUGO);
1526 MODULE_PARM_DESC(debug, "Debug enabled or not");
1527 module_param(initial_mode, int, S_IRUGO);
1528 MODULE_PARM_DESC(initial_mode, "Initial mode");