Unit FTDISerial

Return to Unit Reference

This driver is intended to support a range of USB to Serial converter chips manufactured by Future Technology Devices International Ltd (FTDI). These include devices using the FT232H,FT-X (FT201X, FT230X, FT231X), FT8U100AX and FT4232H as well as others, many of these chips utilize similar communications protocols and where different the driver attempts to account for those differences.

The driver also supports communication with many Arduino models that contain an FTDI serial device on board rather than the USB CDC ADM device found in more recent models.

Any device recognized as an FTDI Serial is presented as a generic serial interface device that can be accessed using the API in the Serial unit. It should not be necessary to directly call any of the functions in this unit from application code.

`FTDISERIAL_DRIVER_NAME = 'FTDI USB to Serial Driver';`	Name of FTDI Serial driver

`FTDISERIAL_SERIAL_DESCRIPTION = 'FTDI USB to Serial';`	Description of FTDI Serial device

`FTDISERIAL_MIN_DATABITS = SERIAL_DATA_7BIT;`
`FTDISERIAL_MAX_DATABITS = SERIAL_DATA_8BIT;`

`FTDISERIAL_MIN_STOPBITS = SERIAL_STOP_1BIT;`
`FTDISERIAL_MAX_STOPBITS = SERIAL_STOP_1BIT5;`

`FTDISERIAL_MAX_PARITY = SERIAL_PARITY_SPACE;`

`FTDISERIAL_MAX_FLOW = SERIAL_FLOW_DSR_DTR;`

`FTDISERIAL_CHIP_NONE = 0;`
`FTDISERIAL_CHIP_SIO = 1;`
`FTDISERIAL_CHIP_FT8U232AM = 2;`
`FTDISERIAL_CHIP_FT232BM = 3;`
`FTDISERIAL_CHIP_FT2232C = 4;`
`FTDISERIAL_CHIP_FT232RL = 5;`
`FTDISERIAL_CHIP_FT2232H = 6;`
`FTDISERIAL_CHIP_FT4232H = 7;`
`FTDISERIAL_CHIP_FT232H = 8;`
`FTDISERIAL_CHIP_FTX = 9;`

`FTDISERIAL_SIO_BAUD300 = 0;`
`FTDISERIAL_SIO_BAUD600 = 1;`
`FTDISERIAL_SIO_BAUD1200 = 2;`
`FTDISERIAL_SIO_BAUD2400 = 3;`
`FTDISERIAL_SIO_BAUD4800 = 4;`
`FTDISERIAL_SIO_BAUD9600 = 5;`
`FTDISERIAL_SIO_BAUD19200 = 6;`
`FTDISERIAL_SIO_BAUD38400 = 7;`
`FTDISERIAL_SIO_BAUD57600 = 8;`
`FTDISERIAL_SIO_BAUD115200 = 9;`

`FTDISERIAL_BULK_IN_SIZE = 512;`
`FTDISERIAL_BULK_OUT_SIZE = 256;`

`FTDISERIAL_TIMEOUT = 5000;`
`FTDISERIAL_SHORT_TIMEOUT = 1000;`

ftdi_sio.h
`FTDISERIAL_RESET_REQUEST = 0;`	Reset the port
`FTDISERIAL_SET_MODEM_CTRL_REQUEST = 1;`	Set the modem control register
`FTDISERIAL_SET_FLOW_CTRL_REQUEST = 2;`	Set flow control register
`FTDISERIAL_SET_BAUD_RATE_REQUEST = 3;`	Set baud rate
`FTDISERIAL_SET_DATA_REQUEST = 4;`	Set the data characteristics of the port
`FTDISERIAL_GET_MODEM_STATUS_REQUEST = 5;`	Retrieve current value of modem status register
`FTDISERIAL_SET_EVENT_CHAR_REQUEST = 6;`	Set the event character
`FTDISERIAL_SET_ERROR_CHAR_REQUEST = 7;`	Set the error character
`FTDISERIAL_SET_LATENCY_TIMER_REQUEST = 9;`	Set the latency timer
`FTDISERIAL_GET_LATENCY_TIMER_REQUEST = 10;`	Get the latency timer

