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