Difference between revisions of "Unit FTDISerial"

From Ultibo.org
Jump to: navigation, search
Line 118: Line 118:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<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>
 
<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 style="font-size: 14px; padding-left: 12px;">'''Description:''' Unbind the FTDI Serial driver from a USB device</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
 
! '''Device'''
 
! '''Device'''
−
| The USB device to unbind ?rom
+
| The USB device to unbind from
 
|-
 
|-
 
! '''Interrface'''
 
! '''Interrface'''
−
| The USB interface to unbind ?rom (or nil for whole device)
+
| The USB interface to unbind from (or nil for whole device)
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''
Line 136: Line 136:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<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>
 
<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 style="font-size: 14px; padding-left: 12px;">'''Description:''' Called (by a Worker thread) to process a completed USB request from the FTDI Serial bulk IN endpoint</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 169: Line 169:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<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>
 
<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 style="font-size: 14px; padding-left: 12px;">'''Description:''' Called when a USB request from the FTDI Serial bulk IN endpoint completes</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 184: Line 184:
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<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>
 
<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 style="font-size: 14px; padding-left: 12px;">'''Description:''' Called to continue transmission of data from the transmit buffer</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"

Revision as of 03:34, 1 December 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

[Expand] 
procedure FTDISerialInit;
Description: To be documented


FTDI serial functions

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


[Expand] 
function FTDISerialDeviceClose(Serial:PSerialDevice):LongWord;
Description: To be documented


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


[Expand] 
function FTDISerialDeviceWrite(Serial:PSerialDevice; Buffer:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: To be 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


[Expand] 
function FTDISerialDriverUnbind(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;
Description: Unbind the FTDI Serial driver from a USB device


[Expand] 
procedure FTDISerialReceiveWorker(Request:PUSBRequest);
Description: Called (by a Worker thread) to process a completed USB request from the FTDI Serial bulk IN endpoint


[Expand] 
procedure FTDISerialReceiveComplete(Request:PUSBRequest);
Description: Called when a USB request from the FTDI Serial bulk IN endpoint completes


[Expand] 
procedure FTDISerialTransmitStart(Request:PUSBRequest);
Description: Called to continue transmission of data from the transmit buffer


[Expand] 
procedure FTDISerialTransmitWorker(Request:PUSBRequest);
Description: Called (by a Worker thread) to process a completed USB request to the FTDI Serial bulk OUT endpoint


[Expand] 
procedure FTDISerialTransmitComplete(Request:PUSBRequest);
Description: Called when a USB request to the FTDI Serial bulk OUT endpoint completes


FTDI serial helper functions

[Expand] 
function FTDISerialCheckDevice(Device:PUSBDevice):LongWord;
Description: Check the Vendor and Device ID against the supported devices


[Expand] 
function FTDISerialCheckDeviceAndInterface(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;
Description: Check the Device and Interface against the supported devices


[Expand] 
function FTDISerialPatchDevice(Device:PUSBDevice; var Quirks:LongWord):LongWord;
Description: Check the USB device for quirks information needed by the driver


[Expand] 
function FTDISerialCheckJTAGDevice(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;
Description: Check for the first port (interface) on JTAG adapters which is reserved for JTAG


[Expand] 
function FTDISerialCheck8U2232CDevice(Device:PUSBDevice; Interrface:PUSBInterface):LongWord;
Description: Check for the first port (interface) on 8U2232C adapters which is reserved for JTAG


[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


[Expand] 
function FTDISerialDetermineType(Serial:PFTDISerialDevice):LongWord;
Description: To be documented


[Expand] 
function FTDISerialGetLatency(Serial:PFTDISerialDevice):LongWord;
Description: To be documented


[Expand] 
function FTDISerialSetLatency(Serial:PFTDISerialDevice):LongWord;
Description: To be documented


[Expand] 
function FTDISerialReset(Serial:PFTDISerialDevice; Value:Word):LongWord;
Description: To be documented


[Expand] 
function FTDISerialSetData(Serial:PFTDISerialDevice; Value:Word):LongWord;
Description: To be documented


[Expand] 
function FTDISerialSetBaudRate(Serial:PFTDISerialDevice; Divisor:LongWord):LongWord;
Description: To be documented


[Expand] 
function FTDISerialSetFlowControl(Serial:PFTDISerialDevice; Index:Word):LongWord;
Description: To be documented


[Expand] 
function FTDISerialGetModemStatus(Serial:PFTDISerialDevice; var Status:Word):LongWord;
Description: To be documented


[Expand] 
function FTDISerialSetModemControl(Serial:PFTDISerialDevice; Value:Word):LongWord;
Description: To be documented


[Expand] 
function FTDISerialGetDivisor(Serial:PFTDISerialDevice; var BaudRate:LongWord):LongWord;
Description: To be documented


[Expand] 
function FTDISerialBaudToDivisor232AM(Serial:PFTDISerialDevice; BaudRate:LongWord):LongWord;
Description: To be documented


[Expand] 
function FTDISerialBaudToDivisor232BM(Serial:PFTDISerialDevice; BaudRate:LongWord):LongWord;
Description: To be documented


[Expand] 
function FTDISerialBaudToDivisor2232H(Serial:PFTDISerialDevice; BaudRate:LongWord):LongWord;
Description: To be documented


Return to Unit Reference

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