ftdi_sio.h
`FTDISERIAL_RESET_REQUEST_TYPE = $40;`
`FTDISERIAL_SET_MODEM_CTRL_REQUEST_TYPE = $40;`
`FTDISERIAL_SET_FLOW_CTRL_REQUEST_TYPE = $40;`
`FTDISERIAL_SET_BAUD_RATE_REQUEST_TYPE = $40;`
`FTDISERIAL_SET_DATA_REQUEST_TYPE = $40;`
`FTDISERIAL_GET_MODEM_STATUS_REQUEST_TYPE = $C0;`
`FTDISERIAL_SET_EVENT_CHAR_REQUEST_TYPE = $40;`
`FTDISERIAL_SET_ERROR_CHAR_REQUEST_TYPE = $40;`
`FTDISERIAL_SET_LATENCY_TIMER_REQUEST_TYPE = $40;`
`FTDISERIAL_GET_LATENCY_TIMER_REQUEST_TYPE = $C0;`

ftdi_sio.h
wValue: Control Value
`FTDISERIAL_RESET_SIO = 0;`	0 = Reset SIO
`FTDISERIAL_RESET_PURGE_RX = 1;`	1 = Purge RX buffer
`FTDISERIAL_RESET_PURGE_TX = 2;`	2 = Purge TX buffer

ftdi_sio.h
wValue: ControlValue
`FTDISERIAL_SET_MODEM_CTRL_NONE = 0;`
`FTDISERIAL_SET_MODEM_CTRL_DTR_ENABLE = 1;`	B0 DTR state (0 = reset/1 = set)
`FTDISERIAL_SET_MODEM_CTRL_DTR_HIGH = (1 or (FTDISERIAL_SET_MODEM_CTRL_DTR_ENABLE shl 8));`	B1 RTS state (0 = reset/1 = set)
`FTDISERIAL_SET_MODEM_CTRL_DTR_LOW = (0 or (FTDISERIAL_SET_MODEM_CTRL_DTR_ENABLE shl 8));`	B2..7 Reserved
`FTDISERIAL_SET_MODEM_CTRL_RTS_ENABLE = 2;`	B8 DTR state enable (0 = ignore/1 = use DTR state)
`FTDISERIAL_SET_MODEM_CTRL_RTS_HIGH = (2 or (FTDISERIAL_SET_MODEM_CTRL_RTS_ENABLE shl 8));`	B9 RTS state enable (0 = ignore/1 = use RTS state)
`FTDISERIAL_SET_MODEM_CTRL_RTS_LOW = (0 or (FTDISERIAL_SET_MODEM_CTRL_RTS_ENABLE shl 8));`	B10..15 Reserved

ftdi_sio.h
wIndex: Protocol/Port - hIndex is protocol/lIndex is port
`FTDISERIAL_SET_FLOW_CTRL_NONE = (0 shl 8);`	hIndex protocol
`FTDISERIAL_SET_FLOW_CTRL_RTS_CTS = (1 shl 8);`	B0 Output handshaking using RTS/CTS (0 = disabled/1 = enabled)
`FTDISERIAL_SET_FLOW_CTRL_DTR_DSR = (2 shl 8);`	B1 Output handshaking using DTR/DSR (0 = disabled/1 = enabled)
`FTDISERIAL_SET_FLOW_CTRL_XON_XOFF = (4 shl 8);`	B2 Xon/Xoff handshaking (0 = disabled/1 = enabled)

ftdi_sio.h
Data characteristics
`FTDISERIAL_SET_DATA_PARITY_NONE = (0 shl 8);`	B0..7 Number of data bits
`FTDISERIAL_SET_DATA_PARITY_ODD = (1 shl 8);`	B8..10 Parity (0 = None/1 = Odd/2 = Even/3 = Mark/4 = Space)
`FTDISERIAL_SET_DATA_PARITY_EVEN = (2 shl 8);`	B11..13 Stop Bits (0 = 1/1 = 1.5/2 = 2)
`FTDISERIAL_SET_DATA_PARITY_MARK = (3 shl 8);`	B14 (1 = TX ON (break)/0 = TX OFF (normal state))
`FTDISERIAL_SET_DATA_PARITY_SPACE = (4 shl 8);`	B15 Reserved
`FTDISERIAL_SET_DATA_STOP_BITS_1 = (0 shl 11);`
`FTDISERIAL_SET_DATA_STOP_BITS_15 = (1 shl 11);`
`FTDISERIAL_SET_DATA_STOP_BITS_2 = (2 shl 11);`
`FTDISERIAL_SET_BREAK = (1 shl 14);`

ftdi_sio.h
One byte of data is returned
`FTDISERIAL_GET_MODEM_STATUS_CTS = $10;`	B0..3 0
`FTDISERIAL_GET_MODEM_STATUS_DSR = $20;`	B4 CTS (0 = inactive/1 = active)
`FTDISERIAL_GET_MODEM_STATUS_RI = $40;`	B5 DSR (0 = inactive/1 = active)
`FTDISERIAL_GET_MODEM_STATUS_RLSD = $80;`	B6 Ring Indicator (RI) (0 = inactive / 1 = active)
	B7 Receive Line Signal Detect (RLSD) (0 = inactive/1 = active)

