[deliverable/linux.git] / include / linux / usb / serial.h

/*
 * USB Serial Converter stuff
 *
 *	Copyright (C) 1999 - 2005
 *	    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; version 2 of the License.
 *
 */

#ifndef __LINUX_USB_SERIAL_H
#define __LINUX_USB_SERIAL_H

#include <linux/kref.h>
#include <linux/mutex.h>

#define SERIAL_TTY_MAJOR	188	/* Nice legal number now */
#define SERIAL_TTY_MINORS	254	/* loads of devices :) */
#define SERIAL_TTY_NO_MINOR	255	/* No minor was assigned */

/* The maximum number of ports one device can grab at once */
#define MAX_NUM_PORTS		8

/* parity check flag */
#define RELEVANT_IFLAG(iflag)	(iflag & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))

/**
 * usb_serial_port: structure for the specific ports of a device.
 * @serial: pointer back to the struct usb_serial owner of this port.
 * @tty: pointer to the corresponding tty for this port.
 * @lock: spinlock to grab when updating portions of this structure.
 * @mutex: mutex used to synchronize serial_open() and serial_close()
 *	access for this port.
 * @number: the number of the port (the minor number).
 * @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
 * @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
 * @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
 *	for this port.
 * @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
 * @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
 * @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
 * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
 * 	for this port.
 * @bulk_in_buffer: pointer to the bulk in buffer for this port.
 * @read_urb: pointer to the bulk in struct urb for this port.
 * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
 *	port.
 * @bulk_out_buffer: pointer to the bulk out buffer for this port.
 * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
 * @write_urb: pointer to the bulk out struct urb for this port.
 * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
 *	port.
 * @write_wait: a wait_queue_head_t used by the port.
 * @work: work queue entry for the line discipline waking up.
 * @open_count: number of times this port has been opened.
 * @throttled: nonzero if the read urb is inactive to throttle the device
 * @throttle_req: nonzero if the tty wants to throttle us
 *
 * This structure is used by the usb-serial core and drivers for the specific
 * ports of a device.
 */
struct usb_serial_port {
	struct usb_serial	*serial;
	struct tty_port		port;
	spinlock_t		lock;
	struct mutex            mutex;
	unsigned char		number;

	unsigned char		*interrupt_in_buffer;
	struct urb		*interrupt_in_urb;
	__u8			interrupt_in_endpointAddress;

	unsigned char		*interrupt_out_buffer;
	int			interrupt_out_size;
	struct urb		*interrupt_out_urb;
	__u8			interrupt_out_endpointAddress;

	unsigned char		*bulk_in_buffer;
	int			bulk_in_size;
	struct urb		*read_urb;
	__u8			bulk_in_endpointAddress;

	unsigned char		*bulk_out_buffer;
	int			bulk_out_size;
	struct urb		*write_urb;
	int			write_urb_busy;
	__u8			bulk_out_endpointAddress;

	wait_queue_head_t	write_wait;
	struct work_struct	work;
	char			throttled;
	char			throttle_req;
	char			console;
	struct device		dev;
};
#define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)

/* get and set the port private data pointer helper functions */
static inline void *usb_get_serial_port_data(struct usb_serial_port *port)
{
	return dev_get_drvdata(&port->dev);
}

static inline void usb_set_serial_port_data(struct usb_serial_port *port,
					    void *data)
{
	dev_set_drvdata(&port->dev, data);
}

/**
 * usb_serial - structure used by the usb-serial core for a device
 * @dev: pointer to the struct usb_device for this device
 * @type: pointer to the struct usb_serial_driver for this device
 * @interface: pointer to the struct usb_interface for this device
 * @minor: the starting minor number for this device
 * @num_ports: the number of ports this device has
 * @num_interrupt_in: number of interrupt in endpoints we have
 * @num_interrupt_out: number of interrupt out endpoints we have
 * @num_bulk_in: number of bulk in endpoints we have
 * @num_bulk_out: number of bulk out endpoints we have
 * @port: array of struct usb_serial_port structures for the different ports.
 * @private: place to put any driver specific information that is needed.  The
 *	usb-serial driver is required to manage this data, the usb-serial core
 *	will not touch this.  Use usb_get_serial_data() and
 *	usb_set_serial_data() to access this.
 */
