Difference between revisions of "Unit FTDISerial"

From Ultibo.org
Jump to: navigation, search
Line 91: Line 91:
 
! '''Note'''
 
! '''Note'''
 
| None documented
 
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
 +
'''FTDI serial USB functions'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function FTDISerialDriverBind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Bind the FTDI Serial driver to a USB device if it is suitable</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''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
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function FTDISerialDriverUnbind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Unbind the FTDI Serial driver ?rom a USB device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''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
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure FTDISerialReceiveWorker(Request:PUSBRequest);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Called (by a Worker thread) to process a completed USB request ?rom the FTDI Serial bulk IN endpoint</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''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)
 +
&nbsp;
 +
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}
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure FTDISerialReceiveComplete(Request:PUSBRequest);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Called when a USB request ?rom the FTDI Serial bulk IN endpoint completes</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''Request'''
 +
| The USB request which has completed
 +
|-
 +
! '''Note'''
 +
| Request is passed to worker thread for processing to prevent blocking the USB completion
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure FTDISerialTransmitStart(Request:PUSBRequest);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Called to continue transmission of data ?rom the transmit buffer</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''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
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure FTDISerialTransmitWorker(Request:PUSBRequest);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Called (by a Worker thread) to process a completed USB request to the FTDI Serial bulk OUT endpoint</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''Request'''
 +
| The USB request which has completed
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">procedure FTDISerialTransmitComplete(Request:PUSBRequest);</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Called when a USB request to the FTDI Serial bulk OUT endpoint completes</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! '''Request'''
 +
| The USB request which has completed
 +
|-
 +
! '''Note'''
 +
| Request is passed to worker thread for processing to prevent blocking the USB completion
 
|-
 
|-
 
|}
 
|}

Revision as of 00:03, 14 October 2016

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 

procedure FTDISerialInit;
Description: To be documented
Note None documented


FTDI serial functions 

function FTDISerialDeviceOpen(Serial:PSerialDevice; BaudRate,DataBits,StopBits,Parity,FlowControl,ReceiveDepth,TransmitDepth:LongWord):LongWord;
Description: To be documented
Note None documented 


function FTDISerialDeviceClose(Serial:PSerialDevice):LongWord;
Description: To be documented
Note None documented 


function FTDISerialDeviceRead(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: To be documented
Note None documented 


function FTDISerialDeviceWrite(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: To be documented
Note None documented


FTDI serial USB functions 

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 


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 


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} 


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 


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 


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 


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


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_FTDISerial&oldid=1245"