ftdi_sio.h
First two bytes of received packet
`FTDISERIAL_RECEIVE_STATUS0_CTS = (1 shl 4);`	Byte 0: Modem Status
`FTDISERIAL_RECEIVE_STATUS0_DSR = (1 shl 5);`	B0 Reserved - must be 1
`FTDISERIAL_RECEIVE_STATUS0_RI = (1 shl 6);`	B1..3 Reserved - must be 0
`FTDISERIAL_RECEIVE_STATUS0_RLSD = (1 shl 7);`	B4 Clear to Send (CTS)
	B5 Data Set Ready (DSR)
	B6 Ring Indicator (RI)
	B7 Receive Line Signal Detect (RLSD)
	Byte 1: Line Status
`FTDISERIAL_RECEIVE_STATUS1_DR = (1 shl 0);`	B0 Data Ready (DR)
`FTDISERIAL_RECEIVE_STATUS1_OE = (1 shl 1);`	B1 Overrun Error (OE)
`FTDISERIAL_RECEIVE_STATUS1_PE = (1 shl 2);`	B2 Parity Error (PE)
`FTDISERIAL_RECEIVE_STATUS1_FE = (1 shl 3);`	B3 Framing Error (FE)
`FTDISERIAL_RECEIVE_STATUS1_BI = (1 shl 4);`	B4 Break Interrupt (BI)
`FTDISERIAL_RECEIVE_STATUS1_THRE = (1 shl 5);`	B5 Transmitter Holding Register (THRE)
`FTDISERIAL_RECEIVE_STATUS1_TEMT = (1 shl 6);`	B6 Transmitter Empty (TEMT)
`FTDISERIAL_RECEIVE_STATUS1_FIFO = (1 shl 7);`	B7 Error in RCVR FIFO

`FTDISERIAL_RECEIVE_STATUS0_MASK = FTDISERIAL_RECEIVE_STATUS0_CTS or FTDISERIAL_RECEIVE_STATUS0_DSR or FTDISERIAL_RECEIVE_STATUS0_RI or FTDISERIAL_RECEIVE_STATUS0_RLSD;`
`FTDISERIAL_RECEIVE_STATUS1_MASK = FTDISERIAL_RECEIVE_STATUS1_OE or FTDISERIAL_RECEIVE_STATUS1_PE or FTDISERIAL_RECEIVE_STATUS1_FE or FTDISERIAL_RECEIVE_STATUS1_BI;`

`FTDISERIAL_QUIRK_NONE = $00000000;`
`FTDISERIAL_QUIRK_8U2232C = $00000001;`
`FTDISERIAL_QUIRK_HE_TIRA1 = $00000002;`
`FTDISERIAL_QUIRK_USB_UIRT = $00000004;`
`FTDISERIAL_QUIRK_JTAG = $00000008;`
`FTDISERIAL_QUIRK_NDI_DEVICE = $00000010;`
`FTDISERIAL_QUIRK_STMCLITE = $00000020;`

ftdi_sio.h
FT2232, FT2232H and FT4232H
`FTDISERIAL_INTERFACE_A = 1;`
`FTDISERIAL_INTERFACE_B = 2;`
`FTDISERIAL_INTERFACE_C = 3;`
`FTDISERIAL_INTERFACE_D = 4;`

`FTDISERIAL_DEVICE_INTERFACE_ID_COUNT = 1;`	Number of supported Device and Interface IDs

`FTDISERIAL_DEVICE_INTERFACE_ID:array[0..FTDISERIAL_DEVICE_INTERFACE_ID_COUNT - 1] of TUSBDeviceAndInterfaceId = (`
`idVendor:MICROCHIP_VID; idProduct:MICROCHIP_USB_BOARD_PID;bInterfaceClass:USB_CLASS_CODE_VENDOR_SPECIFIC; bInterfaceSubClass:USB_SUBCLASS_VENDOR_SPECIFIC; bInterfaceProtocol:0));`

`FTDISERIAL_DEVICE_INTERFACE_NO_COUNT = 7;`	Number of supported Device and Interface Nos

