ipw.c 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. /*
  2. * IPWireless 3G UMTS TDD Modem driver (USB connected)
  3. *
  4. * Copyright (C) 2004 Roelf Diedericks <roelfd@inet.co.za>
  5. * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
  6. *
  7. * This program is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License as published by
  9. * the Free Software Foundation; either version 2 of the License, or
  10. * (at your option) any later version.
  11. *
  12. * All information about the device was acquired using SnoopyPro
  13. * on MSFT's O/S, and examing the MSFT drivers' debug output
  14. * (insanely left _on_ in the enduser version)
  15. *
  16. * It was written out of frustration with the IPWireless USB modem
  17. * supplied by Axity3G/Sentech South Africa not supporting
  18. * Linux whatsoever.
  19. *
  20. * Nobody provided any proprietary information that was not already
  21. * available for this device.
  22. *
  23. * The modem adheres to the "3GPP TS 27.007 AT command set for 3G
  24. * User Equipment (UE)" standard, available from
  25. * http://www.3gpp.org/ftp/Specs/html-info/27007.htm
  26. *
  27. * The code was only tested the IPWireless handheld modem distributed
  28. * in South Africa by Sentech.
  29. *
  30. * It may work for Woosh Inc in .nz too, as it appears they use the
  31. * same kit.
  32. *
  33. * There is still some work to be done in terms of handling
  34. * DCD, DTR, RTS, CTS which are currently faked.
  35. * It's good enough for PPP at this point. It's based off all kinds of
  36. * code found in usb/serial and usb/class
  37. */
  38. #include <linux/kernel.h>
  39. #include <linux/errno.h>
  40. #include <linux/init.h>
  41. #include <linux/slab.h>
  42. #include <linux/tty.h>
  43. #include <linux/tty_flip.h>
  44. #include <linux/module.h>
  45. #include <linux/spinlock.h>
  46. #include <linux/usb.h>
  47. #include <linux/usb/serial.h>
  48. #include <linux/uaccess.h>
  49. #include "usb-wwan.h"
  50. /*
  51. * Version Information
  52. */
  53. #define DRIVER_VERSION "v0.4"
  54. #define DRIVER_AUTHOR "Roelf Diedericks"
  55. #define DRIVER_DESC "IPWireless tty driver"
  56. #define IPW_TTY_MAJOR 240 /* real device node major id, experimental range */
  57. #define IPW_TTY_MINORS 256 /* we support 256 devices, dunno why, it'd be insane :) */
  58. #define USB_IPW_MAGIC 0x6d02 /* magic number for ipw struct */
  59. /* Message sizes */
  60. #define EVENT_BUFFER_SIZE 0xFF
  61. #define CHAR2INT16(c1, c0) (((u32)((c1) & 0xff) << 8) + (u32)((c0) & 0xff))
  62. /* vendor/product pairs that are known work with this driver*/
  63. #define IPW_VID 0x0bc3
  64. #define IPW_PID 0x0001
  65. /* Vendor commands: */
  66. /* baud rates */
  67. enum {
  68. ipw_sio_b256000 = 0x000e,
  69. ipw_sio_b128000 = 0x001d,
  70. ipw_sio_b115200 = 0x0020,
  71. ipw_sio_b57600 = 0x0040,
  72. ipw_sio_b56000 = 0x0042,
  73. ipw_sio_b38400 = 0x0060,
  74. ipw_sio_b19200 = 0x00c0,
  75. ipw_sio_b14400 = 0x0100,
  76. ipw_sio_b9600 = 0x0180,
  77. ipw_sio_b4800 = 0x0300,
  78. ipw_sio_b2400 = 0x0600,
  79. ipw_sio_b1200 = 0x0c00,
  80. ipw_sio_b600 = 0x1800
  81. };
  82. /* data bits */
  83. #define ipw_dtb_7 0x700
  84. #define ipw_dtb_8 0x810 /* ok so the define is misleading, I know, but forces 8,n,1 */
  85. /* I mean, is there a point to any other setting these days? :) */
  86. /* usb control request types : */
  87. #define IPW_SIO_RXCTL 0x00 /* control bulk rx channel transmissions, value=1/0 (on/off) */
  88. #define IPW_SIO_SET_BAUD 0x01 /* set baud, value=requested ipw_sio_bxxxx */
  89. #define IPW_SIO_SET_LINE 0x03 /* set databits, parity. value=ipw_dtb_x */
  90. #define IPW_SIO_SET_PIN 0x03 /* set/clear dtr/rts value=ipw_pin_xxx */
  91. #define IPW_SIO_POLL 0x08 /* get serial port status byte, call with value=0 */
  92. #define IPW_SIO_INIT 0x11 /* initializes ? value=0 (appears as first thing todo on open) */
  93. #define IPW_SIO_PURGE 0x12 /* purge all transmissions?, call with value=numchar_to_purge */
  94. #define IPW_SIO_HANDFLOW 0x13 /* set xon/xoff limits value=0, and a buffer of 0x10 bytes */
  95. #define IPW_SIO_SETCHARS 0x13 /* set the flowcontrol special chars, value=0, buf=6 bytes, */
  96. /* last 2 bytes contain flowcontrol chars e.g. 00 00 00 00 11 13 */
  97. /* values used for request IPW_SIO_SET_PIN */
  98. #define IPW_PIN_SETDTR 0x101
  99. #define IPW_PIN_SETRTS 0x202
  100. #define IPW_PIN_CLRDTR 0x100
  101. #define IPW_PIN_CLRRTS 0x200 /* unconfirmed */
  102. /* values used for request IPW_SIO_RXCTL */
  103. #define IPW_RXBULK_ON 1
  104. #define IPW_RXBULK_OFF 0
  105. /* various 16 byte hardcoded transferbuffers used by flow control */
  106. #define IPW_BYTES_FLOWINIT { 0x01, 0, 0, 0, 0x40, 0, 0, 0, \
  107. 0, 0, 0, 0, 0, 0, 0, 0 }
  108. /* Interpretation of modem status lines */
  109. /* These need sorting out by individually connecting pins and checking
  110. * results. FIXME!
  111. * When data is being sent we see 0x30 in the lower byte; this must
  112. * contain DSR and CTS ...
  113. */
  114. #define IPW_DSR ((1<<4) | (1<<5))
  115. #define IPW_CTS ((1<<5) | (1<<4))
  116. #define IPW_WANTS_TO_SEND 0x30
  117. static const struct usb_device_id usb_ipw_ids[] = {
  118. { USB_DEVICE(IPW_VID, IPW_PID) },
  119. { },
  120. };
  121. MODULE_DEVICE_TABLE(usb, usb_ipw_ids);
  122. static struct usb_driver usb_ipw_driver = {
  123. .name = "ipwtty",
  124. .probe = usb_serial_probe,
  125. .disconnect = usb_serial_disconnect,
  126. .id_table = usb_ipw_ids,
  127. };
  128. static bool debug;
  129. static int ipw_open(struct tty_struct *tty, struct usb_serial_port *port)
  130. {
  131. struct usb_device *dev = port->serial->dev;
  132. u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT;
  133. u8 *buf_flow_init;
  134. int result;
  135. dbg("%s", __func__);
  136. buf_flow_init = kmemdup(buf_flow_static, 16, GFP_KERNEL);
  137. if (!buf_flow_init)
  138. return -ENOMEM;
  139. /* --1: Tell the modem to initialize (we think) From sniffs this is
  140. * always the first thing that gets sent to the modem during
  141. * opening of the device */
  142. dbg("%s: Sending SIO_INIT (we guess)", __func__);
  143. result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  144. IPW_SIO_INIT,
  145. USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
  146. 0,
  147. 0, /* index */
  148. NULL,
  149. 0,
  150. 100000);
  151. if (result < 0)
  152. dev_err(&port->dev,
  153. "Init of modem failed (error = %d)\n", result);
  154. /* reset the bulk pipes */
  155. usb_clear_halt(dev,
  156. usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress));
  157. usb_clear_halt(dev,
  158. usb_sndbulkpipe(dev, port->bulk_out_endpointAddress));
  159. /*--2: Start reading from the device */
  160. dbg("%s: setting up bulk read callback", __func__);
  161. usb_wwan_open(tty, port);
  162. /*--3: Tell the modem to open the floodgates on the rx bulk channel */
  163. dbg("%s:asking modem for RxRead (RXBULK_ON)", __func__);
  164. result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  165. IPW_SIO_RXCTL,
  166. USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
  167. IPW_RXBULK_ON,
  168. 0, /* index */
  169. NULL,
  170. 0,
  171. 100000);
  172. if (result < 0)
  173. dev_err(&port->dev,
  174. "Enabling bulk RxRead failed (error = %d)\n", result);
  175. /*--4: setup the initial flowcontrol */
  176. dbg("%s:setting init flowcontrol (%s)", __func__, buf_flow_init);
  177. result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  178. IPW_SIO_HANDFLOW,
  179. USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
  180. 0,
  181. 0,
  182. buf_flow_init,
  183. 0x10,
  184. 200000);
  185. if (result < 0)
  186. dev_err(&port->dev,
  187. "initial flowcontrol failed (error = %d)\n", result);
  188. kfree(buf_flow_init);
  189. return 0;
  190. }
  191. /* fake probe - only to allocate data structures */
  192. static int ipw_probe(struct usb_serial *serial, const struct usb_device_id *id)
  193. {
  194. struct usb_wwan_intf_private *data;
  195. data = kzalloc(sizeof(struct usb_wwan_intf_private), GFP_KERNEL);
  196. if (!data)
  197. return -ENOMEM;
  198. spin_lock_init(&data->susp_lock);
  199. usb_set_serial_data(serial, data);
  200. return 0;
  201. }
  202. static void ipw_release(struct usb_serial *serial)
  203. {
  204. struct usb_wwan_intf_private *data = usb_get_serial_data(serial);
  205. usb_wwan_release(serial);
  206. usb_set_serial_data(serial, NULL);
  207. kfree(data);
  208. }
  209. static void ipw_dtr_rts(struct usb_serial_port *port, int on)
  210. {
  211. struct usb_device *dev = port->serial->dev;
  212. int result;
  213. dbg("%s: on = %d", __func__, on);
  214. result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  215. IPW_SIO_SET_PIN,
  216. USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
  217. on ? IPW_PIN_SETDTR : IPW_PIN_CLRDTR,
  218. 0,
  219. NULL,
  220. 0,
  221. 200000);
  222. if (result < 0)
  223. dev_err(&port->dev, "setting dtr failed (error = %d)\n",
  224. result);
  225. result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  226. IPW_SIO_SET_PIN, USB_TYPE_VENDOR |
  227. USB_RECIP_INTERFACE | USB_DIR_OUT,
  228. on ? IPW_PIN_SETRTS : IPW_PIN_CLRRTS,
  229. 0,
  230. NULL,
  231. 0,
  232. 200000);
  233. if (result < 0)
  234. dev_err(&port->dev, "setting rts failed (error = %d)\n",
  235. result);
  236. }
  237. static void ipw_close(struct usb_serial_port *port)
  238. {
  239. struct usb_device *dev = port->serial->dev;
  240. int result;
  241. /*--3: purge */
  242. dbg("%s:sending purge", __func__);
  243. result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  244. IPW_SIO_PURGE, USB_TYPE_VENDOR |
  245. USB_RECIP_INTERFACE | USB_DIR_OUT,
  246. 0x03,
  247. 0,
  248. NULL,
  249. 0,
  250. 200000);
  251. if (result < 0)
  252. dev_err(&port->dev, "purge failed (error = %d)\n", result);
  253. /* send RXBULK_off (tell modem to stop transmitting bulk data on
  254. rx chan) */
  255. result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  256. IPW_SIO_RXCTL,
  257. USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
  258. IPW_RXBULK_OFF,
  259. 0, /* index */
  260. NULL,
  261. 0,
  262. 100000);
  263. if (result < 0)
  264. dev_err(&port->dev,
  265. "Disabling bulk RxRead failed (error = %d)\n", result);
  266. usb_wwan_close(port);
  267. }
  268. static struct usb_serial_driver ipw_device = {
  269. .driver = {
  270. .owner = THIS_MODULE,
  271. .name = "ipw",
  272. },
  273. .description = "IPWireless converter",
  274. .id_table = usb_ipw_ids,
  275. .num_ports = 1,
  276. .disconnect = usb_wwan_disconnect,
  277. .open = ipw_open,
  278. .close = ipw_close,
  279. .probe = ipw_probe,
  280. .attach = usb_wwan_startup,
  281. .release = ipw_release,
  282. .dtr_rts = ipw_dtr_rts,
  283. .write = usb_wwan_write,
  284. };
  285. static struct usb_serial_driver * const serial_drivers[] = {
  286. &ipw_device, NULL
  287. };
  288. module_usb_serial_driver(usb_ipw_driver, serial_drivers);
  289. /* Module information */
  290. MODULE_AUTHOR(DRIVER_AUTHOR);
  291. MODULE_DESCRIPTION(DRIVER_DESC);
  292. MODULE_LICENSE("GPL");
  293. module_param(debug, bool, S_IRUGO | S_IWUSR);
  294. MODULE_PARM_DESC(debug, "Debug enabled or not");