Vault 7: Projects
This publication series is about specific projects related to the Vault 7 main publication.
Request Summary
SendEncapsulatedCommand Issues a command in the format of the supported control protocol.
GetEncapsulatedResponse Requests a response in the format of the supported control protocol.
SetLineCoding Configures DTE rate, stop-bits, parity, and number-of-character bits.
GetLineCoding Requests current DTE rate, stop-bits, parity, and number-of-character bits.
SetControlLineState [V24] signal used to tell the DCE device the DTE device is now present.
Data transfers : Once the device is attached the application is ready to start data transfers. Usually two endpoints one in
each direction are supported by the device.
* To receive data from the device the application must set up a IN request at the rate depending on the baudrate settings.
Application can use a timer interrupt to precisely set up the request. Function USBHostCDC_Api_Get_IN_Data()is used to
setup the request. Maximum of 64 bytes can be received in single transfer.
* To transmit data to the device application must set up a OUT request. Function USBHostCDC_Api_Send_OUT_Data()is
used to setup out request. Any amount of data can be transferred to the device. The Client driver takes care of sending the
data in 64 bytes packet.
* USBHostCDC_ApiTransferIsComplete() is used to poll for the status of previous transfer.
* USBHostCDC_ApiDeviceDetect() is used to get the status of the device. If the device is ready for new transfer then the
function returns TRUE.
1.4.2.2.1 Functions
Functions
Name Description
USBHostCDC_Api_ACM_Request This function can be used by application code to dynamically access
ACM specific requests. This function should be used only if apllication
intends to modify for example the Baudrate from previouly configured
rate. Data transmitted/received to/from device is a array of bytes.
Application must take extra care of understanding the data format
before using this function.
USBHostCDC_Api_Get_IN_Data This function is called by application to receive Input data over DATA
interface. This function setsup the request to receive data from the
device.
USBHostCDC_Api_Send_OUT_Data This function is called by application to transmit out data over DATA
interface. This function setsup the request to transmit data to the device.
USBHostCDC_ApiDeviceDetect This function determines if a CDC device is attached and ready to use.
USBHostCDC_ApiTransferIsComplete This function is called by application to poll for transfer status. This
function returns true in the transfer is over. To check whether the
transfer was successfull or not , application must check the error code
returned by reference.
USBHostCDCDeviceStatus This function determines the status of a CDC device.
USBHostCDCEventHandler This function is the event handler for this client driver.
USBHostCDCInitAddress This function intializes the address of the attached CDC device.
USBHostCDCInitialize This function is the initialization routine for this client driver.
USBHostCDCResetDevice This function starts a CDC reset.
USBHostCDCTasks This function performs the maintenance tasks required by CDC class
USBHostCDCTransfer This function starts a CDC transfer.
USBHostCDCTransferIsComplete This function indicates whether or not the last transfer is complete.
Module
CDC Client Driver
1.4 Library Interface MLA - USB Library Help Embedded Host API
133
Protego_Release_01_05-Related-OEM-Documentation-MLA_v2013_12_20-help_mla_usb.pdf