Merge master.kernel.org:/pub/scm/linux/kernel/git/davej/agpgart
[powerpc.git] / drivers / usb / serial / ftdi_sio.h
1 /*
2  * Definitions for the FTDI USB Single Port Serial Converter - 
3  * known as FTDI_SIO (Serial Input/Output application of the chipset) 
4  *
5  * The example I have is known as the USC-1000 which is available from
6  * http://www.dse.co.nz - cat no XH4214 It looks similar to this:
7  * http://www.dansdata.com/usbser.htm but I can't be sure There are other
8  * USC-1000s which don't look like my device though so beware!
9  *
10  * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side, 
11  * USB on the other.
12  *
13  * Thanx to FTDI (http://www.ftdi.co.uk) for so kindly providing details
14  * of the protocol required to talk to the device and ongoing assistence
15  * during development.
16  *
17  * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the 
18  * FTDI_SIO implementation.
19  *
20  * Philipp Gühring - pg@futureware.at - added the Device ID of the USB relais
21  * from Rudolf Gugler
22  *
23  */
24
25 #define FTDI_VID        0x0403  /* Vendor Id */
26 #define FTDI_SIO_PID    0x8372  /* Product Id SIO application of 8U100AX  */
27 #define FTDI_8U232AM_PID 0x6001 /* Similar device to SIO above */
28 #define FTDI_8U232AM_ALT_PID 0x6006 /* FTDI's alternate PID for above */
29 #define FTDI_8U2232C_PID 0x6010 /* Dual channel device */
30 #define FTDI_RELAIS_PID 0xFA10  /* Relais device from Rudolf Gugler */
31 #define FTDI_NF_RIC_VID 0x0DCD  /* Vendor Id */
32 #define FTDI_NF_RIC_PID 0x0001  /* Product Id */
33
34
35 /* www.canusb.com Lawicel CANUSB device */
36 #define FTDI_CANUSB_PID 0xFFA8 /* Product Id */
37
38 /* AlphaMicro Components AMC-232USB01 device */
39 #define FTDI_AMC232_PID 0xFF00 /* Product Id */
40
41 /* ACT Solutions HomePro ZWave interface (http://www.act-solutions.com/HomePro.htm) */
42 #define FTDI_ACTZWAVE_PID       0xF2D0
43
44
45 /* www.starting-point-systems.com µChameleon device */
46 #define FTDI_MICRO_CHAMELEON_PID        0xCAA0  /* Product Id */
47
48 /* www.irtrans.de device */
49 #define FTDI_IRTRANS_PID 0xFC60 /* Product Id */
50
51
52 /* www.thoughttechnology.com/ TT-USB provide with procomp use ftdi_sio */
53 #define FTDI_TTUSB_PID 0xFF20 /* Product Id */
54
55 /* iPlus device */
56 #define FTDI_IPLUS_PID 0xD070 /* Product Id */
57
58 /* www.crystalfontz.com devices - thanx for providing free devices for evaluation ! */
59 /* they use the ftdi chipset for the USB interface and the vendor id is the same */
60 #define FTDI_XF_632_PID 0xFC08  /* 632: 16x2 Character Display */
61 #define FTDI_XF_634_PID 0xFC09  /* 634: 20x4 Character Display */
62 #define FTDI_XF_547_PID 0xFC0A  /* 547: Two line Display */
63 #define FTDI_XF_633_PID 0xFC0B  /* 633: 16x2 Character Display with Keys */
64 #define FTDI_XF_631_PID 0xFC0C  /* 631: 20x2 Character Display */
65 #define FTDI_XF_635_PID 0xFC0D  /* 635: 20x4 Character Display */
66 #define FTDI_XF_640_PID 0xFC0E  /* 640: Two line Display */
67 #define FTDI_XF_642_PID 0xFC0F  /* 642: Two line Display */
68
69 /* Video Networks Limited / Homechoice in the UK use an ftdi-based device for their 1Mb */
70 /* broadband internet service.  The following PID is exhibited by the usb device supplied */
71 /* (the VID is the standard ftdi vid (FTDI_VID) */
72 #define FTDI_VNHCPCUSB_D_PID 0xfe38 /* Product Id */
73
74 /*
75  * PCDJ use ftdi based dj-controllers.  The following PID is for their DAC-2 device
76  * http://www.pcdjhardware.com/DAC2.asp (PID sent by Wouter Paesen)
77  * (the VID is the standard ftdi vid (FTDI_VID) */
78 #define FTDI_PCDJ_DAC2_PID 0xFA88
79
80 /*
81  * The following are the values for the Matrix Orbital LCD displays,
82  * which are the FT232BM ( similar to the 8U232AM )
83  */
84 #define FTDI_MTXORB_0_PID      0xFA00  /* Matrix Orbital Product Id */
85 #define FTDI_MTXORB_1_PID      0xFA01  /* Matrix Orbital Product Id */
86 #define FTDI_MTXORB_2_PID      0xFA02  /* Matrix Orbital Product Id */
87 #define FTDI_MTXORB_3_PID      0xFA03  /* Matrix Orbital Product Id */
88 #define FTDI_MTXORB_4_PID      0xFA04  /* Matrix Orbital Product Id */
89 #define FTDI_MTXORB_5_PID      0xFA05  /* Matrix Orbital Product Id */
90 #define FTDI_MTXORB_6_PID      0xFA06  /* Matrix Orbital Product Id */
91
92 /* Interbiometrics USB I/O Board */
93 /* Developed for Interbiometrics by Rudolf Gugler */
94 #define INTERBIOMETRICS_VID              0x1209
95 #define INTERBIOMETRICS_IOBOARD_PID      0x1002
96 #define INTERBIOMETRICS_MINI_IOBOARD_PID 0x1006
97
98 /*
99  * The following are the values for the Perle Systems
100  * UltraPort USB serial converters
101  */
102 #define FTDI_PERLE_ULTRAPORT_PID 0xF0C0 /* Perle UltraPort Product Id */
103
104 /*
105  * The following are the values for the Sealevel SeaLINK+ adapters.
106  * (Original list sent by Tuan Hoang.  Ian Abbott renamed the macros and
107  * removed some PIDs that don't seem to match any existing products.)
108  */
109 #define SEALEVEL_VID            0x0c52  /* Sealevel Vendor ID */
110 #define SEALEVEL_2101_PID       0x2101  /* SeaLINK+232 (2101/2105) */
111 #define SEALEVEL_2102_PID       0x2102  /* SeaLINK+485 (2102) */
112 #define SEALEVEL_2103_PID       0x2103  /* SeaLINK+232I (2103) */
113 #define SEALEVEL_2104_PID       0x2104  /* SeaLINK+485I (2104) */
114 #define SEALEVEL_2106_PID       0x9020  /* SeaLINK+422 (2106) */
115 #define SEALEVEL_2201_1_PID     0x2211  /* SeaPORT+2/232 (2201) Port 1 */
116 #define SEALEVEL_2201_2_PID     0x2221  /* SeaPORT+2/232 (2201) Port 2 */
117 #define SEALEVEL_2202_1_PID     0x2212  /* SeaPORT+2/485 (2202) Port 1 */
118 #define SEALEVEL_2202_2_PID     0x2222  /* SeaPORT+2/485 (2202) Port 2 */
119 #define SEALEVEL_2203_1_PID     0x2213  /* SeaPORT+2 (2203) Port 1 */
120 #define SEALEVEL_2203_2_PID     0x2223  /* SeaPORT+2 (2203) Port 2 */
121 #define SEALEVEL_2401_1_PID     0x2411  /* SeaPORT+4/232 (2401) Port 1 */
122 #define SEALEVEL_2401_2_PID     0x2421  /* SeaPORT+4/232 (2401) Port 2 */
123 #define SEALEVEL_2401_3_PID     0x2431  /* SeaPORT+4/232 (2401) Port 3 */
124 #define SEALEVEL_2401_4_PID     0x2441  /* SeaPORT+4/232 (2401) Port 4 */
125 #define SEALEVEL_2402_1_PID     0x2412  /* SeaPORT+4/485 (2402) Port 1 */
126 #define SEALEVEL_2402_2_PID     0x2422  /* SeaPORT+4/485 (2402) Port 2 */
127 #define SEALEVEL_2402_3_PID     0x2432  /* SeaPORT+4/485 (2402) Port 3 */
128 #define SEALEVEL_2402_4_PID     0x2442  /* SeaPORT+4/485 (2402) Port 4 */
129 #define SEALEVEL_2403_1_PID     0x2413  /* SeaPORT+4 (2403) Port 1 */
130 #define SEALEVEL_2403_2_PID     0x2423  /* SeaPORT+4 (2403) Port 2 */
131 #define SEALEVEL_2403_3_PID     0x2433  /* SeaPORT+4 (2403) Port 3 */
132 #define SEALEVEL_2403_4_PID     0x2443  /* SeaPORT+4 (2403) Port 4 */
133 #define SEALEVEL_2801_1_PID     0X2811  /* SeaLINK+8/232 (2801) Port 1 */
134 #define SEALEVEL_2801_2_PID     0X2821  /* SeaLINK+8/232 (2801) Port 2 */
135 #define SEALEVEL_2801_3_PID     0X2831  /* SeaLINK+8/232 (2801) Port 3 */
136 #define SEALEVEL_2801_4_PID     0X2841  /* SeaLINK+8/232 (2801) Port 4 */
137 #define SEALEVEL_2801_5_PID     0X2851  /* SeaLINK+8/232 (2801) Port 5 */
138 #define SEALEVEL_2801_6_PID     0X2861  /* SeaLINK+8/232 (2801) Port 6 */
139 #define SEALEVEL_2801_7_PID     0X2871  /* SeaLINK+8/232 (2801) Port 7 */
140 #define SEALEVEL_2801_8_PID     0X2881  /* SeaLINK+8/232 (2801) Port 8 */
141 #define SEALEVEL_2802_1_PID     0X2812  /* SeaLINK+8/485 (2802) Port 1 */
142 #define SEALEVEL_2802_2_PID     0X2822  /* SeaLINK+8/485 (2802) Port 2 */
143 #define SEALEVEL_2802_3_PID     0X2832  /* SeaLINK+8/485 (2802) Port 3 */
144 #define SEALEVEL_2802_4_PID     0X2842  /* SeaLINK+8/485 (2802) Port 4 */
145 #define SEALEVEL_2802_5_PID     0X2852  /* SeaLINK+8/485 (2802) Port 5 */
146 #define SEALEVEL_2802_6_PID     0X2862  /* SeaLINK+8/485 (2802) Port 6 */
147 #define SEALEVEL_2802_7_PID     0X2872  /* SeaLINK+8/485 (2802) Port 7 */
148 #define SEALEVEL_2802_8_PID     0X2882  /* SeaLINK+8/485 (2802) Port 8 */
149 #define SEALEVEL_2803_1_PID     0X2813  /* SeaLINK+8 (2803) Port 1 */
150 #define SEALEVEL_2803_2_PID     0X2823  /* SeaLINK+8 (2803) Port 2 */
151 #define SEALEVEL_2803_3_PID     0X2833  /* SeaLINK+8 (2803) Port 3 */
152 #define SEALEVEL_2803_4_PID     0X2843  /* SeaLINK+8 (2803) Port 4 */
153 #define SEALEVEL_2803_5_PID     0X2853  /* SeaLINK+8 (2803) Port 5 */
154 #define SEALEVEL_2803_6_PID     0X2863  /* SeaLINK+8 (2803) Port 6 */
155 #define SEALEVEL_2803_7_PID     0X2873  /* SeaLINK+8 (2803) Port 7 */
156 #define SEALEVEL_2803_8_PID     0X2883  /* SeaLINK+8 (2803) Port 8 */
157
158 /*
159  * The following are the values for two KOBIL chipcard terminals.
160  */
161 #define KOBIL_VID               0x0d46  /* KOBIL Vendor ID */
162 #define KOBIL_CONV_B1_PID       0x2020  /* KOBIL Konverter for B1 */
163 #define KOBIL_CONV_KAAN_PID     0x2021  /* KOBIL_Konverter for KAAN */
164
165 /*
166  * Icom ID-1 digital transceiver
167  */
168
169 #define ICOM_ID1_VID            0x0C26
170 #define ICOM_ID1_PID            0x0004
171
172 /*
173  * ASK.fr devices
174  */
175 #define FTDI_ASK_RDR400_PID     0xC991  /* ASK RDR 400 series card reader */
176
177 /*
178  * DSS-20 Sync Station for Sony Ericsson P800
179  */
180  
181 #define FTDI_DSS20_PID          0xFC82  
182
183 /*
184  * Home Electronics (www.home-electro.com) USB gadgets
185  */
186 #define FTDI_HE_TIRA1_PID       0xFA78  /* Tira-1 IR transceiver */
187
188 /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */
189 /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */
190 #define FTDI_USB_UIRT_PID       0xF850  /* Product Id */
191
192 /* TNC-X USB-to-packet-radio adapter, versions prior to 3.0 (DLP module) */
193
194 #define FTDI_TNC_X_PID          0xEBE0
195
196 /*
197  * ELV USB devices submitted by Christian Abt of ELV (www.elv.de).
198  * All of these devices use FTDI's vendor ID (0x0403).
199  *
200  * The previously included PID for the UO 100 module was incorrect.
201  * In fact, that PID was for ELV's UR 100 USB-RS232 converter (0xFB58).
202  *
203  * Armin Laeuger originally sent the PID for the UM 100 module.
204  */
205 #define FTDI_ELV_UR100_PID      0xFB58  /* USB-RS232-Umsetzer (UR 100) */
206 #define FTDI_ELV_UM100_PID      0xFB5A  /* USB-Modul UM 100 */
207 #define FTDI_ELV_UO100_PID      0xFB5B  /* USB-Modul UO 100 */
208 #define FTDI_ELV_ALC8500_PID    0xF06E  /* ALC 8500 Expert */
209 /* Additional ELV PIDs that default to using the FTDI D2XX drivers on
210  * MS Windows, rather than the FTDI Virtual Com Port drivers.
211  * Maybe these will be easier to use with the libftdi/libusb user-space
212  * drivers, or possibly the Comedi drivers in some cases. */
213 #define FTDI_ELV_CLI7000_PID    0xFB59  /* Computer-Light-Interface (CLI 7000) */
214 #define FTDI_ELV_PPS7330_PID    0xFB5C  /* Processor-Power-Supply (PPS 7330) */
215 #define FTDI_ELV_TFM100_PID     0xFB5D  /* Temperartur-Feuchte Messgeraet (TFM 100) */
216 #define FTDI_ELV_UDF77_PID      0xFB5E  /* USB DCF Funkurh (UDF 77) */
217 #define FTDI_ELV_UIO88_PID      0xFB5F  /* USB-I/O Interface (UIO 88) */
218 #define FTDI_ELV_UAD8_PID       0xF068  /* USB-AD-Wandler (UAD 8) */
219 #define FTDI_ELV_UDA7_PID       0xF069  /* USB-DA-Wandler (UDA 7) */
220 #define FTDI_ELV_USI2_PID       0xF06A  /* USB-Schrittmotoren-Interface (USI 2) */
221 #define FTDI_ELV_T1100_PID      0xF06B  /* Thermometer (T 1100) */
222 #define FTDI_ELV_PCD200_PID     0xF06C  /* PC-Datenlogger (PCD 200) */
223 #define FTDI_ELV_ULA200_PID     0xF06D  /* USB-LCD-Ansteuerung (ULA 200) */
224 #define FTDI_ELV_FHZ1000PC_PID  0xF06F  /* FHZ 1000 PC */
225 #define FTDI_ELV_CSI8_PID       0xE0F0  /* Computer-Schalt-Interface (CSI 8) */
226 #define FTDI_ELV_EM1000DL_PID   0xE0F1  /* PC-Datenlogger fuer Energiemonitor (EM 1000 DL) */
227 #define FTDI_ELV_PCK100_PID     0xE0F2  /* PC-Kabeltester (PCK 100) */
228 #define FTDI_ELV_RFP500_PID     0xE0F3  /* HF-Leistungsmesser (RFP 500) */
229 #define FTDI_ELV_FS20SIG_PID    0xE0F4  /* Signalgeber (FS 20 SIG) */
230 #define FTDI_ELV_WS300PC_PID    0xE0F6  /* PC-Wetterstation (WS 300 PC) */
231 #define FTDI_ELV_FHZ1300PC_PID  0xE0E8  /* FHZ 1300 PC */
232 #define FTDI_ELV_WS500_PID      0xE0E9  /* PC-Wetterstation (WS 500) */
233
234 /*
235  * Definitions for ID TECH (www.idt-net.com) devices
236  */
237 #define IDTECH_VID              0x0ACD  /* ID TECH Vendor ID */
238 #define IDTECH_IDT1221U_PID     0x0300  /* IDT1221U USB to RS-232 adapter */
239
240 /*
241  * Definitions for Omnidirectional Control Technology, Inc. devices
242  */
243 #define OCT_VID                 0x0B39  /* OCT vendor ID */
244 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
245 /* Also rebadged as Dick Smith Electronics (Aus) XH6451 */
246 /* Also rebadged as SIIG Inc. model US2308 hardware version 1 */
247 #define OCT_US101_PID           0x0421  /* OCT US101 USB to RS-232 */
248
249 /* an infrared receiver for user access control with IR tags */
250 #define FTDI_PIEGROUP_PID       0xF208  /* Product Id */
251
252 /*
253  * Definitions for Artemis astronomical USB based cameras
254  * Check it at http://www.artemisccd.co.uk/
255  */
256 #define FTDI_ARTEMIS_PID        0xDF28  /* All Artemis Cameras */
257
258 /*
259  * Definitions for ATIK Instruments astronomical USB based cameras
260  * Check it at http://www.atik-instruments.com/
261  */
262 #define FTDI_ATIK_ATK16_PID     0xDF30  /* ATIK ATK-16 Grayscale Camera */
263 #define FTDI_ATIK_ATK16C_PID    0xDF32  /* ATIK ATK-16C Colour Camera */
264 #define FTDI_ATIK_ATK16HR_PID   0xDF31  /* ATIK ATK-16HR Grayscale Camera */
265 #define FTDI_ATIK_ATK16HRC_PID  0xDF33  /* ATIK ATK-16HRC Colour Camera */
266
267 /*
268  * Protego product ids
269  */
270 #define PROTEGO_SPECIAL_1       0xFC70  /* special/unknown device */
271 #define PROTEGO_R2X0            0xFC71  /* R200-USB TRNG unit (R210, R220, and R230) */
272 #define PROTEGO_SPECIAL_3       0xFC72  /* special/unknown device */
273 #define PROTEGO_SPECIAL_4       0xFC73  /* special/unknown device */
274
275 /*
276  * Gude Analog- und Digitalsysteme GmbH
277  */
278 #define FTDI_GUDEADS_E808_PID    0xE808
279 #define FTDI_GUDEADS_E809_PID    0xE809
280 #define FTDI_GUDEADS_E80A_PID    0xE80A
281 #define FTDI_GUDEADS_E80B_PID    0xE80B
282 #define FTDI_GUDEADS_E80C_PID    0xE80C
283 #define FTDI_GUDEADS_E80D_PID    0xE80D
284 #define FTDI_GUDEADS_E80E_PID    0xE80E
285 #define FTDI_GUDEADS_E80F_PID    0xE80F
286 #define FTDI_GUDEADS_E888_PID    0xE888  /* Expert ISDN Control USB */
287 #define FTDI_GUDEADS_E889_PID    0xE889  /* USB RS-232 OptoBridge */
288 #define FTDI_GUDEADS_E88A_PID    0xE88A
289 #define FTDI_GUDEADS_E88B_PID    0xE88B
290 #define FTDI_GUDEADS_E88C_PID    0xE88C
291 #define FTDI_GUDEADS_E88D_PID    0xE88D
292 #define FTDI_GUDEADS_E88E_PID    0xE88E
293 #define FTDI_GUDEADS_E88F_PID    0xE88F
294
295 /*
296  * Linx Technologies product ids
297  */
298 #define LINX_SDMUSBQSS_PID      0xF448  /* Linx SDM-USB-QS-S */
299 #define LINX_MASTERDEVEL2_PID   0xF449   /* Linx Master Development 2.0 */
300 #define LINX_FUTURE_0_PID   0xF44A   /* Linx future device */
301 #define LINX_FUTURE_1_PID   0xF44B   /* Linx future device */
302 #define LINX_FUTURE_2_PID   0xF44C   /* Linx future device */
303
304 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
305 /* unit for PIC16's/PIC18's */
306 #define FTDI_CCSICDU20_0_PID    0xF9D0     
307 #define FTDI_CCSICDU40_1_PID    0xF9D1     
308
309 /* Inside Accesso contactless reader (http://www.insidefr.com) */
310 #define INSIDE_ACCESSO          0xFAD0
311
312 /*
313  * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI
314  */
315 #define INTREPID_VID            0x093C
316 #define INTREPID_VALUECAN_PID   0x0601
317 #define INTREPID_NEOVI_PID      0x0701
318
319 /*
320  * Falcom Wireless Communications GmbH
321  */
322 #define FALCOM_VID              0x0F94  /* Vendor Id */
323 #define FALCOM_TWIST_PID        0x0001  /* Falcom Twist USB GPRS modem */
324 #define FALCOM_SAMBA_PID        0x0005  /* Falcom Samba USB GPRS modem */
325
326 /*
327  * SUUNTO product ids
328  */
329 #define FTDI_SUUNTO_SPORTS_PID  0xF680  /* Suunto Sports instrument */
330
331 /*
332  * Definitions for B&B Electronics products.
333  */
334 #define BANDB_VID               0x0856  /* B&B Electronics Vendor ID */
335 #define BANDB_USOTL4_PID        0xAC01  /* USOTL4 Isolated RS-485 Converter */
336 #define BANDB_USTL4_PID         0xAC02  /* USTL4 RS-485 Converter */
337 #define BANDB_USO9ML2_PID       0xAC03  /* USO9ML2 Isolated RS-232 Converter */
338
339 /*
340  * RM Michaelides CANview USB (http://www.rmcan.com)
341  * CAN fieldbus interface adapter, added by port GmbH www.port.de)
342  * Ian Abbott changed the macro names for consistency.
343  */
344 #define FTDI_RM_CANVIEW_PID     0xfd60  /* Product Id */
345
346 /*
347  * EVER Eco Pro UPS (http://www.ever.com.pl/)
348  */
349
350 #define EVER_ECO_PRO_CDS        0xe520  /* RS-232 converter */
351
352 /*
353  * 4N-GALAXY.DE PIDs for CAN-USB, USB-RS232, USB-RS422, USB-RS485,
354  * USB-TTY activ, USB-TTY passiv.  Some PIDs are used by several devices
355  * and I'm not entirely sure which are used by which.
356  */
357 #define FTDI_4N_GALAXY_DE_0_PID 0x8372
358 #define FTDI_4N_GALAXY_DE_1_PID 0xF3C0
359 #define FTDI_4N_GALAXY_DE_2_PID 0xF3C1
360
361 /*
362  * Mobility Electronics products.
363  */
364 #define MOBILITY_VID                    0x1342
365 #define MOBILITY_USB_SERIAL_PID         0x0202  /* EasiDock USB 200 serial */
366
367 /*
368  * microHAM product IDs (http://www.microham.com).
369  * Submitted by Justin Burket (KL1RL) <zorton@jtan.com>
370  * and Mike Studer (K6EEP) <k6eep@hamsoftware.org>.
371  * Ian Abbott <abbotti@mev.co.uk> added a few more from the driver INF file.
372  */
373 #define FTDI_MHAM_KW_PID 0xEEE8         /* USB-KW interface */
374 #define FTDI_MHAM_YS_PID 0xEEE9         /* USB-YS interface */
375 #define FTDI_MHAM_Y6_PID 0xEEEA         /* USB-Y6 interface */
376 #define FTDI_MHAM_Y8_PID 0xEEEB         /* USB-Y8 interface */
377 #define FTDI_MHAM_IC_PID 0xEEEC         /* USB-IC interface */
378 #define FTDI_MHAM_DB9_PID 0xEEED        /* USB-DB9 interface */
379 #define FTDI_MHAM_RS232_PID 0xEEEE      /* USB-RS232 interface */
380 #define FTDI_MHAM_Y9_PID 0xEEEF         /* USB-Y9 interface */
381
382 /*
383  * Active Robots product ids.
384  */
385 #define FTDI_ACTIVE_ROBOTS_PID  0xE548  /* USB comms board */
386
387 /*
388  * Xsens Technologies BV products (http://www.xsens.com).
389  */
390 #define XSENS_CONVERTER_0_PID   0xD388
391 #define XSENS_CONVERTER_1_PID   0xD389
392 #define XSENS_CONVERTER_2_PID   0xD38A
393 #define XSENS_CONVERTER_3_PID   0xD38B
394 #define XSENS_CONVERTER_4_PID   0xD38C
395 #define XSENS_CONVERTER_5_PID   0xD38D
396 #define XSENS_CONVERTER_6_PID   0xD38E
397 #define XSENS_CONVERTER_7_PID   0xD38F
398
399 /*
400  * Teratronik product ids.
401  * Submitted by O. Wölfelschneider.
402  */
403 #define FTDI_TERATRONIK_VCP_PID  0xEC88 /* Teratronik device (preferring VCP driver on windows) */
404 #define FTDI_TERATRONIK_D2XX_PID 0xEC89 /* Teratronik device (preferring D2XX driver on windows) */
405
406 /*
407  * Evolution Robotics products (http://www.evolution.com/).
408  * Submitted by Shawn M. Lavelle.
409  */
410 #define EVOLUTION_VID           0xDEEE  /* Vendor ID */
411 #define EVOLUTION_ER1_PID       0x0300  /* ER1 Control Module */
412
413 /* Pyramid Computer GmbH */
414 #define FTDI_PYRAMID_PID        0xE6C8  /* Pyramid Appliance Display */
415
416 /*
417  * Posiflex inc retail equipment (http://www.posiflex.com.tw)
418  */
419 #define POSIFLEX_VID            0x0d3a  /* Vendor ID */
420 #define POSIFLEX_PP7000_PID     0x0300  /* PP-7000II thermal printer */
421
422 /*
423  * Westrex International devices submitted by Cory Lee
424  */
425 #define FTDI_WESTREX_MODEL_777_PID      0xDC00  /* Model 777 */
426 #define FTDI_WESTREX_MODEL_8900F_PID    0xDC01  /* Model 8900F */
427
428 /*
429  * RR-CirKits LocoBuffer USB (http://www.rr-cirkits.com)
430  */
431 #define FTDI_RRCIRKITS_LOCOBUFFER_PID   0xc7d0  /* LocoBuffer USB */
432
433 /*
434  * Eclo (http://www.eclo.pt/) product IDs.
435  * PID 0xEA90 submitted by Martin Grill.
436  */
437 #define FTDI_ECLO_COM_1WIRE_PID 0xEA90  /* COM to 1-Wire USB adaptor */
438
439 /*
440  * Papouch products (http://www.papouch.com/)
441  * Submitted by Folkert van Heusden
442  */
443
444 #define PAPOUCH_VID                     0x5050  /* Vendor ID */
445 #define PAPOUCH_TMU_PID                 0x0400  /* TMU USB Thermometer */
446
447 /*
448  * ACG Identification Technologies GmbH products (http://www.acg.de/).
449  * Submitted by anton -at- goto10 -dot- org.
450  */
451 #define FTDI_ACG_HFDUAL_PID             0xDD20  /* HF Dual ISO Reader (RFID) */
452
453 /*
454  * Yost Engineering, Inc. products (www.yostengineering.com).
455  * PID 0xE050 submitted by Aaron Prose.
456  */
457 #define FTDI_YEI_SERVOCENTER31_PID      0xE050  /* YEI ServoCenter3.1 USB */
458
459 /*
460  * ThorLabs USB motor drivers
461  */
462 #define FTDI_THORLABS_PID               0xfaf0 /* ThorLabs USB motor drivers */
463
464 /*
465  * Testo products (http://www.testo.com/)
466  * Submitted by Colin Leroy
467  */
468 #define TESTO_VID                       0x128D
469 #define TESTO_USB_INTERFACE_PID         0x0001
470
471 /*
472  * Gamma Scout (http://gamma-scout.com/). Submitted by rsc@runtux.com.
473  */
474 #define FTDI_GAMMA_SCOUT_PID            0xD678  /* Gamma Scout online */
475
476 /*
477  * Tactrix OpenPort (ECU) devices.
478  * OpenPort 1.3M submitted by Donour Sizemore.
479  * OpenPort 1.3S and 1.3U submitted by Ian Abbott.
480  */
481 #define FTDI_TACTRIX_OPENPORT_13M_PID   0xCC48  /* OpenPort 1.3 Mitsubishi */
482 #define FTDI_TACTRIX_OPENPORT_13S_PID   0xCC49  /* OpenPort 1.3 Subaru */
483 #define FTDI_TACTRIX_OPENPORT_13U_PID   0xCC4A  /* OpenPort 1.3 Universal */
484
485 /* Commands */
486 #define FTDI_SIO_RESET          0 /* Reset the port */
487 #define FTDI_SIO_MODEM_CTRL     1 /* Set the modem control register */
488 #define FTDI_SIO_SET_FLOW_CTRL  2 /* Set flow control register */
489 #define FTDI_SIO_SET_BAUD_RATE  3 /* Set baud rate */
490 #define FTDI_SIO_SET_DATA       4 /* Set the data characteristics of the port */
491 #define FTDI_SIO_GET_MODEM_STATUS       5 /* Retrieve current value of modern status register */
492 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
493 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
494 #define FTDI_SIO_SET_LATENCY_TIMER      9 /* Set the latency timer */
495 #define FTDI_SIO_GET_LATENCY_TIMER      10 /* Get the latency timer */
496
497
498 /*
499  *   BmRequestType:  1100 0000b
500  *   bRequest:       FTDI_E2_READ
501  *   wValue:         0
502  *   wIndex:         Address of word to read
503  *   wLength:        2
504  *   Data:           Will return a word of data from E2Address
505  *
506  */
507
508 /* Port Identifier Table */
509 #define PIT_DEFAULT             0 /* SIOA */
510 #define PIT_SIOA                1 /* SIOA */
511 /* The device this driver is tested with one has only one port */
512 #define PIT_SIOB                2 /* SIOB */
513 #define PIT_PARALLEL            3 /* Parallel */
514
515 /* FTDI_SIO_RESET */
516 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
517 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
518 #define FTDI_SIO_RESET_SIO 0
519 #define FTDI_SIO_RESET_PURGE_RX 1
520 #define FTDI_SIO_RESET_PURGE_TX 2
521
522 /*
523  * BmRequestType:  0100 0000B
524  * bRequest:       FTDI_SIO_RESET
525  * wValue:         Control Value 
526  *                   0 = Reset SIO
527  *                   1 = Purge RX buffer
528  *                   2 = Purge TX buffer
529  * wIndex:         Port
530  * wLength:        0
531  * Data:           None
532  *
533  * The Reset SIO command has this effect:
534  *
535  *    Sets flow control set to 'none'
536  *    Event char = $0D
537  *    Event trigger = disabled
538  *    Purge RX buffer
539  *    Purge TX buffer
540  *    Clear DTR
541  *    Clear RTS
542  *    baud and data format not reset
543  *
544  * The Purge RX and TX buffer commands affect nothing except the buffers
545  *
546    */
547
548 /* FTDI_SIO_SET_BAUDRATE */
549 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
550 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
551
552 /*
553  * BmRequestType:  0100 0000B
554  * bRequest:       FTDI_SIO_SET_BAUDRATE
555  * wValue:         BaudDivisor value - see below
556  * wIndex:         Port
557  * wLength:        0
558  * Data:           None
559  * The BaudDivisor values are calculated as follows:
560  * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
561  *   I knew how to detect old chips to select proper base clock!
562  * - BaudDivisor is a fixed point number encoded in a funny way.
563  *   (--WRONG WAY OF THINKING--)
564  *   BaudDivisor is a fixed point number encoded with following bit weighs:
565  *   (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
566  *   end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
567  *   (--THE REALITY--)
568  *   The both-bits-set has quite different meaning from 0.75 - the chip designers
569  *   have decided it to mean 0.125 instead of 0.75.
570  *   This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
571  *   and Flow Control Consideration for USB to RS232".
572  * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
573  *   automagically re-encode the resulting value to take fractions into consideration.
574  * As all values are integers, some bit twiddling is in order:
575  *   BaudDivisor = (BaseClock / 16 / BaudRate) |
576  *   (((BaseClock / 2 / BaudRate) & 4) ? 0x4000    // 0.5
577  *    : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000  // 0.25
578  *    : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000  // 0.125
579  *    : 0)
580  *
581  * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
582  * of 0.125 missing from the FT8U232AM.  Bits 16 to 14 are coded as follows
583  * (the first four codes are the same as for the FT8U232AM, where bit 16 is
584  * always 0):
585  *   000 - add .000 to divisor
586  *   001 - add .500 to divisor
587  *   010 - add .250 to divisor
588  *   011 - add .125 to divisor
589  *   100 - add .375 to divisor
590  *   101 - add .625 to divisor
591  *   110 - add .750 to divisor
592  *   111 - add .875 to divisor
593  * Bits 15 to 0 of the 17-bit divisor are placed in the urb value.  Bit 16 is 
594  * placed in bit 0 of the urb index.
595  *
596  * Note that there are a couple of special cases to support the highest baud
597  * rates.  If the calculated divisor value is 1, this needs to be replaced with
598  * 0.  Additionally for the FT232BM, if the calculated divisor value is 0x4001
599  * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
600  * not supported by the FT8U232AM).
601  */
602
603 typedef enum {
604         SIO = 1,
605         FT8U232AM = 2,
606         FT232BM = 3,
607         FT2232C = 4,
608 } ftdi_chip_type_t;
609
610 typedef enum {
611  ftdi_sio_b300 = 0, 
612  ftdi_sio_b600 = 1, 
613  ftdi_sio_b1200 = 2,
614  ftdi_sio_b2400 = 3,
615  ftdi_sio_b4800 = 4,
616  ftdi_sio_b9600 = 5,
617  ftdi_sio_b19200 = 6,
618  ftdi_sio_b38400 = 7,
619  ftdi_sio_b57600 = 8,
620  ftdi_sio_b115200 = 9
621 } FTDI_SIO_baudrate_t ;
622
623 /*
624  * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
625  * are calculated internally.
626  */
627
628 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
629 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
630 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
631 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
632 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
633 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
634 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
635 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
636 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
637 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
638 #define FTDI_SIO_SET_BREAK (0x1 << 14)
639 /* FTDI_SIO_SET_DATA */
640
641 /*
642  * BmRequestType:  0100 0000B 
643  * bRequest:       FTDI_SIO_SET_DATA
644  * wValue:         Data characteristics (see below)
645  * wIndex:         Port
646  * wLength:        0
647  * Data:           No
648  *
649  * Data characteristics
650  *
651  *   B0..7   Number of data bits
652  *   B8..10  Parity
653  *           0 = None
654  *           1 = Odd
655  *           2 = Even
656  *           3 = Mark
657  *           4 = Space
658  *   B11..13 Stop Bits
659  *           0 = 1
660  *           1 = 1.5
661  *           2 = 2
662  *   B14
663  *           1 = TX ON (break)
664  *           0 = TX OFF (normal state)
665  *   B15 Reserved
666  *
667  */
668
669
670
671 /* FTDI_SIO_MODEM_CTRL */
672 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
673 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
674
675 /* 
676  * BmRequestType:   0100 0000B
677  * bRequest:        FTDI_SIO_MODEM_CTRL
678  * wValue:          ControlValue (see below)
679  * wIndex:          Port
680  * wLength:         0
681  * Data:            None
682  *
683  * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
684  * command will be IGNORED without an error being returned
685  * Also - you can not set DTR and RTS with one control message
686  */
687
688 #define FTDI_SIO_SET_DTR_MASK 0x1
689 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK  << 8))
690 #define FTDI_SIO_SET_DTR_LOW  ( 0 | ( FTDI_SIO_SET_DTR_MASK  << 8))
691 #define FTDI_SIO_SET_RTS_MASK 0x2
692 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
693 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
694
695 /*
696  * ControlValue
697  * B0    DTR state
698  *          0 = reset
699  *          1 = set
700  * B1    RTS state
701  *          0 = reset
702  *          1 = set
703  * B2..7 Reserved
704  * B8    DTR state enable
705  *          0 = ignore
706  *          1 = use DTR state
707  * B9    RTS state enable
708  *          0 = ignore
709  *          1 = use RTS state
710  * B10..15 Reserved
711  */
712
713 /* FTDI_SIO_SET_FLOW_CTRL */
714 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
715 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
716 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0 
717 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
718 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
719 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
720 /*
721  *   BmRequestType:  0100 0000b
722  *   bRequest:       FTDI_SIO_SET_FLOW_CTRL
723  *   wValue:         Xoff/Xon
724  *   wIndex:         Protocol/Port - hIndex is protocl / lIndex is port
725  *   wLength:        0 
726  *   Data:           None
727  *
728  * hIndex protocol is:
729  *   B0 Output handshaking using RTS/CTS
730  *       0 = disabled
731  *       1 = enabled
732  *   B1 Output handshaking using DTR/DSR
733  *       0 = disabled
734  *       1 = enabled
735  *   B2 Xon/Xoff handshaking
736  *       0 = disabled
737  *       1 = enabled
738  *
739  * A value of zero in the hIndex field disables handshaking
740  *
741  * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character 
742  * and the lValue field contains the XON character.
743  */  
744  
745 /*
746  * FTDI_SIO_GET_LATENCY_TIMER
747  *
748  * Set the timeout interval. The FTDI collects data from the slave
749  * device, transmitting it to the host when either A) 62 bytes are
750  * received, or B) the timeout interval has elapsed and the buffer
751  * contains at least 1 byte.  Setting this value to a small number
752  * can dramatically improve performance for applications which send
753  * small packets, since the default value is 16ms.
754  */
755 #define  FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
756 #define  FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
757
758 /* 
759  *  BmRequestType:   1100 0000b
760  *  bRequest:        FTDI_SIO_GET_LATENCY_TIMER
761  *  wValue:          0
762  *  wIndex:          Port
763  *  wLength:         0
764  *  Data:            latency (on return)
765  */
766
767 /* 
768  * FTDI_SIO_SET_LATENCY_TIMER
769  *
770  * Set the timeout interval. The FTDI collects data from the slave
771  * device, transmitting it to the host when either A) 62 bytes are
772  * received, or B) the timeout interval has elapsed and the buffer
773  * contains at least 1 byte.  Setting this value to a small number
774  * can dramatically improve performance for applications which send
775  * small packets, since the default value is 16ms.
776  */
777 #define  FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
778 #define  FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
779
780 /* 
781  *  BmRequestType:   0100 0000b
782  *  bRequest:        FTDI_SIO_SET_LATENCY_TIMER
783  *  wValue:          Latency (milliseconds)
784  *  wIndex:          Port
785  *  wLength:         0
786  *  Data:            None
787  *
788  * wValue:
789  *   B0..7   Latency timer
790  *   B8..15  0
791  *
792  */
793
794 /*
795  * FTDI_SIO_SET_EVENT_CHAR 
796  *
797  * Set the special event character for the specified communications port.
798  * If the device sees this character it will immediately return the
799  * data read so far - rather than wait 40ms or until 62 bytes are read
800  * which is what normally happens.
801  */
802
803
804 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
805 #define  FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
806
807
808 /* 
809  *  BmRequestType:   0100 0000b
810  *  bRequest:        FTDI_SIO_SET_EVENT_CHAR
811  *  wValue:          EventChar
812  *  wIndex:          Port
813  *  wLength:         0
814  *  Data:            None
815  *
816  * wValue:
817  *   B0..7   Event Character
818  *   B8      Event Character Processing
819  *             0 = disabled
820  *             1 = enabled
821  *   B9..15  Reserved
822  *
823  */
824           
825 /* FTDI_SIO_SET_ERROR_CHAR */
826
827 /* Set the parity error replacement character for the specified communications port */
828
829 /* 
830  *  BmRequestType:  0100 0000b
831  *  bRequest:       FTDI_SIO_SET_EVENT_CHAR
832  *  wValue:         Error Char
833  *  wIndex:         Port
834  *  wLength:        0
835  *  Data:           None
836  *
837  *Error Char
838  *  B0..7  Error Character
839  *  B8     Error Character Processing
840  *           0 = disabled
841  *           1 = enabled
842  *  B9..15 Reserved
843  *
844  */
845
846 /* FTDI_SIO_GET_MODEM_STATUS */
847 /* Retrieve the current value of the modem status register */
848
849 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
850 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
851 #define FTDI_SIO_CTS_MASK 0x10
852 #define FTDI_SIO_DSR_MASK 0x20
853 #define FTDI_SIO_RI_MASK  0x40
854 #define FTDI_SIO_RLSD_MASK 0x80
855 /* 
856  *   BmRequestType:   1100 0000b
857  *   bRequest:        FTDI_SIO_GET_MODEM_STATUS
858  *   wValue:          zero
859  *   wIndex:          Port
860  *   wLength:         1
861  *   Data:            Status
862  * 
863  * One byte of data is returned 
864  * B0..3 0
865  * B4    CTS
866  *         0 = inactive
867  *         1 = active
868  * B5    DSR
869  *         0 = inactive
870  *         1 = active
871  * B6    Ring Indicator (RI)
872  *         0 = inactive
873  *         1 = active
874  * B7    Receive Line Signal Detect (RLSD)
875  *         0 = inactive
876  *         1 = active 
877  */
878
879
880
881 /* Descriptors returned by the device 
882  * 
883  *  Device Descriptor
884  * 
885  * Offset       Field           Size    Value   Description
886  * 0    bLength         1       0x12    Size of descriptor in bytes
887  * 1    bDescriptorType 1       0x01    DEVICE Descriptor Type
888  * 2    bcdUSB          2       0x0110  USB Spec Release Number
889  * 4    bDeviceClass    1       0x00    Class Code
890  * 5    bDeviceSubClass 1       0x00    SubClass Code
891  * 6    bDeviceProtocol 1       0x00    Protocol Code
892  * 7    bMaxPacketSize0 1       0x08    Maximum packet size for endpoint 0
893  * 8    idVendor        2       0x0403  Vendor ID
894  * 10   idProduct       2       0x8372  Product ID (FTDI_SIO_PID)
895  * 12   bcdDevice       2       0x0001  Device release number
896  * 14   iManufacturer   1       0x01    Index of man. string desc
897  * 15   iProduct        1       0x02    Index of prod string desc
898  * 16   iSerialNumber   1       0x02    Index of serial nmr string desc
899  * 17   bNumConfigurations 1    0x01    Number of possible configurations
900  * 
901  * Configuration Descriptor
902  * 
903  * Offset       Field                   Size    Value
904  * 0    bLength                 1       0x09    Size of descriptor in bytes
905  * 1    bDescriptorType         1       0x02    CONFIGURATION Descriptor Type
906  * 2    wTotalLength            2       0x0020  Total length of data
907  * 4    bNumInterfaces          1       0x01    Number of interfaces supported
908  * 5    bConfigurationValue     1       0x01    Argument for SetCOnfiguration() req
909  * 6    iConfiguration          1       0x02    Index of config string descriptor
910  * 7    bmAttributes            1       0x20    Config characteristics Remote Wakeup
911  * 8    MaxPower                1       0x1E    Max power consumption
912  * 
913  * Interface Descriptor
914  * 
915  * Offset       Field                   Size    Value
916  * 0    bLength                 1       0x09    Size of descriptor in bytes
917  * 1    bDescriptorType         1       0x04    INTERFACE Descriptor Type
918  * 2    bInterfaceNumber        1       0x00    Number of interface
919  * 3    bAlternateSetting       1       0x00    Value used to select alternate
920  * 4    bNumEndpoints           1       0x02    Number of endpoints
921  * 5    bInterfaceClass         1       0xFF    Class Code
922  * 6    bInterfaceSubClass      1       0xFF    Subclass Code
923  * 7    bInterfaceProtocol      1       0xFF    Protocol Code
924  * 8    iInterface              1       0x02    Index of interface string description
925  * 
926  * IN Endpoint Descriptor
927  * 
928  * Offset       Field                   Size    Value
929  * 0    bLength                 1       0x07    Size of descriptor in bytes
930  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
931  * 2    bEndpointAddress        1       0x82    Address of endpoint
932  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
933  * 4    bNumEndpoints           2       0x0040  maximum packet size
934  * 5    bInterval               1       0x00    Interval for polling endpoint
935  * 
936  * OUT Endpoint Descriptor
937  * 
938  * Offset       Field                   Size    Value
939  * 0    bLength                 1       0x07    Size of descriptor in bytes
940  * 1    bDescriptorType         1       0x05    ENDPOINT descriptor type
941  * 2    bEndpointAddress        1       0x02    Address of endpoint
942  * 3    bmAttributes            1       0x02    Endpoint attributes - Bulk
943  * 4    bNumEndpoints           2       0x0040  maximum packet size
944  * 5    bInterval               1       0x00    Interval for polling endpoint
945  *     
946  * DATA FORMAT
947  * 
948  * IN Endpoint
949  * 
950  * The device reserves the first two bytes of data on this endpoint to contain the current
951  * values of the modem and line status registers. In the absence of data, the device 
952  * generates a message consisting of these two status bytes every 40 ms
953  * 
954  * Byte 0: Modem Status
955  * 
956  * Offset       Description
957  * B0   Reserved - must be 1
958  * B1   Reserved - must be 0
959  * B2   Reserved - must be 0
960  * B3   Reserved - must be 0
961  * B4   Clear to Send (CTS)
962  * B5   Data Set Ready (DSR)
963  * B6   Ring Indicator (RI)
964  * B7   Receive Line Signal Detect (RLSD)
965  * 
966  * Byte 1: Line Status
967  * 
968  * Offset       Description
969  * B0   Data Ready (DR)
970  * B1   Overrun Error (OE)
971  * B2   Parity Error (PE)
972  * B3   Framing Error (FE)
973  * B4   Break Interrupt (BI)
974  * B5   Transmitter Holding Register (THRE)
975  * B6   Transmitter Empty (TEMT)
976  * B7   Error in RCVR FIFO
977  * 
978  */
979 #define FTDI_RS0_CTS    (1 << 4)
980 #define FTDI_RS0_DSR    (1 << 5)
981 #define FTDI_RS0_RI     (1 << 6)
982 #define FTDI_RS0_RLSD   (1 << 7)
983
984 #define FTDI_RS_DR  1
985 #define FTDI_RS_OE (1<<1)
986 #define FTDI_RS_PE (1<<2)
987 #define FTDI_RS_FE (1<<3)
988 #define FTDI_RS_BI (1<<4)
989 #define FTDI_RS_THRE (1<<5)
990 #define FTDI_RS_TEMT (1<<6)
991 #define FTDI_RS_FIFO  (1<<7)
992
993 /*
994  * OUT Endpoint
995  * 
996  * This device reserves the first bytes of data on this endpoint contain the length
997  * and port identifier of the message. For the FTDI USB Serial converter the port 
998  * identifier is always 1.
999  * 
1000  * Byte 0: Line Status
1001  * 
1002  * Offset       Description
1003  * B0   Reserved - must be 1
1004  * B1   Reserved - must be 0
1005  * B2..7        Length of message - (not including Byte 0)
1006  * 
1007  */
1008