[mirror_ubuntu-artful-kernel.git] / drivers / usb / serial / ipw.c

/*
 * IPWireless 3G UMTS TDD Modem driver (USB connected)
 *
 *   Copyright (C) 2004 Roelf Diedericks <roelfd@inet.co.za>
 *   Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 * All information about the device was acquired using SnoopyPro
 * on MSFT's O/S, and examing the MSFT drivers' debug output 
 * (insanely left _on_ in the enduser version)
 *
 * It was written out of frustration with the IPWireless USB modem
 * supplied by Axity3G/Sentech South Africa not supporting
 * Linux whatsoever.
 *
 * Nobody provided any proprietary information that was not already 
 * available for this device.
 * 
 * The modem adheres to the "3GPP TS  27.007 AT command set for 3G 
 * User Equipment (UE)" standard, available from 
 * http://www.3gpp.org/ftp/Specs/html-info/27007.htm
 *
 * The code was only tested the IPWireless handheld modem distributed
 * in South Africa by Sentech.
 * 
 * It may work for Woosh Inc in .nz too, as it appears they use the
 * same kit.
 *
 * There is still some work to be done in terms of handling 
 * DCD, DTR, RTS, CTS which are currently faked.
 * It's good enough for PPP at this point. It's based off all kinds of
 * code found in usb/serial and usb/class
 *
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/spinlock.h>
#include <linux/usb.h>
#include <linux/usb/serial.h>
#include <asm/uaccess.h>

/*
 * Version Information
 */
#define DRIVER_VERSION	"v0.3"
#define DRIVER_AUTHOR	"Roelf Diedericks"
#define DRIVER_DESC	"IPWireless tty driver"

#define IPW_TTY_MAJOR	240	/* real device node major id, experimental range */
#define IPW_TTY_MINORS	256	/* we support 256 devices, dunno why, it'd be insane :) */

#define USB_IPW_MAGIC	0x6d02	/* magic number for ipw struct */


/* Message sizes */
#define EVENT_BUFFER_SIZE	0xFF
#define CHAR2INT16(c1,c0)	(((u32)((c1) & 0xff) << 8) + (u32)((c0) & 0xff))
#define NUM_BULK_URBS		24
#define NUM_CONTROL_URBS	16

/* vendor/product pairs that are known work with this driver*/
#define IPW_VID		0x0bc3
#define IPW_PID		0x0001


/* Vendor commands: */

/* baud rates */
enum {
	ipw_sio_b256000 = 0x000e,
	ipw_sio_b128000 = 0x001d,
	ipw_sio_b115200 = 0x0020,
	ipw_sio_b57600  = 0x0040,
	ipw_sio_b56000  = 0x0042,
	ipw_sio_b38400  = 0x0060,
	ipw_sio_b19200  = 0x00c0,
	ipw_sio_b14400  = 0x0100,
	ipw_sio_b9600   = 0x0180,
	ipw_sio_b4800   = 0x0300,
	ipw_sio_b2400   = 0x0600,
	ipw_sio_b1200   = 0x0c00,
	ipw_sio_b600    = 0x1800
};

/* data bits */
#define ipw_dtb_7		0x700
#define ipw_dtb_8		0x810	// ok so the define is misleading, I know, but forces 8,n,1
					// I mean, is there a point to any other setting these days? :)	

/* usb control request types : */
#define IPW_SIO_RXCTL		0x00	// control bulk rx channel transmissions, value=1/0 (on/off)
#define IPW_SIO_SET_BAUD	0x01	// set baud, value=requested ipw_sio_bxxxx
#define IPW_SIO_SET_LINE	0x03	// set databits, parity. value=ipw_dtb_x
#define IPW_SIO_SET_PIN		0x03	// set/clear dtr/rts value=ipw_pin_xxx
#define IPW_SIO_POLL		0x08	// get serial port status byte, call with value=0
#define IPW_SIO_INIT		0x11	// initializes ? value=0 (appears as first thing todo on open)
#define IPW_SIO_PURGE		0x12	// purge all transmissions?, call with value=numchar_to_purge
#define IPW_SIO_HANDFLOW	0x13	// set xon/xoff limits value=0, and a buffer of 0x10 bytes
#define IPW_SIO_SETCHARS	0x13	// set the flowcontrol special chars, value=0, buf=6 bytes, 
					// last 2 bytes contain flowcontrol chars e.g. 00 00 00 00 11 13

