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 */ 76enum { 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#define IPW_DSR ((1<<4) | (1<<5)) 125#define IPW_CTS ((1<<5) | (1<<4)) 126 127#define IPW_WANTS_TO_SEND 0x30 128 129static const struct usb_device_id usb_ipw_ids[] = { 130 { USB_DEVICE(IPW_VID, IPW_PID) }, 131 { }, 132}; 133 134MODULE_DEVICE_TABLE(usb, usb_ipw_ids); 135 136static struct usb_driver usb_ipw_driver = { 137 .name = "ipwtty", 138 .probe = usb_serial_probe, 139 .disconnect = usb_serial_disconnect, 140 .id_table = usb_ipw_ids, 141 .no_dynamic_id = 1, 142}; 143 144static int debug; 145 146static int ipw_open(struct tty_struct *tty, struct usb_serial_port *port) 147{ 148 struct usb_device *dev = port->serial->dev; 149 u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT; 150 u8 *buf_flow_init; 151 int result; 152 153 dbg("%s", __func__); 154 155 buf_flow_init = kmemdup(buf_flow_static, 16, GFP_KERNEL); 156 if (!buf_flow_init) 157 return -ENOMEM; 158 159 /* --1: Tell the modem to initialize (we think) From sniffs this is 160 * always the first thing that gets sent to the modem during 161 * opening of the device */ 162 dbg("%s: Sending SIO_INIT (we guess)", __func__); 163 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 164 IPW_SIO_INIT, 165 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 166 0, 167 0, /* index */ 168 NULL, 169 0, 170 100000); 171 if (result < 0) 172 dev_err(&port->dev, 173 "Init of modem failed (error = %d)\n", result); 174 175 /* reset the bulk pipes */ 176 usb_clear_halt(dev, 177 usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress)); 178 usb_clear_halt(dev, 179 usb_sndbulkpipe(dev, port->bulk_out_endpointAddress)); 180 181 /*--2: Start reading from the device */ 182 dbg("%s: setting up bulk read callback", __func__); 183 usb_serial_generic_open(tty, port); 184 185 /*--3: Tell the modem to open the floodgates on the rx bulk channel */ 186 dbg("%s:asking modem for RxRead (RXBULK_ON)", __func__); 187 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 188 IPW_SIO_RXCTL, 189 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 190 IPW_RXBULK_ON, 191 0, /* index */ 192 NULL, 193 0, 194 100000); 195 if (result < 0) 196 dev_err(&port->dev, 197 "Enabling bulk RxRead failed (error = %d)\n", result); 198 199 /*--4: setup the initial flowcontrol */ 200 dbg("%s:setting init flowcontrol (%s)", __func__, buf_flow_init); 201 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 202 IPW_SIO_HANDFLOW, 203 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 204 0, 205 0, 206 buf_flow_init, 207 0x10, 208 200000); 209 if (result < 0) 210 dev_err(&port->dev, 211 "initial flowcontrol failed (error = %d)\n", result); 212 213 kfree(buf_flow_init); 214 return 0; 215} 216 217static void ipw_dtr_rts(struct usb_serial_port *port, int on) 218{ 219 struct usb_device *dev = port->serial->dev; 220 int result; 221 222 dbg("%s: on = %d", __func__, on); 223 224 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 225 IPW_SIO_SET_PIN, 226 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 227 on ? IPW_PIN_SETDTR : IPW_PIN_CLRDTR, 228 0, 229 NULL, 230 0, 231 200000); 232 if (result < 0) 233 dev_err(&port->dev, "setting dtr failed (error = %d)\n", 234 result); 235 236 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 237 IPW_SIO_SET_PIN, USB_TYPE_VENDOR | 238 USB_RECIP_INTERFACE | USB_DIR_OUT, 239 on ? IPW_PIN_SETRTS : IPW_PIN_CLRRTS, 240 0, 241 NULL, 242 0, 243 200000); 244 if (result < 0) 245 dev_err(&port->dev, "setting rts failed (error = %d)\n", 246 result); 247} 248 249static void ipw_close(struct usb_serial_port *port) 250{ 251 struct usb_device *dev = port->serial->dev; 252 int result; 253 254 /*--3: purge */ 255 dbg("%s:sending purge", __func__); 256 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 257 IPW_SIO_PURGE, USB_TYPE_VENDOR | 258 USB_RECIP_INTERFACE | USB_DIR_OUT, 259 0x03, 260 0, 261 NULL, 262 0, 263 200000); 264 if (result < 0) 265 dev_err(&port->dev, "purge failed (error = %d)\n", result); 266 267 268 /* send RXBULK_off (tell modem to stop transmitting bulk data on 269 rx chan) */ 270 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 271 IPW_SIO_RXCTL, 272 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT, 273 IPW_RXBULK_OFF, 274 0, /* index */ 275 NULL, 276 0, 277 100000); 278 279 if (result < 0) 280 dev_err(&port->dev, 281 "Disabling bulk RxRead failed (error = %d)\n", result); 282 283 usb_serial_generic_close(port); 284} 285 286static struct usb_serial_driver ipw_device = { 287 .driver = { 288 .owner = THIS_MODULE, 289 .name = "ipw", 290 }, 291 .description = "IPWireless converter", 292 .usb_driver = &usb_ipw_driver, 293 .id_table = usb_ipw_ids, 294 .num_ports = 1, 295 .open = ipw_open, 296 .close = ipw_close, 297 .dtr_rts = ipw_dtr_rts, 298}; 299 300 301 302static int __init usb_ipw_init(void) 303{ 304 int retval; 305 306 retval = usb_serial_register(&ipw_device); 307 if (retval) 308 return retval; 309 retval = usb_register(&usb_ipw_driver); 310 if (retval) { 311 usb_serial_deregister(&ipw_device); 312 return retval; 313 } 314 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":" 315 DRIVER_DESC "\n"); 316 return 0; 317} 318 319static void __exit usb_ipw_exit(void) 320{ 321 usb_deregister(&usb_ipw_driver); 322 usb_serial_deregister(&ipw_device); 323} 324 325module_init(usb_ipw_init); 326module_exit(usb_ipw_exit); 327 328/* Module information */ 329MODULE_AUTHOR(DRIVER_AUTHOR); 330MODULE_DESCRIPTION(DRIVER_DESC); 331MODULE_LICENSE("GPL"); 332 333module_param(debug, bool, S_IRUGO | S_IWUSR); 334MODULE_PARM_DESC(debug, "Debug enabled or not"); 335