usb/serial/ftdi_sio.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * Driver definitions for the FTDI USB Single Port Serial Converter -
9  * The example I have is known as the USC-1000 which is available from
10  * http://www.dse.co.nz - cat no XH4214 It looks similar to this:
12  * USC-1000s which don't look like my device though so beware!
21  * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the
107  * wValue:         BaudDivisor value - see below
112  * - BaseClock is either 12000000 or 48000000 depending on the device.
114  * - BaudDivisor is a fixed point number encoded in a funny way.
115  *   (--WRONG WAY OF THINKING--)
117  *   (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
119  *   (--THE REALITY--)
120  *   The both-bits-set has quite different meaning from 0.75 - the chip
124  * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
125  *   automagically re-encode the resulting value to take fractions into
138  *   000 - add .000 to divisor
139  *   001 - add .500 to divisor
140  *   010 - add .250 to divisor
141  *   011 - add .125 to divisor
142  *   100 - add .375 to divisor
143  *   101 - add .625 to divisor
144  *   110 - add .750 to divisor
145  *   111 - add .875 to divisor
146  * Bits 15 to 0 of the 17-bit divisor are placed in the urb value.  Bit 16 is
200  *           2 = Even
230  * Also - you can not set DTR and RTS with one control message
269  *   wIndex:         Protocol/Port - hIndex is protocol / lIndex is port
284  * A value of zero in the hIndex field disables handshaking
286  * If Xon/Xoff handshaking is specified, the hValue field should contain the
287  * XOFF character and the lValue field contains the XON character.
344  * data read so far - rather than wait 40ms or until 62 bytes are read
415  *         1 = active
418  *         1 = active
421  *         1 = active
424  *         1 = active
442  * EEPROM format found in FTDI AN_201, "FT-X MTP memory Configuration",
443  * http://www.ftdichip.com/Support/Documents/AppNotes/AN_201_FT-X%20MTP%20Memory%20Configuration.pdf
456  * Offset	Field		Size	Value	Description
474  * Offset	Field			Size	Value
486  * Offset	Field			Size	Value
499  * Offset	Field			Size	Value
503  * 3	bmAttributes		1	0x02	Endpoint attributes - Bulk
509  * Offset	Field			Size	Value
513  * 3	bmAttributes		1	0x02	Endpoint attributes - Bulk
529  * B0	Reserved - must be 1
530  * B1	Reserved - must be 0
531  * B2	Reserved - must be 0
532  * B3	Reserved - must be 0
575  * B0	Reserved - must be 1
576  * B1	Reserved - must be 0
577  * B2..7	Length of message - (not including Byte 0)