/* values used for request IPW_SIO_SET_PIN */
#define IPW_PIN_SETDTR		0x101
#define IPW_PIN_SETRTS		0x202
#define IPW_PIN_CLRDTR		0x100
#define IPW_PIN_CLRRTS		0x200 // unconfirmed

/* values used for request IPW_SIO_RXCTL */
#define IPW_RXBULK_ON		1
#define IPW_RXBULK_OFF		0

/* various 16 byte hardcoded transferbuffers used by flow control */
#define IPW_BYTES_FLOWINIT	{ 0x01, 0, 0, 0, 0x40, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }

/* Interpretation of modem status lines */
/* These need sorting out by individually connecting pins and checking
 * results. FIXME!
 * When data is being sent we see 0x30 in the lower byte; this must
 * contain DSR and CTS ...
 */
#define IPW_DSR			((1<<4) | (1<<5))
#define IPW_CTS			((1<<5) | (1<<4))

#define IPW_WANTS_TO_SEND	0x30
//#define IPW_DTR			/* Data Terminal Ready */
//#define IPW_CTS			/* Clear To Send */
//#define IPW_CD			/* Carrier Detect */
//#define IPW_DSR			/* Data Set Ready */
//#define IPW_RxD			/* Receive pin */

//#define IPW_LE
//#define IPW_RTS		
//#define IPW_ST		
//#define IPW_SR		
//#define IPW_RI			/* Ring Indicator */

static struct usb_device_id usb_ipw_ids[] = {
	{ USB_DEVICE(IPW_VID, IPW_PID) },
	{ },
};

MODULE_DEVICE_TABLE(usb, usb_ipw_ids);

static struct usb_driver usb_ipw_driver = {
	.name =		"ipwtty",
	.probe =	usb_serial_probe,
	.disconnect =	usb_serial_disconnect,
	.id_table =	usb_ipw_ids,
	.no_dynamic_id = 	1,
};

static int debug;

static void ipw_read_bulk_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;
	unsigned char *data = urb->transfer_buffer;
	struct tty_struct *tty;
	int result;

	dbg("%s - port %d", __FUNCTION__, port->number);

	if (urb->status) {
		dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
		return;
	}

	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);

	tty = port->tty;
	if (tty && urb->actual_length) {
		tty_buffer_request_room(tty, urb->actual_length);
		tty_insert_flip_string(tty, data, urb->actual_length);
		tty_flip_buffer_push(tty);
	}

	/* Continue trying to always read  */
	usb_fill_bulk_urb (port->read_urb, port->serial->dev,
			   usb_rcvbulkpipe(port->serial->dev,
					   port->bulk_in_endpointAddress),
			   port->read_urb->transfer_buffer,
			   port->read_urb->transfer_buffer_length,
			   ipw_read_bulk_callback, port);
	result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
	if (result)
		dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
	return;
}

