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