struct usb_serial {
	struct usb_device		*dev;
	struct usb_serial_driver	*type;
	struct usb_interface		*interface;
	unsigned char			disconnected;
	unsigned char			minor;
	unsigned char			num_ports;
	unsigned char			num_port_pointers;
	char				num_interrupt_in;
	char				num_interrupt_out;
	char				num_bulk_in;
	char				num_bulk_out;
	struct usb_serial_port		*port[MAX_NUM_PORTS];
	struct kref			kref;
	struct mutex			disc_mutex;
	void				*private;
};
#define to_usb_serial(d) container_of(d, struct usb_serial, kref)

/* get and set the serial private data pointer helper functions */
static inline void *usb_get_serial_data(struct usb_serial *serial)
{
	return serial->private;
}

static inline void usb_set_serial_data(struct usb_serial *serial, void *data)
{
	serial->private = data;
}

/**
 * usb_serial_driver - describes a usb serial driver
 * @description: pointer to a string that describes this driver.  This string
 *	used in the syslog messages when a device is inserted or removed.
 * @id_table: pointer to a list of usb_device_id structures that define all
 *	of the devices this structure can support.
 * @num_ports: the number of different ports this device will have.
 * @calc_num_ports: pointer to a function to determine how many ports this
 *	device has dynamically.  It will be called after the probe()
 *	callback is called, but before attach()
 * @probe: pointer to the driver's probe function.
 *	This will be called when the device is inserted into the system,
 *	but before the device has been fully initialized by the usb_serial
 *	subsystem.  Use this function to download any firmware to the device,
 *	or any other early initialization that might be needed.
 *	Return 0 to continue on with the initialization sequence.  Anything
 *	else will abort it.
 * @attach: pointer to the driver's attach function.
 *	This will be called when the struct usb_serial structure is fully set
 *	set up.  Do any local initialization of the device, or any private
 *	memory structure allocation at this point in time.
 * @shutdown: pointer to the driver's shutdown function.  This will be
 *	called when the device is removed from the system.
 * @usb_driver: pointer to the struct usb_driver that controls this
 *	device.  This is necessary to allow dynamic ids to be added to
 *	the driver from sysfs.
 *
 * This structure is defines a USB Serial driver.  It provides all of
 * the information that the USB serial core code needs.  If the function
 * pointers are defined, then the USB serial core code will call them when
 * the corresponding tty port functions are called.  If they are not
 * called, the generic serial function will be used instead.
 *
 * The driver.owner field should be set to the module owner of this driver.
 * The driver.name field should be set to the name of this driver (remember
 * it will show up in sysfs, so it needs to be short and to the point.
 * Using the module name is a good idea.)
 */
struct usb_serial_driver {
	const char *description;
	const struct usb_device_id *id_table;
	char	num_ports;

	struct list_head	driver_list;
	struct device_driver	driver;
	struct usb_driver	*usb_driver;
	struct usb_dynids	dynids;

	int (*probe)(struct usb_serial *serial, const struct usb_device_id *id);
	int (*attach)(struct usb_serial *serial);
	int (*calc_num_ports) (struct usb_serial *serial);

	void (*shutdown)(struct usb_serial *serial);

	int (*port_probe)(struct usb_serial_port *port);
	int (*port_remove)(struct usb_serial_port *port);

	int (*suspend)(struct usb_serial *serial, pm_message_t message);
	int (*resume)(struct usb_serial *serial);

	/* serial function calls */
	/* Called by console with tty = NULL and by tty */
	int  (*open)(struct tty_struct *tty,
			struct usb_serial_port *port, struct file *filp);
	void (*close)(struct tty_struct *tty,
			struct usb_serial_port *port, struct file *filp);
	int  (*write)(struct tty_struct *tty, struct usb_serial_port *port,
			const unsigned char *buf, int count);
	/* Called only by the tty layer */
	int  (*write_room)(struct tty_struct *tty);
	int  (*ioctl)(struct tty_struct *tty, struct file *file,
		      unsigned int cmd, unsigned long arg);
	void (*set_termios)(struct tty_struct *tty,
			struct usb_serial_port *port, struct ktermios *old);
	void (*break_ctl)(struct tty_struct *tty, int break_state);
	int  (*chars_in_buffer)(struct tty_struct *tty);
	void (*throttle)(struct tty_struct *tty);
	void (*unthrottle)(struct tty_struct *tty);
	int  (*tiocmget)(struct tty_struct *tty, struct file *file);
	int  (*tiocmset)(struct tty_struct *tty, struct file *file,
			 unsigned int set, unsigned int clear);
	/* USB events */
	void (*read_int_callback)(struct urb *urb);
	void (*write_int_callback)(struct urb *urb);
	void (*read_bulk_callback)(struct urb *urb);
	void (*write_bulk_callback)(struct urb *urb);
};
#define to_usb_serial_driver(d) \
	container_of(d, struct usb_serial_driver, driver)