static int ipw_open(struct usb_serial_port *port, struct file *filp)
{
	struct usb_device *dev = port->serial->dev;
	u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT;
	u8 *buf_flow_init;
	int result;

	dbg("%s", __FUNCTION__);

	buf_flow_init = kmalloc(16, GFP_KERNEL);
	if (!buf_flow_init)
		return -ENOMEM;
	memcpy(buf_flow_init, buf_flow_static, 16);

	if (port->tty)
		port->tty->low_latency = 1;

	/* --1: Tell the modem to initialize (we think) From sniffs this is always the
	 * first thing that gets sent to the modem during opening of the device */
	dbg("%s: Sending SIO_INIT (we guess)",__FUNCTION__);
	result = usb_control_msg(dev, usb_sndctrlpipe(dev,0),
				 IPW_SIO_INIT,
				 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 0,
				 0, /* index */
				 NULL,
				 0,
				 100000);
	if (result < 0)
		dev_err(&port->dev, "Init of modem failed (error = %d)", result);

	/* reset the bulk pipes */
	usb_clear_halt(dev, usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress));
	usb_clear_halt(dev, usb_sndbulkpipe(dev, port->bulk_out_endpointAddress));

	/*--2: Start reading from the device */	
	dbg("%s: setting up bulk read callback",__FUNCTION__);
	usb_fill_bulk_urb(port->read_urb, dev,
			  usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
			  port->bulk_in_buffer,
			  port->bulk_in_size,
			  ipw_read_bulk_callback, port);
	result = usb_submit_urb(port->read_urb, GFP_KERNEL);
	if (result < 0)
		dbg("%s - usb_submit_urb(read bulk) failed with status %d", __FUNCTION__, result);

	/*--3: Tell the modem to open the floodgates on the rx bulk channel */
	dbg("%s:asking modem for RxRead (RXBULK_ON)",__FUNCTION__);
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 IPW_SIO_RXCTL,
				 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 IPW_RXBULK_ON,
				 0, /* index */
				 NULL,
				 0,
				 100000);
	if (result < 0) 
		dev_err(&port->dev, "Enabling bulk RxRead failed (error = %d)", result);

	/*--4: setup the initial flowcontrol */
	dbg("%s:setting init flowcontrol (%s)",__FUNCTION__,buf_flow_init);
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 IPW_SIO_HANDFLOW,
				 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 0,
				 0,
				 buf_flow_init,
				 0x10,
				 200000);
	if (result < 0)
		dev_err(&port->dev, "initial flowcontrol failed (error = %d)", result);


	/*--5: raise the dtr */
	dbg("%s:raising dtr",__FUNCTION__);
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 IPW_SIO_SET_PIN,
				 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 IPW_PIN_SETDTR,
				 0,
				 NULL,
				 0,
				 200000);
	if (result < 0)
		dev_err(&port->dev, "setting dtr failed (error = %d)", result);

	/*--6: raise the rts */
	dbg("%s:raising rts",__FUNCTION__);
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 IPW_SIO_SET_PIN,
				 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 IPW_PIN_SETRTS,
				 0,
				 NULL,
				 0,
				 200000);
	if (result < 0)
		dev_err(&port->dev, "setting dtr failed (error = %d)", result);
	
	kfree(buf_flow_init);
	return 0;
}

static void ipw_close(struct usb_serial_port *port, struct file * filp)
{
	struct usb_device *dev = port->serial->dev;
	int result;

	if (tty_hung_up_p(filp)) {
		dbg("%s: tty_hung_up_p ...", __FUNCTION__);
		return;
	}

	/*--1: drop the dtr */
	dbg("%s:dropping dtr",__FUNCTION__);
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 IPW_SIO_SET_PIN,
				 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 IPW_PIN_CLRDTR,
				 0,
				 NULL,
				 0,
				 200000);
	if (result < 0)
		dev_err(&port->dev, "dropping dtr failed (error = %d)", result);

	/*--2: drop the rts */
	dbg("%s:dropping rts",__FUNCTION__);
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 IPW_SIO_SET_PIN, USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 IPW_PIN_CLRRTS,
				 0,
				 NULL,
				 0,
				 200000);
	if (result < 0)
		dev_err(&port->dev, "dropping rts failed (error = %d)", result);


	/*--3: purge */
	dbg("%s:sending purge",__FUNCTION__);
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 IPW_SIO_PURGE, USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 0x03,
				 0,
				 NULL,
				 0,
				 200000);
	if (result < 0)
		dev_err(&port->dev, "purge failed (error = %d)", result);


	/* send RXBULK_off (tell modem to stop transmitting bulk data on rx chan) */
	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 IPW_SIO_RXCTL,
				 USB_TYPE_VENDOR | USB_RECIP_INTERFACE | USB_DIR_OUT,
				 IPW_RXBULK_OFF,
				 0, /* index */
				 NULL,
				 0,
				 100000);

	if (result < 0)
		dev_err(&port->dev, "Disabling bulk RxRead failed (error = %d)", result);

	/* shutdown any in-flight urbs that we know about */
	usb_kill_urb(port->read_urb);
	usb_kill_urb(port->write_urb);
}

