Unit FTDISerial

Return to Unit Reference

Description

---

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 within application code.

Constants

---

To be documented

Type definitions

---

To be documented

Public variables

---

To be documented

Function declarations

---

Initialization functions

[Expand]

procedure FTDISerialInit;

Description: To be documented

Note	None documented

FTDI serial functions

[Expand]

function FTDISerialDeviceOpen(Serial:PSerialDevice; BaudRate,DataBits,StopBits,Parity,FlowControl,ReceiveDepth,TransmitDepth:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialDeviceClose(Serial:PSerialDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialDeviceRead(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialDeviceWrite(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

Description: To be documented

Note	None documented

FTDI serial USB functions

[Expand]

function FTDISerialDriverBind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;

Description: Bind the FTDI Serial driver to a USB device if it is suitable

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

[Expand]

function FTDISerialDriverUnbind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;

Description: Unbind the FTDI Serial driver ?rom a USB device

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

[Expand]

procedure FTDISerialReceiveWorker(Request:PUSBRequest);

Description: Called (by a Worker thread) to process a completed USB request ?rom the FTDI Serial bulk IN endpoint

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}

[Expand]

procedure FTDISerialReceiveComplete(Request:PUSBRequest);

Description: Called when a USB request ?rom the FTDI Serial bulk IN endpoint completes

Request	The USB request which has completed
Note	Request is passed to worker thread for processing to prevent blocking the USB completion

[Expand]

procedure FTDISerialTransmitStart(Request:PUSBRequest);

Description: Called to continue transmission of data ?rom the transmit buffer

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

[Expand]

procedure FTDISerialTransmitWorker(Request:PUSBRequest);

Description: Called (by a Worker thread) to process a completed USB request to the FTDI Serial bulk OUT endpoint

Request	The USB request which has completed

[Expand]

procedure FTDISerialTransmitComplete(Request:PUSBRequest);

Description: Called when a USB request to the FTDI Serial bulk OUT endpoint completes

Request	The USB request which has completed
Note	Request is passed to worker thread for processing to prevent blocking the USB completion

FTDI serial helper functions

[Expand]

function FTDISerialCheckDevice(Device:PUSBDevice):LongWord;

Description: Check the Vendor and Device ID against the supported devices

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

[Expand]

function FTDISerialCheckDeviceAndInterface(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;

Description: Check the Device and Interface against the supported devices

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

[Expand]

function FTDISerialPatchDevice(Device:PUSBDevice; var Quirks:LongWord):LongWord;

Description: Check the USB device for quirks information needed by the driver

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

[Expand]

function FTDISerialCheckJTAGDevice(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;

Description: Check for the first port (interface) on JTAG adapters which is reserved for JTAG

Note	None documented

[Expand]

function FTDISerialCheck8U2232CDevice(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;

Description: Check for the first port (interface) on 8U2232C adapters which is reserved for JTAG

Note	None documented

[Expand]

function FTDISerialCheckSTMCLiteDevice(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;

Description: Check for the first and second ports (interfaces) on FT4232 adapters which are reserved for JTAG or other non UART interfaces. Port (interface) 2 is a standard RS232 UART

Note	None documented

[Expand]

function FTDISerialDetermineType(Serial:PFTDISerialDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialGetLatency(Serial:PFTDISerialDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialSetLatency(Serial:PFTDISerialDevice):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialReset(Serial:PFTDISerialDevice; Value:Word):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialSetData(Serial:PFTDISerialDevice; Value:Word):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialSetBaudRate(Serial:PFTDISerialDevice; Divisor:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialSetFlowControl(Serial:PFTDISerialDevice; Index:Word):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialGetModemStatus(Serial:PFTDISerialDevice; var Status:Word):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialSetModemControl(Serial:PFTDISerialDevice; Value:Word):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialGetDivisor(Serial:PFTDISerialDevice; var BaudRate:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialBaudToDivisor232AM(Serial:PFTDISerialDevice; BaudRate:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialBaudToDivisor232BM(Serial:PFTDISerialDevice; BaudRate:LongWord):LongWord;

Description: To be documented

Note	None documented

[Expand]

function FTDISerialBaudToDivisor2232H(Serial:PFTDISerialDevice; BaudRate:LongWord):LongWord;

Description: To be documented

Note	None documented

Return to Unit Reference