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
40 #include <linux/kernel.h>
41 #include <linux/errno.h>
42 #include <linux/init.h>
43 #include <linux/slab.h>
44 #include <linux/tty.h>
45 #include <linux/tty_flip.h>
46 #include <linux/module.h>
47 #include <linux/spinlock.h>
48 #include <linux/usb.h>
49 #include <linux/usb/serial.h>
50 #include <asm/uaccess.h>
55 #define DRIVER_VERSION "v0.3"
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))
68 #define NUM_BULK_URBS 24
69 #define NUM_CONTROL_URBS 16
71 /* vendor/product pairs that are known work with this driver*/
72 #define IPW_VID 0x0bc3
73 #define IPW_PID 0x0001
76 /* Vendor commands: */
80 ipw_sio_b256000
= 0x000e,
81 ipw_sio_b128000
= 0x001d,
82 ipw_sio_b115200
= 0x0020,
83 ipw_sio_b57600
= 0x0040,
84 ipw_sio_b56000
= 0x0042,
85 ipw_sio_b38400
= 0x0060,
86 ipw_sio_b19200
= 0x00c0,
87 ipw_sio_b14400
= 0x0100,
88 ipw_sio_b9600
= 0x0180,
89 ipw_sio_b4800
= 0x0300,
90 ipw_sio_b2400
= 0x0600,
91 ipw_sio_b1200
= 0x0c00,
96 #define ipw_dtb_7 0x700
97 #define ipw_dtb_8 0x810 // ok so the define is misleading, I know, but forces 8,n,1
98 // I mean, is there a point to any other setting these days? :)
100 /* usb control request types : */
101 #define IPW_SIO_RXCTL 0x00 // control bulk rx channel transmissions, value=1/0 (on/off)
102 #define IPW_SIO_SET_BAUD 0x01 // set baud, value=requested ipw_sio_bxxxx
103 #define IPW_SIO_SET_LINE 0x03 // set databits, parity. value=ipw_dtb_x
104 #define IPW_SIO_SET_PIN 0x03 // set/clear dtr/rts value=ipw_pin_xxx
105 #define IPW_SIO_POLL 0x08 // get serial port status byte, call with value=0
106 #define IPW_SIO_INIT 0x11 // initializes ? value=0 (appears as first thing todo on open)
107 #define IPW_SIO_PURGE 0x12 // purge all transmissions?, call with value=numchar_to_purge
108 #define IPW_SIO_HANDFLOW 0x13 // set xon/xoff limits value=0, and a buffer of 0x10 bytes
109 #define IPW_SIO_SETCHARS 0x13 // set the flowcontrol special chars, value=0, buf=6 bytes,
110 // last 2 bytes contain flowcontrol chars e.g. 00 00 00 00 11 13
112 /* values used for request IPW_SIO_SET_PIN */
113 #define IPW_PIN_SETDTR 0x101
114 #define IPW_PIN_SETRTS 0x202
115 #define IPW_PIN_CLRDTR 0x100
116 #define IPW_PIN_CLRRTS 0x200 // unconfirmed
118 /* values used for request IPW_SIO_RXCTL */
119 #define IPW_RXBULK_ON 1
120 #define IPW_RXBULK_OFF 0
122 /* various 16 byte hardcoded transferbuffers used by flow control */
123 #define IPW_BYTES_FLOWINIT { 0x01, 0, 0, 0, 0x40, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
125 /* Interpretation of modem status lines */
126 /* These need sorting out by individually connecting pins and checking
128 * When data is being sent we see 0x30 in the lower byte; this must
129 * contain DSR and CTS ...
131 #define IPW_DSR ((1<<4) | (1<<5))
132 #define IPW_CTS ((1<<5) | (1<<4))
134 #define IPW_WANTS_TO_SEND 0x30
135 //#define IPW_DTR /* Data Terminal Ready */
136 //#define IPW_CTS /* Clear To Send */
137 //#define IPW_CD /* Carrier Detect */
138 //#define IPW_DSR /* Data Set Ready */
139 //#define IPW_RxD /* Receive pin */
145 //#define IPW_RI /* Ring Indicator */
147 static struct usb_device_id usb_ipw_ids
[] = {
148 { USB_DEVICE(IPW_VID
, IPW_PID
) },
152 MODULE_DEVICE_TABLE(usb
, usb_ipw_ids
);
154 static struct usb_driver usb_ipw_driver
= {
156 .probe
= usb_serial_probe
,
157 .disconnect
= usb_serial_disconnect
,
158 .id_table
= usb_ipw_ids
,
164 static void ipw_read_bulk_callback(struct urb
*urb
)
166 struct usb_serial_port
*port
= urb
->context
;
167 unsigned char *data
= urb
->transfer_buffer
;
168 struct tty_struct
*tty
;
171 dbg("%s - port %d", __FUNCTION__
, port
->number
);
174 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__
, urb
->status
);
178 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, urb
->actual_length
, data
);
181 if (tty
&& urb
->actual_length
) {
182 tty_buffer_request_room(tty
, urb
->actual_length
);
183 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
184 tty_flip_buffer_push(tty
);
187 /* Continue trying to always read */
188 usb_fill_bulk_urb (port
->read_urb
, port
->serial
->dev
,
189 usb_rcvbulkpipe(port
->serial
->dev
,
190 port
->bulk_in_endpointAddress
),
191 port
->read_urb
->transfer_buffer
,
192 port
->read_urb
->transfer_buffer_length
,
193 ipw_read_bulk_callback
, port
);
194 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
196 dev_err(&port
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
200 static int ipw_open(struct usb_serial_port
*port
, struct file
*filp
)
202 struct usb_device
*dev
= port
->serial
->dev
;
203 u8 buf_flow_static
[16] = IPW_BYTES_FLOWINIT
;
207 dbg("%s", __FUNCTION__
);
209 buf_flow_init
= kmalloc(16, GFP_KERNEL
);
212 memcpy(buf_flow_init
, buf_flow_static
, 16);
215 port
->tty
->low_latency
= 1;
217 /* --1: Tell the modem to initialize (we think) From sniffs this is always the
218 * first thing that gets sent to the modem during opening of the device */
219 dbg("%s: Sending SIO_INIT (we guess)",__FUNCTION__
);
220 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
,0),
222 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
229 dev_err(&port
->dev
, "Init of modem failed (error = %d)", result
);
231 /* reset the bulk pipes */
232 usb_clear_halt(dev
, usb_rcvbulkpipe(dev
, port
->bulk_in_endpointAddress
));
233 usb_clear_halt(dev
, usb_sndbulkpipe(dev
, port
->bulk_out_endpointAddress
));
235 /*--2: Start reading from the device */
236 dbg("%s: setting up bulk read callback",__FUNCTION__
);
237 usb_fill_bulk_urb(port
->read_urb
, dev
,
238 usb_rcvbulkpipe(dev
, port
->bulk_in_endpointAddress
),
239 port
->bulk_in_buffer
,
241 ipw_read_bulk_callback
, port
);
242 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
244 dbg("%s - usb_submit_urb(read bulk) failed with status %d", __FUNCTION__
, result
);
246 /*--3: Tell the modem to open the floodgates on the rx bulk channel */
247 dbg("%s:asking modem for RxRead (RXBULK_ON)",__FUNCTION__
);
248 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
250 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
257 dev_err(&port
->dev
, "Enabling bulk RxRead failed (error = %d)", result
);
259 /*--4: setup the initial flowcontrol */
260 dbg("%s:setting init flowcontrol (%s)",__FUNCTION__
,buf_flow_init
);
261 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
263 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
270 dev_err(&port
->dev
, "initial flowcontrol failed (error = %d)", result
);
273 /*--5: raise the dtr */
274 dbg("%s:raising dtr",__FUNCTION__
);
275 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
277 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
284 dev_err(&port
->dev
, "setting dtr failed (error = %d)", result
);
286 /*--6: raise the rts */
287 dbg("%s:raising rts",__FUNCTION__
);
288 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
290 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
297 dev_err(&port
->dev
, "setting dtr failed (error = %d)", result
);
299 kfree(buf_flow_init
);
303 static void ipw_close(struct usb_serial_port
*port
, struct file
* filp
)
305 struct usb_device
*dev
= port
->serial
->dev
;
308 if (tty_hung_up_p(filp
)) {
309 dbg("%s: tty_hung_up_p ...", __FUNCTION__
);
313 /*--1: drop the dtr */
314 dbg("%s:dropping dtr",__FUNCTION__
);
315 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
317 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
324 dev_err(&port
->dev
, "dropping dtr failed (error = %d)", result
);
326 /*--2: drop the rts */
327 dbg("%s:dropping rts",__FUNCTION__
);
328 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
329 IPW_SIO_SET_PIN
, USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
336 dev_err(&port
->dev
, "dropping rts failed (error = %d)", result
);
340 dbg("%s:sending purge",__FUNCTION__
);
341 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
342 IPW_SIO_PURGE
, USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
349 dev_err(&port
->dev
, "purge failed (error = %d)", result
);
352 /* send RXBULK_off (tell modem to stop transmitting bulk data on rx chan) */
353 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
355 USB_TYPE_VENDOR
| USB_RECIP_INTERFACE
| USB_DIR_OUT
,
363 dev_err(&port
->dev
, "Disabling bulk RxRead failed (error = %d)", result
);
365 /* shutdown any in-flight urbs that we know about */
366 usb_kill_urb(port
->read_urb
);
367 usb_kill_urb(port
->write_urb
);
370 static void ipw_write_bulk_callback(struct urb
*urb
)
372 struct usb_serial_port
*port
= urb
->context
;
374 dbg("%s", __FUNCTION__
);
376 port
->write_urb_busy
= 0;
379 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__
, urb
->status
);
381 usb_serial_port_softint(port
);
384 static int ipw_write(struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
386 struct usb_device
*dev
= port
->serial
->dev
;
389 dbg("%s: TOP: count=%d, in_interrupt=%ld", __FUNCTION__
,
390 count
, in_interrupt() );
393 dbg("%s - write request of 0 bytes", __FUNCTION__
);
397 spin_lock_bh(&port
->lock
);
398 if (port
->write_urb_busy
) {
399 spin_unlock_bh(&port
->lock
);
400 dbg("%s - already writing", __FUNCTION__
);
403 port
->write_urb_busy
= 1;
404 spin_unlock_bh(&port
->lock
);
406 count
= min(count
, port
->bulk_out_size
);
407 memcpy(port
->bulk_out_buffer
, buf
, count
);
409 dbg("%s count now:%d", __FUNCTION__
, count
);
411 usb_fill_bulk_urb(port
->write_urb
, dev
,
412 usb_sndbulkpipe(dev
, port
->bulk_out_endpointAddress
),
413 port
->write_urb
->transfer_buffer
,
415 ipw_write_bulk_callback
,
418 ret
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
420 port
->write_urb_busy
= 0;
421 dbg("%s - usb_submit_urb(write bulk) failed with error = %d", __FUNCTION__
, ret
);
425 dbg("%s returning %d", __FUNCTION__
, count
);
429 static int ipw_probe(struct usb_serial_port
*port
)
434 static int ipw_disconnect(struct usb_serial_port
*port
)
436 usb_set_serial_port_data(port
, NULL
);
440 static struct usb_serial_driver ipw_device
= {
442 .owner
= THIS_MODULE
,
445 .description
= "IPWireless converter",
446 .id_table
= usb_ipw_ids
,
447 .num_interrupt_in
= NUM_DONT_CARE
,
453 .port_probe
= ipw_probe
,
454 .port_remove
= ipw_disconnect
,
456 .write_bulk_callback
= ipw_write_bulk_callback
,
457 .read_bulk_callback
= ipw_read_bulk_callback
,
462 static int usb_ipw_init(void)
466 retval
= usb_serial_register(&ipw_device
);
469 retval
= usb_register(&usb_ipw_driver
);
471 usb_serial_deregister(&ipw_device
);
474 info(DRIVER_DESC
" " DRIVER_VERSION
);
478 static void usb_ipw_exit(void)
480 usb_deregister(&usb_ipw_driver
);
481 usb_serial_deregister(&ipw_device
);
484 module_init(usb_ipw_init
);
485 module_exit(usb_ipw_exit
);
487 /* Module information */
488 MODULE_AUTHOR( DRIVER_AUTHOR
);
489 MODULE_DESCRIPTION( DRIVER_DESC
);
490 MODULE_LICENSE("GPL");
492 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
493 MODULE_PARM_DESC(debug
, "Debug enabled or not");