static void ipw_write_bulk_callback(struct urb *urb)
{
	struct usb_serial_port *port = urb->context;

	dbg("%s", __FUNCTION__);

	port->write_urb_busy = 0;

	if (urb->status)
		dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);

	usb_serial_port_softint(port);
}

static int ipw_write(struct usb_serial_port *port, const unsigned char *buf, int count)
{
	struct usb_device *dev = port->serial->dev;
	int ret;

	dbg("%s: TOP: count=%d, in_interrupt=%ld", __FUNCTION__,
		count, in_interrupt() );

	if (count == 0) {
		dbg("%s - write request of 0 bytes", __FUNCTION__);
		return 0;
	}

	spin_lock_bh(&port->lock);
	if (port->write_urb_busy) {
		spin_unlock_bh(&port->lock);
		dbg("%s - already writing", __FUNCTION__);
		return 0;
	}
	port->write_urb_busy = 1;
	spin_unlock_bh(&port->lock);

	count = min(count, port->bulk_out_size);
	memcpy(port->bulk_out_buffer, buf, count);

	dbg("%s count now:%d", __FUNCTION__, count);

	usb_fill_bulk_urb(port->write_urb, dev,
			  usb_sndbulkpipe(dev, port->bulk_out_endpointAddress),
			  port->write_urb->transfer_buffer,
			  count,
			  ipw_write_bulk_callback,
			  port);

	ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
	if (ret != 0) {
		port->write_urb_busy = 0;
		dbg("%s - usb_submit_urb(write bulk) failed with error = %d", __FUNCTION__, ret);
		return ret;
	}

	dbg("%s returning %d", __FUNCTION__, count);
	return count;
} 

static int ipw_probe(struct usb_serial_port *port)
{
	return 0;
}

static int ipw_disconnect(struct usb_serial_port *port)
{
	usb_set_serial_port_data(port, NULL);
	return 0;
}

static struct usb_serial_driver ipw_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"ipw",
	},
	.description =		"IPWireless converter",
	.id_table =		usb_ipw_ids,
	.num_interrupt_in =	NUM_DONT_CARE,
	.num_bulk_in =		1,
	.num_bulk_out =		1,
	.num_ports =		1,
	.open =			ipw_open,
	.close =		ipw_close,
	.port_probe = 		ipw_probe,
	.port_remove =		ipw_disconnect,
	.write =		ipw_write,
	.write_bulk_callback =	ipw_write_bulk_callback,
	.read_bulk_callback =	ipw_read_bulk_callback,
};


static int usb_ipw_init(void)
{
	int retval;

	retval = usb_serial_register(&ipw_device);
	if (retval)
		return retval;
	retval = usb_register(&usb_ipw_driver);
	if (retval) {
		usb_serial_deregister(&ipw_device);
		return retval;
	}
	info(DRIVER_DESC " " DRIVER_VERSION);
	return 0;
}

static void usb_ipw_exit(void)
{
	usb_deregister(&usb_ipw_driver);
	usb_serial_deregister(&ipw_device);
}

module_init(usb_ipw_init);
module_exit(usb_ipw_exit);

/* Module information */
MODULE_AUTHOR( DRIVER_AUTHOR );
MODULE_DESCRIPTION( DRIVER_DESC );
MODULE_LICENSE("GPL");

module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug enabled or not");
Commit	Line	Data
1da177e4 LT	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
	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>
a969888c	49	#include <linux/usb/serial.h>
1da177e4	50	#include <asm/uaccess.h>
1da177e4 LT	51
	52	/*
	53	* Version Information
	54	*/
	55	#define DRIVER_VERSION "v0.3"
	56	#define DRIVER_AUTHOR "Roelf Diedericks"
	57	#define DRIVER_DESC "IPWireless tty driver"
	58
	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 :) */
	61
	62	#define USB_IPW_MAGIC 0x6d02 /* magic number for ipw struct */
	63
	64
	65	/* Message sizes */
	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
	70
	71	/* vendor/product pairs that are known work with this driver*/
	72	#define IPW_VID 0x0bc3
	73	#define IPW_PID 0x0001
	74
	75
	76	/* Vendor commands: */
	77
	78	/* baud rates */
	79	enum {
	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,
	92	ipw_sio_b600 = 0x1800
	93	};
	94
	95	/* data bits */
	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? :)
	99
	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
	111
	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
