Merge branch 'locks' of git://linux-nfs.org/~bfields/linux
[linux-2.6] / drivers / usb / serial / belkin_sa.h
1 /*
2  * Definitions for Belkin USB Serial Adapter Driver
3  *
4  *  Copyright (C) 2000
5  *      William Greathouse (wgreathouse@smva.com)
6  *
7  *  This program is largely derived from work by the linux-usb group
8  *  and associated source files.  Please see the usb/serial files for
9  *  individual credits and copyrights.
10  *  
11  *      This program is free software; you can redistribute it and/or modify
12  *      it under the terms of the GNU General Public License as published by
13  *      the Free Software Foundation; either version 2 of the License, or
14  *      (at your option) any later version.
15  *
16  * See Documentation/usb/usb-serial.txt for more information on using this driver
17  *
18  * 12-Mar-2001 gkh
19  *      Added GoHubs GO-COM232 device id.
20  *
21  * 06-Nov-2000 gkh
22  *      Added old Belkin and Peracom device ids, which this driver supports
23  *
24  * 12-Oct-2000 William Greathouse
25  *    First cut at supporting Belkin USB Serial Adapter F5U103
26  *    I did not have a copy of the original work to support this
27  *    adapter, so pardon any stupid mistakes.  All of the information
28  *    I am using to write this driver was acquired by using a modified
29  *    UsbSnoop on Windows2000.
30  *    
31  */
32
33 #ifndef __LINUX_USB_SERIAL_BSA_H
34 #define __LINUX_USB_SERIAL_BSA_H
35
36 #define BELKIN_DOCKSTATION_VID  0x050d  /* Vendor Id */
37 #define BELKIN_DOCKSTATION_PID  0x1203  /* Product Id */
38
39 #define BELKIN_SA_VID   0x050d  /* Vendor Id */
40 #define BELKIN_SA_PID   0x0103  /* Product Id */
41
42 #define BELKIN_OLD_VID  0x056c  /* Belkin's "old" vendor id */
43 #define BELKIN_OLD_PID  0x8007  /* Belkin's "old" single port serial converter's id */
44
45 #define PERACOM_VID     0x0565  /* Peracom's vendor id */
46 #define PERACOM_PID     0x0001  /* Peracom's single port serial converter's id */
47
48 #define GOHUBS_VID      0x0921  /* GoHubs vendor id */
49 #define GOHUBS_PID      0x1000  /* GoHubs single port serial converter's id (identical to the Peracom device) */
50 #define HANDYLINK_PID   0x1200  /* HandyLink USB's id (identical to the Peracom device) */
51
52 /* Vendor Request Interface */
53 #define BELKIN_SA_SET_BAUDRATE_REQUEST  0  /* Set baud rate */
54 #define BELKIN_SA_SET_STOP_BITS_REQUEST 1  /* Set stop bits (1,2) */
55 #define BELKIN_SA_SET_DATA_BITS_REQUEST 2  /* Set data bits (5,6,7,8) */
56 #define BELKIN_SA_SET_PARITY_REQUEST    3  /* Set parity (None, Even, Odd) */
57
58 #define BELKIN_SA_SET_DTR_REQUEST       10 /* Set DTR state */
59 #define BELKIN_SA_SET_RTS_REQUEST       11 /* Set RTS state */
60 #define BELKIN_SA_SET_BREAK_REQUEST     12 /* Set BREAK state */
61
62 #define BELKIN_SA_SET_FLOW_CTRL_REQUEST 16 /* Set flow control mode */
63
64
65 #ifdef WHEN_I_LEARN_THIS
66 #define BELKIN_SA_SET_MAGIC_REQUEST     17 /* I don't know, possibly flush */
67                                            /* (always in Wininit sequence before flow control) */
68 #define BELKIN_SA_RESET                 xx /* Reset the port */
69 #define BELKIN_SA_GET_MODEM_STATUS      xx /* Force return of modem status register */
70 #endif
71
72 #define BELKIN_SA_SET_REQUEST_TYPE      0x40
73
74 #define BELKIN_SA_BAUD(b)               (230400/b)
75
76 #define BELKIN_SA_STOP_BITS(b)          (b-1)
77
78 #define BELKIN_SA_DATA_BITS(b)          (b-5)
79
80 #define BELKIN_SA_PARITY_NONE           0
81 #define BELKIN_SA_PARITY_EVEN           1
82 #define BELKIN_SA_PARITY_ODD            2
83 #define BELKIN_SA_PARITY_MARK           3
84 #define BELKIN_SA_PARITY_SPACE          4
85
86 #define BELKIN_SA_FLOW_NONE             0x0000  /* No flow control */
87 #define BELKIN_SA_FLOW_OCTS             0x0001  /* use CTS input to throttle output */
88 #define BELKIN_SA_FLOW_ODSR             0x0002  /* use DSR input to throttle output */
89 #define BELKIN_SA_FLOW_IDSR             0x0004  /* use DSR input to enable receive */
90 #define BELKIN_SA_FLOW_IDTR             0x0008  /* use DTR output for input flow control */
91 #define BELKIN_SA_FLOW_IRTS             0x0010  /* use RTS output for input flow control */
92 #define BELKIN_SA_FLOW_ORTS             0x0020  /* use RTS to indicate data available to send */
93 #define BELKIN_SA_FLOW_ERRSUB           0x0040  /* ???? guess ???? substitute inline errors */
94 #define BELKIN_SA_FLOW_OXON             0x0080  /* use XON/XOFF for output flow control */
95 #define BELKIN_SA_FLOW_IXON             0x0100  /* use XON/XOFF for input flow control */
96
97 /*
98  * It seems that the interrupt pipe is closely modelled after the
99  * 16550 register layout.  This is probably because the adapter can 
100  * be used in a "DOS" environment to simulate a standard hardware port.
101  */
102 #define BELKIN_SA_LSR_INDEX             2               /* Line Status Register */
103 #define BELKIN_SA_LSR_RDR               0x01    /* receive data ready */
104 #define BELKIN_SA_LSR_OE                0x02    /* overrun error */
105 #define BELKIN_SA_LSR_PE                0x04    /* parity error */
106 #define BELKIN_SA_LSR_FE                0x08    /* framing error */
107 #define BELKIN_SA_LSR_BI                0x10    /* break indicator */
108 #define BELKIN_SA_LSR_THE               0x20    /* transmit holding register empty */
109 #define BELKIN_SA_LSR_TE                0x40    /* transmit register empty */
110 #define BELKIN_SA_LSR_ERR               0x80    /* OE | PE | FE | BI */
111
112 #define BELKIN_SA_MSR_INDEX             3               /* Modem Status Register */
113 #define BELKIN_SA_MSR_DCTS              0x01    /* Delta CTS */
114 #define BELKIN_SA_MSR_DDSR              0x02    /* Delta DSR */
115 #define BELKIN_SA_MSR_DRI               0x04    /* Delta RI */
116 #define BELKIN_SA_MSR_DCD               0x08    /* Delta CD */
117 #define BELKIN_SA_MSR_CTS               0x10    /* Current CTS */
118 #define BELKIN_SA_MSR_DSR               0x20    /* Current DSR */
119 #define BELKIN_SA_MSR_RI                0x40    /* Current RI */
120 #define BELKIN_SA_MSR_CD                0x80    /* Current CD */
121
122 #endif /* __LINUX_USB_SERIAL_BSA_H */
123