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