USB Library
Functions

 

Functions and macro functions used to interface with the CDC module.

Functions
 
Name 
Description 
 
This function initializes the CDC function driver. This function should be called after the SET_CONFIGURATION command (ex: within the context of the USBCBInitEP() function). 
 
Checks for changes in DSR status and reports them to the USB host. 
 
CDCTxService handles device-to-host transaction(s). This function should be called once per Main Program loop after the device reaches the configured state. 
 
getsUSBUSART copies a string of BYTEs received through USB CDC Bulk OUT endpoint to a user's specified location. It is a non-blocking function. It does not wait for data if there is no data available. Instead it returns '0' to notify the caller that there is no data available. 
 
putrsUSBUSART writes a string of data to the USB including the null character. Use this version, 'putrs', to transfer data literals and data located in program memory. 
 
putsUSBUSART writes a string of data to the USB including the null character. Use this version, 'puts', to transfer data from a RAM buffer. 
 
putUSBUSART writes an array of data to the USB. Use this version, is capable of transferring 0x00 (what is typically a NULL character in any of the string transfer functions). 
 
Handles events from the USB stack, which may have an effect on the CDC endpoint(s). 
 
This routine checks the most recently received SETUP data packet to see if the request is specific to the CDC class. If the request was a CDC specific request, this function will take care of handling the request and responding appropriately. 
Macros
 
Name 
Description 
 
This macro is used set the baud rate reported back to the host during a get line coding request. (optional) 
 
This macro is used manually set the character format reported back to the host during a get line coding request. (optional) 
 
This function is used manually set the number of data bits reported back to the host during a get line coding request. (optional) 
 
This function is used to manually set the data reported back to the host during a get line coding request. (optional) 
 
This function is used manually set the parity format reported back to the host during a get line coding request. (optional) 
 
Deprecated in MCHPFSUSB v2.3. This macro has been replaced by USBUSARTIsTxTrfReady(). 
 
Use this macro to transfer data located in data memory. Use this macro when:
  1. Data stream is not null-terminated
  2. Transfer length is known
Remember: cdc_trf_state must == CDC_TX_READY Unlike putsUSBUSART, there is not code double checking the transfer state. Unexpected behavior will occur if this function is called when cdc_trf_state != CDC_TX_READY
Typical Usage:  
 
Use this macro to transfer data located in program memory. Use this macro when:
  1. Data stream is not null-terminated
  2. Transfer length is known

Remember: cdc_trf_state must == CDC_TX_READY Unlike putrsUSBUSART, there is not code double checking the transfer state. Unexpected behavior will occur if this function is called when cdc_trf_state != CDC_TX_READY
Typical Usage:  
 
This macro is used to check if the CDC class is ready to send more data. 
Module
MLA - USB Library Help Version : 2.16
http://www.microchip.com/mla