tty: Update cdc_acm
[linux-2.6.git] / drivers / usb / class / cdc-acm.h
1 /*
2  *
3  * Includes for cdc-acm.c
4  *
5  * Mainly take from usbnet's cdc-ether part
6  *
7  */
8
9 /*
10  * CMSPAR, some architectures can't have space and mark parity.
11  */
12
13 #ifndef CMSPAR
14 #define CMSPAR                  0
15 #endif
16
17 /*
18  * Major and minor numbers.
19  */
20
21 #define ACM_TTY_MAJOR           166
22 #define ACM_TTY_MINORS          32
23
24 /*
25  * Requests.
26  */
27
28 #define USB_RT_ACM              (USB_TYPE_CLASS | USB_RECIP_INTERFACE)
29
30 /*
31  * Output control lines.
32  */
33
34 #define ACM_CTRL_DTR            0x01
35 #define ACM_CTRL_RTS            0x02
36
37 /*
38  * Input control lines and line errors.
39  */
40
41 #define ACM_CTRL_DCD            0x01
42 #define ACM_CTRL_DSR            0x02
43 #define ACM_CTRL_BRK            0x04
44 #define ACM_CTRL_RI             0x08
45
46 #define ACM_CTRL_FRAMING        0x10
47 #define ACM_CTRL_PARITY         0x20
48 #define ACM_CTRL_OVERRUN        0x40
49
50 /*
51  * Internal driver structures.
52  */
53
54 /*
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. These values must be
60  * powers of 2.
61  */
62 #define ACM_NW  16
63 #define ACM_NR  16
64
65 struct acm_wb {
66         unsigned char *buf;
67         dma_addr_t dmah;
68         int len;
69         int use;
70         struct urb              *urb;
71         struct acm              *instance;
72 };
73
74 struct acm_rb {
75         struct list_head        list;
76         int                     size;
77         unsigned char           *base;
78         dma_addr_t              dma;
79 };
80
81 struct acm_ru {
82         struct list_head        list;
83         struct acm_rb           *buffer;
84         struct urb              *urb;
85         struct acm              *instance;
86 };
87
88 struct acm {
89         struct usb_device *dev;                         /* the corresponding usb device */
90         struct usb_interface *control;                  /* control interface */
91         struct usb_interface *data;                     /* data interface */
92         struct tty_struct *tty;                         /* the corresponding tty */
93         struct tty_port port;                           /* our tty port data */
94         struct urb *ctrlurb;                            /* urbs */
95         u8 *ctrl_buffer;                                /* buffers of urbs */
96         dma_addr_t ctrl_dma;                            /* dma handles of buffers */
97         u8 *country_codes;                              /* country codes from device */
98         unsigned int country_code_size;                 /* size of this buffer */
99         unsigned int country_rel_date;                  /* release date of version */
100         struct acm_wb wb[ACM_NW];
101         struct acm_ru ru[ACM_NR];
102         struct acm_rb rb[ACM_NR];
103         int rx_buflimit;
104         int rx_endpoint;
105         spinlock_t read_lock;
106         struct list_head spare_read_urbs;
107         struct list_head spare_read_bufs;
108         struct list_head filled_read_bufs;
109         int write_used;                                 /* number of non-empty write buffers */
110         int processing;
111         int transmitting;
112         spinlock_t write_lock;
113         struct mutex mutex;
114         struct usb_cdc_line_coding line;                /* bits, stop, parity */
115         struct work_struct work;                        /* work queue entry for line discipline waking up */
116         struct work_struct waker;
117         wait_queue_head_t drain_wait;                   /* close processing */
118         struct tasklet_struct urb_task;                 /* rx processing */
119         spinlock_t throttle_lock;                       /* synchronize throtteling and read callback */
120         unsigned int ctrlin;                            /* input control lines (DCD, DSR, RI, break, overruns) */
121         unsigned int ctrlout;                           /* output control lines (DTR, RTS) */
122         unsigned int writesize;                         /* max packet size for the output bulk endpoint */
123         unsigned int readsize,ctrlsize;                 /* buffer sizes for freeing */
124         unsigned int used;                              /* someone has this acm's device open */
125         unsigned int minor;                             /* acm minor number */
126         unsigned char throttle;                         /* throttled by tty layer */
127         unsigned char clocal;                           /* termios CLOCAL */
128         unsigned int ctrl_caps;                         /* control capabilities from the class specific header */
129         unsigned int susp_count;                        /* number of suspended interfaces */
130         struct acm_wb *delayed_wb;                      /* write queued for a device about to be woken */
131 };
132
133 #define CDC_DATA_INTERFACE_TYPE 0x0a
134
135 /* constants describing various quirks and errors */
136 #define NO_UNION_NORMAL                 1
137 #define SINGLE_RX_URB                   2