USB: new id for ti_usb_3410_5052 driver
[linux-2.6.git] / drivers / usb / serial / ti_usb_3410_5052.h
1 /* vi: ts=8 sw=8
2  *
3  * TI 3410/5052 USB Serial Driver Header
4  *
5  * Copyright (C) 2004 Texas Instruments
6  *
7  * This driver is based on the Linux io_ti driver, which is
8  *   Copyright (C) 2000-2002 Inside Out Networks
9  *   Copyright (C) 2001-2002 Greg Kroah-Hartman
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  * For questions or problems with this driver, contact Texas Instruments
17  * technical support, or Al Borchers <alborchers@steinerpoint.com>, or
18  * Peter Berger <pberger@brimson.com>.
19  */
20
21 #ifndef _TI_3410_5052_H_
22 #define _TI_3410_5052_H_
23
24 /* Configuration ids */
25 #define TI_BOOT_CONFIG                  1
26 #define TI_ACTIVE_CONFIG                2
27
28 /* Vendor and product ids */
29 #define TI_VENDOR_ID                    0x0451
30 #define IBM_VENDOR_ID                   0x04b3
31 #define TI_3410_PRODUCT_ID              0x3410
32 #define IBM_4543_PRODUCT_ID             0x4543
33 #define TI_3410_EZ430_ID                0xF430  /* TI ez430 development tool */
34 #define TI_5052_BOOT_PRODUCT_ID         0x5052  /* no EEPROM, no firmware */
35 #define TI_5152_BOOT_PRODUCT_ID         0x5152  /* no EEPROM, no firmware */
36 #define TI_5052_EEPROM_PRODUCT_ID       0x505A  /* EEPROM, no firmware */
37 #define TI_5052_FIRMWARE_PRODUCT_ID     0x505F  /* firmware is running */
38
39 /* Multi-Tech vendor and product ids */
40 #define MTS_VENDOR_ID                   0x06E0
41 #define MTS_GSM_NO_FW_PRODUCT_ID        0xF108
42 #define MTS_CDMA_NO_FW_PRODUCT_ID       0xF109
43 #define MTS_CDMA_PRODUCT_ID             0xF110
44 #define MTS_GSM_PRODUCT_ID              0xF111
45 #define MTS_EDGE_PRODUCT_ID             0xF112
46
47 /* Commands */
48 #define TI_GET_VERSION                  0x01
49 #define TI_GET_PORT_STATUS              0x02
50 #define TI_GET_PORT_DEV_INFO            0x03
51 #define TI_GET_CONFIG                   0x04
52 #define TI_SET_CONFIG                   0x05
53 #define TI_OPEN_PORT                    0x06
54 #define TI_CLOSE_PORT                   0x07
55 #define TI_START_PORT                   0x08
56 #define TI_STOP_PORT                    0x09
57 #define TI_TEST_PORT                    0x0A
58 #define TI_PURGE_PORT                   0x0B
59 #define TI_RESET_EXT_DEVICE             0x0C
60 #define TI_WRITE_DATA                   0x80
61 #define TI_READ_DATA                    0x81
62 #define TI_REQ_TYPE_CLASS               0x82
63
64 /* Module identifiers */
65 #define TI_I2C_PORT                     0x01
66 #define TI_IEEE1284_PORT                0x02
67 #define TI_UART1_PORT                   0x03
68 #define TI_UART2_PORT                   0x04
69 #define TI_RAM_PORT                     0x05
70
71 /* Modem status */
72 #define TI_MSR_DELTA_CTS                0x01
73 #define TI_MSR_DELTA_DSR                0x02
74 #define TI_MSR_DELTA_RI                 0x04
75 #define TI_MSR_DELTA_CD                 0x08
76 #define TI_MSR_CTS                      0x10
77 #define TI_MSR_DSR                      0x20
78 #define TI_MSR_RI                       0x40
79 #define TI_MSR_CD                       0x80
80 #define TI_MSR_DELTA_MASK               0x0F
81 #define TI_MSR_MASK                     0xF0
82
83 /* Line status */
84 #define TI_LSR_OVERRUN_ERROR            0x01
85 #define TI_LSR_PARITY_ERROR             0x02
86 #define TI_LSR_FRAMING_ERROR            0x04
87 #define TI_LSR_BREAK                    0x08
88 #define TI_LSR_ERROR                    0x0F
89 #define TI_LSR_RX_FULL                  0x10
90 #define TI_LSR_TX_EMPTY                 0x20
91
92 /* Line control */
93 #define TI_LCR_BREAK                    0x40
94
95 /* Modem control */
96 #define TI_MCR_LOOP                     0x04
97 #define TI_MCR_DTR                      0x10
98 #define TI_MCR_RTS                      0x20
99
100 /* Mask settings */
101 #define TI_UART_ENABLE_RTS_IN           0x0001
102 #define TI_UART_DISABLE_RTS             0x0002
103 #define TI_UART_ENABLE_PARITY_CHECKING  0x0008
104 #define TI_UART_ENABLE_DSR_OUT          0x0010
105 #define TI_UART_ENABLE_CTS_OUT          0x0020
106 #define TI_UART_ENABLE_X_OUT            0x0040
107 #define TI_UART_ENABLE_XA_OUT           0x0080
108 #define TI_UART_ENABLE_X_IN             0x0100
109 #define TI_UART_ENABLE_DTR_IN           0x0800
110 #define TI_UART_DISABLE_DTR             0x1000
111 #define TI_UART_ENABLE_MS_INTS          0x2000
112 #define TI_UART_ENABLE_AUTO_START_DMA   0x4000
113
114 /* Parity */
115 #define TI_UART_NO_PARITY               0x00
116 #define TI_UART_ODD_PARITY              0x01
117 #define TI_UART_EVEN_PARITY             0x02
118 #define TI_UART_MARK_PARITY             0x03
119 #define TI_UART_SPACE_PARITY            0x04
120
121 /* Stop bits */
122 #define TI_UART_1_STOP_BITS             0x00
123 #define TI_UART_1_5_STOP_BITS           0x01
124 #define TI_UART_2_STOP_BITS             0x02
125
126 /* Bits per character */
127 #define TI_UART_5_DATA_BITS             0x00
128 #define TI_UART_6_DATA_BITS             0x01
129 #define TI_UART_7_DATA_BITS             0x02
130 #define TI_UART_8_DATA_BITS             0x03
131
132 /* 232/485 modes */
133 #define TI_UART_232                     0x00
134 #define TI_UART_485_RECEIVER_DISABLED   0x01
135 #define TI_UART_485_RECEIVER_ENABLED    0x02
136
137 /* Pipe transfer mode and timeout */
138 #define TI_PIPE_MODE_CONTINOUS          0x01
139 #define TI_PIPE_MODE_MASK               0x03
140 #define TI_PIPE_TIMEOUT_MASK            0x7C
141 #define TI_PIPE_TIMEOUT_ENABLE          0x80
142
143 /* Config struct */
144 struct ti_uart_config {
145         __u16   wBaudRate;
146         __u16   wFlags;
147         __u8    bDataBits;
148         __u8    bParity;
149         __u8    bStopBits;
150         char    cXon;
151         char    cXoff;
152         __u8    bUartMode;
153 } __attribute__((packed));
154
155 /* Get port status */
156 struct ti_port_status {
157         __u8    bCmdCode;
158         __u8    bModuleId;
159         __u8    bErrorCode;
160         __u8    bMSR;
161         __u8    bLSR;
162 } __attribute__((packed));
163
164 /* Purge modes */
165 #define TI_PURGE_OUTPUT                 0x00
166 #define TI_PURGE_INPUT                  0x80
167
168 /* Read/Write data */
169 #define TI_RW_DATA_ADDR_SFR             0x10
170 #define TI_RW_DATA_ADDR_IDATA           0x20
171 #define TI_RW_DATA_ADDR_XDATA           0x30
172 #define TI_RW_DATA_ADDR_CODE            0x40
173 #define TI_RW_DATA_ADDR_GPIO            0x50
174 #define TI_RW_DATA_ADDR_I2C             0x60
175 #define TI_RW_DATA_ADDR_FLASH           0x70
176 #define TI_RW_DATA_ADDR_DSP             0x80
177
178 #define TI_RW_DATA_UNSPECIFIED          0x00
179 #define TI_RW_DATA_BYTE                 0x01
180 #define TI_RW_DATA_WORD                 0x02
181 #define TI_RW_DATA_DOUBLE_WORD          0x04
182
183 struct ti_write_data_bytes {
184         __u8    bAddrType;
185         __u8    bDataType;
186         __u8    bDataCounter;
187         __be16  wBaseAddrHi;
188         __be16  wBaseAddrLo;
189         __u8    bData[0];
190 } __attribute__((packed));
191
192 struct ti_read_data_request {
193         __u8    bAddrType;
194         __u8    bDataType;
195         __u8    bDataCounter;
196         __be16  wBaseAddrHi;
197         __be16  wBaseAddrLo;
198 } __attribute__((packed));
199
200 struct ti_read_data_bytes {
201         __u8    bCmdCode;
202         __u8    bModuleId;
203         __u8    bErrorCode;
204         __u8    bData[0];
205 } __attribute__((packed));
206
207 /* Interrupt struct */
208 struct ti_interrupt {
209         __u8    bICode;
210         __u8    bIInfo;
211 } __attribute__((packed));
212
213 /* Interrupt codes */
214 #define TI_GET_PORT_FROM_CODE(c)        (((c) >> 4) - 3)
215 #define TI_GET_FUNC_FROM_CODE(c)        ((c) & 0x0f)
216 #define TI_CODE_HARDWARE_ERROR          0xFF
217 #define TI_CODE_DATA_ERROR              0x03
218 #define TI_CODE_MODEM_STATUS            0x04
219
220 /* Download firmware max packet size */
221 #define TI_DOWNLOAD_MAX_PACKET_SIZE     64
222
223 /* Firmware image header */
224 struct ti_firmware_header {
225         __le16  wLength;
226         __u8    bCheckSum;
227 } __attribute__((packed));
228
229 /* UART addresses */
230 #define TI_UART1_BASE_ADDR              0xFFA0  /* UART 1 base address */
231 #define TI_UART2_BASE_ADDR              0xFFB0  /* UART 2 base address */
232 #define TI_UART_OFFSET_LCR              0x0002  /* UART MCR register offset */
233 #define TI_UART_OFFSET_MCR              0x0004  /* UART MCR register offset */
234
235 #endif /* _TI_3410_5052_H_ */