extern int  usb_serial_register(struct usb_serial_driver *driver);
extern void usb_serial_deregister(struct usb_serial_driver *driver);
extern void usb_serial_port_softint(struct usb_serial_port *port);

extern int usb_serial_probe(struct usb_interface *iface,
			    const struct usb_device_id *id);
extern void usb_serial_disconnect(struct usb_interface *iface);

extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message);
extern int usb_serial_resume(struct usb_interface *intf);

extern int ezusb_writememory(struct usb_serial *serial, int address,
			     unsigned char *data, int length, __u8 bRequest);
extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit);

/* USB Serial console functions */
#ifdef CONFIG_USB_SERIAL_CONSOLE
extern void usb_serial_console_init(int debug, int minor);
extern void usb_serial_console_exit(void);
extern void usb_serial_console_disconnect(struct usb_serial *serial);
#else
static inline void usb_serial_console_init(int debug, int minor) { }
static inline void usb_serial_console_exit(void) { }
static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}
#endif

/* Functions needed by other parts of the usbserial core */
extern struct usb_serial *usb_serial_get_by_index(unsigned int minor);
extern void usb_serial_put(struct usb_serial *serial);
extern int usb_serial_generic_open(struct tty_struct *tty,
		struct usb_serial_port *port, struct file *filp);
extern int usb_serial_generic_write(struct tty_struct *tty,
	struct usb_serial_port *port, const unsigned char *buf, int count);
extern void usb_serial_generic_close(struct tty_struct *tty,
			struct usb_serial_port *port, struct file *filp);
extern int usb_serial_generic_resume(struct usb_serial *serial);
extern int usb_serial_generic_write_room(struct tty_struct *tty);
extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty);
extern void usb_serial_generic_read_bulk_callback(struct urb *urb);
extern void usb_serial_generic_write_bulk_callback(struct urb *urb);
extern void usb_serial_generic_throttle(struct tty_struct *tty);
extern void usb_serial_generic_unthrottle(struct tty_struct *tty);
extern void usb_serial_generic_shutdown(struct usb_serial *serial);
extern int usb_serial_generic_register(int debug);
extern void usb_serial_generic_deregister(void);

extern int usb_serial_bus_register(struct usb_serial_driver *device);
extern void usb_serial_bus_deregister(struct usb_serial_driver *device);

extern struct usb_serial_driver usb_serial_generic_device;
extern struct bus_type usb_serial_bus_type;
extern struct tty_driver *usb_serial_tty_driver;

static inline void usb_serial_debug_data(int debug,
					 struct device *dev,
					 const char *function, int size,
					 const unsigned char *data)
{
	int i;

	if (debug) {
		dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ",
			   function, size);
		for (i = 0; i < size; ++i)
			printk("%.2x ", data[i]);
		printk("\n");
	}
}

/* Use our own dbg macro */
#undef dbg
#define dbg(format, arg...) \
	do { \
		if (debug) \
			printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , \
				## arg); \
	} while (0)


#endif /* __LINUX_USB_SERIAL_H */
Commit	Line	Data
1da177e4	1	/*
a969888c	2	* USB Serial Converter stuff
1da177e4	3	*
502b95c1	4	* Copyright (C) 1999 - 2005
1da177e4 LT	5	* 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
a969888c	9	* the Free Software Foundation; version 2 of the License.
1da177e4	10	*
1da177e4 LT	11	*/
1da177e4 LT	12
1da177e4 LT	13	#ifndef __LINUX_USB_SERIAL_H
	14	#define __LINUX_USB_SERIAL_H
	15
