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