Merge branch 'master' of /pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6] / 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.
60  */
61 #define ACM_NWB  2
62 struct acm_wb {
63         unsigned char *buf;
64         dma_addr_t dmah;
65         int len;
66         int use;
67 };
68
69 struct acm {
70         struct usb_device *dev;                         /* the corresponding usb device */
71         struct usb_interface *control;                  /* control interface */
72         struct usb_interface *data;                     /* data interface */
73         struct tty_struct *tty;                         /* the corresponding tty */
74         struct urb *ctrlurb, *readurb, *writeurb;       /* urbs */
75         u8 *ctrl_buffer, *read_buffer;                  /* buffers of urbs */
76         dma_addr_t ctrl_dma, read_dma;                  /* dma handles of buffers */
77         struct acm_wb wb[ACM_NWB];
78         int write_current;                              /* current write buffer */
79         int write_used;                                 /* number of non-empty write buffers */
80         int write_ready;                                /* write urb is not running */
81         spinlock_t write_lock;
82         struct usb_cdc_line_coding line;                /* bits, stop, parity */
83         struct work_struct work;                        /* work queue entry for line discipline waking up */
84         struct tasklet_struct bh;                       /* rx processing */
85         spinlock_t throttle_lock;                       /* synchronize throtteling and read callback */
86         unsigned int ctrlin;                            /* input control lines (DCD, DSR, RI, break, overruns) */
87         unsigned int ctrlout;                           /* output control lines (DTR, RTS) */
88         unsigned int writesize;                         /* max packet size for the output bulk endpoint */
89         unsigned int readsize,ctrlsize;                 /* buffer sizes for freeing */
90         unsigned int used;                              /* someone has this acm's device open */
91         unsigned int minor;                             /* acm minor number */
92         unsigned char throttle;                         /* throttled by tty layer */
93         unsigned char clocal;                           /* termios CLOCAL */
94         unsigned char resubmit_to_unthrottle;           /* throtteling has disabled the read urb */
95         unsigned int ctrl_caps;                         /* control capabilities from the class specific header */
96 };
97
98 #define CDC_DATA_INTERFACE_TYPE 0x0a
99
100 /* constants describing various quirks and errors */
101 #define NO_UNION_NORMAL                 1