ftdi_sio.h 33 KB

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