1da177e4	16	#include <linux/kref.h>
1ce7dd26	17	#include <linux/mutex.h>
1da177e4 LT	18
1da177e4 LT	19	#define SERIAL_TTY_MAJOR 188 /* Nice legal number now */
0282b7f2 AS	20	#define SERIAL_TTY_MINORS 254 /* loads of devices :) */
0282b7f2 AS	21	#define SERIAL_TTY_NO_MINOR 255 /* No minor was assigned */
1da177e4	22
41dceed5 GKH	23	/* The maximum number of ports one device can grab at once */
41dceed5 GKH	24	#define MAX_NUM_PORTS 8
1da177e4 LT	25
	26	/* parity check flag */
	27	#define RELEVANT_IFLAG(iflag) (iflag & (IGNBRK\|BRKINT\|IGNPAR\|PARMRK\|INPCK))
	28
	29	/**
	30	* usb_serial_port: structure for the specific ports of a device.
	31	* @serial: pointer back to the struct usb_serial owner of this port.
	32	* @tty: pointer to the corresponding tty for this port.
507ca9bc	33	* @lock: spinlock to grab when updating portions of this structure.
1ce7dd26	34	* @mutex: mutex used to synchronize serial_open() and serial_close()
8a4613f0	35	* access for this port.
1da177e4 LT	36	* @number: the number of the port (the minor number).
	37	* @interrupt_in_buffer: pointer to the interrupt in buffer for this port.
	38	* @interrupt_in_urb: pointer to the interrupt in struct urb for this port.
	39	* @interrupt_in_endpointAddress: endpoint address for the interrupt in pipe
	40	* for this port.
	41	* @interrupt_out_buffer: pointer to the interrupt out buffer for this port.
	42	* @interrupt_out_size: the size of the interrupt_out_buffer, in bytes.
	43	* @interrupt_out_urb: pointer to the interrupt out struct urb for this port.
	44	* @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
	45	* for this port.
	46	* @bulk_in_buffer: pointer to the bulk in buffer for this port.
	47	* @read_urb: pointer to the bulk in struct urb for this port.
	48	* @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
	49	* port.
	50	* @bulk_out_buffer: pointer to the bulk out buffer for this port.
	51	* @bulk_out_size: the size of the bulk_out_buffer, in bytes.
	52	* @write_urb: pointer to the bulk out struct urb for this port.
	53	* @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
	54	* port.
	55	* @write_wait: a wait_queue_head_t used by the port.
	56	* @work: work queue entry for the line discipline waking up.
	57	* @open_count: number of times this port has been opened.
253ca923 JR	58	* @throttled: nonzero if the read urb is inactive to throttle the device
253ca923 JR	59	* @throttle_req: nonzero if the tty wants to throttle us
1da177e4 LT	60	*
	61	* This structure is used by the usb-serial core and drivers for the specific
	62	* ports of a device.
	63	*/
	64	struct usb_serial_port {
41dceed5	65	struct usb_serial *serial;
95da310e	66	struct tty_port port;
507ca9bc	67	spinlock_t lock;
1ce7dd26	68	struct mutex mutex;
1da177e4 LT	69	unsigned char number;
1da177e4 LT	70
41dceed5 GKH	71	unsigned char *interrupt_in_buffer;
41dceed5 GKH	72	struct urb *interrupt_in_urb;
1da177e4 LT	73	__u8 interrupt_in_endpointAddress;
1da177e4 LT	74
41dceed5	75	unsigned char *interrupt_out_buffer;
1da177e4	76	int interrupt_out_size;
41dceed5	77	struct urb *interrupt_out_urb;
1da177e4 LT	78	__u8 interrupt_out_endpointAddress;
1da177e4 LT	79
41dceed5	80	unsigned char *bulk_in_buffer;
1da177e4	81	int bulk_in_size;
41dceed5	82	struct urb *read_urb;
1da177e4 LT	83	__u8 bulk_in_endpointAddress;
1da177e4 LT	84
41dceed5	85	unsigned char *bulk_out_buffer;
1da177e4	86	int bulk_out_size;
41dceed5	87	struct urb *write_urb;
507ca9bc	88	int write_urb_busy;
1da177e4 LT	89	__u8 bulk_out_endpointAddress;
	90
	91	wait_queue_head_t write_wait;
	92	struct work_struct work;
253ca923 JR	93	char throttled;
253ca923 JR	94	char throttle_req;
9a6b1efa	95	char console;
1da177e4 LT	96	struct device dev;
	97	};
	98	#define to_usb_serial_port(d) container_of(d, struct usb_serial_port, dev)
	99
	100	/* get and set the port private data pointer helper functions */
