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 /* www.irtrans.de device */
35 #define FTDI_IRTRANS_PID 0xFC60 /* Product Id */
36
37 /* www.crystalfontz.com devices - thanx for providing free devices for evaluation ! */
38 /* they use the ftdi chipset for the USB interface and the vendor id is the same */
39 #define FTDI_XF_632_PID 0xFC08 /* 632: 16x2 Character Display */
40 #define FTDI_XF_634_PID 0xFC09 /* 634: 20x4 Character Display */
41 #define FTDI_XF_547_PID 0xFC0A /* 547: Two line Display */
42 #define FTDI_XF_633_PID 0xFC0B /* 633: 16x2 Character Display with Keys */
43 #define FTDI_XF_631_PID 0xFC0C /* 631: 20x2 Character Display */
44 #define FTDI_XF_635_PID 0xFC0D /* 635: 20x4 Character Display */
45 #define FTDI_XF_640_PID 0xFC0E /* 640: Two line Display */
46 #define FTDI_XF_642_PID 0xFC0F /* 642: Two line Display */
47
48 /* Video Networks Limited / Homechoice in the UK use an ftdi-based device for their 1Mb */
49 /* broadband internet service. The following PID is exhibited by the usb device supplied */
50 /* (the VID is the standard ftdi vid (FTDI_VID) */
51 #define FTDI_VNHCPCUSB_D_PID 0xfe38 /* Product Id */
52
53 /*
54 * The following are the values for the Matrix Orbital LCD displays,
55 * which are the FT232BM ( similar to the 8U232AM )
56 */
57 #define FTDI_MTXORB_0_PID 0xFA00 /* Matrix Orbital Product Id */
58 #define FTDI_MTXORB_1_PID 0xFA01 /* Matrix Orbital Product Id */
59 #define FTDI_MTXORB_2_PID 0xFA02 /* Matrix Orbital Product Id */
60 #define FTDI_MTXORB_3_PID 0xFA03 /* Matrix Orbital Product Id */
61 #define FTDI_MTXORB_4_PID 0xFA04 /* Matrix Orbital Product Id */
62 #define FTDI_MTXORB_5_PID 0xFA05 /* Matrix Orbital Product Id */
63 #define FTDI_MTXORB_6_PID 0xFA06 /* Matrix Orbital Product Id */
64
65 /* Interbiometrics USB I/O Board */
66 /* Developed for Interbiometrics by Rudolf Gugler */
67 #define INTERBIOMETRICS_VID 0x1209
68 #define INTERBIOMETRICS_IOBOARD_PID 0x1002
69 #define INTERBIOMETRICS_MINI_IOBOARD_PID 0x1006
70
71 /*
72 * The following are the values for the Perle Systems
73 * UltraPort USB serial converters
74 */
75 #define FTDI_PERLE_ULTRAPORT_PID 0xF0C0 /* Perle UltraPort Product Id */
76
77 /*
78 * The following are the values for the Sealevel SeaLINK+ adapters.
79 * (Original list sent by Tuan Hoang. Ian Abbott renamed the macros and
80 * removed some PIDs that don't seem to match any existing products.)
81 */
82 #define SEALEVEL_VID 0x0c52 /* Sealevel Vendor ID */
83 #define SEALEVEL_2101_PID 0x2101 /* SeaLINK+232 (2101/2105) */
84 #define SEALEVEL_2102_PID 0x2102 /* SeaLINK+485 (2102) */
85 #define SEALEVEL_2103_PID 0x2103 /* SeaLINK+232I (2103) */
86 #define SEALEVEL_2104_PID 0x2104 /* SeaLINK+485I (2104) */
87 #define SEALEVEL_2201_1_PID 0x2211 /* SeaPORT+2/232 (2201) Port 1 */
88 #define SEALEVEL_2201_2_PID 0x2221 /* SeaPORT+2/232 (2201) Port 2 */
89 #define SEALEVEL_2202_1_PID 0x2212 /* SeaPORT+2/485 (2202) Port 1 */
90 #define SEALEVEL_2202_2_PID 0x2222 /* SeaPORT+2/485 (2202) Port 2 */
91 #define SEALEVEL_2203_1_PID 0x2213 /* SeaPORT+2 (2203) Port 1 */
92 #define SEALEVEL_2203_2_PID 0x2223 /* SeaPORT+2 (2203) Port 2 */
93 #define SEALEVEL_2401_1_PID 0x2411 /* SeaPORT+4/232 (2401) Port 1 */
94 #define SEALEVEL_2401_2_PID 0x2421 /* SeaPORT+4/232 (2401) Port 2 */
95 #define SEALEVEL_2401_3_PID 0x2431 /* SeaPORT+4/232 (2401) Port 3 */
96 #define SEALEVEL_2401_4_PID 0x2441 /* SeaPORT+4/232 (2401) Port 4 */
97 #define SEALEVEL_2402_1_PID 0x2412 /* SeaPORT+4/485 (2402) Port 1 */
98 #define SEALEVEL_2402_2_PID 0x2422 /* SeaPORT+4/485 (2402) Port 2 */
99 #define SEALEVEL_2402_3_PID 0x2432 /* SeaPORT+4/485 (2402) Port 3 */
100 #define SEALEVEL_2402_4_PID 0x2442 /* SeaPORT+4/485 (2402) Port 4 */
101 #define SEALEVEL_2403_1_PID 0x2413 /* SeaPORT+4 (2403) Port 1 */
102 #define SEALEVEL_2403_2_PID 0x2423 /* SeaPORT+4 (2403) Port 2 */
103 #define SEALEVEL_2403_3_PID 0x2433 /* SeaPORT+4 (2403) Port 3 */
104 #define SEALEVEL_2403_4_PID 0x2443 /* SeaPORT+4 (2403) Port 4 */
105 #define SEALEVEL_2801_1_PID 0X2811 /* SeaLINK+8/232 (2801) Port 1 */
106 #define SEALEVEL_2801_2_PID 0X2821 /* SeaLINK+8/232 (2801) Port 2 */
107 #define SEALEVEL_2801_3_PID 0X2831 /* SeaLINK+8/232 (2801) Port 3 */
108 #define SEALEVEL_2801_4_PID 0X2841 /* SeaLINK+8/232 (2801) Port 4 */
109 #define SEALEVEL_2801_5_PID 0X2851 /* SeaLINK+8/232 (2801) Port 5 */
110 #define SEALEVEL_2801_6_PID 0X2861 /* SeaLINK+8/232 (2801) Port 6 */
111 #define SEALEVEL_2801_7_PID 0X2871 /* SeaLINK+8/232 (2801) Port 7 */
112 #define SEALEVEL_2801_8_PID 0X2881 /* SeaLINK+8/232 (2801) Port 8 */
113 #define SEALEVEL_2802_1_PID 0X2812 /* SeaLINK+8/485 (2802) Port 1 */
114 #define SEALEVEL_2802_2_PID 0X2822 /* SeaLINK+8/485 (2802) Port 2 */
115 #define SEALEVEL_2802_3_PID 0X2832 /* SeaLINK+8/485 (2802) Port 3 */
116 #define SEALEVEL_2802_4_PID 0X2842 /* SeaLINK+8/485 (2802) Port 4 */
117 #define SEALEVEL_2802_5_PID 0X2852 /* SeaLINK+8/485 (2802) Port 5 */
118 #define SEALEVEL_2802_6_PID 0X2862 /* SeaLINK+8/485 (2802) Port 6 */
119 #define SEALEVEL_2802_7_PID 0X2872 /* SeaLINK+8/485 (2802) Port 7 */
120 #define SEALEVEL_2802_8_PID 0X2882 /* SeaLINK+8/485 (2802) Port 8 */
121 #define SEALEVEL_2803_1_PID 0X2813 /* SeaLINK+8 (2803) Port 1 */
122 #define SEALEVEL_2803_2_PID 0X2823 /* SeaLINK+8 (2803) Port 2 */
123 #define SEALEVEL_2803_3_PID 0X2833 /* SeaLINK+8 (2803) Port 3 */
124 #define SEALEVEL_2803_4_PID 0X2843 /* SeaLINK+8 (2803) Port 4 */
125 #define SEALEVEL_2803_5_PID 0X2853 /* SeaLINK+8 (2803) Port 5 */
126 #define SEALEVEL_2803_6_PID 0X2863 /* SeaLINK+8 (2803) Port 6 */
127 #define SEALEVEL_2803_7_PID 0X2873 /* SeaLINK+8 (2803) Port 7 */
128 #define SEALEVEL_2803_8_PID 0X2883 /* SeaLINK+8 (2803) Port 8 */
129
130 /*
131 * DSS-20 Sync Station for Sony Ericsson P800
132 */
133
134 #define FTDI_DSS20_PID 0xFC82
135
136 /*
137 * Home Electronics (www.home-electro.com) USB gadgets
138 */
139 #define FTDI_HE_TIRA1_PID 0xFA78 /* Tira-1 IR tranceiver */
140
141 /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */
142 /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */
143 #define FTDI_USB_UIRT_PID 0xF850 /* Product Id */
144
145 /* ELV USB Module UO100 (PID sent by Stefan Frings) */
146 #define FTDI_ELV_UO100_PID 0xFB58 /* Product Id */
147
148 /*
149 * Definitions for ID TECH (www.idt-net.com) devices
150 */
151 #define IDTECH_VID 0x0ACD /* ID TECH Vendor ID */
152 #define IDTECH_IDT1221U_PID 0x0300 /* IDT1221U USB to RS-232 adapter */
153
154 /*
155 * Definitions for Omnidirectional Control Technology, Inc. devices
156 */
157 #define OCT_VID 0x0B39 /* OCT vendor ID */
158 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
159 /* Also rebadged as SIIG Inc. model US2308 */
160 #define OCT_US101_PID 0x0421 /* OCT US101 USB to RS-232 */
161
162 /* an infrared receiver for user access control with IR tags */
163 #define FTDI_PIEGROUP_PID 0xF208 /* Product Id */
164
165 /*
166 * Protego product ids
167 */
168 #define PROTEGO_SPECIAL_1 0xFC70 /* special/unknown device */
169 #define PROTEGO_R2X0 0xFC71 /* R200-USB TRNG unit (R210, R220, and R230) */
170 #define PROTEGO_SPECIAL_3 0xFC72 /* special/unknown device */
171 #define PROTEGO_SPECIAL_4 0xFC73 /* special/unknown device */
172
173 /*
174 * Gude Analog- und Digitalsysteme GmbH
175 */
176 #define FTDI_GUDEADS_E808_PID 0xE808
177 #define FTDI_GUDEADS_E809_PID 0xE809
178 #define FTDI_GUDEADS_E80A_PID 0xE80A
179 #define FTDI_GUDEADS_E80B_PID 0xE80B
180 #define FTDI_GUDEADS_E80C_PID 0xE80C
181 #define FTDI_GUDEADS_E80D_PID 0xE80D
182 #define FTDI_GUDEADS_E80E_PID 0xE80E
183 #define FTDI_GUDEADS_E80F_PID 0xE80F
184 #define FTDI_GUDEADS_E888_PID 0xE888 /* Expert ISDN Control USB */
185 #define FTDI_GUDEADS_E889_PID 0xE889 /* USB RS-232 OptoBridge */
186 #define FTDI_GUDEADS_E88A_PID 0xE88A
187 #define FTDI_GUDEADS_E88B_PID 0xE88B
188 #define FTDI_GUDEADS_E88C_PID 0xE88C
189 #define FTDI_GUDEADS_E88D_PID 0xE88D
190 #define FTDI_GUDEADS_E88E_PID 0xE88E
191 #define FTDI_GUDEADS_E88F_PID 0xE88F
192
193 /*
194 * Linx Technologies product ids
195 */
196 #define LINX_SDMUSBQSS_PID 0xF448 /* Linx SDM-USB-QS-S */
197 #define LINX_MASTERDEVEL2_PID 0xF449 /* Linx Master Development 2.0 */
198 #define LINX_FUTURE_0_PID 0xF44A /* Linx future device */
199 #define LINX_FUTURE_1_PID 0xF44B /* Linx future device */
200 #define LINX_FUTURE_2_PID 0xF44C /* Linx future device */
201
202 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
203 /* unit for PIC16's/PIC18's */
204 #define FTDI_CCSICDU20_0_PID 0xF9D0
205 #define FTDI_CCSICDU40_1_PID 0xF9D1
206
207 /* Inside Accesso contactless reader (http://www.insidefr.com) */
208 #define INSIDE_ACCESSO 0xFAD0
209
210 /*
211 * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI
212 */
213 #define INTREPID_VID 0x093C
214 #define INTREPID_VALUECAN_PID 0x0601
215 #define INTREPID_NEOVI_PID 0x0701
216
217 /*
218 * Falcom Wireless Communications GmbH
219 */
220 #define FALCOM_VID 0x0F94 /* Vendor Id */
221 #define FALCOM_TWIST_PID 0x0001 /* Falcom Twist USB GPRS modem */
222
223 /*
224 * SUUNTO product ids
225 */
226 #define FTDI_SUUNTO_SPORTS_PID 0xF680 /* Suunto Sports instrument */
227
228 /*
229 * Definitions for B&B Electronics products.
230 */
231 #define BANDB_VID 0x0856 /* B&B Electronics Vendor ID */
232 #define BANDB_USOTL4_PID 0xAC01 /* USOTL4 Isolated RS-485 Converter */
233 #define BANDB_USTL4_PID 0xAC02 /* USTL4 RS-485 Converter */
234 #define BANDB_USO9ML2_PID 0xAC03 /* USO9ML2 Isolated RS-232 Converter */
235
236 /*
237 * RM Michaelides CANview USB (http://www.rmcan.com)
238 * CAN filedbus interface adapter, addad by port GmbH www.port.de)
239 */
240 #define FTDI_RM_VID 0x0403 /* Vendor Id */
241 #define FTDI_RMCANVIEW_PID 0xfd60 /* Product Id */
242
243 /*
244 * EVER Eco Pro UPS (http://www.ever.com.pl/)
245 */
246
247 #define EVER_ECO_PRO_CDS 0xe520 /* RS-232 converter */
248
249 /* Commands */
250 #define FTDI_SIO_RESET 0 /* Reset the port */
251 #define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */
252 #define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */
253 #define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */
254 #define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of the port */
255 #define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modern status register */
256 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
257 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
258 #define FTDI_SIO_SET_LATENCY_TIMER 9 /* Set the latency timer */
259 #define FTDI_SIO_GET_LATENCY_TIMER 10 /* Get the latency timer */
260
261 /* Port interface code for FT2232C */
262 #define INTERFACE_A 1
263 #define INTERFACE_B 2
264
265
266 /*
267 * BmRequestType: 1100 0000b
268 * bRequest: FTDI_E2_READ
269 * wValue: 0
270 * wIndex: Address of word to read
271 * wLength: 2
272 * Data: Will return a word of data from E2Address
273 *
274 */
275
276 /* Port Identifier Table */
277 #define PIT_DEFAULT 0 /* SIOA */
278 #define PIT_SIOA 1 /* SIOA */
279 /* The device this driver is tested with one has only one port */
280 #define PIT_SIOB 2 /* SIOB */
281 #define PIT_PARALLEL 3 /* Parallel */
282
283 /* FTDI_SIO_RESET */
284 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
285 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
286 #define FTDI_SIO_RESET_SIO 0
287 #define FTDI_SIO_RESET_PURGE_RX 1
288 #define FTDI_SIO_RESET_PURGE_TX 2
289
290 /*
291 * BmRequestType: 0100 0000B
292 * bRequest: FTDI_SIO_RESET
293 * wValue: Control Value
294 * 0 = Reset SIO
295 * 1 = Purge RX buffer
296 * 2 = Purge TX buffer
297 * wIndex: Port
298 * wLength: 0
299 * Data: None
300 *
301 * The Reset SIO command has this effect:
302 *
303 * Sets flow control set to 'none'
304 * Event char = $0D
305 * Event trigger = disabled
306 * Purge RX buffer
307 * Purge TX buffer
308 * Clear DTR
309 * Clear RTS
310 * baud and data format not reset
311 *
312 * The Purge RX and TX buffer commands affect nothing except the buffers
313 *
314 */
315
316 /* FTDI_SIO_SET_BAUDRATE */
317 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
318 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
319
320 /*
321 * BmRequestType: 0100 0000B
322 * bRequest: FTDI_SIO_SET_BAUDRATE
323 * wValue: BaudDivisor value - see below
324 * wIndex: Port
325 * wLength: 0
326 * Data: None
327 * The BaudDivisor values are calculated as follows:
328 * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
329 * I knew how to detect old chips to select proper base clock!
330 * - BaudDivisor is a fixed point number encoded in a funny way.
331 * (--WRONG WAY OF THINKING--)
332 * BaudDivisor is a fixed point number encoded with following bit weighs:
333 * (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
334 * end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
335 * (--THE REALITY--)
336 * The both-bits-set has quite different meaning from 0.75 - the chip designers
337 * have decided it to mean 0.125 instead of 0.75.
338 * This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
339 * and Flow Control Consideration for USB to RS232".
340 * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
341 * automagically re-encode the resulting value to take fractions into consideration.
342 * As all values are integers, some bit twiddling is in order:
343 * BaudDivisor = (BaseClock / 16 / BaudRate) |
344 * (((BaseClock / 2 / BaudRate) & 4) ? 0x4000 // 0.5
345 * : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000 // 0.25
346 * : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000 // 0.125
347 * : 0)
348 *
349 * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
350 * of 0.125 missing from the FT8U232AM. Bits 16 to 14 are coded as follows
351 * (the first four codes are the same as for the FT8U232AM, where bit 16 is
352 * always 0):
353 * 000 - add .000 to divisor
354 * 001 - add .500 to divisor
355 * 010 - add .250 to divisor
356 * 011 - add .125 to divisor
357 * 100 - add .375 to divisor
358 * 101 - add .625 to divisor
359 * 110 - add .750 to divisor
360 * 111 - add .875 to divisor
361 * Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is
362 * placed in bit 0 of the urb index.
363 *
364 * Note that there are a couple of special cases to support the highest baud
365 * rates. If the calculated divisor value is 1, this needs to be replaced with
366 * 0. Additionally for the FT232BM, if the calculated divisor value is 0x4001
367 * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
368 * not supported by the FT8U232AM).
369 */
370
371 typedef enum {
372 SIO = 1,
373 FT8U232AM = 2,
374 FT232BM = 3,
375 FT2232C = 4,
376 } ftdi_chip_type_t;
377
378 typedef enum {
379 ftdi_sio_b300 = 0,
380 ftdi_sio_b600 = 1,
381 ftdi_sio_b1200 = 2,
382 ftdi_sio_b2400 = 3,
383 ftdi_sio_b4800 = 4,
384 ftdi_sio_b9600 = 5,
385 ftdi_sio_b19200 = 6,
386 ftdi_sio_b38400 = 7,
387 ftdi_sio_b57600 = 8,
388 ftdi_sio_b115200 = 9
389 } FTDI_SIO_baudrate_t ;
390
391 /*
392 * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
393 * are calculated internally.
394 */
395
396 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
397 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
398 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
399 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
400 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
401 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
402 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
403 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
404 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
405 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
406 #define FTDI_SIO_SET_BREAK (0x1 << 14)
407 /* FTDI_SIO_SET_DATA */
408
409 /*
410 * BmRequestType: 0100 0000B
411 * bRequest: FTDI_SIO_SET_DATA
412 * wValue: Data characteristics (see below)
413 * wIndex: Port
414 * wLength: 0
415 * Data: No
416 *
417 * Data characteristics
418 *
419 * B0..7 Number of data bits
420 * B8..10 Parity
421 * 0 = None
422 * 1 = Odd
423 * 2 = Even
424 * 3 = Mark
425 * 4 = Space
426 * B11..13 Stop Bits
427 * 0 = 1
428 * 1 = 1.5
429 * 2 = 2
430 * B14
431 * 1 = TX ON (break)
432 * 0 = TX OFF (normal state)
433 * B15 Reserved
434 *
435 */
436
437
438
439 /* FTDI_SIO_MODEM_CTRL */
440 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
441 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
442
443 /*
444 * BmRequestType: 0100 0000B
445 * bRequest: FTDI_SIO_MODEM_CTRL
446 * wValue: ControlValue (see below)
447 * wIndex: Port
448 * wLength: 0
449 * Data: None
450 *
451 * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
452 * command will be IGNORED without an error being returned
453 * Also - you can not set DTR and RTS with one control message
454 */
455
456 #define FTDI_SIO_SET_DTR_MASK 0x1
457 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK << 8))
458 #define FTDI_SIO_SET_DTR_LOW ( 0 | ( FTDI_SIO_SET_DTR_MASK << 8))
459 #define FTDI_SIO_SET_RTS_MASK 0x2
460 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
461 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
462
463 /*
464 * ControlValue
465 * B0 DTR state
466 * 0 = reset
467 * 1 = set
468 * B1 RTS state
469 * 0 = reset
470 * 1 = set
471 * B2..7 Reserved
472 * B8 DTR state enable
473 * 0 = ignore
474 * 1 = use DTR state
475 * B9 RTS state enable
476 * 0 = ignore
477 * 1 = use RTS state
478 * B10..15 Reserved
479 */
480
481 /* FTDI_SIO_SET_FLOW_CTRL */
482 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
483 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
484 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
485 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
486 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
487 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
488 /*
489 * BmRequestType: 0100 0000b
490 * bRequest: FTDI_SIO_SET_FLOW_CTRL
491 * wValue: Xoff/Xon
492 * wIndex: Protocol/Port - hIndex is protocl / lIndex is port
493 * wLength: 0
494 * Data: None
495 *
496 * hIndex protocol is:
497 * B0 Output handshaking using RTS/CTS
498 * 0 = disabled
499 * 1 = enabled
500 * B1 Output handshaking using DTR/DSR
501 * 0 = disabled
502 * 1 = enabled
503 * B2 Xon/Xoff handshaking
504 * 0 = disabled
505 * 1 = enabled
506 *
507 * A value of zero in the hIndex field disables handshaking
508 *
509 * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
510 * and the lValue field contains the XON character.
511 */
512
513 /*
514 * FTDI_SIO_GET_LATENCY_TIMER
515 *
516 * Set the timeout interval. The FTDI collects data from the slave
517 * device, transmitting it to the host when either A) 62 bytes are
518 * received, or B) the timeout interval has elapsed and the buffer
519 * contains at least 1 byte. Setting this value to a small number
520 * can dramatically improve performance for applications which send
521 * small packets, since the default value is 16ms.
522 */
523 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
524 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
525
526 /*
527 * BmRequestType: 1100 0000b
528 * bRequest: FTDI_SIO_GET_LATENCY_TIMER
529 * wValue: 0
530 * wIndex: Port
531 * wLength: 0
532 * Data: latency (on return)
533 */
534
535 /*
536 * FTDI_SIO_SET_LATENCY_TIMER
537 *
538 * Set the timeout interval. The FTDI collects data from the slave
539 * device, transmitting it to the host when either A) 62 bytes are
540 * received, or B) the timeout interval has elapsed and the buffer
541 * contains at least 1 byte. Setting this value to a small number
542 * can dramatically improve performance for applications which send
543 * small packets, since the default value is 16ms.
544 */
545 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
546 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
547
548 /*
549 * BmRequestType: 0100 0000b
550 * bRequest: FTDI_SIO_SET_LATENCY_TIMER
551 * wValue: Latency (milliseconds)
552 * wIndex: Port
553 * wLength: 0
554 * Data: None
555 *
556 * wValue:
557 * B0..7 Latency timer
558 * B8..15 0
559 *
560 */
561
562 /*
563 * FTDI_SIO_SET_EVENT_CHAR
564 *
565 * Set the special event character for the specified communications port.
566 * If the device sees this character it will immediately return the
567 * data read so far - rather than wait 40ms or until 62 bytes are read
568 * which is what normally happens.
569 */
570
571
572 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
573 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
574
575
576 /*
577 * BmRequestType: 0100 0000b
578 * bRequest: FTDI_SIO_SET_EVENT_CHAR
579 * wValue: EventChar
580 * wIndex: Port
581 * wLength: 0
582 * Data: None
583 *
584 * wValue:
585 * B0..7 Event Character
586 * B8 Event Character Processing
587 * 0 = disabled
588 * 1 = enabled
589 * B9..15 Reserved
590 *
591 */
592
593 /* FTDI_SIO_SET_ERROR_CHAR */
594
595 /* Set the parity error replacement character for the specified communications port */
596
597 /*
598 * BmRequestType: 0100 0000b
599 * bRequest: FTDI_SIO_SET_EVENT_CHAR
600 * wValue: Error Char
601 * wIndex: Port
602 * wLength: 0
603 * Data: None
604 *
605 *Error Char
606 * B0..7 Error Character
607 * B8 Error Character Processing
608 * 0 = disabled
609 * 1 = enabled
610 * B9..15 Reserved
611 *
612 */
613
614 /* FTDI_SIO_GET_MODEM_STATUS */
615 /* Retreive the current value of the modem status register */
616
617 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
618 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
619 #define FTDI_SIO_CTS_MASK 0x10
620 #define FTDI_SIO_DSR_MASK 0x20
621 #define FTDI_SIO_RI_MASK 0x40
622 #define FTDI_SIO_RLSD_MASK 0x80
623 /*
624 * BmRequestType: 1100 0000b
625 * bRequest: FTDI_SIO_GET_MODEM_STATUS
626 * wValue: zero
627 * wIndex: Port
628 * wLength: 1
629 * Data: Status
630 *
631 * One byte of data is returned
632 * B0..3 0
633 * B4 CTS
634 * 0 = inactive
635 * 1 = active
636 * B5 DSR
637 * 0 = inactive
638 * 1 = active
639 * B6 Ring Indicator (RI)
640 * 0 = inactive
641 * 1 = active
642 * B7 Receive Line Signal Detect (RLSD)
643 * 0 = inactive
644 * 1 = active
645 */
646
647
648
649 /* Descriptors returned by the device
650 *
651 * Device Descriptor
652 *
653 * Offset Field Size Value Description
654 * 0 bLength 1 0x12 Size of descriptor in bytes
655 * 1 bDescriptorType 1 0x01 DEVICE Descriptor Type
656 * 2 bcdUSB 2 0x0110 USB Spec Release Number
657 * 4 bDeviceClass 1 0x00 Class Code
658 * 5 bDeviceSubClass 1 0x00 SubClass Code
659 * 6 bDeviceProtocol 1 0x00 Protocol Code
660 * 7 bMaxPacketSize0 1 0x08 Maximum packet size for endpoint 0
661 * 8 idVendor 2 0x0403 Vendor ID
662 * 10 idProduct 2 0x8372 Product ID (FTDI_SIO_PID)
663 * 12 bcdDevice 2 0x0001 Device release number
664 * 14 iManufacturer 1 0x01 Index of man. string desc
665 * 15 iProduct 1 0x02 Index of prod string desc
666 * 16 iSerialNumber 1 0x02 Index of serial nmr string desc
667 * 17 bNumConfigurations 1 0x01 Number of possible configurations
668 *
669 * Configuration Descriptor
670 *
671 * Offset Field Size Value
672 * 0 bLength 1 0x09 Size of descriptor in bytes
673 * 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type
674 * 2 wTotalLength 2 0x0020 Total length of data
675 * 4 bNumInterfaces 1 0x01 Number of interfaces supported
676 * 5 bConfigurationValue 1 0x01 Argument for SetCOnfiguration() req
677 * 6 iConfiguration 1 0x02 Index of config string descriptor
678 * 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup
679 * 8 MaxPower 1 0x1E Max power consumption
680 *
681 * Interface Descriptor
682 *
683 * Offset Field Size Value
684 * 0 bLength 1 0x09 Size of descriptor in bytes
685 * 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type
686 * 2 bInterfaceNumber 1 0x00 Number of interface
687 * 3 bAlternateSetting 1 0x00 Value used to select alternate
688 * 4 bNumEndpoints 1 0x02 Number of endpoints
689 * 5 bInterfaceClass 1 0xFF Class Code
690 * 6 bInterfaceSubClass 1 0xFF Subclass Code
691 * 7 bInterfaceProtocol 1 0xFF Protocol Code
692 * 8 iInterface 1 0x02 Index of interface string description
693 *
694 * IN Endpoint Descriptor
695 *
696 * Offset Field Size Value
697 * 0 bLength 1 0x07 Size of descriptor in bytes
698 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
699 * 2 bEndpointAddress 1 0x82 Address of endpoint
700 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
701 * 4 bNumEndpoints 2 0x0040 maximum packet size
702 * 5 bInterval 1 0x00 Interval for polling endpoint
703 *
704 * OUT Endpoint Descriptor
705 *
706 * Offset Field Size Value
707 * 0 bLength 1 0x07 Size of descriptor in bytes
708 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
709 * 2 bEndpointAddress 1 0x02 Address of endpoint
710 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
711 * 4 bNumEndpoints 2 0x0040 maximum packet size
712 * 5 bInterval 1 0x00 Interval for polling endpoint
713 *
714 * DATA FORMAT
715 *
716 * IN Endpoint
717 *
718 * The device reserves the first two bytes of data on this endpoint to contain the current
719 * values of the modem and line status registers. In the absence of data, the device
720 * generates a message consisting of these two status bytes every 40 ms
721 *
722 * Byte 0: Modem Status
723 *
724 * Offset Description
725 * B0 Reserved - must be 1
726 * B1 Reserved - must be 0
727 * B2 Reserved - must be 0
728 * B3 Reserved - must be 0
729 * B4 Clear to Send (CTS)
730 * B5 Data Set Ready (DSR)
731 * B6 Ring Indicator (RI)
732 * B7 Receive Line Signal Detect (RLSD)
733 *
734 * Byte 1: Line Status
735 *
736 * Offset Description
737 * B0 Data Ready (DR)
738 * B1 Overrun Error (OE)
739 * B2 Parity Error (PE)
740 * B3 Framing Error (FE)
741 * B4 Break Interrupt (BI)
742 * B5 Transmitter Holding Register (THRE)
743 * B6 Transmitter Empty (TEMT)
744 * B7 Error in RCVR FIFO
745 *
746 */
747 #define FTDI_RS0_CTS (1 << 4)
748 #define FTDI_RS0_DSR (1 << 5)
749 #define FTDI_RS0_RI (1 << 6)
750 #define FTDI_RS0_RLSD (1 << 7)
751
752 #define FTDI_RS_DR 1
753 #define FTDI_RS_OE (1<<1)
754 #define FTDI_RS_PE (1<<2)
755 #define FTDI_RS_FE (1<<3)
756 #define FTDI_RS_BI (1<<4)
757 #define FTDI_RS_THRE (1<<5)
758 #define FTDI_RS_TEMT (1<<6)
759 #define FTDI_RS_FIFO (1<<7)
760
761 /*
762 * OUT Endpoint
763 *
764 * This device reserves the first bytes of data on this endpoint contain the length
765 * and port identifier of the message. For the FTDI USB Serial converter the port
766 * identifier is always 1.
767 *
768 * Byte 0: Line Status
769 *
770 * Offset Description
771 * B0 Reserved - must be 1
772 * B1 Reserved - must be 0
773 * B2..7 Length of message - (not including Byte 0)
774 *
775 */
776
777
|
This page was automatically generated by the
LXR engine.
|