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 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> 50 51 /* 52 * Version Information 53 */ 54 #define DRIVER_VERSION "v0.4" 55 #define DRIVER_AUTHOR "Roelf Diedericks" 56 #define DRIVER_DESC "IPWireless tty driver" 57 58 #define IPW_TTY_MAJOR 240 /* real device node major id, experimental range */ 59 #define IPW_TTY_MINORS 256 /* we support 256 devices, dunno why, it'd be insane :) */ 60 61 #define USB_IPW_MAGIC 0x6d02 /* magic number for ipw struct */ 62 63 64 /* Message sizes */ 65 #define EVENT_BUFFER_SIZE 0xFF 66 #define CHAR2INT16(c1, c0) (((u32)((c1) & 0xff) << 8) + (u32)((c0) & 0xff)) 67 68 /* vendor/product pairs that are known work with this driver*/ 69 #define IPW_VID 0x0bc3 70 #define IPW_PID 0x0001 71 72 73 /* Vendor commands: */ 74 75 /* baud rates */ 76 enum { 77 ipw_sio_b256000 = 0x000e, 78 ipw_sio_b128000 = 0x001d, 79 ipw_sio_b115200 = 0x0020, 80 ipw_sio_b57600 = 0x0040, 81 ipw_sio_b56000 = 0x0042, 82 ipw_sio_b38400 = 0x0060, 83 ipw_sio_b19200 = 0x00c0, 84 ipw_sio_b14400 = 0x0100, 85 ipw_sio_b9600 = 0x0180, 86 ipw_sio_b4800 = 0x0300, 87 ipw_sio_b2400 = 0x0600, 88 ipw_sio_b1200 = 0x0c00, 89 ipw_sio_b600 = 0x1800 90 }; 91 92 /* data bits */ 93 #define ipw_dtb_7 0x700 94 #define ipw_dtb_8 0x810 /* ok so the define is misleading, I know, but forces 8,n,1 */ 95 /* I mean, is there a point to any other setting these days? :) */ 96 97 /* usb control request types : */ 98 #define IPW_SIO_RXCTL 0x00 /* control bulk rx channel transmissions, value=1/0 (on/off) */ 99 #define IPW_SIO_SET_BAUD 0x01 /* set baud, value=requested ipw_sio_bxxxx */ 100 #define IPW_SIO_SET_LINE 0x03 /* set databits, parity. value=ipw_dtb_x */ 101 #define IPW_SIO_SET_PIN 0x03 /* set/clear dtr/rts value=ipw_pin_xxx */ 102 #define IPW_SIO_POLL 0x08 /* get serial port status byte, call with value=0 */ 103 #define IPW_SIO_INIT 0x11 /* initializes ? value=0 (appears as first thing todo on open) */ 104 #define IPW_SIO_PURGE 0x12 /* purge all transmissions?, call with value=numchar_to_purge */ 105 #define IPW_SIO_HANDFLOW 0x13 /* set xon/xoff limits value=0, and a buffer of 0x10 bytes */ 106 #define IPW_SIO_SETCHARS 0x13 /* set the flowcontrol special chars, value=0, buf=6 bytes, */ 107 /* last 2 bytes contain flowcontrol chars e.g. 00 00 00 00 11 13 */ 108 109 /* values used for request IPW_SIO_SET_PIN */ 110 #define IPW_PIN_SETDTR 0x101 111 #define IPW_PIN_SETRTS 0x202 112 #define IPW_PIN_CLRDTR 0x100 113 #define IPW_PIN_CLRRTS 0x200 /* unconfirmed */ 114 115 /* values used for request IPW_SIO_RXCTL */ 116 #define IPW_RXBULK_ON 1 117 #define IPW_RXBULK_OFF 0 118 119 /* various 16 byte hardcoded transferbuffers used by flow control */ 120 #define IPW_BYTES_FLOWINIT { 0x01, 0, 0, 0, 0x40, 0, 0, 0, \ 121 0, 0, 0, 0, 0, 0, 0, 0 } 122 123 /* Interpretation of modem status lines */ 124 /* These need sorting out by individually connecting pins and checking 125 * results. FIXME! 126 * When data is being sent we see 0x30 in the lower byte; this must 127 * contain DSR and CTS ... 128 */ 129 #define IPW_DSR ((1<<4) | (1<<5)) 130 #define IPW_CTS ((1<<5) | (1<<4)) 131 132 #define IPW_WANTS_TO_SEND 0x30 133 134 static const struct usb_device_id usb_ipw_ids[] = { 135 { USB_DEVICE(IPW_VID, IPW_PID) }, 136 { }, 137 }; 138 139 MODULE_DEVICE_TABLE(usb, usb_ipw_ids); 140 141 static struct usb_driver usb_ipw_driver = { 142 .name = "ipwtty", 143 .probe = usb_serial_probe, 144 .disconnect = usb_serial_disconnect, 145 .id_table = usb_ipw_ids, 146 .no_dynamic_id = 1, 147 }; 148 149 static int debug; 150 151 static int ipw_open(struct tty_struct *tty, struct usb_serial_port *port) 152 { 153 struct usb_device *dev = port->serial->dev; 154 u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT; 155 u8 *buf_flow_init; 156 int result; 157 158 dbg("%s", __func__); 159 160 buf_flow_init = kmemdup(buf_flow_static, 16, GFP_KERNEL); 161 if (!buf_flow_init) 162 return -ENOMEM; 163 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), 169 IPW_SIO_INIT, 170 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 171 0, 172 0, /* index */ 173 NULL, 174 0, 175 100000); 176 if (result < 0) 177 dev_err(&port->dev, 178 "Init of modem failed (error = %d)\n", result); 179 180 /* reset the bulk pipes */ 181 usb_clear_halt(dev, 182 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress)); 183 usb_clear_halt(dev, 184 usb_sndbulkpipe(dev, port->bulk_out_endpointAddress)); 185 186 /*--2: Start reading from the device */ 187 dbg("%s: setting up bulk read callback", __func__); 188 usb_serial_generic_open(tty, port); 189 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), 193 IPW_SIO_RXCTL, 194 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 195 IPW_RXBULK_ON, 196 0, /* index */ 197 NULL, 198 0, 199 100000); 200 if (result < 0) 201 dev_err(&port->dev, 202 "Enabling bulk RxRead failed (error = %d)\n", result); 203 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), 207 IPW_SIO_HANDFLOW, 208 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 209 0, 210 0, 211 buf_flow_init, 212 0x10, 213 200000); 214 if (result < 0) 215 dev_err(&port->dev, 216 "initial flowcontrol failed (error = %d)\n", result); 217 218 kfree(buf_flow_init); 219 return 0; 220 } 221 222 static void ipw_dtr_rts(struct usb_serial_port *port, int on) 223 { 224 struct usb_device *dev = port->serial->dev; 225 int result; 226 227 dbg("%s: on = %d", __func__, on); 228 229 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 230 IPW_SIO_SET_PIN, 231 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 232 on ? IPW_PIN_SETDTR : IPW_PIN_CLRDTR, 233 0, 234 NULL, 235 0, 236 200000); 237 if (result < 0) 238 dev_err(&port->dev, "setting dtr failed (error = %d)\n", 239 result); 240 241 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 242 IPW_SIO_SET_PIN, USB_TYPE_VENDOR | 243 USB_RECIP_INTERFACE | USB_DIR_OUT, 244 on ? IPW_PIN_SETRTS : IPW_PIN_CLRRTS, 245 0, 246 NULL, 247 0, 248 200000); 249 if (result < 0) 250 dev_err(&port->dev, "setting rts failed (error = %d)\n", 251 result); 252 } 253 254 static void ipw_close(struct usb_serial_port *port) 255 { 256 struct usb_device *dev = port->serial->dev; 257 int result; 258 259 /*--3: purge */ 260 dbg("%s:sending purge", __func__); 261 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 262 IPW_SIO_PURGE, USB_TYPE_VENDOR | 263 USB_RECIP_INTERFACE | USB_DIR_OUT, 264 0x03, 265 0, 266 NULL, 267 0, 268 200000); 269 if (result < 0) 270 dev_err(&port->dev, "purge failed (error = %d)\n", result); 271 272 273 /* send RXBULK_off (tell modem to stop transmitting bulk data on 274 rx chan) */ 275 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 276 IPW_SIO_RXCTL, 277 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 278 IPW_RXBULK_OFF, 279 0, /* index */ 280 NULL, 281 0, 282 100000); 283 284 if (result < 0) 285 dev_err(&port->dev, 286 "Disabling bulk RxRead failed (error = %d)\n", result); 287 288 usb_serial_generic_close(port); 289 } 290 291 static struct usb_serial_driver ipw_device = { 292 .driver = { 293 .owner = THIS_MODULE, 294 .name = "ipw", 295 }, 296 .description = "IPWireless converter", 297 .usb_driver = &usb_ipw_driver, 298 .id_table = usb_ipw_ids, 299 .num_ports = 1, 300 .open = ipw_open, 301 .close = ipw_close, 302 .dtr_rts = ipw_dtr_rts, 303 }; 304 305 306 307 static int __init usb_ipw_init(void) 308 { 309 int retval; 310 311 retval = usb_serial_register(&ipw_device); 312 if (retval) 313 return retval; 314 retval = usb_register(&usb_ipw_driver); 315 if (retval) { 316 usb_serial_deregister(&ipw_device); 317 return retval; 318 } 319 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":" 320 DRIVER_DESC "\n"); 321 return 0; 322 } 323 324 static void __exit usb_ipw_exit(void) 325 { 326 usb_deregister(&usb_ipw_driver); 327 usb_serial_deregister(&ipw_device); 328 } 329 330 module_init(usb_ipw_init); 331 module_exit(usb_ipw_exit); 332 333 /* Module information */ 334 MODULE_AUTHOR(DRIVER_AUTHOR); 335 MODULE_DESCRIPTION(DRIVER_DESC); 336 MODULE_LICENSE("GPL"); 337 338 module_param(debug, bool, S_IRUGO | S_IWUSR); 339 MODULE_PARM_DESC(debug, "Debug enabled or not"); 340