garmin_gps.c 40 KB

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