EU1KY AA FW
USBD_CORE_Exported_FunctionsPrototype

Functions

USBD_StatusTypeDef USBD_Init (USBD_HandleTypeDef *pdev, USBD_DescriptorsTypeDef *pdesc, uint8_t id)
 USBD_Init Initializes the device stack and load the class driver. More...
 
USBD_StatusTypeDef USBD_DeInit (USBD_HandleTypeDef *pdev)
 USBD_DeInit Re-Initialize th device library. More...
 
USBD_StatusTypeDef USBD_Start (USBD_HandleTypeDef *pdev)
 USBD_Start Start the USB Device Core. More...
 
USBD_StatusTypeDef USBD_Stop (USBD_HandleTypeDef *pdev)
 USBD_Stop Stop the USB Device Core. More...
 
USBD_StatusTypeDef USBD_RegisterClass (USBD_HandleTypeDef *pdev, USBD_ClassTypeDef *pclass)
 USBD_RegisterClass Link class driver to Device Core. More...
 
USBD_StatusTypeDef USBD_RunTestMode (USBD_HandleTypeDef *pdev)
 USBD_RunTestMode Launch test mode process. More...
 
USBD_StatusTypeDef USBD_SetClassConfig (USBD_HandleTypeDef *pdev, uint8_t cfgidx)
 USBD_SetClassConfig Configure device and start the interface. More...
 
USBD_StatusTypeDef USBD_ClrClassConfig (USBD_HandleTypeDef *pdev, uint8_t cfgidx)
 USBD_ClrClassConfig Clear current configuration. More...
 
USBD_StatusTypeDef USBD_LL_SetupStage (USBD_HandleTypeDef *pdev, uint8_t *psetup)
 USBD_SetupStage Handle the setup stage. More...
 
USBD_StatusTypeDef USBD_LL_DataOutStage (USBD_HandleTypeDef *pdev, uint8_t epnum, uint8_t *pdata)
 USBD_DataOutStage Handle data OUT stage. More...
 
USBD_StatusTypeDef USBD_LL_DataInStage (USBD_HandleTypeDef *pdev, uint8_t epnum, uint8_t *pdata)
 USBD_DataInStage Handle data in stage. More...
 
USBD_StatusTypeDef USBD_LL_Reset (USBD_HandleTypeDef *pdev)
 USBD_LL_Reset Handle Reset event. More...
 
USBD_StatusTypeDef USBD_LL_SetSpeed (USBD_HandleTypeDef *pdev, USBD_SpeedTypeDef speed)
 USBD_LL_Reset Handle Reset event. More...
 
USBD_StatusTypeDef USBD_LL_Suspend (USBD_HandleTypeDef *pdev)
 USBD_Suspend Handle Suspend event. More...
 
USBD_StatusTypeDef USBD_LL_Resume (USBD_HandleTypeDef *pdev)
 USBD_Resume Handle Resume event. More...
 
USBD_StatusTypeDef USBD_LL_SOF (USBD_HandleTypeDef *pdev)
 USBD_SOF Handle SOF event. More...
 
USBD_StatusTypeDef USBD_LL_IsoINIncomplete (USBD_HandleTypeDef *pdev, uint8_t epnum)
 USBD_IsoINIncomplete Handle iso in incomplete event. More...
 
USBD_StatusTypeDef USBD_LL_IsoOUTIncomplete (USBD_HandleTypeDef *pdev, uint8_t epnum)
 USBD_IsoOUTIncomplete Handle iso out incomplete event. More...
 
USBD_StatusTypeDef USBD_LL_DevConnected (USBD_HandleTypeDef *pdev)
 USBD_DevConnected Handle device connection event. More...
 
USBD_StatusTypeDef USBD_LL_DevDisconnected (USBD_HandleTypeDef *pdev)
 USBD_DevDisconnected Handle device disconnection event. More...
 
USBD_StatusTypeDef USBD_LL_Init (USBD_HandleTypeDef *pdev)
 Initializes the Low Level portion of the Device driver. More...
 
USBD_StatusTypeDef USBD_LL_DeInit (USBD_HandleTypeDef *pdev)
 De-Initializes the Low Level portion of the Device driver. More...
 
USBD_StatusTypeDef USBD_LL_Start (USBD_HandleTypeDef *pdev)
 Starts the Low Level portion of the Device driver. More...
 
USBD_StatusTypeDef USBD_LL_Stop (USBD_HandleTypeDef *pdev)
 Stops the Low Level portion of the Device driver. More...
 
