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