`FTDISERIAL_DEVICE_INTERFACE_NO:array[0..FTDISERIAL_DEVICE_INTERFACE_NO_COUNT - 1] of TUSBDeviceAndInterfaceNo = (`
Infineon Devices
`(idVendor:INFINEON_VID;idProduct:INFINEON_TRIBOARD_TC1798_PID;bInterfaceNumber:1),`
`(idVendor:INFINEON_VID;idProduct:INFINEON_TRIBOARD_TC2X7_PID;bInterfaceNumber:1),`
`(idVendor:ACTEL_VID;idProduct:MICROSEMI_ARROW_SF2PLUS_BOARD_PID;bInterfaceNumber:2),`
`(idVendor:OLIMEX_VID;idProduct:OLIMEX_ARM_USB_OCD_PID;bInterfaceNumber:1),`
`(idVendor:OLIMEX_VID;idProduct:OLIMEX_ARM_USB_OCD_H_PID;bInterfaceNumber:1),`
`(idVendor:OLIMEX_VID;idProduct:OLIMEX_ARM_USB_TINY_PID;bInterfaceNumber:1),`
`(idVendor:OLIMEX_VID;idProduct:OLIMEX_ARM_USB_TINY_H_PID;bInterfaceNumber:1));`

Serial Properties
`Serial:TSerialDevice;`
USB Properties
`Chip:LongWord;`	The FTDI chip type (eg FTDISERIAL_CHIP_SIO)
`Quirks:LongWord;`	Unusual behaviours of specific chip versions
`Index:LongWord;`	Interface index for USB control requests
`Latency:LongWord;`	Latency timer value for the device
`ForceBaud:LongWord;`	The detected device has a fixed baud rate
`ForceRTSCTS:LongBool;`	The detected device requires RTS-CTS usage
`BaudBase:LongWord;`	The baud rate clock base value for the device
`FixedDivisor:LongWord;`	The fixed divisor value for fixed a baud rate device
`LastStatus:LongWord;`	The modem status received with the last packet (eg FTDISERIAL_RECEIVE_STATUS0_CTS)
`ReceiveSize:LongWord;`	Maximum Receive size for Bulk IN Endpoint
`TransmitSize:LongWord;`	Maximum Transmit size for Bulk OUT Endpoint
`ReceiveActive:LongBool;`	True if a Receive request is currently in progress
`TransmitActive:LongBool;`	True if a Transmit request is currently in progress
`SerialInterface:PUSBInterface;`	USB interface for the serial device
`ReceiveRequest:PUSBRequest;`	USB request Bulk IN Endpoint
`ReceiveEndpoint:PUSBEndpointDescriptor;`	FTDI Serial Bulk IN Endpoint
`TransmitRequest:PUSBRequest;`	USB request for Bulk OUT Endpoint
`TransmitEndpoint:PUSBEndpointDescriptor;`	FTDI Serial Bulk OUT Endpoint
`PendingCount:LongWord;`	Number of USB requests pending for this device
`WaiterThread:TThreadId;`	Thread waiting for pending requests to complete (for device detachment)
Statistics Properties
`ReceiveComplete:LongWord;`
`TransmitComplete:LongWord;`

Device	The USB device to attempt to bind to
Interrface	The USB interface to attempt to bind to (or nil for whole device)
Return	USB_STATUS_SUCCESS if completed, USB_STATUS_DEVICE_UNSUPPORTED if unsupported or another error code on failure.

Device	The USB device to unbind from
Interrface	The USB interface to unbind from (or nil for whole device)
Return	USB_STATUS_SUCCESS if completed or another error code on failure

Request	The USB receive request to use
Note	Caller must hold the lock on the serial device

Request	The USB request which has completed
Note	The first two bytes of the received packet will be: Byte 0: Modem Status Bit0 Reserved - must be 1 Bit1 Reserved - must be 0 Bit2 Reserved - must be 0 Bit3 Reserved - must be 0 Bit4 Clear to Send (CTS) Bit5 Data Set Ready (DSR) Bit6 Ring Indicator (RI) Bit7 Receive Line Signal Detect (RLSD) Byte 1: Line Status Bit0 Data Ready (DR) Bit1 Overrun Error (OE) Bit2 Parity Error (PE) Bit3 Framing Error (FE) Bit4 Break Interrupt (BI) Bit5 Transmitter Holding Register (THRE) Bit6 Transmitter Empty (TEMT) Bit7 Error in RCVR FIFO

Request	The USB transmit request to use
Note	The FTDISERIAL_CHIP_SIO device requires the first byte to be: Bit0 1 Reserved must be 1 Bit1 0 Reserved must be 0 Bit2..7 Length of message (not including this byte) Caller must hold the lock on the serial device

Device	USB device to check
Return	USB_STATUS_SUCCESS if completed or another error code on failure

Unit FTDISerial

Contents

Description

Constants

Type definitions

Public variables

Function declarations

Navigation menu

Search