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