blob: a42b29a695b2a6995a4e331197bc1a2c35a0fa36 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Garmin GPS driver
3 *
Hermann Kneisselb4072f42009-04-26 22:42:04 +02004 * Copyright (C) 2006-2009 Hermann Kneissel herkne@users.sourceforge.net
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#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>
Alan Coxaf6d7802008-07-22 11:11:44 +010036#include <linux/uaccess.h>
Hermann Kneissel468d1362007-08-03 20:20:33 +020037#include <asm/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/usb.h>
Greg Kroah-Hartmana9698882006-07-11 21:22:58 -070039#include <linux/usb/serial.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41/* the mode to be set when the port ist opened */
42static int initial_mode = 1;
43
44/* debug flag */
Alan Coxaf6d7802008-07-22 11:11:44 +010045static int debug;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define GARMIN_VENDOR_ID 0x091E
48
49/*
50 * Version Information
51 */
52
53#define VERSION_MAJOR 0
Hermann Kneisselb4072f42009-04-26 22:42:04 +020054#define VERSION_MINOR 33
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56#define _STR(s) #s
Alan Coxaf6d7802008-07-22 11:11:44 +010057#define _DRIVER_VERSION(a, b) "v" _STR(a) "." _STR(b)
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#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
Alan Coxaf6d7802008-07-22 11:11:44 +010066/* size of the header of a packet using the usb protocol */
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#define GARMIN_PKTHDR_LENGTH 12
68
Alan Coxaf6d7802008-07-22 11:11:44 +010069/* max. possible size of a packet using the serial protocol */
70#define MAX_SERIAL_PKT_SIZ (3 + 255 + 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Alan Coxaf6d7802008-07-22 11:11:44 +010072/* max. possible size of a packet with worst case stuffing */
73#define MAX_SERIAL_PKT_SIZ_STUFFED (MAX_SERIAL_PKT_SIZ + 256)
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Alan Coxaf6d7802008-07-22 11:11:44 +010075/* 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Alan Coxaf6d7802008-07-22 11:11:44 +010083/* 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Alan Coxaf6d7802008-07-22 11:11:44 +010086/* 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089#define GSP_INITIAL_OFFSET (GARMIN_PKTHDR_LENGTH-2)
90
Alan Coxaf6d7802008-07-22 11:11:44 +010091/* max. size of incoming private packets (header+1 param) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070092#define PRIVPKTSIZ (GARMIN_PKTHDR_LENGTH+4)
93
94#define GARMIN_LAYERID_TRANSPORT 0
95#define GARMIN_LAYERID_APPL 20
Alan Coxaf6d7802008-07-22 11:11:44 +010096/* our own layer-id to use for some control mechanisms */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#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
Alan Coxaf6d7802008-07-22 11:11:44 +0100104/* packet ids used in private layer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105#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;
Alan Coxaf6d7802008-07-22 11:11:44 +0100122 /* the real size of the data array, always > 0 */
123 int size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 __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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 __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
Alan Coxaf6d7802008-07-22 11:11:44 +0100163/* Flags used in garmin_data.flags: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164#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
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200168#define FLAGS_BULK_IN_RESTART 0x0010
169#define FLAGS_THROTTLED 0x0008
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200170#define APP_REQ_SEEN 0x0004
171#define APP_RESP_SEEN 0x0002
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172#define CLEAR_HALT_REQUIRED 0x0001
173
174#define FLAGS_QUEUING 0x0100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175#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 */
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200186static int gsp_next_packet(struct garmin_data *garmin_data_p);
187static int garmin_write_bulk(struct usb_serial_port *port,
Hermann Kneissel468d1362007-08-03 20:20:33 +0200188 const unsigned char *buf, int count,
189 int dismiss_ack);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
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 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194static unsigned char const GARMIN_START_SESSION_REPLY[]
195 = { 0, 0, 0, 0, 6, 0, 0, 0, 4, 0, 0, 0 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196static 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
Németh Márton7d40d7e2010-01-10 15:34:24 +0100213static const struct usb_device_id id_table[] = {
Alan Coxaf6d7802008-07-22 11:11:44 +0100214 /* the same device id seems to be used by all
215 usb enabled GPS devices */
216 { USB_DEVICE(GARMIN_VENDOR_ID, 3) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 { } /* Terminating entry */
218};
219
Alan Coxaf6d7802008-07-22 11:11:44 +0100220MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222static struct usb_driver garmin_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 .name = "garmin_gps",
224 .probe = usb_serial_probe,
225 .disconnect = usb_serial_disconnect,
226 .id_table = id_table,
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200227 .no_dynamic_id = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228};
229
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231static 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{
Alan Coxaf6d7802008-07-22 11:11:44 +0100253 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)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 return 1;
258 else
259 return 0;
260}
261
262
263
264static void send_to_tty(struct usb_serial_port *port,
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200265 char *data, unsigned int actual_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266{
Alan Cox4a90f092008-10-13 10:39:46 +0100267 struct tty_struct *tty = tty_port_tty_get(&port->port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269 if (tty && actual_length) {
270
Alan Coxaf6d7802008-07-22 11:11:44 +0100271 usb_serial_debug_data(debug, &port->dev,
Harvey Harrison441b62c2008-03-03 16:08:34 -0800272 __func__, actual_length, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
Alan Cox33f0f882006-01-09 20:54:13 -0800274 tty_insert_flip_string(tty, data, actual_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 tty_flip_buffer_push(tty);
276 }
Alan Cox4a90f092008-10-13 10:39:46 +0100277 tty_kref_put(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278}
279
280
281/******************************************************************************
282 * packet queue handling
283 ******************************************************************************/
284
285/*
286 * queue a received (usb-)packet for later processing
287 */
Alan Coxaf6d7802008-07-22 11:11:44 +0100288static int pkt_add(struct garmin_data *garmin_data_p,
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200289 unsigned char *data, unsigned int data_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200291 int state = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 int result = 0;
293 unsigned long flags;
294 struct garmin_packet *pkt;
295
296 /* process only packets containg data ... */
297 if (data_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 pkt = kmalloc(sizeof(struct garmin_packet)+data_length,
Alan Coxaf6d7802008-07-22 11:11:44 +0100299 GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 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);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200308 garmin_data_p->flags |= FLAGS_QUEUING;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 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);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200312 state = garmin_data_p->state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
314
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200315 dbg("%s - added: pkt: %d - %d bytes",
316 __func__, pkt->seq, data_length);
317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 /* in serial mode, if someone is waiting for data from
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200319 the device, convert and send the next packet to tty. */
Alan Coxaf6d7802008-07-22 11:11:44 +0100320 if (result && (state == STATE_GSP_WAIT_DATA))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 gsp_next_packet(garmin_data_p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 }
323 return result;
324}
325
326
327/* get the next pending packet */
Alan Coxaf6d7802008-07-22 11:11:44 +0100328static struct garmin_packet *pkt_pop(struct garmin_data *garmin_data_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329{
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 */
Alan Coxaf6d7802008-07-22 11:11:44 +0100344static void pkt_clear(struct garmin_data *garmin_data_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345{
346 unsigned long flags;
347 struct garmin_packet *result = NULL;
348
Harvey Harrison441b62c2008-03-03 16:08:34 -0800349 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
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 */
Alan Coxaf6d7802008-07-22 11:11:44 +0100366static int gsp_send_ack(struct garmin_data *garmin_data_p, __u8 pkt_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367{
368 __u8 pkt[10];
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200369 __u8 cksum = 0;
370 __u8 *ptr = pkt;
371 unsigned l = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Harvey Harrison441b62c2008-03-03 16:08:34 -0800373 dbg("%s - pkt-id: 0x%X.", __func__, 0xFF & pkt_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
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
Alan Coxaf6d7802008-07-22 11:11:44 +0100385 if (pkt_id == DLE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 *ptr++ = DLE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
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 *
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200404 * the complete packet (pktid ... cksum) is in garmin_data_p->inbuf starting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 * at GSP_INITIAL_OFFSET.
406 *
407 * count - number of bytes in the input buffer including space reserved for
Alan Coxaf6d7802008-07-22 11:11:44 +0100408 * the usb header: GSP_INITIAL_OFFSET + number of bytes in packet
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 * (including pkt-id, data-length a. cksum)
410 */
Alan Coxaf6d7802008-07-22 11:11:44 +0100411static int gsp_rec_packet(struct garmin_data *garmin_data_p, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412{
Alan Coxaf6d7802008-07-22 11:11:44 +0100413 const __u8 *recpkt = garmin_data_p->inbuffer+GSP_INITIAL_OFFSET;
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200414 __le32 *usbdata = (__le32 *) garmin_data_p->inbuffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416 int cksum = 0;
417 int n = 0;
418 int pktid = recpkt[0];
419 int size = recpkt[1];
420
421 usb_serial_debug_data(debug, &garmin_data_p->port->dev,
Harvey Harrison441b62c2008-03-03 16:08:34 -0800422 __func__, count-GSP_INITIAL_OFFSET, recpkt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
424 if (size != (count-GSP_INITIAL_OFFSET-3)) {
425 dbg("%s - invalid size, expected %d bytes, got %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800426 __func__, size, (count-GSP_INITIAL_OFFSET-3));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 return -EINVPKT;
428 }
429
430 cksum += *recpkt++;
431 cksum += *recpkt++;
432
Alan Coxaf6d7802008-07-22 11:11:44 +0100433 /* sanity check, remove after test ... */
434 if ((__u8 *)&(usbdata[3]) != recpkt) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 dbg("%s - ptr mismatch %p - %p",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800436 __func__, &(usbdata[4]), recpkt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 return -EINVPKT;
438 }
439
440 while (n < size) {
441 cksum += *recpkt++;
442 n++;
443 }
444
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200445 if ((0xff & (cksum + *recpkt)) != 0) {
446 dbg("%s - invalid checksum, expected %02x, got %02x",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800447 __func__, 0xff & -cksum, 0xff & *recpkt);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200448 return -EINVPKT;
449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
451 usbdata[0] = __cpu_to_le32(GARMIN_LAYERID_APPL);
452 usbdata[1] = __cpu_to_le32(pktid);
453 usbdata[2] = __cpu_to_le32(size);
454
Alan Coxaf6d7802008-07-22 11:11:44 +0100455 garmin_write_bulk(garmin_data_p->port, garmin_data_p->inbuffer,
Hermann Kneissel468d1362007-08-03 20:20:33 +0200456 GARMIN_PKTHDR_LENGTH+size, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
458 /* if this was an abort-transfer command, flush all
459 queued data. */
460 if (isAbortTrfCmnd(garmin_data_p->inbuffer)) {
461 garmin_data_p->flags |= FLAGS_DROP_DATA;
462 pkt_clear(garmin_data_p);
463 }
464
465 return count;
466}
467
468
469
470/*
471 * Called for data received from tty
472 *
473 * buf contains the data read, it may span more than one packet or even
474 * incomplete packets
475 *
476 * input record should be a serial-record, but it may not be complete.
477 * Copy it into our local buffer, until an etx is seen (or an error
478 * occurs).
479 * Once the record is complete, convert into a usb packet and send it
480 * to the bulk pipe, send an ack back to the tty.
481 *
482 * If the input is an ack, just send the last queued packet to the
483 * tty layer.
484 *
485 * if the input is an abort command, drop all queued data.
486 */
487
Alan Coxaf6d7802008-07-22 11:11:44 +0100488static int gsp_receive(struct garmin_data *garmin_data_p,
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200489 const unsigned char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200491 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 int offs = 0;
493 int ack_or_nak_seen = 0;
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200494 __u8 *dest;
495 int size;
Alan Coxaf6d7802008-07-22 11:11:44 +0100496 /* dleSeen: set if last byte read was a DLE */
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200497 int dleSeen;
Alan Coxaf6d7802008-07-22 11:11:44 +0100498 /* skip: if set, skip incoming data until possible start of
499 * new packet
500 */
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200501 int skip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 __u8 data;
503
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200504 spin_lock_irqsave(&garmin_data_p->lock, flags);
505 dest = garmin_data_p->inbuffer;
506 size = garmin_data_p->insize;
507 dleSeen = garmin_data_p->flags & FLAGS_GSP_DLESEEN;
508 skip = garmin_data_p->flags & FLAGS_GSP_SKIP;
509 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
510
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200511 /* dbg("%s - dle=%d skip=%d size=%d count=%d",
512 __func__, dleSeen, skip, size, count); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Alan Coxaf6d7802008-07-22 11:11:44 +0100514 if (size == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 size = GSP_INITIAL_OFFSET;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
517 while (offs < count) {
518
519 data = *(buf+offs);
Alan Coxaf6d7802008-07-22 11:11:44 +0100520 offs++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
522 if (data == DLE) {
523 if (skip) { /* start of a new pkt */
524 skip = 0;
525 size = GSP_INITIAL_OFFSET;
526 dleSeen = 1;
527 } else if (dleSeen) {
528 dest[size++] = data;
529 dleSeen = 0;
530 } else {
531 dleSeen = 1;
532 }
533 } else if (data == ETX) {
534 if (dleSeen) {
535 /* packet complete */
536
537 data = dest[GSP_INITIAL_OFFSET];
538
539 if (data == ACK) {
540 ack_or_nak_seen = ACK;
541 dbg("ACK packet complete.");
542 } else if (data == NAK) {
543 ack_or_nak_seen = NAK;
544 dbg("NAK packet complete.");
545 } else {
Alan Coxaf6d7802008-07-22 11:11:44 +0100546 dbg("packet complete - id=0x%X.",
547 0xFF & data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 gsp_rec_packet(garmin_data_p, size);
549 }
550
551 skip = 1;
552 size = GSP_INITIAL_OFFSET;
553 dleSeen = 0;
554 } else {
555 dest[size++] = data;
556 }
557 } else if (!skip) {
558
559 if (dleSeen) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 size = GSP_INITIAL_OFFSET;
561 dleSeen = 0;
562 }
563
564 dest[size++] = data;
565 }
566
567 if (size >= GPS_IN_BUFSIZ) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800568 dbg("%s - packet too large.", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 skip = 1;
570 size = GSP_INITIAL_OFFSET;
571 dleSeen = 0;
572 }
573 }
574
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200575 spin_lock_irqsave(&garmin_data_p->lock, flags);
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 garmin_data_p->insize = size;
578
Alan Coxaf6d7802008-07-22 11:11:44 +0100579 /* copy flags back to structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 if (skip)
581 garmin_data_p->flags |= FLAGS_GSP_SKIP;
582 else
583 garmin_data_p->flags &= ~FLAGS_GSP_SKIP;
584
585 if (dleSeen)
586 garmin_data_p->flags |= FLAGS_GSP_DLESEEN;
587 else
588 garmin_data_p->flags &= ~FLAGS_GSP_DLESEEN;
589
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200590 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
591
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200592 if (ack_or_nak_seen) {
593 if (gsp_next_packet(garmin_data_p) > 0)
594 garmin_data_p->state = STATE_ACTIVE;
595 else
596 garmin_data_p->state = STATE_GSP_WAIT_DATA;
597 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 return count;
599}
600
601
602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603/*
604 * Sends a usb packet to the tty
605 *
606 * Assumes, that all packages and at an usb-packet boundary.
607 *
608 * return <0 on error, 0 if packet is incomplete or > 0 if packet was sent
609 */
Alan Coxaf6d7802008-07-22 11:11:44 +0100610static int gsp_send(struct garmin_data *garmin_data_p,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 const unsigned char *buf, int count)
612{
613 const unsigned char *src;
614 unsigned char *dst;
615 int pktid = 0;
616 int datalen = 0;
617 int cksum = 0;
Alan Coxaf6d7802008-07-22 11:11:44 +0100618 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 int k;
620
Harvey Harrison441b62c2008-03-03 16:08:34 -0800621 dbg("%s - state %d - %d bytes.", __func__,
Alan Coxaf6d7802008-07-22 11:11:44 +0100622 garmin_data_p->state, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
624 k = garmin_data_p->outsize;
625 if ((k+count) > GPS_OUT_BUFSIZ) {
626 dbg("packet too large");
627 garmin_data_p->outsize = 0;
628 return -4;
629 }
630
631 memcpy(garmin_data_p->outbuffer+k, buf, count);
632 k += count;
633 garmin_data_p->outsize = k;
634
635 if (k >= GARMIN_PKTHDR_LENGTH) {
636 pktid = getPacketId(garmin_data_p->outbuffer);
Alan Coxaf6d7802008-07-22 11:11:44 +0100637 datalen = getDataLength(garmin_data_p->outbuffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 i = GARMIN_PKTHDR_LENGTH + datalen;
639 if (k < i)
640 return 0;
641 } else {
642 return 0;
643 }
644
Alan Coxaf6d7802008-07-22 11:11:44 +0100645 dbg("%s - %d bytes in buffer, %d bytes in pkt.", __func__, k, i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
647 /* garmin_data_p->outbuffer now contains a complete packet */
648
649 usb_serial_debug_data(debug, &garmin_data_p->port->dev,
Alan Coxaf6d7802008-07-22 11:11:44 +0100650 __func__, k, garmin_data_p->outbuffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
652 garmin_data_p->outsize = 0;
653
654 if (GARMIN_LAYERID_APPL != getLayerId(garmin_data_p->outbuffer)) {
Alan Coxaf6d7802008-07-22 11:11:44 +0100655 dbg("not an application packet (%d)",
656 getLayerId(garmin_data_p->outbuffer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 return -1;
658 }
659
660 if (pktid > 255) {
661 dbg("packet-id %d too large", pktid);
662 return -2;
663 }
664
665 if (datalen > 255) {
666 dbg("packet-size %d too large", datalen);
667 return -3;
668 }
669
670 /* the serial protocol should be able to handle this packet */
671
672 k = 0;
673 src = garmin_data_p->outbuffer+GARMIN_PKTHDR_LENGTH;
Alan Coxaf6d7802008-07-22 11:11:44 +0100674 for (i = 0; i < datalen; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 if (*src++ == DLE)
676 k++;
677 }
678
679 src = garmin_data_p->outbuffer+GARMIN_PKTHDR_LENGTH;
680 if (k > (GARMIN_PKTHDR_LENGTH-2)) {
Alan Coxaf6d7802008-07-22 11:11:44 +0100681 /* can't add stuffing DLEs in place, move data to end
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200682 of buffer ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 dst = garmin_data_p->outbuffer+GPS_OUT_BUFSIZ-datalen;
684 memcpy(dst, src, datalen);
685 src = dst;
686 }
687
688 dst = garmin_data_p->outbuffer;
689
690 *dst++ = DLE;
691 *dst++ = pktid;
692 cksum += pktid;
693 *dst++ = datalen;
694 cksum += datalen;
695 if (datalen == DLE)
696 *dst++ = DLE;
697
Alan Coxaf6d7802008-07-22 11:11:44 +0100698 for (i = 0; i < datalen; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 __u8 c = *src++;
700 *dst++ = c;
701 cksum += c;
702 if (c == DLE)
703 *dst++ = DLE;
704 }
Alan Coxaf6d7802008-07-22 11:11:44 +0100705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 cksum = 0xFF & -cksum;
707 *dst++ = cksum;
708 if (cksum == DLE)
709 *dst++ = DLE;
710 *dst++ = DLE;
711 *dst++ = ETX;
712
713 i = dst-garmin_data_p->outbuffer;
714
715 send_to_tty(garmin_data_p->port, garmin_data_p->outbuffer, i);
716
717 garmin_data_p->pkt_id = pktid;
718 garmin_data_p->state = STATE_WAIT_TTY_ACK;
719
720 return i;
721}
722
723
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724/*
725 * Process the next pending data packet - if there is one
726 */
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200727static int gsp_next_packet(struct garmin_data *garmin_data_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200729 int result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 struct garmin_packet *pkt = NULL;
731
732 while ((pkt = pkt_pop(garmin_data_p)) != NULL) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800733 dbg("%s - next pkt: %d", __func__, pkt->seq);
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200734 result = gsp_send(garmin_data_p, pkt->data, pkt->size);
735 if (result > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 kfree(pkt);
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200737 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 }
739 kfree(pkt);
740 }
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200741 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742}
743
744
745
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746/******************************************************************************
747 * garmin native mode
748 ******************************************************************************/
749
750
751/*
752 * Called for data received from tty
753 *
754 * The input data is expected to be in garmin usb-packet format.
755 *
756 * buf contains the data read, it may span more than one packet
757 * or even incomplete packets
758 */
Alan Coxaf6d7802008-07-22 11:11:44 +0100759static int nat_receive(struct garmin_data *garmin_data_p,
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200760 const unsigned char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200762 unsigned long flags;
Alan Coxaf6d7802008-07-22 11:11:44 +0100763 __u8 *dest;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 int offs = 0;
765 int result = count;
766 int len;
767
768 while (offs < count) {
Alan Coxaf6d7802008-07-22 11:11:44 +0100769 /* if buffer contains header, copy rest of data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 if (garmin_data_p->insize >= GARMIN_PKTHDR_LENGTH)
771 len = GARMIN_PKTHDR_LENGTH
772 +getDataLength(garmin_data_p->inbuffer);
773 else
774 len = GARMIN_PKTHDR_LENGTH;
775
776 if (len >= GPS_IN_BUFSIZ) {
Alan Coxaf6d7802008-07-22 11:11:44 +0100777 /* seems to be an invalid packet, ignore rest
778 of input */
779 dbg("%s - packet size too large: %d", __func__, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 garmin_data_p->insize = 0;
781 count = 0;
782 result = -EINVPKT;
783 } else {
784 len -= garmin_data_p->insize;
785 if (len > (count-offs))
786 len = (count-offs);
787 if (len > 0) {
788 dest = garmin_data_p->inbuffer
Alan Coxaf6d7802008-07-22 11:11:44 +0100789 + garmin_data_p->insize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 memcpy(dest, buf+offs, len);
791 garmin_data_p->insize += len;
792 offs += len;
793 }
794 }
795
796 /* do we have a complete packet ? */
797 if (garmin_data_p->insize >= GARMIN_PKTHDR_LENGTH) {
798 len = GARMIN_PKTHDR_LENGTH+
799 getDataLength(garmin_data_p->inbuffer);
800 if (garmin_data_p->insize >= len) {
Alan Coxaf6d7802008-07-22 11:11:44 +0100801 garmin_write_bulk(garmin_data_p->port,
802 garmin_data_p->inbuffer,
803 len, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 garmin_data_p->insize = 0;
805
806 /* if this was an abort-transfer command,
807 flush all queued data. */
808 if (isAbortTrfCmnd(garmin_data_p->inbuffer)) {
Alan Coxaf6d7802008-07-22 11:11:44 +0100809 spin_lock_irqsave(&garmin_data_p->lock,
810 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 garmin_data_p->flags |= FLAGS_DROP_DATA;
Alan Coxaf6d7802008-07-22 11:11:44 +0100812 spin_unlock_irqrestore(
813 &garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 pkt_clear(garmin_data_p);
815 }
816 }
817 }
818 }
819 return result;
820}
821
822
823/******************************************************************************
824 * private packets
825 ******************************************************************************/
826
827static void priv_status_resp(struct usb_serial_port *port)
828{
Alan Coxaf6d7802008-07-22 11:11:44 +0100829 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 __le32 *pkt = (__le32 *)garmin_data_p->privpkt;
831
832 pkt[0] = __cpu_to_le32(GARMIN_LAYERID_PRIVATE);
833 pkt[1] = __cpu_to_le32(PRIV_PKTID_INFO_RESP);
834 pkt[2] = __cpu_to_le32(12);
835 pkt[3] = __cpu_to_le32(VERSION_MAJOR << 16 | VERSION_MINOR);
836 pkt[4] = __cpu_to_le32(garmin_data_p->mode);
837 pkt[5] = __cpu_to_le32(garmin_data_p->serial_num);
838
Alan Coxaf6d7802008-07-22 11:11:44 +0100839 send_to_tty(port, (__u8 *)pkt, 6 * 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840}
841
842
843/******************************************************************************
844 * Garmin specific driver functions
845 ******************************************************************************/
846
847static int process_resetdev_request(struct usb_serial_port *port)
848{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200849 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 int status;
Alan Coxaf6d7802008-07-22 11:11:44 +0100851 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200853 spin_lock_irqsave(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 garmin_data_p->flags &= ~(CLEAR_HALT_REQUIRED);
855 garmin_data_p->state = STATE_RESET;
856 garmin_data_p->serial_num = 0;
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200857 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
Alan Coxaf6d7802008-07-22 11:11:44 +0100859 usb_kill_urb(port->interrupt_in_urb);
860 dbg("%s - usb_reset_device", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 status = usb_reset_device(port->serial->dev);
862 if (status)
863 dbg("%s - usb_reset_device failed: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800864 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 return status;
866}
867
868
869
870/*
871 * clear all cached data
872 */
Alan Coxaf6d7802008-07-22 11:11:44 +0100873static int garmin_clear(struct garmin_data *garmin_data_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200875 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 int status = 0;
877
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 /* flush all queued data */
879 pkt_clear(garmin_data_p);
880
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200881 spin_lock_irqsave(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 garmin_data_p->insize = 0;
883 garmin_data_p->outsize = 0;
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200884 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
886 return status;
887}
888
889
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890static int garmin_init_session(struct usb_serial_port *port)
891{
892 struct usb_serial *serial = port->serial;
Alan Coxaf6d7802008-07-22 11:11:44 +0100893 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 int status = 0;
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200895 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
897 if (status == 0) {
Alan Coxaf6d7802008-07-22 11:11:44 +0100898 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Harvey Harrison441b62c2008-03-03 16:08:34 -0800900 dbg("%s - adding interrupt input", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 port->interrupt_in_urb->dev = serial->dev;
902 status = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
903 if (status)
904 dev_err(&serial->dev->dev,
Alan Coxaf6d7802008-07-22 11:11:44 +0100905 "%s - failed submitting interrupt urb, error %d\n",
906 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 }
908
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200909 /*
910 * using the initialization method from gpsbabel. See comments in
911 * gpsbabel/jeeps/gpslibusb.c gusb_reset_toggles()
912 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 if (status == 0) {
Harvey Harrison441b62c2008-03-03 16:08:34 -0800914 dbg("%s - starting session ...", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 garmin_data_p->state = STATE_ACTIVE;
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200916
917 for (i = 0; i < 3; i++) {
918 status = garmin_write_bulk(port,
919 GARMIN_START_SESSION_REQ,
Alan Coxaf6d7802008-07-22 11:11:44 +0100920 sizeof(GARMIN_START_SESSION_REQ), 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200922 if (status < 0)
923 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 }
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200925
926 if (status > 0)
927 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 }
929
930 return status;
931}
932
933
934
Alan Coxa509a7e2009-09-19 13:13:26 -0700935static int garmin_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200937 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 int status = 0;
Alan Coxaf6d7802008-07-22 11:11:44 +0100939 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Harvey Harrison441b62c2008-03-03 16:08:34 -0800941 dbg("%s - port %d", __func__, port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200943 spin_lock_irqsave(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 garmin_data_p->mode = initial_mode;
945 garmin_data_p->count = 0;
946 garmin_data_p->flags = 0;
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +0200947 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948
949 /* shutdown any bulk reads that might be going on */
Alan Coxaf6d7802008-07-22 11:11:44 +0100950 usb_kill_urb(port->write_urb);
951 usb_kill_urb(port->read_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Alan Cox95da3102008-07-22 11:09:07 +0100953 if (garmin_data_p->state == STATE_RESET)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 status = garmin_init_session(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955
956 garmin_data_p->state = STATE_ACTIVE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 return status;
958}
959
960
Alan Cox335f8512009-06-11 12:26:29 +0100961static void garmin_close(struct usb_serial_port *port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962{
963 struct usb_serial *serial = port->serial;
Alan Coxaf6d7802008-07-22 11:11:44 +0100964 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Harvey Harrison441b62c2008-03-03 16:08:34 -0800966 dbg("%s - port %d - mode=%d state=%d flags=0x%X", __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 port->number, garmin_data_p->mode,
968 garmin_data_p->state, garmin_data_p->flags);
969
970 if (!serial)
971 return;
972
Oliver Neukum95bef012008-01-22 13:56:18 +0100973 mutex_lock(&port->serial->disc_mutex);
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200974
Oliver Neukum95bef012008-01-22 13:56:18 +0100975 if (!port->serial->disconnected)
976 garmin_clear(garmin_data_p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
978 /* shutdown our urbs */
Alan Coxaf6d7802008-07-22 11:11:44 +0100979 usb_kill_urb(port->read_urb);
980 usb_kill_urb(port->write_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200982 /* keep reset state so we know that we must start a new session */
983 if (garmin_data_p->state != STATE_RESET)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 garmin_data_p->state = STATE_DISCONNECTED;
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200985
Oliver Neukum95bef012008-01-22 13:56:18 +0100986 mutex_unlock(&port->serial->disc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987}
988
Hermann Kneisselb4072f42009-04-26 22:42:04 +0200989
Alan Coxaf6d7802008-07-22 11:11:44 +0100990static void garmin_write_bulk_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991{
Ming Leicdc97792008-02-24 18:41:47 +0800992 struct usb_serial_port *port = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Hermann Kneissel468d1362007-08-03 20:20:33 +0200994 if (port) {
Alan Coxaf6d7802008-07-22 11:11:44 +0100995 struct garmin_data *garmin_data_p =
996 usb_get_serial_port_data(port);
Hermann Kneissel468d1362007-08-03 20:20:33 +0200997
Harvey Harrison441b62c2008-03-03 16:08:34 -0800998 dbg("%s - port %d", __func__, port->number);
Hermann Kneissel468d1362007-08-03 20:20:33 +0200999
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001000 if (GARMIN_LAYERID_APPL == getLayerId(urb->transfer_buffer)) {
1001
1002 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1003 gsp_send_ack(garmin_data_p,
Alan Coxaf6d7802008-07-22 11:11:44 +01001004 ((__u8 *)urb->transfer_buffer)[4]);
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001005 }
Hermann Kneissel468d1362007-08-03 20:20:33 +02001006 }
Hermann Kneissel468d1362007-08-03 20:20:33 +02001007 usb_serial_port_softint(port);
1008 }
1009
Alan Coxaf6d7802008-07-22 11:11:44 +01001010 /* Ignore errors that resulted from garmin_write_bulk with
1011 dismiss_ack = 1 */
Hermann Kneissel468d1362007-08-03 20:20:33 +02001012
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 /* free up the transfer buffer, as usb_free_urb() does not do this */
Alan Coxaf6d7802008-07-22 11:11:44 +01001014 kfree(urb->transfer_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015}
1016
1017
Alan Coxaf6d7802008-07-22 11:11:44 +01001018static int garmin_write_bulk(struct usb_serial_port *port,
Hermann Kneissel468d1362007-08-03 20:20:33 +02001019 const unsigned char *buf, int count,
1020 int dismiss_ack)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001022 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 struct usb_serial *serial = port->serial;
Alan Coxaf6d7802008-07-22 11:11:44 +01001024 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 struct urb *urb;
1026 unsigned char *buffer;
1027 int status;
1028
Harvey Harrison441b62c2008-03-03 16:08:34 -08001029 dbg("%s - port %d, state %d", __func__, port->number,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 garmin_data_p->state);
1031
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001032 spin_lock_irqsave(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 garmin_data_p->flags &= ~FLAGS_DROP_DATA;
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001034 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Alan Coxaf6d7802008-07-22 11:11:44 +01001036 buffer = kmalloc(count, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 if (!buffer) {
1038 dev_err(&port->dev, "out of memory\n");
1039 return -ENOMEM;
1040 }
1041
1042 urb = usb_alloc_urb(0, GFP_ATOMIC);
1043 if (!urb) {
1044 dev_err(&port->dev, "no more free urbs\n");
Alan Coxaf6d7802008-07-22 11:11:44 +01001045 kfree(buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 return -ENOMEM;
1047 }
1048
Alan Coxaf6d7802008-07-22 11:11:44 +01001049 memcpy(buffer, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
Harvey Harrison441b62c2008-03-03 16:08:34 -08001051 usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
Alan Coxaf6d7802008-07-22 11:11:44 +01001053 usb_fill_bulk_urb(urb, serial->dev,
1054 usb_sndbulkpipe(serial->dev,
1055 port->bulk_out_endpointAddress),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 buffer, count,
Hermann Kneissel468d1362007-08-03 20:20:33 +02001057 garmin_write_bulk_callback,
1058 dismiss_ack ? NULL : port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 urb->transfer_flags |= URB_ZERO_PACKET;
1060
1061 if (GARMIN_LAYERID_APPL == getLayerId(buffer)) {
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001062
1063 spin_lock_irqsave(&garmin_data_p->lock, flags);
1064 garmin_data_p->flags |= APP_REQ_SEEN;
1065 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1066
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1068 pkt_clear(garmin_data_p);
1069 garmin_data_p->state = STATE_GSP_WAIT_DATA;
1070 }
1071 }
1072
1073 /* send it down the pipe */
1074 status = usb_submit_urb(urb, GFP_ATOMIC);
1075 if (status) {
1076 dev_err(&port->dev,
Alan Coxaf6d7802008-07-22 11:11:44 +01001077 "%s - usb_submit_urb(write bulk) failed with status = %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001078 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 count = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 }
1081
1082 /* we are done with this urb, so let the host driver
1083 * really free it when it is finished with it */
Alan Coxaf6d7802008-07-22 11:11:44 +01001084 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085
1086 return count;
1087}
1088
Alan Coxaf6d7802008-07-22 11:11:44 +01001089static int garmin_write(struct tty_struct *tty, struct usb_serial_port *port,
Alan Cox95da3102008-07-22 11:09:07 +01001090 const unsigned char *buf, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091{
1092 int pktid, pktsiz, len;
Alan Coxaf6d7802008-07-22 11:11:44 +01001093 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 __le32 *privpkt = (__le32 *)garmin_data_p->privpkt;
1095
Harvey Harrison441b62c2008-03-03 16:08:34 -08001096 usb_serial_debug_data(debug, &port->dev, __func__, count, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001098 if (garmin_data_p->state == STATE_RESET)
1099 return -EIO;
1100
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 /* check for our private packets */
1102 if (count >= GARMIN_PKTHDR_LENGTH) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 len = PRIVPKTSIZ;
1104 if (count < len)
1105 len = count;
1106
1107 memcpy(garmin_data_p->privpkt, buf, len);
1108
1109 pktsiz = getDataLength(garmin_data_p->privpkt);
1110 pktid = getPacketId(garmin_data_p->privpkt);
1111
1112 if (count == (GARMIN_PKTHDR_LENGTH+pktsiz)
Alan Coxaf6d7802008-07-22 11:11:44 +01001113 && GARMIN_LAYERID_PRIVATE ==
1114 getLayerId(garmin_data_p->privpkt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115
1116 dbg("%s - processing private request %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001117 __func__, pktid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
Alan Coxaf6d7802008-07-22 11:11:44 +01001119 /* drop all unfinished transfers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 garmin_clear(garmin_data_p);
1121
Alan Coxaf6d7802008-07-22 11:11:44 +01001122 switch (pktid) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
1124 case PRIV_PKTID_SET_DEBUG:
1125 if (pktsiz != 4)
1126 return -EINVPKT;
1127 debug = __le32_to_cpu(privpkt[3]);
1128 dbg("%s - debug level set to 0x%X",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001129 __func__, debug);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 break;
1131
1132 case PRIV_PKTID_SET_MODE:
1133 if (pktsiz != 4)
1134 return -EINVPKT;
1135 garmin_data_p->mode = __le32_to_cpu(privpkt[3]);
1136 dbg("%s - mode set to %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001137 __func__, garmin_data_p->mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 break;
1139
1140 case PRIV_PKTID_INFO_REQ:
1141 priv_status_resp(port);
1142 break;
1143
1144 case PRIV_PKTID_RESET_REQ:
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001145 process_resetdev_request(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 break;
1147
1148 case PRIV_PKTID_SET_DEF_MODE:
1149 if (pktsiz != 4)
1150 return -EINVPKT;
1151 initial_mode = __le32_to_cpu(privpkt[3]);
1152 dbg("%s - initial_mode set to %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001153 __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 garmin_data_p->mode);
1155 break;
1156 }
1157 return count;
1158 }
1159 }
1160
1161 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
1162 return gsp_receive(garmin_data_p, buf, count);
1163 } else { /* MODE_NATIVE */
1164 return nat_receive(garmin_data_p, buf, count);
1165 }
1166}
1167
1168
Alan Cox95da3102008-07-22 11:09:07 +01001169static int garmin_write_room(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170{
Alan Cox95da3102008-07-22 11:09:07 +01001171 struct usb_serial_port *port = tty->driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 /*
1173 * Report back the bytes currently available in the output buffer.
1174 */
Alan Coxaf6d7802008-07-22 11:11:44 +01001175 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 return GPS_OUT_BUFSIZ-garmin_data_p->outsize;
1177}
1178
1179
Alan Coxaf6d7802008-07-22 11:11:44 +01001180static void garmin_read_process(struct garmin_data *garmin_data_p,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 unsigned char *data, unsigned data_length)
1182{
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001183 unsigned long flags;
1184
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 if (garmin_data_p->flags & FLAGS_DROP_DATA) {
1186 /* abort-transfer cmd is actice */
Harvey Harrison441b62c2008-03-03 16:08:34 -08001187 dbg("%s - pkt dropped", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 } else if (garmin_data_p->state != STATE_DISCONNECTED &&
Alan Coxaf6d7802008-07-22 11:11:44 +01001189 garmin_data_p->state != STATE_RESET) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 /* if throttling is active or postprecessing is required
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001192 put the received data in the input queue, otherwise
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 send it directly to the tty port */
1194 if (garmin_data_p->flags & FLAGS_QUEUING) {
1195 pkt_add(garmin_data_p, data, data_length);
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001196 } else if (getLayerId(data) == GARMIN_LAYERID_APPL) {
1197
1198 spin_lock_irqsave(&garmin_data_p->lock, flags);
1199 garmin_data_p->flags |= APP_RESP_SEEN;
1200 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
1201
1202 if (garmin_data_p->mode == MODE_GARMIN_SERIAL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 pkt_add(garmin_data_p, data, data_length);
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001204 } else {
1205 send_to_tty(garmin_data_p->port, data,
1206 data_length);
1207 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 }
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001209 /* ignore system layer packets ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 }
1211}
1212
1213
Alan Coxaf6d7802008-07-22 11:11:44 +01001214static void garmin_read_bulk_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001216 unsigned long flags;
Ming Leicdc97792008-02-24 18:41:47 +08001217 struct usb_serial_port *port = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 struct usb_serial *serial = port->serial;
Alan Coxaf6d7802008-07-22 11:11:44 +01001219 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 unsigned char *data = urb->transfer_buffer;
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001221 int status = urb->status;
1222 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
Harvey Harrison441b62c2008-03-03 16:08:34 -08001224 dbg("%s - port %d", __func__, port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
1226 if (!serial) {
Harvey Harrison441b62c2008-03-03 16:08:34 -08001227 dbg("%s - bad serial pointer, exiting", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 return;
1229 }
1230
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001231 if (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 dbg("%s - nonzero read bulk status received: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001233 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 return;
1235 }
1236
Alan Coxaf6d7802008-07-22 11:11:44 +01001237 usb_serial_debug_data(debug, &port->dev,
Harvey Harrison441b62c2008-03-03 16:08:34 -08001238 __func__, urb->actual_length, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
1240 garmin_read_process(garmin_data_p, data, urb->actual_length);
1241
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001242 if (urb->actual_length == 0 &&
1243 0 != (garmin_data_p->flags & FLAGS_BULK_IN_RESTART)) {
1244 spin_lock_irqsave(&garmin_data_p->lock, flags);
1245 garmin_data_p->flags &= ~FLAGS_BULK_IN_RESTART;
1246 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001247 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1248 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 dev_err(&port->dev,
1250 "%s - failed resubmitting read urb, error %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001251 __func__, retval);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001252 } else if (urb->actual_length > 0) {
1253 /* Continue trying to read until nothing more is received */
1254 if (0 == (garmin_data_p->flags & FLAGS_THROTTLED)) {
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001255 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1256 if (retval)
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001257 dev_err(&port->dev,
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001258 "%s - failed resubmitting read urb, "
Harvey Harrison441b62c2008-03-03 16:08:34 -08001259 "error %d\n", __func__, retval);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001260 }
1261 } else {
Harvey Harrison441b62c2008-03-03 16:08:34 -08001262 dbg("%s - end of bulk data", __func__);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001263 spin_lock_irqsave(&garmin_data_p->lock, flags);
1264 garmin_data_p->flags &= ~FLAGS_BULK_IN_ACTIVE;
1265 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 }
1267 return;
1268}
1269
1270
Alan Coxaf6d7802008-07-22 11:11:44 +01001271static void garmin_read_int_callback(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001273 unsigned long flags;
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001274 int retval;
Ming Leicdc97792008-02-24 18:41:47 +08001275 struct usb_serial_port *port = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 struct usb_serial *serial = port->serial;
Alan Coxaf6d7802008-07-22 11:11:44 +01001277 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 unsigned char *data = urb->transfer_buffer;
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001279 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001281 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 case 0:
1283 /* success */
1284 break;
1285 case -ECONNRESET:
1286 case -ENOENT:
1287 case -ESHUTDOWN:
1288 /* this urb is terminated, clean up */
1289 dbg("%s - urb shutting down with status: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001290 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 return;
1292 default:
1293 dbg("%s - nonzero urb status received: %d",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001294 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 return;
1296 }
1297
Harvey Harrison441b62c2008-03-03 16:08:34 -08001298 usb_serial_debug_data(debug, &port->dev, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 urb->actual_length, urb->transfer_buffer);
1300
1301 if (urb->actual_length == sizeof(GARMIN_BULK_IN_AVAIL_REPLY) &&
1302 0 == memcmp(data, GARMIN_BULK_IN_AVAIL_REPLY,
Alan Coxaf6d7802008-07-22 11:11:44 +01001303 sizeof(GARMIN_BULK_IN_AVAIL_REPLY))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
Harvey Harrison441b62c2008-03-03 16:08:34 -08001305 dbg("%s - bulk data available.", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001307 if (0 == (garmin_data_p->flags & FLAGS_BULK_IN_ACTIVE)) {
1308
1309 /* bulk data available */
Alan Coxaf6d7802008-07-22 11:11:44 +01001310 usb_fill_bulk_urb(port->read_urb, serial->dev,
1311 usb_rcvbulkpipe(serial->dev,
1312 port->bulk_in_endpointAddress),
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001313 port->read_urb->transfer_buffer,
1314 port->read_urb->transfer_buffer_length,
1315 garmin_read_bulk_callback, port);
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001316 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1317 if (retval) {
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001318 dev_err(&port->dev,
Alan Coxaf6d7802008-07-22 11:11:44 +01001319 "%s - failed submitting read urb, error %d\n",
1320 __func__, retval);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001321 } else {
1322 spin_lock_irqsave(&garmin_data_p->lock, flags);
1323 garmin_data_p->flags |= FLAGS_BULK_IN_ACTIVE;
Alan Coxaf6d7802008-07-22 11:11:44 +01001324 spin_unlock_irqrestore(&garmin_data_p->lock,
1325 flags);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001326 }
1327 } else {
1328 /* bulk-in transfer still active */
1329 spin_lock_irqsave(&garmin_data_p->lock, flags);
1330 garmin_data_p->flags |= FLAGS_BULK_IN_RESTART;
1331 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 }
1333
1334 } else if (urb->actual_length == (4+sizeof(GARMIN_START_SESSION_REPLY))
1335 && 0 == memcmp(data, GARMIN_START_SESSION_REPLY,
Alan Coxaf6d7802008-07-22 11:11:44 +01001336 sizeof(GARMIN_START_SESSION_REPLY))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001338 spin_lock_irqsave(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 garmin_data_p->flags |= FLAGS_SESSION_REPLY1_SEEN;
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001340 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
1342 /* save the serial number */
Alan Coxaf6d7802008-07-22 11:11:44 +01001343 garmin_data_p->serial_num = __le32_to_cpup(
1344 (__le32 *)(data+GARMIN_PKTHDR_LENGTH));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
1346 dbg("%s - start-of-session reply seen - serial %u.",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001347 __func__, garmin_data_p->serial_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 }
1349
Hermann Kneisselb4072f42009-04-26 22:42:04 +02001350 garmin_read_process(garmin_data_p, data, urb->actual_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
1352 port->interrupt_in_urb->dev = port->serial->dev;
Alan Coxaf6d7802008-07-22 11:11:44 +01001353 retval = usb_submit_urb(urb, GFP_ATOMIC);
Greg Kroah-Hartmanf9feb512007-06-15 15:44:13 -07001354 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 dev_err(&urb->dev->dev,
1356 "%s - Error %d submitting interrupt urb\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001357 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358}
1359
1360
1361/*
1362 * Sends the next queued packt to the tty port (garmin native mode only)
1363 * and then sets a timer to call itself again until all queued data
1364 * is sent.
1365 */
Alan Coxaf6d7802008-07-22 11:11:44 +01001366static int garmin_flush_queue(struct garmin_data *garmin_data_p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367{
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001368 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 struct garmin_packet *pkt;
1370
1371 if ((garmin_data_p->flags & FLAGS_THROTTLED) == 0) {
1372 pkt = pkt_pop(garmin_data_p);
1373 if (pkt != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 send_to_tty(garmin_data_p->port, pkt->data, pkt->size);
1375 kfree(pkt);
1376 mod_timer(&garmin_data_p->timer, (1)+jiffies);
1377
1378 } else {
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001379 spin_lock_irqsave(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 garmin_data_p->flags &= ~FLAGS_QUEUING;
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001381 spin_unlock_irqrestore(&garmin_data_p->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 }
1383 }
1384 return 0;
1385}
1386
1387
Alan Cox95da3102008-07-22 11:09:07 +01001388static void garmin_throttle(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389{
Alan Cox95da3102008-07-22 11:09:07 +01001390 struct usb_serial_port *port = tty->driver_data;
Alan Coxaf6d7802008-07-22 11:11:44 +01001391 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Harvey Harrison441b62c2008-03-03 16:08:34 -08001393 dbg("%s - port %d", __func__, port->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 /* set flag, data received will be put into a queue
1395 for later processing */
Oliver Neukum63832512009-10-07 10:50:23 +02001396 spin_lock_irq(&garmin_data_p->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 garmin_data_p->flags |= FLAGS_QUEUING|FLAGS_THROTTLED;
Oliver Neukum63832512009-10-07 10:50:23 +02001398 spin_unlock_irq(&garmin_data_p->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399}
1400
1401
Alan Coxaf6d7802008-07-22 11:11:44 +01001402static void garmin_unthrottle(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403{
Alan Cox95da3102008-07-22 11:09:07 +01001404 struct usb_serial_port *port = tty->driver_data;
Alan Coxaf6d7802008-07-22 11:11:44 +01001405 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001406 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
Harvey Harrison441b62c2008-03-03 16:08:34 -08001408 dbg("%s - port %d", __func__, port->number);
Oliver Neukum63832512009-10-07 10:50:23 +02001409 spin_lock_irq(&garmin_data_p->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 garmin_data_p->flags &= ~FLAGS_THROTTLED;
Oliver Neukum63832512009-10-07 10:50:23 +02001411 spin_unlock_irq(&garmin_data_p->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
1413 /* in native mode send queued data to tty, in
1414 serial mode nothing needs to be done here */
1415 if (garmin_data_p->mode == MODE_NATIVE)
1416 garmin_flush_queue(garmin_data_p);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001417
1418 if (0 != (garmin_data_p->flags & FLAGS_BULK_IN_ACTIVE)) {
Oliver Neukum63832512009-10-07 10:50:23 +02001419 status = usb_submit_urb(port->read_urb, GFP_KERNEL);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001420 if (status)
1421 dev_err(&port->dev,
1422 "%s - failed resubmitting read urb, error %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -08001423 __func__, status);
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001424 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425}
1426
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427/*
1428 * The timer is currently only used to send queued packets to
1429 * the tty in cases where the protocol provides no own handshaking
1430 * to initiate the transfer.
1431 */
1432static void timeout_handler(unsigned long data)
1433{
1434 struct garmin_data *garmin_data_p = (struct garmin_data *) data;
1435
1436 /* send the next queued packet to the tty port */
1437 if (garmin_data_p->mode == MODE_NATIVE)
1438 if (garmin_data_p->flags & FLAGS_QUEUING)
1439 garmin_flush_queue(garmin_data_p);
1440}
1441
1442
1443
Alan Cox95da3102008-07-22 11:09:07 +01001444static int garmin_attach(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445{
1446 int status = 0;
1447 struct usb_serial_port *port = serial->port[0];
Alan Coxaf6d7802008-07-22 11:11:44 +01001448 struct garmin_data *garmin_data_p = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449
Harvey Harrison441b62c2008-03-03 16:08:34 -08001450 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Burman Yan7ac9da12006-11-22 20:54:38 +02001452 garmin_data_p = kzalloc(sizeof(struct garmin_data), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 if (garmin_data_p == NULL) {
Harvey Harrison441b62c2008-03-03 16:08:34 -08001454 dev_err(&port->dev, "%s - Out of memory\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 return -ENOMEM;
1456 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 init_timer(&garmin_data_p->timer);
1458 spin_lock_init(&garmin_data_p->lock);
1459 INIT_LIST_HEAD(&garmin_data_p->pktlist);
Alan Coxaf6d7802008-07-22 11:11:44 +01001460 /* garmin_data_p->timer.expires = jiffies + session_timeout; */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 garmin_data_p->timer.data = (unsigned long)garmin_data_p;
1462 garmin_data_p->timer.function = timeout_handler;
1463 garmin_data_p->port = port;
1464 garmin_data_p->state = 0;
1465 garmin_data_p->count = 0;
1466 usb_set_serial_port_data(port, garmin_data_p);
1467
1468 status = garmin_init_session(port);
1469
1470 return status;
1471}
1472
1473
Alan Sternf9c99bb2009-06-02 11:53:55 -04001474static void garmin_disconnect(struct usb_serial *serial)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475{
1476 struct usb_serial_port *port = serial->port[0];
Alan Coxaf6d7802008-07-22 11:11:44 +01001477 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
Harvey Harrison441b62c2008-03-03 16:08:34 -08001479 dbg("%s", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Alan Coxaf6d7802008-07-22 11:11:44 +01001481 usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 del_timer_sync(&garmin_data_p->timer);
Alan Sternf9c99bb2009-06-02 11:53:55 -04001483}
1484
1485
1486static void garmin_release(struct usb_serial *serial)
1487{
1488 struct usb_serial_port *port = serial->port[0];
1489 struct garmin_data *garmin_data_p = usb_get_serial_port_data(port);
1490
1491 dbg("%s", __func__);
1492
Alan Coxaf6d7802008-07-22 11:11:44 +01001493 kfree(garmin_data_p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494}
1495
1496
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497/* All of the device info needed */
Greg Kroah-Hartmanea653702005-06-20 21:15:16 -07001498static struct usb_serial_driver garmin_device = {
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -07001499 .driver = {
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001500 .owner = THIS_MODULE,
1501 .name = "garmin_gps",
Greg Kroah-Hartman18fcac32005-06-20 21:15:16 -07001502 },
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001503 .description = "Garmin GPS usb/tty",
Johannes Hölzld9b1b782006-12-17 21:50:24 +01001504 .usb_driver = &garmin_driver,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 .id_table = id_table,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 .num_ports = 1,
1507 .open = garmin_open,
1508 .close = garmin_close,
1509 .throttle = garmin_throttle,
1510 .unthrottle = garmin_unthrottle,
1511 .attach = garmin_attach,
Alan Sternf9c99bb2009-06-02 11:53:55 -04001512 .disconnect = garmin_disconnect,
1513 .release = garmin_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 .write = garmin_write,
1515 .write_room = garmin_write_room,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 .write_bulk_callback = garmin_write_bulk_callback,
1517 .read_bulk_callback = garmin_read_bulk_callback,
1518 .read_int_callback = garmin_read_int_callback,
1519};
1520
1521
Hermann Kneisseleb6d8c22006-07-11 19:41:33 +02001522
Alan Coxaf6d7802008-07-22 11:11:44 +01001523static int __init garmin_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524{
1525 int retval;
1526
1527 retval = usb_serial_register(&garmin_device);
1528 if (retval)
1529 goto failed_garmin_register;
1530 retval = usb_register(&garmin_driver);
1531 if (retval)
1532 goto failed_usb_register;
Greg Kroah-Hartmanc197a8d2008-08-18 13:21:04 -07001533 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1534 DRIVER_DESC "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
1536 return 0;
1537failed_usb_register:
1538 usb_serial_deregister(&garmin_device);
1539failed_garmin_register:
1540 return retval;
1541}
1542
1543
Alan Coxaf6d7802008-07-22 11:11:44 +01001544static void __exit garmin_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545{
Alan Coxaf6d7802008-07-22 11:11:44 +01001546 usb_deregister(&garmin_driver);
1547 usb_serial_deregister(&garmin_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548}
1549
1550
1551
1552
1553module_init(garmin_init);
1554module_exit(garmin_exit);
1555
Alan Coxaf6d7802008-07-22 11:11:44 +01001556MODULE_AUTHOR(DRIVER_AUTHOR);
1557MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558MODULE_LICENSE("GPL");
1559
1560module_param(debug, bool, S_IWUSR | S_IRUGO);
1561MODULE_PARM_DESC(debug, "Debug enabled or not");
1562module_param(initial_mode, int, S_IRUGO);
1563MODULE_PARM_DESC(initial_mode, "Initial mode");
1564