kbuild: document howto build external modules using several directories
[linux-2.6/verdex.git] / drivers / usb / class / cdc-acm.h
blobfd2aaccdcbac7a4d04cc65f74743ea92541299fe
1 /*
3 * Includes for cdc-acm.c
5 * Mainly take from usbnet's cdc-ether part
7 */
9 /*
10 * CMSPAR, some architectures can't have space and mark parity.
13 #ifndef CMSPAR
14 #define CMSPAR 0
15 #endif
18 * Major and minor numbers.
21 #define ACM_TTY_MAJOR 166
22 #define ACM_TTY_MINORS 32
25 * Requests.
28 #define USB_RT_ACM (USB_TYPE_CLASS | USB_RECIP_INTERFACE)
31 * Output control lines.
34 #define ACM_CTRL_DTR 0x01
35 #define ACM_CTRL_RTS 0x02
38 * Input control lines and line errors.
41 #define ACM_CTRL_DCD 0x01
42 #define ACM_CTRL_DSR 0x02
43 #define ACM_CTRL_BRK 0x04
44 #define ACM_CTRL_RI 0x08
46 #define ACM_CTRL_FRAMING 0x10
47 #define ACM_CTRL_PARITY 0x20
48 #define ACM_CTRL_OVERRUN 0x40
51 * Internal driver structures.
55 * The only reason to have several buffers is to accomodate assumptions
56 * in line disciplines. They ask for empty space amount, receive our URB size,
57 * and proceed to issue several 1-character writes, assuming they will fit.
58 * The very first write takes a complete URB. Fortunately, this only happens
59 * when processing onlcr, so we only need 2 buffers.
61 #define ACM_NWB 2
62 #define ACM_NRU 16
63 #define ACM_NRB 16
65 struct acm_wb {
66 unsigned char *buf;
67 dma_addr_t dmah;
68 int len;
69 int use;
72 struct acm_rb {
73 struct list_head list;
74 int size;
75 unsigned char *base;
76 dma_addr_t dma;
79 struct acm_ru {
80 struct list_head list;
81 struct acm_rb *buffer;
82 struct urb *urb;
83 struct acm *instance;
86 struct acm {
87 struct usb_device *dev; /* the corresponding usb device */
88 struct usb_interface *control; /* control interface */
89 struct usb_interface *data; /* data interface */
90 struct tty_struct *tty; /* the corresponding tty */
91 struct urb *ctrlurb, *writeurb; /* urbs */
92 u8 *ctrl_buffer; /* buffers of urbs */
93 dma_addr_t ctrl_dma; /* dma handles of buffers */
94 struct acm_wb wb[ACM_NWB];
95 struct acm_ru ru[ACM_NRU];
96 struct acm_rb rb[ACM_NRB];
97 int rx_endpoint;
98 spinlock_t read_lock;
99 struct list_head spare_read_urbs;
100 struct list_head spare_read_bufs;
101 struct list_head filled_read_bufs;
102 int write_current; /* current write buffer */
103 int write_used; /* number of non-empty write buffers */
104 int write_ready; /* write urb is not running */
105 spinlock_t write_lock;
106 struct usb_cdc_line_coding line; /* bits, stop, parity */
107 struct work_struct work; /* work queue entry for line discipline waking up */
108 struct tasklet_struct urb_task; /* rx processing */
109 spinlock_t throttle_lock; /* synchronize throtteling and read callback */
110 unsigned int ctrlin; /* input control lines (DCD, DSR, RI, break, overruns) */
111 unsigned int ctrlout; /* output control lines (DTR, RTS) */
112 unsigned int writesize; /* max packet size for the output bulk endpoint */
113 unsigned int readsize,ctrlsize; /* buffer sizes for freeing */
114 unsigned int used; /* someone has this acm's device open */
115 unsigned int minor; /* acm minor number */
116 unsigned char throttle; /* throttled by tty layer */
117 unsigned char clocal; /* termios CLOCAL */
118 unsigned int ctrl_caps; /* control capabilities from the class specific header */
121 #define CDC_DATA_INTERFACE_TYPE 0x0a
123 /* constants describing various quirks and errors */
124 #define NO_UNION_NORMAL 1