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