117
118	/* values used for request IPW_SIO_RXCTL */
119	#define IPW_RXBULK_ON 1
120	#define IPW_RXBULK_OFF 0
121
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 }
124
125	/* Interpretation of modem status lines */
126	/* These need sorting out by individually connecting pins and checking
127	* results. FIXME!
128	* When data is being sent we see 0x30 in the lower byte; this must
129	* contain DSR and CTS ...
130	*/
131	#define IPW_DSR ((1<<4) \| (1<<5))
132	#define IPW_CTS ((1<<5) \| (1<<4))
133
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 */
140
141	//#define IPW_LE
142	//#define IPW_RTS
143	//#define IPW_ST
144	//#define IPW_SR
145	//#define IPW_RI /* Ring Indicator */
146
147	static struct usb_device_id usb_ipw_ids[] = {
148	{ USB_DEVICE(IPW_VID, IPW_PID) },
149	{ },
150	};
151
152	MODULE_DEVICE_TABLE(usb, usb_ipw_ids);
153
154	static struct usb_driver usb_ipw_driver = {
1da177e4 LT	155	.name = "ipwtty",
	156	.probe = usb_serial_probe,
	157	.disconnect = usb_serial_disconnect,
	158	.id_table = usb_ipw_ids,
ba9dc657	159	.no_dynamic_id = 1,
1da177e4 LT	160	};
	161
	162	static int debug;
	163
7d12e780	164	static void ipw_read_bulk_callback(struct urb *urb)
1da177e4 LT	165	{
	166	struct usb_serial_port *port = urb->context;
	167	unsigned char *data = urb->transfer_buffer;
	168	struct tty_struct *tty;
1da177e4 LT	169	int result;
	170
	171	dbg("%s - port %d", __FUNCTION__, port->number);
	172
	173	if (urb->status) {
	174	dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
	175	return;
	176	}
	177
	178	usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
	179
	180	tty = port->tty;
	181	if (tty && urb->actual_length) {
33f0f88f AC	182	tty_buffer_request_room(tty, urb->actual_length);
33f0f88f AC	183	tty_insert_flip_string(tty, data, urb->actual_length);
1da177e4 LT	184	tty_flip_buffer_push(tty);
	185	}
	186
	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);
	195	if (result)
	196	dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
	197	return;
	198	}
	199
	200	static int ipw_open(struct usb_serial_port port, struct file filp)
	201	{
	202	struct usb_device *dev = port->serial->dev;
	203	u8 buf_flow_static[16] = IPW_BYTES_FLOWINIT;
	204	u8 *buf_flow_init;
	205	int result;
	206
	207	dbg("%s", __FUNCTION__);
	208
	209	buf_flow_init = kmalloc(16, GFP_KERNEL);
	210	if (!buf_flow_init)
	211	return -ENOMEM;
	212	memcpy(buf_flow_init, buf_flow_static, 16);
	213
	214	if (port->tty)
	215	port->tty->low_latency = 1;
	216
	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),
	221	IPW_SIO_INIT,
	222	USB_TYPE_VENDOR \| USB_RECIP_INTERFACE \| USB_DIR_OUT,
	223	0,
	224	0, /* index */
	225	NULL,
	226	0,
	227	100000);
	228	if (result < 0)
	229	dev_err(&port->dev, "Init of modem failed (error = %d)", result);
	230
	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));
	234
	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,
	240	port->bulk_in_size,
	241	ipw_read_bulk_callback, port);
	242	result = usb_submit_urb(port->read_urb, GFP_KERNEL);
	243	if (result < 0)
	244	dbg("%s - usb_submit_urb(read bulk) failed with status %d", __FUNCTION__, result);
	245
	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),
