2 * IPWireless 3G UMTS TDD Modem driver (USB connected)
4 * Copyright (C) 2004 Roelf Diedericks <roelfd@inet.co.za>
5 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
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.
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)
16 * It was written out of frustration with the IPWireless USB modem
17 * supplied by Axity3G/Sentech South Africa not supporting
20 * Nobody provided any proprietary information that was not already
21 * available for this device.
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
27 * The code was only tested the IPWireless handheld modem distributed
28 * in South Africa by Sentech.
30 * It may work for Woosh Inc in .nz too, as it appears they use the
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
39 #include <linux/kernel.h>
40 #include <linux/errno.h>
41 #include <linux/init.h>
42 #include <linux/slab.h>
43 #include <linux/tty.h>
44 #include <linux/tty_flip.h>
45 #include <linux/module.h>
46 #include <linux/spinlock.h>
47 #include <linux/usb.h>
48 #include <linux/usb/serial.h>
49 #include <linux/uaccess.h>
55 #define DRIVER_VERSION "v0.4"
56 #define DRIVER_AUTHOR "Roelf Diedericks"
57 #define DRIVER_DESC "IPWireless tty driver"
59 #define IPW_TTY_MAJOR 240 /* real device node major id, experimental range */
60 #define IPW_TTY_MINORS 256 /* we support 256 devices, dunno why, it'd be insane :) */
62 #define USB_IPW_MAGIC 0x6d02 /* magic number for ipw struct */
66 #define EVENT_BUFFER_SIZE 0xFF
67 #define CHAR2INT16(c1, c0) (((u32)((c1) & 0xff) << 8) + (u32)((c0) & 0xff))
69 /* vendor/product pairs that are known work with this driver*/
70 #define IPW_VID 0x0bc3
71 #define IPW_PID 0x0001
74 /* Vendor commands: */
78 ipw_sio_b256000 = 0x000e,
79 ipw_sio_b128000 = 0x001d,
80 ipw_sio_b115200 = 0x0020,
81 ipw_sio_b57600 = 0x0040,
82 ipw_sio_b56000 = 0x0042,
83 ipw_sio_b38400 = 0x0060,
84 ipw_sio_b19200 = 0x00c0,
85 ipw_sio_b14400 = 0x0100,
86 ipw_sio_b9600 = 0x0180,
87 ipw_sio_b4800 = 0x0300,
88 ipw_sio_b2400 = 0x0600,
89 ipw_sio_b1200 = 0x0c00,
94 #define ipw_dtb_7 0x700
95 #define ipw_dtb_8 0x810 /* ok so the define is misleading, I know, but forces 8,n,1 */
96 /* I mean, is there a point to any other setting these days? :) */
98 /* usb control request types : */
99 #define IPW_SIO_RXCTL 0x00 /* control bulk rx channel transmissions, value=1/0 (on/off) */
100 #define IPW_SIO_SET_BAUD 0x01 /* set baud, value=requested ipw_sio_bxxxx */
101 #define IPW_SIO_SET_LINE 0x03 /* set databits, parity. value=ipw_dtb_x */
102 #define IPW_SIO_SET_PIN 0x03 /* set/clear dtr/rts value=ipw_pin_xxx */
103 #define IPW_SIO_POLL 0x08 /* get serial port status byte, call with value=0 */
104 #define IPW_SIO_INIT 0x11 /* initializes ? value=0 (appears as first thing todo on open) */
105 #define IPW_SIO_PURGE 0x12 /* purge all transmissions?, call with value=numchar_to_purge */
106 #define IPW_SIO_HANDFLOW 0x13 /* set xon/xoff limits value=0, and a buffer of 0x10 bytes */
107 #define IPW_SIO_SETCHARS 0x13 /* set the flowcontrol special chars, value=0, buf=6 bytes, */
108 /* last 2 bytes contain flowcontrol chars e.g. 00 00 00 00 11 13 */
110 /* values used for request IPW_SIO_SET_PIN */
111 #define IPW_PIN_SETDTR 0x101
112 #define IPW_PIN_SETRTS 0x202
113 #define IPW_PIN_CLRDTR 0x100
114 #define IPW_PIN_CLRRTS 0x200 /* unconfirmed */
116 /* values used for request IPW_SIO_RXCTL */
117 #define IPW_RXBULK_ON 1
118 #define IPW_RXBULK_OFF 0
120 /* various 16 byte hardcoded transferbuffers used by flow control */
121 #define IPW_BYTES_FLOWINIT { 0x01, 0, 0, 0, 0x40, 0, 0, 0, \
122 0, 0, 0, 0, 0, 0, 0, 0 }
124 /* Interpretation of modem status lines */
125 /* These need sorting out by individually connecting pins and checking
127 * When data is being sent we see 0x30 in the lower byte; this must
128 * contain DSR and CTS ...
130 #define IPW_DSR ((1<<4) | (1<<5))
131 #define IPW_CTS ((1<<5) | (1<<4))
133 #define IPW_WANTS_TO_SEND 0x30
135 static const struct usb_device_id usb_ipw_ids[] = {
136 { USB_DEVICE(IPW_VID, IPW_PID) },
140 MODULE_DEVICE_TABLE(usb, usb_ipw_ids);
142 static struct usb_driver usb_ipw_driver = {
144 .probe = usb_serial_probe,
145 .disconnect = usb_serial_disconnect,
146 .id_table = usb_ipw_ids,
151 static int ipw_open(struct tty_struct *tty, struct usb_serial_port *port)
153 struct usb_device *dev = port->serial->dev;
154 u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT;
160 buf_flow_init = kmemdup(buf_flow_static, 16, GFP_KERNEL);
164 /* --1: Tell the modem to initialize (we think) From sniffs this is
165 * always the first thing that gets sent to the modem during
166 * opening of the device */
167 dbg("%s: Sending SIO_INIT (we guess)", __func__);
168 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
170 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
178 "Init of modem failed (error = %d)\n", result);
180 /* reset the bulk pipes */
182 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress));
184 usb_sndbulkpipe(dev, port->bulk_out_endpointAddress));
186 /*--2: Start reading from the device */
187 dbg("%s: setting up bulk read callback", __func__);
188 usb_wwan_open(tty, port);
190 /*--3: Tell the modem to open the floodgates on the rx bulk channel */
191 dbg("%s:asking modem for RxRead (RXBULK_ON)", __func__);
192 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
194 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
202 "Enabling bulk RxRead failed (error = %d)\n", result);
204 /*--4: setup the initial flowcontrol */
205 dbg("%s:setting init flowcontrol (%s)", __func__, buf_flow_init);
206 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
208 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
216 "initial flowcontrol failed (error = %d)\n", result);
218 kfree(buf_flow_init);
222 /* fake probe - only to allocate data structures */
223 static int ipw_probe(struct usb_serial *serial, const struct usb_device_id *id)
225 struct usb_wwan_intf_private *data;
227 data = kzalloc(sizeof(struct usb_wwan_intf_private), GFP_KERNEL);
231 spin_lock_init(&data->susp_lock);
232 usb_set_serial_data(serial, data);
236 static void ipw_release(struct usb_serial *serial)
238 struct usb_wwan_intf_private *data = usb_get_serial_data(serial);
240 usb_wwan_release(serial);
241 usb_set_serial_data(serial, NULL);
245 static void ipw_dtr_rts(struct usb_serial_port *port, int on)
247 struct usb_device *dev = port->serial->dev;
250 dbg("%s: on = %d", __func__, on);
252 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
254 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
255 on ? IPW_PIN_SETDTR : IPW_PIN_CLRDTR,
261 dev_err(&port->dev, "setting dtr failed (error = %d)\n",
264 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
265 IPW_SIO_SET_PIN, USB_TYPE_VENDOR |
266 USB_RECIP_INTERFACE | USB_DIR_OUT,
267 on ? IPW_PIN_SETRTS : IPW_PIN_CLRRTS,
273 dev_err(&port->dev, "setting rts failed (error = %d)\n",
277 static void ipw_close(struct usb_serial_port *port)
279 struct usb_device *dev = port->serial->dev;
283 dbg("%s:sending purge", __func__);
284 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
285 IPW_SIO_PURGE, USB_TYPE_VENDOR |
286 USB_RECIP_INTERFACE | USB_DIR_OUT,
293 dev_err(&port->dev, "purge failed (error = %d)\n", result);
296 /* send RXBULK_off (tell modem to stop transmitting bulk data on
298 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
300 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
309 "Disabling bulk RxRead failed (error = %d)\n", result);
311 usb_wwan_close(port);
314 static struct usb_serial_driver ipw_device = {
316 .owner = THIS_MODULE,
319 .description = "IPWireless converter",
320 .id_table = usb_ipw_ids,
322 .disconnect = usb_wwan_disconnect,
326 .attach = usb_wwan_startup,
327 .release = ipw_release,
328 .dtr_rts = ipw_dtr_rts,
329 .write = usb_wwan_write,
332 static struct usb_serial_driver * const serial_drivers[] = {
336 module_usb_serial_driver(usb_ipw_driver, serial_drivers);
338 /* Module information */
339 MODULE_AUTHOR(DRIVER_AUTHOR);
340 MODULE_DESCRIPTION(DRIVER_DESC);
341 MODULE_LICENSE("GPL");
343 module_param(debug, bool, S_IRUGO | S_IWUSR);
344 MODULE_PARM_DESC(debug, "Debug enabled or not");