41dceed5	101	static inline void usb_get_serial_port_data(struct usb_serial_port port)
1da177e4 LT	102	{
	103	return dev_get_drvdata(&port->dev);
	104	}
	105
41dceed5 GKH	106	static inline void usb_set_serial_port_data(struct usb_serial_port *port,
41dceed5 GKH	107	void *data)
1da177e4 LT	108	{
	109	dev_set_drvdata(&port->dev, data);
	110	}
	111
	112	/**
	113	* usb_serial - structure used by the usb-serial core for a device
	114	* @dev: pointer to the struct usb_device for this device
ea65370d	115	* @type: pointer to the struct usb_serial_driver for this device
1da177e4 LT	116	* @interface: pointer to the struct usb_interface for this device
	117	* @minor: the starting minor number for this device
	118	* @num_ports: the number of ports this device has
	119	* @num_interrupt_in: number of interrupt in endpoints we have
	120	* @num_interrupt_out: number of interrupt out endpoints we have
	121	* @num_bulk_in: number of bulk in endpoints we have
	122	* @num_bulk_out: number of bulk out endpoints we have
	123	* @port: array of struct usb_serial_port structures for the different ports.
	124	* @private: place to put any driver specific information that is needed. The
	125	* usb-serial driver is required to manage this data, the usb-serial core
	126	* will not touch this. Use usb_get_serial_data() and
	127	* usb_set_serial_data() to access this.
	128	*/
	129	struct usb_serial {
41dceed5 GKH	130	struct usb_device *dev;
	131	struct usb_serial_driver *type;
	132	struct usb_interface *interface;
a1cd7e99	133	unsigned char disconnected;
1da177e4 LT	134	unsigned char minor;
	135	unsigned char num_ports;
	136	unsigned char num_port_pointers;
	137	char num_interrupt_in;
	138	char num_interrupt_out;
	139	char num_bulk_in;
	140	char num_bulk_out;
41dceed5	141	struct usb_serial_port *port[MAX_NUM_PORTS];
1da177e4	142	struct kref kref;
a1cd7e99	143	struct mutex disc_mutex;
41dceed5	144	void *private;
1da177e4 LT	145	};
	146	#define to_usb_serial(d) container_of(d, struct usb_serial, kref)
	147
1da177e4	148	/* get and set the serial private data pointer helper functions */
41dceed5	149	static inline void usb_get_serial_data(struct usb_serial serial)
1da177e4 LT	150	{
	151	return serial->private;
	152	}
	153