249	IPW_SIO_RXCTL,
250	USB_TYPE_VENDOR \| USB_RECIP_INTERFACE \| USB_DIR_OUT,
251	IPW_RXBULK_ON,
252	0, /* index */
253	NULL,
254	0,
255	100000);
256	if (result < 0)
257	dev_err(&port->dev, "Enabling bulk RxRead failed (error = %d)", result);
258
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),
262	IPW_SIO_HANDFLOW,
263	USB_TYPE_VENDOR \| USB_RECIP_INTERFACE \| USB_DIR_OUT,
264	0,
265	0,
266	buf_flow_init,
267	0x10,
268	200000);
269	if (result < 0)
270	dev_err(&port->dev, "initial flowcontrol failed (error = %d)", result);
271
272
273	/--5: raise the dtr /
274	dbg("%s:raising dtr",__FUNCTION__);
275	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
276	IPW_SIO_SET_PIN,
277	USB_TYPE_VENDOR \| USB_RECIP_INTERFACE \| USB_DIR_OUT,
278	IPW_PIN_SETDTR,
279	0,
280	NULL,
281	0,
282	200000);
283	if (result < 0)
284	dev_err(&port->dev, "setting dtr failed (error = %d)", result);
285
286	/--6: raise the rts /
287	dbg("%s:raising rts",__FUNCTION__);
288	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
289	IPW_SIO_SET_PIN,
290	USB_TYPE_VENDOR \| USB_RECIP_INTERFACE \| USB_DIR_OUT,
291	IPW_PIN_SETRTS,
292	0,
293	NULL,
294	0,
295	200000);
296	if (result < 0)
297	dev_err(&port->dev, "setting dtr failed (error = %d)", result);
298
299	kfree(buf_flow_init);
300	return 0;
301	}
302
303	static void ipw_close(struct usb_serial_port port, struct file filp)
304	{
305	struct usb_device *dev = port->serial->dev;
306	int result;
307
308	if (tty_hung_up_p(filp)) {
309	dbg("%s: tty_hung_up_p ...", __FUNCTION__);
310	return;
311	}
312
313	/--1: drop the dtr /
314	dbg("%s:dropping dtr",__FUNCTION__);
315	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
316	IPW_SIO_SET_PIN,
317	USB_TYPE_VENDOR \| USB_RECIP_INTERFACE \| USB_DIR_OUT,
318	IPW_PIN_CLRDTR,
319	0,
320	NULL,
321	0,
322	200000);
323	if (result < 0)
324	dev_err(&port->dev, "dropping dtr failed (error = %d)", result);
325
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,
330	IPW_PIN_CLRRTS,
331	0,
332	NULL,
333	0,
334	200000);
335	if (result < 0)
336	dev_err(&port->dev, "dropping rts failed (error = %d)", result);
337
338
339	/--3: purge /
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,
343	0x03,
344	0,
345	NULL,
346	0,
347	200000);
348	if (result < 0)
349	dev_err(&port->dev, "purge failed (error = %d)", result);
350
351
352	/* send RXBULK_off (tell modem to stop transmitting bulk data on rx chan) */
353	result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
354	IPW_SIO_RXCTL,
355	USB_TYPE_VENDOR \| USB_RECIP_INTERFACE \| USB_DIR_OUT,
356	IPW_RXBULK_OFF,
357	0, /* index */
358	NULL,
359	0,
360	100000);
361
362	if (result < 0)
363	dev_err(&port->dev, "Disabling bulk RxRead failed (error = %d)", result);
364
365	/* shutdown any in-flight urbs that we know about */
366	usb_kill_urb(port->read_urb);
367	usb_kill_urb(port->write_urb);
368	}
369
7d12e780	370	static void ipw_write_bulk_callback(struct urb *urb)
1da177e4 LT	371	{
	372	struct usb_serial_port *port = urb->context;
	373
	374	dbg("%s", __FUNCTION__);
	375
b2f1b0d4 BO	376	port->write_urb_busy = 0;
b2f1b0d4 BO	377
1da177e4 LT	378	if (urb->status)
	379	dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
	380
cf2c7481	381	usb_serial_port_softint(port);
1da177e4 LT	382	}
	383
	384	static int ipw_write(struct usb_serial_port port, const unsigned char buf, int count)
	385	{
	386	struct usb_device *dev = port->serial->dev;
	387	int ret;
	388
	389	dbg("%s: TOP: count=%d, in_interrupt=%ld", __FUNCTION__,
	390	count, in_interrupt() );
	391
	392	if (count == 0) {
	393	dbg("%s - write request of 0 bytes", __FUNCTION__);
	394	return 0;
	395	}
507ca9bc	396
e81ee637	397	spin_lock_bh(&port->lock);
507ca9bc	398	if (port->write_urb_busy) {
e81ee637	399	spin_unlock_bh(&port->lock);
507ca9bc	400	dbg("%s - already writing", __FUNCTION__);
1da177e4	401	return 0;
507ca9bc GKH	402	}
507ca9bc GKH	403	port->write_urb_busy = 1;
e81ee637	404	spin_unlock_bh(&port->lock);
1da177e4 LT	405
	406	count = min(count, port->bulk_out_size);
	407	memcpy(port->bulk_out_buffer, buf, count);
	408
	409	dbg("%s count now:%d", __FUNCTION__, count);
507ca9bc	410
1da177e4 LT	411	usb_fill_bulk_urb(port->write_urb, dev,
	412	usb_sndbulkpipe(dev, port->bulk_out_endpointAddress),
	413	port->write_urb->transfer_buffer,
	414	count,
	415	ipw_write_bulk_callback,
	416	port);
	417
	418	ret = usb_submit_urb(port->write_urb, GFP_ATOMIC);
	419	if (ret != 0) {
507ca9bc	420	port->write_urb_busy = 0;
1da177e4 LT	421	dbg("%s - usb_submit_urb(write bulk) failed with error = %d", __FUNCTION__, ret);
	422	return ret;
	423	}
	424
	425	dbg("%s returning %d", __FUNCTION__, count);
	426	return count;
	427	}
	428
	429	static int ipw_probe(struct usb_serial_port *port)
	430	{
	431	return 0;
	432	}
	433
	434	static int ipw_disconnect(struct usb_serial_port *port)
	435	{
	436	usb_set_serial_port_data(port, NULL);
	437	return 0;
	438	}
	439