USBD_StatusTypeDef USBD_LL_OpenEP (USBD_HandleTypeDef *pdev, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_mps)
 Opens an endpoint of the Low Level Driver. More...
 
USBD_StatusTypeDef USBD_LL_CloseEP (USBD_HandleTypeDef *pdev, uint8_t ep_addr)
 Closes an endpoint of the Low Level Driver. More...
 
USBD_StatusTypeDef USBD_LL_FlushEP (USBD_HandleTypeDef *pdev, uint8_t ep_addr)
 Flushes an endpoint of the Low Level Driver. More...
 
USBD_StatusTypeDef USBD_LL_StallEP (USBD_HandleTypeDef *pdev, uint8_t ep_addr)
 Sets a Stall condition on an endpoint of the Low Level Driver. More...
 
USBD_StatusTypeDef USBD_LL_ClearStallEP (USBD_HandleTypeDef *pdev, uint8_t ep_addr)
 Clears a Stall condition on an endpoint of the Low Level Driver. More...
 
uint8_t USBD_LL_IsStallEP (USBD_HandleTypeDef *pdev, uint8_t ep_addr)
 Returns Stall condition. More...
 
USBD_StatusTypeDef USBD_LL_SetUSBAddress (USBD_HandleTypeDef *pdev, uint8_t dev_addr)
 Assigns a USB address to the device. More...
 
USBD_StatusTypeDef USBD_LL_Transmit (USBD_HandleTypeDef *pdev, uint8_t ep_addr, uint8_t *pbuf, uint16_t size)
 Transmits data over an endpoint. More...
 
USBD_StatusTypeDef USBD_LL_PrepareReceive (USBD_HandleTypeDef *pdev, uint8_t ep_addr, uint8_t *pbuf, uint16_t size)
 Prepares an endpoint for reception. More...
 
uint32_t USBD_LL_GetRxDataSize (USBD_HandleTypeDef *pdev, uint8_t ep_addr)
 Returns the last transferred packet size. More...
 
void USBD_LL_Delay (uint32_t Delay)
 Delays routine for the USB Device Library. More...
 

Detailed Description

Function Documentation

USBD_StatusTypeDef USBD_ClrClassConfig ( USBD_HandleTypeDef pdev,
uint8_t  cfgidx 
)

USBD_ClrClassConfig Clear current configuration.

Parameters
pdevdevice instance
cfgidxconfiguration index
Return values
statusUSBD_StatusTypeDef
USBD_StatusTypeDef USBD_DeInit ( USBD_HandleTypeDef pdev)

USBD_DeInit Re-Initialize th device library.

Parameters
pdevdevice instance
Return values
statusstatus
USBD_StatusTypeDef USBD_Init ( USBD_HandleTypeDef pdev,
USBD_DescriptorsTypeDef pdesc,
uint8_t  id 
)

USBD_Init Initializes the device stack and load the class driver.

Parameters
pdevdevice instance
pdescDescriptor structure address
idLow level core index
Return values
None
USBD_StatusTypeDef USBD_LL_ClearStallEP ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr 
)

Clears a Stall condition on an endpoint of the Low Level Driver.

Parameters
pdevDevice handle
ep_addrEndpoint Number
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_CloseEP ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr 
)

Closes an endpoint of the Low Level Driver.

Parameters
pdevDevice handle
ep_addrEndpoint Number
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_DataInStage ( USBD_HandleTypeDef pdev,
uint8_t  epnum,
uint8_t *  pdata 
)

USBD_DataInStage Handle data in stage.

Parameters
pdevdevice instance
epnumendpoint index
Return values
status
USBD_StatusTypeDef USBD_LL_DataOutStage ( USBD_HandleTypeDef pdev,
uint8_t  epnum,
uint8_t *  pdata 
)

USBD_DataOutStage Handle data OUT stage.

Parameters
pdevdevice instance
epnumendpoint index
Return values
status
USBD_StatusTypeDef USBD_LL_DeInit ( USBD_HandleTypeDef pdev)

De-Initializes the Low Level portion of the Device driver.

Parameters
pdevDevice handle
Return values
USBDStatus
void USBD_LL_Delay ( uint32_t  Delay)

Delays routine for the USB Device Library.

Parameters
DelayDelay in ms
Return values
None
USBD_StatusTypeDef USBD_LL_DevConnected ( USBD_HandleTypeDef pdev)

USBD_DevConnected Handle device connection event.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_DevDisconnected ( USBD_HandleTypeDef pdev)

USBD_DevDisconnected Handle device disconnection event.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_FlushEP ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr 
)

Flushes an endpoint of the Low Level Driver.