41dceed5	154	static inline void usb_set_serial_data(struct usb_serial serial, void data)
1da177e4 LT	155	{
	156	serial->private = data;
	157	}
	158
	159	/**
ea65370d	160	* usb_serial_driver - describes a usb serial driver
41dceed5 GKH	161	* @description: pointer to a string that describes this driver. This string
41dceed5 GKH	162	* used in the syslog messages when a device is inserted or removed.
1da177e4 LT	163	* @id_table: pointer to a list of usb_device_id structures that define all
1da177e4 LT	164	* of the devices this structure can support.
1da177e4 LT	165	* @num_ports: the number of different ports this device will have.
	166	* @calc_num_ports: pointer to a function to determine how many ports this
	167	* device has dynamically. It will be called after the probe()
	168	* callback is called, but before attach()
	169	* @probe: pointer to the driver's probe function.
	170	* This will be called when the device is inserted into the system,
	171	* but before the device has been fully initialized by the usb_serial
	172	* subsystem. Use this function to download any firmware to the device,
	173	* or any other early initialization that might be needed.
a969888c	174	* Return 0 to continue on with the initialization sequence. Anything
1da177e4 LT	175	* else will abort it.
	176	* @attach: pointer to the driver's attach function.
	177	* This will be called when the struct usb_serial structure is fully set
	178	* set up. Do any local initialization of the device, or any private
	179	* memory structure allocation at this point in time.
	180	* @shutdown: pointer to the driver's shutdown function. This will be
	181	* called when the device is removed from the system.
93bacefc GKH	182	* @usb_driver: pointer to the struct usb_driver that controls this
	183	* device. This is necessary to allow dynamic ids to be added to
	184	* the driver from sysfs.
1da177e4	185	*
ea65370d	186	* This structure is defines a USB Serial driver. It provides all of
1da177e4 LT	187	* the information that the USB serial core code needs. If the function
	188	* pointers are defined, then the USB serial core code will call them when
	189	* the corresponding tty port functions are called. If they are not
	190	* called, the generic serial function will be used instead.
18fcac35 GKH	191	*
18fcac35 GKH	192	* The driver.owner field should be set to the module owner of this driver.
269bda1c GKH	193	* The driver.name field should be set to the name of this driver (remember
269bda1c GKH	194	* it will show up in sysfs, so it needs to be short and to the point.
0b14c388	195	* Using the module name is a good idea.)
1da177e4	196	*/
ea65370d	197	struct usb_serial_driver {
269bda1c	198	const char *description;
1da177e4	199	const struct usb_device_id *id_table;
1da177e4 LT	200	char num_ports;
	201
	202	struct list_head driver_list;
	203	struct device_driver driver;
93bacefc GKH	204	struct usb_driver *usb_driver;
93bacefc GKH	205	struct usb_dynids dynids;
1da177e4	206
41dceed5 GKH	207	int (probe)(struct usb_serial serial, const struct usb_device_id *id);
41dceed5 GKH	208	int (attach)(struct usb_serial serial);
1da177e4 LT	209	int (calc_num_ports) (struct usb_serial serial);
1da177e4 LT	210
41dceed5	211	void (shutdown)(struct usb_serial serial);
1da177e4	212
41dceed5 GKH	213	int (port_probe)(struct usb_serial_port port);
41dceed5 GKH	214	int (port_remove)(struct usb_serial_port port);
1da177e4	215
41dceed5 GKH	216	int (suspend)(struct usb_serial serial, pm_message_t message);
41dceed5 GKH	217	int (resume)(struct usb_serial serial);
ec22559e	218
1da177e4	219	/* serial function calls */
95da310e AC	220	/* Called by console with tty = NULL and by tty */
	221	int (open)(struct tty_struct tty,
	222	struct usb_serial_port port, struct file filp);
	223	void (close)(struct tty_struct tty,
	224	struct usb_serial_port port, struct file filp);
	225	int (write)(struct tty_struct tty, struct usb_serial_port *port,
	226	const unsigned char *buf, int count);
	227	/* Called only by the tty layer */
	228	int (write_room)(struct tty_struct tty);
	229	int (ioctl)(struct tty_struct tty, struct file *file,
41dceed5	230	unsigned int cmd, unsigned long arg);
95da310e AC	231	void (set_termios)(struct tty_struct tty,
	232	struct usb_serial_port port, struct ktermios old);
	233	void (break_ctl)(struct tty_struct tty, int break_state);
	234	int (chars_in_buffer)(struct tty_struct tty);
	235	void (throttle)(struct tty_struct tty);
	236	void (unthrottle)(struct tty_struct tty);
	237	int (tiocmget)(struct tty_struct tty, struct file *file);
	238	int (tiocmset)(struct tty_struct tty, struct file *file,
41dceed5	239	unsigned int set, unsigned int clear);
95da310e	240	/* USB events */
7d12e780 DH	241	void (read_int_callback)(struct urb urb);
	242	void (write_int_callback)(struct urb urb);
	243	void (read_bulk_callback)(struct urb urb);
	244	void (write_bulk_callback)(struct urb urb);
1da177e4	245	};
41dceed5 GKH	246	#define to_usb_serial_driver(d) \
41dceed5 GKH	247	container_of(d, struct usb_serial_driver, driver)
1da177e4	248
ea65370d GKH	249	extern int usb_serial_register(struct usb_serial_driver *driver);
ea65370d GKH	250	extern void usb_serial_deregister(struct usb_serial_driver *driver);
cf2c7481	251	extern void usb_serial_port_softint(struct usb_serial_port *port);
1da177e4	252
41dceed5 GKH	253	extern int usb_serial_probe(struct usb_interface *iface,
41dceed5 GKH	254	const struct usb_device_id *id);
1da177e4 LT	255	extern void usb_serial_disconnect(struct usb_interface *iface);
1da177e4 LT	256
ec22559e ON	257	extern int usb_serial_suspend(struct usb_interface *intf, pm_message_t message);
	258	extern int usb_serial_resume(struct usb_interface *intf);
	259
