MOXA linux-2.6.x / linux-2.6.19-uc1 from UC-7110-LX-BOOTLOADER-1.9_VERSION-4.2.tgz
[linux-2.6.19-moxart.git] / drivers / usb / serial / ftdi_sio.h
blobbae117d359af1ba1d38f8e62471111828e11a104
1 /*
2 * Definitions for the FTDI USB Single Port Serial Converter -
3 * known as FTDI_SIO (Serial Input/Output application of the chipset)
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!
10 * The device is based on the FTDI FT8U100AX chip. It has a DB25 on one side,
11 * USB on the other.
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.
17 * Bill Ryder - bryder@sgi.com formerly of Silicon Graphics, Inc.- wrote the
18 * FTDI_SIO implementation.
20 * Philipp Gühring - pg@futureware.at - added the Device ID of the USB relais
21 * from Rudolf Gugler
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 */
35 /* www.canusb.com Lawicel CANUSB device */
36 #define FTDI_CANUSB_PID 0xFFA8 /* Product Id */
38 /* AlphaMicro Components AMC-232USB01 device */
39 #define FTDI_AMC232_PID 0xFF00 /* Product Id */
41 /* ACT Solutions HomePro ZWave interface (http://www.act-solutions.com/HomePro.htm) */
42 #define FTDI_ACTZWAVE_PID 0xF2D0
45 /* www.starting-point-systems.com µChameleon device */
46 #define FTDI_MICRO_CHAMELEON_PID 0xCAA0 /* Product Id */
48 /* www.irtrans.de device */
49 #define FTDI_IRTRANS_PID 0xFC60 /* Product Id */
52 /* www.thoughttechnology.com/ TT-USB provide with procomp use ftdi_sio */
53 #define FTDI_TTUSB_PID 0xFF20 /* Product Id */
55 /* iPlus device */
56 #define FTDI_IPLUS_PID 0xD070 /* Product Id */
58 /* DMX4ALL DMX Interfaces */
59 #define FTDI_DMX4ALL 0xC850
61 /* www.crystalfontz.com devices - thanx for providing free devices for evaluation ! */
62 /* they use the ftdi chipset for the USB interface and the vendor id is the same */
63 #define FTDI_XF_632_PID 0xFC08 /* 632: 16x2 Character Display */
64 #define FTDI_XF_634_PID 0xFC09 /* 634: 20x4 Character Display */
65 #define FTDI_XF_547_PID 0xFC0A /* 547: Two line Display */
66 #define FTDI_XF_633_PID 0xFC0B /* 633: 16x2 Character Display with Keys */
67 #define FTDI_XF_631_PID 0xFC0C /* 631: 20x2 Character Display */
68 #define FTDI_XF_635_PID 0xFC0D /* 635: 20x4 Character Display */
69 #define FTDI_XF_640_PID 0xFC0E /* 640: Two line Display */
70 #define FTDI_XF_642_PID 0xFC0F /* 642: Two line Display */
72 /* Video Networks Limited / Homechoice in the UK use an ftdi-based device for their 1Mb */
73 /* broadband internet service. The following PID is exhibited by the usb device supplied */
74 /* (the VID is the standard ftdi vid (FTDI_VID) */
75 #define FTDI_VNHCPCUSB_D_PID 0xfe38 /* Product Id */
78 * PCDJ use ftdi based dj-controllers. The following PID is for their DAC-2 device
79 * http://www.pcdjhardware.com/DAC2.asp (PID sent by Wouter Paesen)
80 * (the VID is the standard ftdi vid (FTDI_VID) */
81 #define FTDI_PCDJ_DAC2_PID 0xFA88
84 * The following are the values for the Matrix Orbital LCD displays,
85 * which are the FT232BM ( similar to the 8U232AM )
87 #define FTDI_MTXORB_0_PID 0xFA00 /* Matrix Orbital Product Id */
88 #define FTDI_MTXORB_1_PID 0xFA01 /* Matrix Orbital Product Id */
89 #define FTDI_MTXORB_2_PID 0xFA02 /* Matrix Orbital Product Id */
90 #define FTDI_MTXORB_3_PID 0xFA03 /* Matrix Orbital Product Id */
91 #define FTDI_MTXORB_4_PID 0xFA04 /* Matrix Orbital Product Id */
92 #define FTDI_MTXORB_5_PID 0xFA05 /* Matrix Orbital Product Id */
93 #define FTDI_MTXORB_6_PID 0xFA06 /* Matrix Orbital Product Id */
95 /* Interbiometrics USB I/O Board */
96 /* Developed for Interbiometrics by Rudolf Gugler */
97 #define INTERBIOMETRICS_VID 0x1209
98 #define INTERBIOMETRICS_IOBOARD_PID 0x1002
99 #define INTERBIOMETRICS_MINI_IOBOARD_PID 0x1006
102 * The following are the values for the Perle Systems
103 * UltraPort USB serial converters
105 #define FTDI_PERLE_ULTRAPORT_PID 0xF0C0 /* Perle UltraPort Product Id */
108 * The following are the values for the Sealevel SeaLINK+ adapters.
109 * (Original list sent by Tuan Hoang. Ian Abbott renamed the macros and
110 * removed some PIDs that don't seem to match any existing products.)
112 #define SEALEVEL_VID 0x0c52 /* Sealevel Vendor ID */
113 #define SEALEVEL_2101_PID 0x2101 /* SeaLINK+232 (2101/2105) */
114 #define SEALEVEL_2102_PID 0x2102 /* SeaLINK+485 (2102) */
115 #define SEALEVEL_2103_PID 0x2103 /* SeaLINK+232I (2103) */
116 #define SEALEVEL_2104_PID 0x2104 /* SeaLINK+485I (2104) */
117 #define SEALEVEL_2106_PID 0x9020 /* SeaLINK+422 (2106) */
118 #define SEALEVEL_2201_1_PID 0x2211 /* SeaPORT+2/232 (2201) Port 1 */
119 #define SEALEVEL_2201_2_PID 0x2221 /* SeaPORT+2/232 (2201) Port 2 */
120 #define SEALEVEL_2202_1_PID 0x2212 /* SeaPORT+2/485 (2202) Port 1 */
121 #define SEALEVEL_2202_2_PID 0x2222 /* SeaPORT+2/485 (2202) Port 2 */
122 #define SEALEVEL_2203_1_PID 0x2213 /* SeaPORT+2 (2203) Port 1 */
123 #define SEALEVEL_2203_2_PID 0x2223 /* SeaPORT+2 (2203) Port 2 */
124 #define SEALEVEL_2401_1_PID 0x2411 /* SeaPORT+4/232 (2401) Port 1 */
125 #define SEALEVEL_2401_2_PID 0x2421 /* SeaPORT+4/232 (2401) Port 2 */
126 #define SEALEVEL_2401_3_PID 0x2431 /* SeaPORT+4/232 (2401) Port 3 */
127 #define SEALEVEL_2401_4_PID 0x2441 /* SeaPORT+4/232 (2401) Port 4 */
128 #define SEALEVEL_2402_1_PID 0x2412 /* SeaPORT+4/485 (2402) Port 1 */
129 #define SEALEVEL_2402_2_PID 0x2422 /* SeaPORT+4/485 (2402) Port 2 */
130 #define SEALEVEL_2402_3_PID 0x2432 /* SeaPORT+4/485 (2402) Port 3 */
131 #define SEALEVEL_2402_4_PID 0x2442 /* SeaPORT+4/485 (2402) Port 4 */
132 #define SEALEVEL_2403_1_PID 0x2413 /* SeaPORT+4 (2403) Port 1 */
133 #define SEALEVEL_2403_2_PID 0x2423 /* SeaPORT+4 (2403) Port 2 */
134 #define SEALEVEL_2403_3_PID 0x2433 /* SeaPORT+4 (2403) Port 3 */
135 #define SEALEVEL_2403_4_PID 0x2443 /* SeaPORT+4 (2403) Port 4 */
136 #define SEALEVEL_2801_1_PID 0X2811 /* SeaLINK+8/232 (2801) Port 1 */
137 #define SEALEVEL_2801_2_PID 0X2821 /* SeaLINK+8/232 (2801) Port 2 */
138 #define SEALEVEL_2801_3_PID 0X2831 /* SeaLINK+8/232 (2801) Port 3 */
139 #define SEALEVEL_2801_4_PID 0X2841 /* SeaLINK+8/232 (2801) Port 4 */
140 #define SEALEVEL_2801_5_PID 0X2851 /* SeaLINK+8/232 (2801) Port 5 */
141 #define SEALEVEL_2801_6_PID 0X2861 /* SeaLINK+8/232 (2801) Port 6 */
142 #define SEALEVEL_2801_7_PID 0X2871 /* SeaLINK+8/232 (2801) Port 7 */
143 #define SEALEVEL_2801_8_PID 0X2881 /* SeaLINK+8/232 (2801) Port 8 */
144 #define SEALEVEL_2802_1_PID 0X2812 /* SeaLINK+8/485 (2802) Port 1 */
145 #define SEALEVEL_2802_2_PID 0X2822 /* SeaLINK+8/485 (2802) Port 2 */
146 #define SEALEVEL_2802_3_PID 0X2832 /* SeaLINK+8/485 (2802) Port 3 */
147 #define SEALEVEL_2802_4_PID 0X2842 /* SeaLINK+8/485 (2802) Port 4 */
148 #define SEALEVEL_2802_5_PID 0X2852 /* SeaLINK+8/485 (2802) Port 5 */
149 #define SEALEVEL_2802_6_PID 0X2862 /* SeaLINK+8/485 (2802) Port 6 */
150 #define SEALEVEL_2802_7_PID 0X2872 /* SeaLINK+8/485 (2802) Port 7 */
151 #define SEALEVEL_2802_8_PID 0X2882 /* SeaLINK+8/485 (2802) Port 8 */
152 #define SEALEVEL_2803_1_PID 0X2813 /* SeaLINK+8 (2803) Port 1 */
153 #define SEALEVEL_2803_2_PID 0X2823 /* SeaLINK+8 (2803) Port 2 */
154 #define SEALEVEL_2803_3_PID 0X2833 /* SeaLINK+8 (2803) Port 3 */
155 #define SEALEVEL_2803_4_PID 0X2843 /* SeaLINK+8 (2803) Port 4 */
156 #define SEALEVEL_2803_5_PID 0X2853 /* SeaLINK+8 (2803) Port 5 */
157 #define SEALEVEL_2803_6_PID 0X2863 /* SeaLINK+8 (2803) Port 6 */
158 #define SEALEVEL_2803_7_PID 0X2873 /* SeaLINK+8 (2803) Port 7 */
159 #define SEALEVEL_2803_8_PID 0X2883 /* SeaLINK+8 (2803) Port 8 */
162 * The following are the values for two KOBIL chipcard terminals.
164 #define KOBIL_VID 0x0d46 /* KOBIL Vendor ID */
165 #define KOBIL_CONV_B1_PID 0x2020 /* KOBIL Konverter for B1 */
166 #define KOBIL_CONV_KAAN_PID 0x2021 /* KOBIL_Konverter for KAAN */
169 * Icom ID-1 digital transceiver
172 #define ICOM_ID1_VID 0x0C26
173 #define ICOM_ID1_PID 0x0004
176 * ASK.fr devices
178 #define FTDI_ASK_RDR400_PID 0xC991 /* ASK RDR 400 series card reader */
181 * FTDI USB UART chips used in construction projects from the
182 * Elektor Electronics magazine (http://elektor-electronics.co.uk)
184 #define ELEKTOR_VID 0x0C7D
185 #define ELEKTOR_FT323R_PID 0x0005 /* RFID-Reader, issue 09-2006 */
188 * DSS-20 Sync Station for Sony Ericsson P800
190 #define FTDI_DSS20_PID 0xFC82
193 * Home Electronics (www.home-electro.com) USB gadgets
195 #define FTDI_HE_TIRA1_PID 0xFA78 /* Tira-1 IR transceiver */
197 /* USB-UIRT - An infrared receiver and transmitter using the 8U232AM chip */
198 /* http://home.earthlink.net/~jrhees/USBUIRT/index.htm */
199 #define FTDI_USB_UIRT_PID 0xF850 /* Product Id */
201 /* TNC-X USB-to-packet-radio adapter, versions prior to 3.0 (DLP module) */
203 #define FTDI_TNC_X_PID 0xEBE0
206 * ELV USB devices submitted by Christian Abt of ELV (www.elv.de).
207 * All of these devices use FTDI's vendor ID (0x0403).
209 * The previously included PID for the UO 100 module was incorrect.
210 * In fact, that PID was for ELV's UR 100 USB-RS232 converter (0xFB58).
212 * Armin Laeuger originally sent the PID for the UM 100 module.
214 #define FTDI_ELV_UR100_PID 0xFB58 /* USB-RS232-Umsetzer (UR 100) */
215 #define FTDI_ELV_UM100_PID 0xFB5A /* USB-Modul UM 100 */
216 #define FTDI_ELV_UO100_PID 0xFB5B /* USB-Modul UO 100 */
217 #define FTDI_ELV_ALC8500_PID 0xF06E /* ALC 8500 Expert */
218 /* Additional ELV PIDs that default to using the FTDI D2XX drivers on
219 * MS Windows, rather than the FTDI Virtual Com Port drivers.
220 * Maybe these will be easier to use with the libftdi/libusb user-space
221 * drivers, or possibly the Comedi drivers in some cases. */
222 #define FTDI_ELV_CLI7000_PID 0xFB59 /* Computer-Light-Interface (CLI 7000) */
223 #define FTDI_ELV_PPS7330_PID 0xFB5C /* Processor-Power-Supply (PPS 7330) */
224 #define FTDI_ELV_TFM100_PID 0xFB5D /* Temperartur-Feuchte Messgeraet (TFM 100) */
225 #define FTDI_ELV_UDF77_PID 0xFB5E /* USB DCF Funkurh (UDF 77) */
226 #define FTDI_ELV_UIO88_PID 0xFB5F /* USB-I/O Interface (UIO 88) */
227 #define FTDI_ELV_UAD8_PID 0xF068 /* USB-AD-Wandler (UAD 8) */
228 #define FTDI_ELV_UDA7_PID 0xF069 /* USB-DA-Wandler (UDA 7) */
229 #define FTDI_ELV_USI2_PID 0xF06A /* USB-Schrittmotoren-Interface (USI 2) */
230 #define FTDI_ELV_T1100_PID 0xF06B /* Thermometer (T 1100) */
231 #define FTDI_ELV_PCD200_PID 0xF06C /* PC-Datenlogger (PCD 200) */
232 #define FTDI_ELV_ULA200_PID 0xF06D /* USB-LCD-Ansteuerung (ULA 200) */
233 #define FTDI_ELV_FHZ1000PC_PID 0xF06F /* FHZ 1000 PC */
234 #define FTDI_ELV_CSI8_PID 0xE0F0 /* Computer-Schalt-Interface (CSI 8) */
235 #define FTDI_ELV_EM1000DL_PID 0xE0F1 /* PC-Datenlogger fuer Energiemonitor (EM 1000 DL) */
236 #define FTDI_ELV_PCK100_PID 0xE0F2 /* PC-Kabeltester (PCK 100) */
237 #define FTDI_ELV_RFP500_PID 0xE0F3 /* HF-Leistungsmesser (RFP 500) */
238 #define FTDI_ELV_FS20SIG_PID 0xE0F4 /* Signalgeber (FS 20 SIG) */
239 #define FTDI_ELV_WS300PC_PID 0xE0F6 /* PC-Wetterstation (WS 300 PC) */
240 #define FTDI_ELV_FHZ1300PC_PID 0xE0E8 /* FHZ 1300 PC */
241 #define FTDI_ELV_WS500_PID 0xE0E9 /* PC-Wetterstation (WS 500) */
244 * Definitions for ID TECH (www.idt-net.com) devices
246 #define IDTECH_VID 0x0ACD /* ID TECH Vendor ID */
247 #define IDTECH_IDT1221U_PID 0x0300 /* IDT1221U USB to RS-232 adapter */
250 * Definitions for Omnidirectional Control Technology, Inc. devices
252 #define OCT_VID 0x0B39 /* OCT vendor ID */
253 /* Note: OCT US101 is also rebadged as Dick Smith Electronics (NZ) XH6381 */
254 /* Also rebadged as Dick Smith Electronics (Aus) XH6451 */
255 /* Also rebadged as SIIG Inc. model US2308 hardware version 1 */
256 #define OCT_US101_PID 0x0421 /* OCT US101 USB to RS-232 */
258 /* an infrared receiver for user access control with IR tags */
259 #define FTDI_PIEGROUP_PID 0xF208 /* Product Id */
262 * Definitions for Artemis astronomical USB based cameras
263 * Check it at http://www.artemisccd.co.uk/
265 #define FTDI_ARTEMIS_PID 0xDF28 /* All Artemis Cameras */
268 * Definitions for ATIK Instruments astronomical USB based cameras
269 * Check it at http://www.atik-instruments.com/
271 #define FTDI_ATIK_ATK16_PID 0xDF30 /* ATIK ATK-16 Grayscale Camera */
272 #define FTDI_ATIK_ATK16C_PID 0xDF32 /* ATIK ATK-16C Colour Camera */
273 #define FTDI_ATIK_ATK16HR_PID 0xDF31 /* ATIK ATK-16HR Grayscale Camera */
274 #define FTDI_ATIK_ATK16HRC_PID 0xDF33 /* ATIK ATK-16HRC Colour Camera */
277 * Protego product ids
279 #define PROTEGO_SPECIAL_1 0xFC70 /* special/unknown device */
280 #define PROTEGO_R2X0 0xFC71 /* R200-USB TRNG unit (R210, R220, and R230) */
281 #define PROTEGO_SPECIAL_3 0xFC72 /* special/unknown device */
282 #define PROTEGO_SPECIAL_4 0xFC73 /* special/unknown device */
285 * Gude Analog- und Digitalsysteme GmbH
287 #define FTDI_GUDEADS_E808_PID 0xE808
288 #define FTDI_GUDEADS_E809_PID 0xE809
289 #define FTDI_GUDEADS_E80A_PID 0xE80A
290 #define FTDI_GUDEADS_E80B_PID 0xE80B
291 #define FTDI_GUDEADS_E80C_PID 0xE80C
292 #define FTDI_GUDEADS_E80D_PID 0xE80D
293 #define FTDI_GUDEADS_E80E_PID 0xE80E
294 #define FTDI_GUDEADS_E80F_PID 0xE80F
295 #define FTDI_GUDEADS_E888_PID 0xE888 /* Expert ISDN Control USB */
296 #define FTDI_GUDEADS_E889_PID 0xE889 /* USB RS-232 OptoBridge */
297 #define FTDI_GUDEADS_E88A_PID 0xE88A
298 #define FTDI_GUDEADS_E88B_PID 0xE88B
299 #define FTDI_GUDEADS_E88C_PID 0xE88C
300 #define FTDI_GUDEADS_E88D_PID 0xE88D
301 #define FTDI_GUDEADS_E88E_PID 0xE88E
302 #define FTDI_GUDEADS_E88F_PID 0xE88F
305 * Linx Technologies product ids
307 #define LINX_SDMUSBQSS_PID 0xF448 /* Linx SDM-USB-QS-S */
308 #define LINX_MASTERDEVEL2_PID 0xF449 /* Linx Master Development 2.0 */
309 #define LINX_FUTURE_0_PID 0xF44A /* Linx future device */
310 #define LINX_FUTURE_1_PID 0xF44B /* Linx future device */
311 #define LINX_FUTURE_2_PID 0xF44C /* Linx future device */
313 /* CCS Inc. ICDU/ICDU40 product ID - the FT232BM is used in an in-circuit-debugger */
314 /* unit for PIC16's/PIC18's */
315 #define FTDI_CCSICDU20_0_PID 0xF9D0
316 #define FTDI_CCSICDU40_1_PID 0xF9D1
318 /* Inside Accesso contactless reader (http://www.insidefr.com) */
319 #define INSIDE_ACCESSO 0xFAD0
322 * Intrepid Control Systems (http://www.intrepidcs.com/) ValueCAN and NeoVI
324 #define INTREPID_VID 0x093C
325 #define INTREPID_VALUECAN_PID 0x0601
326 #define INTREPID_NEOVI_PID 0x0701
329 * Falcom Wireless Communications GmbH
331 #define FALCOM_VID 0x0F94 /* Vendor Id */
332 #define FALCOM_TWIST_PID 0x0001 /* Falcom Twist USB GPRS modem */
333 #define FALCOM_SAMBA_PID 0x0005 /* Falcom Samba USB GPRS modem */
336 * SUUNTO product ids
338 #define FTDI_SUUNTO_SPORTS_PID 0xF680 /* Suunto Sports instrument */
341 * Definitions for B&B Electronics products.
343 #define BANDB_VID 0x0856 /* B&B Electronics Vendor ID */
344 #define BANDB_USOTL4_PID 0xAC01 /* USOTL4 Isolated RS-485 Converter */
345 #define BANDB_USTL4_PID 0xAC02 /* USTL4 RS-485 Converter */
346 #define BANDB_USO9ML2_PID 0xAC03 /* USO9ML2 Isolated RS-232 Converter */
349 * RM Michaelides CANview USB (http://www.rmcan.com)
350 * CAN fieldbus interface adapter, added by port GmbH www.port.de)
351 * Ian Abbott changed the macro names for consistency.
353 #define FTDI_RM_CANVIEW_PID 0xfd60 /* Product Id */
356 * EVER Eco Pro UPS (http://www.ever.com.pl/)
359 #define EVER_ECO_PRO_CDS 0xe520 /* RS-232 converter */
362 * 4N-GALAXY.DE PIDs for CAN-USB, USB-RS232, USB-RS422, USB-RS485,
363 * USB-TTY activ, USB-TTY passiv. Some PIDs are used by several devices
364 * and I'm not entirely sure which are used by which.
366 #define FTDI_4N_GALAXY_DE_0_PID 0x8372
367 #define FTDI_4N_GALAXY_DE_1_PID 0xF3C0
368 #define FTDI_4N_GALAXY_DE_2_PID 0xF3C1
371 * Mobility Electronics products.
373 #define MOBILITY_VID 0x1342
374 #define MOBILITY_USB_SERIAL_PID 0x0202 /* EasiDock USB 200 serial */
377 * microHAM product IDs (http://www.microham.com).
378 * Submitted by Justin Burket (KL1RL) <zorton@jtan.com>
379 * and Mike Studer (K6EEP) <k6eep@hamsoftware.org>.
380 * Ian Abbott <abbotti@mev.co.uk> added a few more from the driver INF file.
382 #define FTDI_MHAM_KW_PID 0xEEE8 /* USB-KW interface */
383 #define FTDI_MHAM_YS_PID 0xEEE9 /* USB-YS interface */
384 #define FTDI_MHAM_Y6_PID 0xEEEA /* USB-Y6 interface */
385 #define FTDI_MHAM_Y8_PID 0xEEEB /* USB-Y8 interface */
386 #define FTDI_MHAM_IC_PID 0xEEEC /* USB-IC interface */
387 #define FTDI_MHAM_DB9_PID 0xEEED /* USB-DB9 interface */
388 #define FTDI_MHAM_RS232_PID 0xEEEE /* USB-RS232 interface */
389 #define FTDI_MHAM_Y9_PID 0xEEEF /* USB-Y9 interface */
392 * Active Robots product ids.
394 #define FTDI_ACTIVE_ROBOTS_PID 0xE548 /* USB comms board */
397 * Xsens Technologies BV products (http://www.xsens.com).
399 #define XSENS_CONVERTER_0_PID 0xD388
400 #define XSENS_CONVERTER_1_PID 0xD389
401 #define XSENS_CONVERTER_2_PID 0xD38A
402 #define XSENS_CONVERTER_3_PID 0xD38B
403 #define XSENS_CONVERTER_4_PID 0xD38C
404 #define XSENS_CONVERTER_5_PID 0xD38D
405 #define XSENS_CONVERTER_6_PID 0xD38E
406 #define XSENS_CONVERTER_7_PID 0xD38F
409 * Teratronik product ids.
410 * Submitted by O. Wölfelschneider.
412 #define FTDI_TERATRONIK_VCP_PID 0xEC88 /* Teratronik device (preferring VCP driver on windows) */
413 #define FTDI_TERATRONIK_D2XX_PID 0xEC89 /* Teratronik device (preferring D2XX driver on windows) */
416 * Evolution Robotics products (http://www.evolution.com/).
417 * Submitted by Shawn M. Lavelle.
419 #define EVOLUTION_VID 0xDEEE /* Vendor ID */
420 #define EVOLUTION_ER1_PID 0x0300 /* ER1 Control Module */
422 /* Pyramid Computer GmbH */
423 #define FTDI_PYRAMID_PID 0xE6C8 /* Pyramid Appliance Display */
426 * Posiflex inc retail equipment (http://www.posiflex.com.tw)
428 #define POSIFLEX_VID 0x0d3a /* Vendor ID */
429 #define POSIFLEX_PP7000_PID 0x0300 /* PP-7000II thermal printer */
432 * Westrex International devices submitted by Cory Lee
434 #define FTDI_WESTREX_MODEL_777_PID 0xDC00 /* Model 777 */
435 #define FTDI_WESTREX_MODEL_8900F_PID 0xDC01 /* Model 8900F */
438 * RR-CirKits LocoBuffer USB (http://www.rr-cirkits.com)
440 #define FTDI_RRCIRKITS_LOCOBUFFER_PID 0xc7d0 /* LocoBuffer USB */
443 * Eclo (http://www.eclo.pt/) product IDs.
444 * PID 0xEA90 submitted by Martin Grill.
446 #define FTDI_ECLO_COM_1WIRE_PID 0xEA90 /* COM to 1-Wire USB adaptor */
449 * Papouch products (http://www.papouch.com/)
450 * Submitted by Folkert van Heusden
453 #define PAPOUCH_VID 0x5050 /* Vendor ID */
454 #define PAPOUCH_TMU_PID 0x0400 /* TMU USB Thermometer */
457 * ACG Identification Technologies GmbH products (http://www.acg.de/).
458 * Submitted by anton -at- goto10 -dot- org.
460 #define FTDI_ACG_HFDUAL_PID 0xDD20 /* HF Dual ISO Reader (RFID) */
463 * Yost Engineering, Inc. products (www.yostengineering.com).
464 * PID 0xE050 submitted by Aaron Prose.
466 #define FTDI_YEI_SERVOCENTER31_PID 0xE050 /* YEI ServoCenter3.1 USB */
469 * ThorLabs USB motor drivers
471 #define FTDI_THORLABS_PID 0xfaf0 /* ThorLabs USB motor drivers */
474 * Testo products (http://www.testo.com/)
475 * Submitted by Colin Leroy
477 #define TESTO_VID 0x128D
478 #define TESTO_USB_INTERFACE_PID 0x0001
481 * Gamma Scout (http://gamma-scout.com/). Submitted by rsc@runtux.com.
483 #define FTDI_GAMMA_SCOUT_PID 0xD678 /* Gamma Scout online */
486 * Tactrix OpenPort (ECU) devices.
487 * OpenPort 1.3M submitted by Donour Sizemore.
488 * OpenPort 1.3S and 1.3U submitted by Ian Abbott.
490 #define FTDI_TACTRIX_OPENPORT_13M_PID 0xCC48 /* OpenPort 1.3 Mitsubishi */
491 #define FTDI_TACTRIX_OPENPORT_13S_PID 0xCC49 /* OpenPort 1.3 Subaru */
492 #define FTDI_TACTRIX_OPENPORT_13U_PID 0xCC4A /* OpenPort 1.3 Universal */
494 /* Commands */
495 #define FTDI_SIO_RESET 0 /* Reset the port */
496 #define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */
497 #define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */
498 #define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */
499 #define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of the port */
500 #define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modern status register */
501 #define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
502 #define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
503 #define FTDI_SIO_SET_LATENCY_TIMER 9 /* Set the latency timer */
504 #define FTDI_SIO_GET_LATENCY_TIMER 10 /* Get the latency timer */
508 * BmRequestType: 1100 0000b
509 * bRequest: FTDI_E2_READ
510 * wValue: 0
511 * wIndex: Address of word to read
512 * wLength: 2
513 * Data: Will return a word of data from E2Address
517 /* Port Identifier Table */
518 #define PIT_DEFAULT 0 /* SIOA */
519 #define PIT_SIOA 1 /* SIOA */
520 /* The device this driver is tested with one has only one port */
521 #define PIT_SIOB 2 /* SIOB */
522 #define PIT_PARALLEL 3 /* Parallel */
524 /* FTDI_SIO_RESET */
525 #define FTDI_SIO_RESET_REQUEST FTDI_SIO_RESET
526 #define FTDI_SIO_RESET_REQUEST_TYPE 0x40
527 #define FTDI_SIO_RESET_SIO 0
528 #define FTDI_SIO_RESET_PURGE_RX 1
529 #define FTDI_SIO_RESET_PURGE_TX 2
532 * BmRequestType: 0100 0000B
533 * bRequest: FTDI_SIO_RESET
534 * wValue: Control Value
535 * 0 = Reset SIO
536 * 1 = Purge RX buffer
537 * 2 = Purge TX buffer
538 * wIndex: Port
539 * wLength: 0
540 * Data: None
542 * The Reset SIO command has this effect:
544 * Sets flow control set to 'none'
545 * Event char = $0D
546 * Event trigger = disabled
547 * Purge RX buffer
548 * Purge TX buffer
549 * Clear DTR
550 * Clear RTS
551 * baud and data format not reset
553 * The Purge RX and TX buffer commands affect nothing except the buffers
557 /* FTDI_SIO_SET_BAUDRATE */
558 #define FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
559 #define FTDI_SIO_SET_BAUDRATE_REQUEST 3
562 * BmRequestType: 0100 0000B
563 * bRequest: FTDI_SIO_SET_BAUDRATE
564 * wValue: BaudDivisor value - see below
565 * wIndex: Port
566 * wLength: 0
567 * Data: None
568 * The BaudDivisor values are calculated as follows:
569 * - BaseClock is either 12000000 or 48000000 depending on the device. FIXME: I wish
570 * I knew how to detect old chips to select proper base clock!
571 * - BaudDivisor is a fixed point number encoded in a funny way.
572 * (--WRONG WAY OF THINKING--)
573 * BaudDivisor is a fixed point number encoded with following bit weighs:
574 * (-2)(-1)(13..0). It is a radical with a denominator of 4, so values
575 * end with 0.0 (00...), 0.25 (10...), 0.5 (01...), and 0.75 (11...).
576 * (--THE REALITY--)
577 * The both-bits-set has quite different meaning from 0.75 - the chip designers
578 * have decided it to mean 0.125 instead of 0.75.
579 * This info looked up in FTDI application note "FT8U232 DEVICES \ Data Rates
580 * and Flow Control Consideration for USB to RS232".
581 * - BaudDivisor = (BaseClock / 16) / BaudRate, where the (=) operation should
582 * automagically re-encode the resulting value to take fractions into consideration.
583 * As all values are integers, some bit twiddling is in order:
584 * BaudDivisor = (BaseClock / 16 / BaudRate) |
585 * (((BaseClock / 2 / BaudRate) & 4) ? 0x4000 // 0.5
586 * : ((BaseClock / 2 / BaudRate) & 2) ? 0x8000 // 0.25
587 * : ((BaseClock / 2 / BaudRate) & 1) ? 0xc000 // 0.125
588 * : 0)
590 * For the FT232BM, a 17th divisor bit was introduced to encode the multiples
591 * of 0.125 missing from the FT8U232AM. Bits 16 to 14 are coded as follows
592 * (the first four codes are the same as for the FT8U232AM, where bit 16 is
593 * always 0):
594 * 000 - add .000 to divisor
595 * 001 - add .500 to divisor
596 * 010 - add .250 to divisor
597 * 011 - add .125 to divisor
598 * 100 - add .375 to divisor
599 * 101 - add .625 to divisor
600 * 110 - add .750 to divisor
601 * 111 - add .875 to divisor
602 * Bits 15 to 0 of the 17-bit divisor are placed in the urb value. Bit 16 is
603 * placed in bit 0 of the urb index.
605 * Note that there are a couple of special cases to support the highest baud
606 * rates. If the calculated divisor value is 1, this needs to be replaced with
607 * 0. Additionally for the FT232BM, if the calculated divisor value is 0x4001
608 * (1.5), this needs to be replaced with 0x0001 (1) (but this divisor value is
609 * not supported by the FT8U232AM).
612 typedef enum {
613 SIO = 1,
614 FT8U232AM = 2,
615 FT232BM = 3,
616 FT2232C = 4,
617 } ftdi_chip_type_t;
619 typedef enum {
620 ftdi_sio_b300 = 0,
621 ftdi_sio_b600 = 1,
622 ftdi_sio_b1200 = 2,
623 ftdi_sio_b2400 = 3,
624 ftdi_sio_b4800 = 4,
625 ftdi_sio_b9600 = 5,
626 ftdi_sio_b19200 = 6,
627 ftdi_sio_b38400 = 7,
628 ftdi_sio_b57600 = 8,
629 ftdi_sio_b115200 = 9
630 } FTDI_SIO_baudrate_t ;
633 * The ftdi_8U232AM_xxMHz_byyy constants have been removed. The encoded divisor values
634 * are calculated internally.
637 #define FTDI_SIO_SET_DATA_REQUEST FTDI_SIO_SET_DATA
638 #define FTDI_SIO_SET_DATA_REQUEST_TYPE 0x40
639 #define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
640 #define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
641 #define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
642 #define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
643 #define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
644 #define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11 )
645 #define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11 )
646 #define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11 )
647 #define FTDI_SIO_SET_BREAK (0x1 << 14)
648 /* FTDI_SIO_SET_DATA */
651 * BmRequestType: 0100 0000B
652 * bRequest: FTDI_SIO_SET_DATA
653 * wValue: Data characteristics (see below)
654 * wIndex: Port
655 * wLength: 0
656 * Data: No
658 * Data characteristics
660 * B0..7 Number of data bits
661 * B8..10 Parity
662 * 0 = None
663 * 1 = Odd
664 * 2 = Even
665 * 3 = Mark
666 * 4 = Space
667 * B11..13 Stop Bits
668 * 0 = 1
669 * 1 = 1.5
670 * 2 = 2
671 * B14
672 * 1 = TX ON (break)
673 * 0 = TX OFF (normal state)
674 * B15 Reserved
680 /* FTDI_SIO_MODEM_CTRL */
681 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
682 #define FTDI_SIO_SET_MODEM_CTRL_REQUEST FTDI_SIO_MODEM_CTRL
685 * BmRequestType: 0100 0000B
686 * bRequest: FTDI_SIO_MODEM_CTRL
687 * wValue: ControlValue (see below)
688 * wIndex: Port
689 * wLength: 0
690 * Data: None
692 * NOTE: If the device is in RTS/CTS flow control, the RTS set by this
693 * command will be IGNORED without an error being returned
694 * Also - you can not set DTR and RTS with one control message
697 #define FTDI_SIO_SET_DTR_MASK 0x1
698 #define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK << 8))
699 #define FTDI_SIO_SET_DTR_LOW ( 0 | ( FTDI_SIO_SET_DTR_MASK << 8))
700 #define FTDI_SIO_SET_RTS_MASK 0x2
701 #define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
702 #define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
705 * ControlValue
706 * B0 DTR state
707 * 0 = reset
708 * 1 = set
709 * B1 RTS state
710 * 0 = reset
711 * 1 = set
712 * B2..7 Reserved
713 * B8 DTR state enable
714 * 0 = ignore
715 * 1 = use DTR state
716 * B9 RTS state enable
717 * 0 = ignore
718 * 1 = use RTS state
719 * B10..15 Reserved
722 /* FTDI_SIO_SET_FLOW_CTRL */
723 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
724 #define FTDI_SIO_SET_FLOW_CTRL_REQUEST FTDI_SIO_SET_FLOW_CTRL
725 #define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
726 #define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
727 #define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
728 #define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
730 * BmRequestType: 0100 0000b
731 * bRequest: FTDI_SIO_SET_FLOW_CTRL
732 * wValue: Xoff/Xon
733 * wIndex: Protocol/Port - hIndex is protocl / lIndex is port
734 * wLength: 0
735 * Data: None
737 * hIndex protocol is:
738 * B0 Output handshaking using RTS/CTS
739 * 0 = disabled
740 * 1 = enabled
741 * B1 Output handshaking using DTR/DSR
742 * 0 = disabled
743 * 1 = enabled
744 * B2 Xon/Xoff handshaking
745 * 0 = disabled
746 * 1 = enabled
748 * A value of zero in the hIndex field disables handshaking
750 * If Xon/Xoff handshaking is specified, the hValue field should contain the XOFF character
751 * and the lValue field contains the XON character.
755 * FTDI_SIO_GET_LATENCY_TIMER
757 * Set the timeout interval. The FTDI collects data from the slave
758 * device, transmitting it to the host when either A) 62 bytes are
759 * received, or B) the timeout interval has elapsed and the buffer
760 * contains at least 1 byte. Setting this value to a small number
761 * can dramatically improve performance for applications which send
762 * small packets, since the default value is 16ms.
764 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST FTDI_SIO_GET_LATENCY_TIMER
765 #define FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE 0xC0
768 * BmRequestType: 1100 0000b
769 * bRequest: FTDI_SIO_GET_LATENCY_TIMER
770 * wValue: 0
771 * wIndex: Port
772 * wLength: 0
773 * Data: latency (on return)
777 * FTDI_SIO_SET_LATENCY_TIMER
779 * Set the timeout interval. The FTDI collects data from the slave
780 * device, transmitting it to the host when either A) 62 bytes are
781 * received, or B) the timeout interval has elapsed and the buffer
782 * contains at least 1 byte. Setting this value to a small number
783 * can dramatically improve performance for applications which send
784 * small packets, since the default value is 16ms.
786 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST FTDI_SIO_SET_LATENCY_TIMER
787 #define FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE 0x40
790 * BmRequestType: 0100 0000b
791 * bRequest: FTDI_SIO_SET_LATENCY_TIMER
792 * wValue: Latency (milliseconds)
793 * wIndex: Port
794 * wLength: 0
795 * Data: None
797 * wValue:
798 * B0..7 Latency timer
799 * B8..15 0
804 * FTDI_SIO_SET_EVENT_CHAR
806 * Set the special event character for the specified communications port.
807 * If the device sees this character it will immediately return the
808 * data read so far - rather than wait 40ms or until 62 bytes are read
809 * which is what normally happens.
813 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST FTDI_SIO_SET_EVENT_CHAR
814 #define FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE 0x40
818 * BmRequestType: 0100 0000b
819 * bRequest: FTDI_SIO_SET_EVENT_CHAR
820 * wValue: EventChar
821 * wIndex: Port
822 * wLength: 0
823 * Data: None
825 * wValue:
826 * B0..7 Event Character
827 * B8 Event Character Processing
828 * 0 = disabled
829 * 1 = enabled
830 * B9..15 Reserved
834 /* FTDI_SIO_SET_ERROR_CHAR */
836 /* Set the parity error replacement character for the specified communications port */
839 * BmRequestType: 0100 0000b
840 * bRequest: FTDI_SIO_SET_EVENT_CHAR
841 * wValue: Error Char
842 * wIndex: Port
843 * wLength: 0
844 * Data: None
846 *Error Char
847 * B0..7 Error Character
848 * B8 Error Character Processing
849 * 0 = disabled
850 * 1 = enabled
851 * B9..15 Reserved
855 /* FTDI_SIO_GET_MODEM_STATUS */
856 /* Retrieve the current value of the modem status register */
858 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE 0xc0
859 #define FTDI_SIO_GET_MODEM_STATUS_REQUEST FTDI_SIO_GET_MODEM_STATUS
860 #define FTDI_SIO_CTS_MASK 0x10
861 #define FTDI_SIO_DSR_MASK 0x20
862 #define FTDI_SIO_RI_MASK 0x40
863 #define FTDI_SIO_RLSD_MASK 0x80
865 * BmRequestType: 1100 0000b
866 * bRequest: FTDI_SIO_GET_MODEM_STATUS
867 * wValue: zero
868 * wIndex: Port
869 * wLength: 1
870 * Data: Status
872 * One byte of data is returned
873 * B0..3 0
874 * B4 CTS
875 * 0 = inactive
876 * 1 = active
877 * B5 DSR
878 * 0 = inactive
879 * 1 = active
880 * B6 Ring Indicator (RI)
881 * 0 = inactive
882 * 1 = active
883 * B7 Receive Line Signal Detect (RLSD)
884 * 0 = inactive
885 * 1 = active
890 /* Descriptors returned by the device
892 * Device Descriptor
894 * Offset Field Size Value Description
895 * 0 bLength 1 0x12 Size of descriptor in bytes
896 * 1 bDescriptorType 1 0x01 DEVICE Descriptor Type
897 * 2 bcdUSB 2 0x0110 USB Spec Release Number
898 * 4 bDeviceClass 1 0x00 Class Code
899 * 5 bDeviceSubClass 1 0x00 SubClass Code
900 * 6 bDeviceProtocol 1 0x00 Protocol Code
901 * 7 bMaxPacketSize0 1 0x08 Maximum packet size for endpoint 0
902 * 8 idVendor 2 0x0403 Vendor ID
903 * 10 idProduct 2 0x8372 Product ID (FTDI_SIO_PID)
904 * 12 bcdDevice 2 0x0001 Device release number
905 * 14 iManufacturer 1 0x01 Index of man. string desc
906 * 15 iProduct 1 0x02 Index of prod string desc
907 * 16 iSerialNumber 1 0x02 Index of serial nmr string desc
908 * 17 bNumConfigurations 1 0x01 Number of possible configurations
910 * Configuration Descriptor
912 * Offset Field Size Value
913 * 0 bLength 1 0x09 Size of descriptor in bytes
914 * 1 bDescriptorType 1 0x02 CONFIGURATION Descriptor Type
915 * 2 wTotalLength 2 0x0020 Total length of data
916 * 4 bNumInterfaces 1 0x01 Number of interfaces supported
917 * 5 bConfigurationValue 1 0x01 Argument for SetCOnfiguration() req
918 * 6 iConfiguration 1 0x02 Index of config string descriptor
919 * 7 bmAttributes 1 0x20 Config characteristics Remote Wakeup
920 * 8 MaxPower 1 0x1E Max power consumption
922 * Interface Descriptor
924 * Offset Field Size Value
925 * 0 bLength 1 0x09 Size of descriptor in bytes
926 * 1 bDescriptorType 1 0x04 INTERFACE Descriptor Type
927 * 2 bInterfaceNumber 1 0x00 Number of interface
928 * 3 bAlternateSetting 1 0x00 Value used to select alternate
929 * 4 bNumEndpoints 1 0x02 Number of endpoints
930 * 5 bInterfaceClass 1 0xFF Class Code
931 * 6 bInterfaceSubClass 1 0xFF Subclass Code
932 * 7 bInterfaceProtocol 1 0xFF Protocol Code
933 * 8 iInterface 1 0x02 Index of interface string description
935 * IN Endpoint Descriptor
937 * Offset Field Size Value
938 * 0 bLength 1 0x07 Size of descriptor in bytes
939 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
940 * 2 bEndpointAddress 1 0x82 Address of endpoint
941 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
942 * 4 bNumEndpoints 2 0x0040 maximum packet size
943 * 5 bInterval 1 0x00 Interval for polling endpoint
945 * OUT Endpoint Descriptor
947 * Offset Field Size Value
948 * 0 bLength 1 0x07 Size of descriptor in bytes
949 * 1 bDescriptorType 1 0x05 ENDPOINT descriptor type
950 * 2 bEndpointAddress 1 0x02 Address of endpoint
951 * 3 bmAttributes 1 0x02 Endpoint attributes - Bulk
952 * 4 bNumEndpoints 2 0x0040 maximum packet size
953 * 5 bInterval 1 0x00 Interval for polling endpoint
955 * DATA FORMAT
957 * IN Endpoint
959 * The device reserves the first two bytes of data on this endpoint to contain the current
960 * values of the modem and line status registers. In the absence of data, the device
961 * generates a message consisting of these two status bytes every 40 ms
963 * Byte 0: Modem Status
965 * Offset Description
966 * B0 Reserved - must be 1
967 * B1 Reserved - must be 0
968 * B2 Reserved - must be 0
969 * B3 Reserved - must be 0
970 * B4 Clear to Send (CTS)
971 * B5 Data Set Ready (DSR)
972 * B6 Ring Indicator (RI)
973 * B7 Receive Line Signal Detect (RLSD)
975 * Byte 1: Line Status
977 * Offset Description
978 * B0 Data Ready (DR)
979 * B1 Overrun Error (OE)
980 * B2 Parity Error (PE)
981 * B3 Framing Error (FE)
982 * B4 Break Interrupt (BI)
983 * B5 Transmitter Holding Register (THRE)
984 * B6 Transmitter Empty (TEMT)
985 * B7 Error in RCVR FIFO
988 #define FTDI_RS0_CTS (1 << 4)
989 #define FTDI_RS0_DSR (1 << 5)
990 #define FTDI_RS0_RI (1 << 6)
991 #define FTDI_RS0_RLSD (1 << 7)
993 #define FTDI_RS_DR 1
994 #define FTDI_RS_OE (1<<1)
995 #define FTDI_RS_PE (1<<2)
996 #define FTDI_RS_FE (1<<3)
997 #define FTDI_RS_BI (1<<4)
998 #define FTDI_RS_THRE (1<<5)
999 #define FTDI_RS_TEMT (1<<6)
1000 #define FTDI_RS_FIFO (1<<7)
1003 * OUT Endpoint
1005 * This device reserves the first bytes of data on this endpoint contain the length
1006 * and port identifier of the message. For the FTDI USB Serial converter the port
1007 * identifier is always 1.
1009 * Byte 0: Line Status
1011 * Offset Description
1012 * B0 Reserved - must be 1
1013 * B1 Reserved - must be 0
1014 * B2..7 Length of message - (not including Byte 0)