Parameters
pdevDevice handle
ep_addrEndpoint Number
Return values
USBDStatus
uint32_t USBD_LL_GetRxDataSize ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr 
)

Returns the last transferred packet size.

Parameters
pdevDevice handle
ep_addrEndpoint Number
Return values
ReceivedData Size
USBD_StatusTypeDef USBD_LL_Init ( USBD_HandleTypeDef pdev)

Initializes the Low Level portion of the Device driver.

Parameters
pdevDevice handle
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_IsoINIncomplete ( USBD_HandleTypeDef pdev,
uint8_t  epnum 
)

USBD_IsoINIncomplete Handle iso in incomplete event.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_IsoOUTIncomplete ( USBD_HandleTypeDef pdev,
uint8_t  epnum 
)

USBD_IsoOUTIncomplete Handle iso out incomplete event.

Parameters
pdevdevice instance
Return values
status
uint8_t USBD_LL_IsStallEP ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr 
)

Returns Stall condition.

Parameters
pdevDevice handle
ep_addrEndpoint Number
Return values
Stall(1: Yes, 0: No)
USBD_StatusTypeDef USBD_LL_OpenEP ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr,
uint8_t  ep_type,
uint16_t  ep_mps 
)

Opens an endpoint of the Low Level Driver.

Parameters
pdevDevice handle
ep_addrEndpoint Number
ep_typeEndpoint Type
ep_mpsEndpoint Max Packet Size
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_PrepareReceive ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr,
uint8_t *  pbuf,
uint16_t  size 
)

Prepares an endpoint for reception.

Parameters
pdevDevice handle
ep_addrEndpoint Number
pbufPointer to data to be received
sizeData size
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_Reset ( USBD_HandleTypeDef pdev)

USBD_LL_Reset Handle Reset event.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_Resume ( USBD_HandleTypeDef pdev)

USBD_Resume Handle Resume event.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_SetSpeed ( USBD_HandleTypeDef pdev,
USBD_SpeedTypeDef  speed 
)

USBD_LL_Reset Handle Reset event.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_SetupStage ( USBD_HandleTypeDef pdev,
uint8_t *  psetup 
)

USBD_SetupStage Handle the setup stage.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_SetUSBAddress ( USBD_HandleTypeDef pdev,
uint8_t  dev_addr 
)

Assigns a USB address to the device.

Parameters
pdevDevice handle
ep_addrEndpoint Number
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_SOF ( USBD_HandleTypeDef pdev)

USBD_SOF Handle SOF event.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_StallEP ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr 
)

Sets a Stall condition on an endpoint of the Low Level Driver.

Parameters
pdevDevice handle
ep_addrEndpoint Number
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_Start ( USBD_HandleTypeDef pdev)

Starts the Low Level portion of the Device driver.

Parameters
pdevDevice handle
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_Stop ( USBD_HandleTypeDef pdev)

Stops the Low Level portion of the Device driver.

Parameters
pdevDevice handle
Return values
USBDStatus
USBD_StatusTypeDef USBD_LL_Suspend ( USBD_HandleTypeDef pdev)

USBD_Suspend Handle Suspend event.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_LL_Transmit ( USBD_HandleTypeDef pdev,
uint8_t  ep_addr,
uint8_t *  pbuf,
uint16_t  size 
)

Transmits data over an endpoint.

Parameters
pdevDevice handle
ep_addrEndpoint Number
pbufPointer to data to be sent
sizeData size
Return values
USBDStatus
USBD_StatusTypeDef USBD_RegisterClass ( USBD_HandleTypeDef pdev,
USBD_ClassTypeDef pclass 
)

USBD_RegisterClass Link class driver to Device Core.

Parameters
pDevice: Device Handle
pclassClass handle
Return values
USBDStatus
USBD_StatusTypeDef USBD_RunTestMode ( USBD_HandleTypeDef pdev)

USBD_RunTestMode Launch test mode process.

Parameters
pdevdevice instance
Return values
status
USBD_StatusTypeDef USBD_SetClassConfig ( USBD_HandleTypeDef pdev,
uint8_t  cfgidx 
)

USBD_SetClassConfig Configure device and start the interface.

Parameters
pdevdevice instance
cfgidxconfiguration index
Return values
status
USBD_StatusTypeDef USBD_Start ( USBD_HandleTypeDef pdev)

USBD_Start Start the USB Device Core.

Parameters
pdevDevice Handle
Return values
USBDStatus
USBD_StatusTypeDef USBD_Stop ( USBD_HandleTypeDef pdev)

USBD_Stop Stop the USB Device Core.

Parameters
pdevDevice Handle
Return values
USBDStatus