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