41dceed5 GKH	260	extern int ezusb_writememory(struct usb_serial *serial, int address,
	261	unsigned char *data, int length, __u8 bRequest);
	262	extern int ezusb_set_reset(struct usb_serial *serial, unsigned char reset_bit);
1da177e4 LT	263
	264	/* USB Serial console functions */
	265	#ifdef CONFIG_USB_SERIAL_CONSOLE
41dceed5 GKH	266	extern void usb_serial_console_init(int debug, int minor);
41dceed5 GKH	267	extern void usb_serial_console_exit(void);
73e487fd	268	extern void usb_serial_console_disconnect(struct usb_serial *serial);
1da177e4	269	#else
41dceed5 GKH	270	static inline void usb_serial_console_init(int debug, int minor) { }
41dceed5 GKH	271	static inline void usb_serial_console_exit(void) { }
73e487fd	272	static inline void usb_serial_console_disconnect(struct usb_serial *serial) {}
1da177e4 LT	273	#endif
	274
	275	/* Functions needed by other parts of the usbserial core */
41dceed5	276	extern struct usb_serial *usb_serial_get_by_index(unsigned int minor);
73e487fd	277	extern void usb_serial_put(struct usb_serial *serial);
95da310e AC	278	extern int usb_serial_generic_open(struct tty_struct *tty,
	279	struct usb_serial_port port, struct file filp);
	280	extern int usb_serial_generic_write(struct tty_struct *tty,
	281	struct usb_serial_port port, const unsigned char buf, int count);
	282	extern void usb_serial_generic_close(struct tty_struct *tty,
	283	struct usb_serial_port port, struct file filp);
41dceed5	284	extern int usb_serial_generic_resume(struct usb_serial *serial);
95da310e AC	285	extern int usb_serial_generic_write_room(struct tty_struct *tty);
95da310e AC	286	extern int usb_serial_generic_chars_in_buffer(struct tty_struct *tty);
41dceed5 GKH	287	extern void usb_serial_generic_read_bulk_callback(struct urb *urb);
41dceed5 GKH	288	extern void usb_serial_generic_write_bulk_callback(struct urb *urb);
95da310e AC	289	extern void usb_serial_generic_throttle(struct tty_struct *tty);
95da310e AC	290	extern void usb_serial_generic_unthrottle(struct tty_struct *tty);
41dceed5 GKH	291	extern void usb_serial_generic_shutdown(struct usb_serial *serial);
	292	extern int usb_serial_generic_register(int debug);
	293	extern void usb_serial_generic_deregister(void);
	294
	295	extern int usb_serial_bus_register(struct usb_serial_driver *device);
	296	extern void usb_serial_bus_deregister(struct usb_serial_driver *device);
1da177e4	297
ea65370d	298	extern struct usb_serial_driver usb_serial_generic_device;
1da177e4 LT	299	extern struct bus_type usb_serial_bus_type;
	300	extern struct tty_driver *usb_serial_tty_driver;
	301
	302	static inline void usb_serial_debug_data(int debug,
	303	struct device *dev,
	304	const char *function, int size,
	305	const unsigned char *data)
	306	{
	307	int i;
	308
	309	if (debug) {
41dceed5 GKH	310	dev_printk(KERN_DEBUG, dev, "%s - length = %d, data = ",
41dceed5 GKH	311	function, size);
1da177e4	312	for (i = 0; i < size; ++i)
41dceed5 GKH	313	printk("%.2x ", data[i]);
41dceed5 GKH	314	printk("\n");
1da177e4 LT	315	}
	316	}
	317
	318	/* Use our own dbg macro */
	319	#undef dbg
41dceed5 GKH	320	#define dbg(format, arg...) \
	321	do { \
	322	if (debug) \
	323	printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , \
	324	## arg); \
	325	} while (0)
1da177e4 LT	326
	327
	328
dda43a0e	329	#endif /* __LINUX_USB_SERIAL_H */
1da177e4	330