ea65370d	440	static struct usb_serial_driver ipw_device = {
18fcac35 GKH	441	.driver = {
18fcac35 GKH	442	.owner = THIS_MODULE,
269bda1c	443	.name = "ipw",
18fcac35	444	},
269bda1c	445	.description = "IPWireless converter",
1da177e4 LT	446	.id_table = usb_ipw_ids,
	447	.num_interrupt_in = NUM_DONT_CARE,
	448	.num_bulk_in = 1,
	449	.num_bulk_out = 1,
	450	.num_ports = 1,
	451	.open = ipw_open,
	452	.close = ipw_close,
	453	.port_probe = ipw_probe,
	454	.port_remove = ipw_disconnect,
	455	.write = ipw_write,
	456	.write_bulk_callback = ipw_write_bulk_callback,
	457	.read_bulk_callback = ipw_read_bulk_callback,
	458	};
	459
	460
	461
	462	static int usb_ipw_init(void)
	463	{
	464	int retval;
	465
	466	retval = usb_serial_register(&ipw_device);
	467	if (retval)
	468	return retval;
	469	retval = usb_register(&usb_ipw_driver);
	470	if (retval) {
	471	usb_serial_deregister(&ipw_device);
	472	return retval;
	473	}
	474	info(DRIVER_DESC " " DRIVER_VERSION);
	475	return 0;
	476	}
	477
	478	static void usb_ipw_exit(void)
	479	{
	480	usb_deregister(&usb_ipw_driver);
	481	usb_serial_deregister(&ipw_device);
	482	}
	483
	484	module_init(usb_ipw_init);
	485	module_exit(usb_ipw_exit);
	486
	487	/* Module information */
	488	MODULE_AUTHOR( DRIVER_AUTHOR );
	489	MODULE_DESCRIPTION( DRIVER_DESC );
	490	MODULE_LICENSE("GPL");
	491
	492	module_param(debug, bool, S_IRUGO \| S_IWUSR);
	493	MODULE_PARM_DESC(debug, "Debug enabled or not");