|
STM32F479xx HAL User Manual
|
PCD HAL module driver. This file provides firmware functions to manage the following functionalities of the USB Peripheral Controller: + Initialization and de-initialization functions + IO operation functions + Peripheral Control functions + Peripheral State functions. More...
#include "stm32f4xx_hal.h"Go to the source code of this file.
Defines | |
| #define | PCD_MIN(a, b) (((a) < (b)) ? (a) : (b)) |
| #define | PCD_MAX(a, b) (((a) > (b)) ? (a) : (b)) |
Functions | |
| static HAL_StatusTypeDef | PCD_WriteEmptyTxFifo (PCD_HandleTypeDef *hpcd, uint32_t epnum) |
| Check FIFO for the next packet to be loaded. | |
| static HAL_StatusTypeDef | PCD_EP_OutXfrComplete_int (PCD_HandleTypeDef *hpcd, uint32_t epnum) |
| process EP OUT transfer complete interrupt. | |
| static HAL_StatusTypeDef | PCD_EP_OutSetupPacket_int (PCD_HandleTypeDef *hpcd, uint32_t epnum) |
| process EP OUT setup packet received interrupt. | |
| HAL_StatusTypeDef | HAL_PCD_Init (PCD_HandleTypeDef *hpcd) |
| Initializes the PCD according to the specified parameters in the PCD_InitTypeDef and initialize the associated handle. | |
| HAL_StatusTypeDef | HAL_PCD_DeInit (PCD_HandleTypeDef *hpcd) |
| DeInitializes the PCD peripheral. | |
| __weak void | HAL_PCD_MspInit (PCD_HandleTypeDef *hpcd) |
| Initializes the PCD MSP. | |
| __weak void | HAL_PCD_MspDeInit (PCD_HandleTypeDef *hpcd) |
| DeInitializes PCD MSP. | |
| HAL_StatusTypeDef | HAL_PCD_RegisterCallback (PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID, pPCD_CallbackTypeDef pCallback) |
| Register a User USB PCD Callback To be used instead of the weak predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_UnRegisterCallback (PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID) |
| Unregister an USB PCD Callback USB PCD callabck is redirected to the weak predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_RegisterDataOutStageCallback (PCD_HandleTypeDef *hpcd, pPCD_DataOutStageCallbackTypeDef pCallback) |
| Register USB PCD Data OUT Stage Callback To be used instead of the weak HAL_PCD_DataOutStageCallback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_UnRegisterDataOutStageCallback (PCD_HandleTypeDef *hpcd) |
| Unregister the USB PCD Data OUT Stage Callback USB PCD Data OUT Stage Callback is redirected to the weak HAL_PCD_DataOutStageCallback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_RegisterDataInStageCallback (PCD_HandleTypeDef *hpcd, pPCD_DataInStageCallbackTypeDef pCallback) |
| Register USB PCD Data IN Stage Callback To be used instead of the weak HAL_PCD_DataInStageCallback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_UnRegisterDataInStageCallback (PCD_HandleTypeDef *hpcd) |
| Unregister the USB PCD Data IN Stage Callback USB PCD Data OUT Stage Callback is redirected to the weak HAL_PCD_DataInStageCallback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_RegisterIsoOutIncpltCallback (PCD_HandleTypeDef *hpcd, pPCD_IsoOutIncpltCallbackTypeDef pCallback) |
| Register USB PCD Iso OUT incomplete Callback To be used instead of the weak HAL_PCD_ISOOUTIncompleteCallback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_UnRegisterIsoOutIncpltCallback (PCD_HandleTypeDef *hpcd) |
| Unregister the USB PCD Iso OUT incomplete Callback USB PCD Iso OUT incomplete Callback is redirected to the weak HAL_PCD_ISOOUTIncompleteCallback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_RegisterIsoInIncpltCallback (PCD_HandleTypeDef *hpcd, pPCD_IsoInIncpltCallbackTypeDef pCallback) |
| Register USB PCD Iso IN incomplete Callback To be used instead of the weak HAL_PCD_ISOINIncompleteCallback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_UnRegisterIsoInIncpltCallback (PCD_HandleTypeDef *hpcd) |
| Unregister the USB PCD Iso IN incomplete Callback USB PCD Iso IN incomplete Callback is redirected to the weak HAL_PCD_ISOINIncompleteCallback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_RegisterBcdCallback (PCD_HandleTypeDef *hpcd, pPCD_BcdCallbackTypeDef pCallback) |
| Register USB PCD BCD Callback To be used instead of the weak HAL_PCDEx_BCD_Callback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_UnRegisterBcdCallback (PCD_HandleTypeDef *hpcd) |
| Unregister the USB PCD BCD Callback USB BCD Callback is redirected to the weak HAL_PCDEx_BCD_Callback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_RegisterLpmCallback (PCD_HandleTypeDef *hpcd, pPCD_LpmCallbackTypeDef pCallback) |
| Register USB PCD LPM Callback To be used instead of the weak HAL_PCDEx_LPM_Callback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_UnRegisterLpmCallback (PCD_HandleTypeDef *hpcd) |
| Unregister the USB PCD LPM Callback USB LPM Callback is redirected to the weak HAL_PCDEx_LPM_Callback() predefined callback. | |
| HAL_StatusTypeDef | HAL_PCD_Start (PCD_HandleTypeDef *hpcd) |
| Start the USB device. | |
| HAL_StatusTypeDef | HAL_PCD_Stop (PCD_HandleTypeDef *hpcd) |
| Stop the USB device. | |
| void | HAL_PCD_IRQHandler (PCD_HandleTypeDef *hpcd) |
| Handles PCD interrupt request. | |
| void | HAL_PCD_WKUP_IRQHandler (PCD_HandleTypeDef *hpcd) |
| Handles PCD Wakeup interrupt request. | |
| __weak void | HAL_PCD_DataOutStageCallback (PCD_HandleTypeDef *hpcd, uint8_t epnum) |
| Data OUT stage callback. | |
| __weak void | HAL_PCD_DataInStageCallback (PCD_HandleTypeDef *hpcd, uint8_t epnum) |
| Data IN stage callback. | |
| __weak void | HAL_PCD_SetupStageCallback (PCD_HandleTypeDef *hpcd) |
| Setup stage callback. | |
| __weak void | HAL_PCD_SOFCallback (PCD_HandleTypeDef *hpcd) |
| USB Start Of Frame callback. | |
| __weak void | HAL_PCD_ResetCallback (PCD_HandleTypeDef *hpcd) |
| USB Reset callback. | |
| __weak void | HAL_PCD_SuspendCallback (PCD_HandleTypeDef *hpcd) |
| Suspend event callback. | |
| __weak void | HAL_PCD_ResumeCallback (PCD_HandleTypeDef *hpcd) |
| Resume event callback. | |
| __weak void | HAL_PCD_ISOOUTIncompleteCallback (PCD_HandleTypeDef *hpcd, uint8_t epnum) |
| Incomplete ISO OUT callback. | |
| __weak void | HAL_PCD_ISOINIncompleteCallback (PCD_HandleTypeDef *hpcd, uint8_t epnum) |
| Incomplete ISO IN callback. | |
| __weak void | HAL_PCD_ConnectCallback (PCD_HandleTypeDef *hpcd) |
| Connection event callback. | |
| __weak void | HAL_PCD_DisconnectCallback (PCD_HandleTypeDef *hpcd) |
| Disconnection event callback. | |
| HAL_StatusTypeDef | HAL_PCD_DevConnect (PCD_HandleTypeDef *hpcd) |
| Connect the USB device. | |
| HAL_StatusTypeDef | HAL_PCD_DevDisconnect (PCD_HandleTypeDef *hpcd) |
| Disconnect the USB device. | |
| HAL_StatusTypeDef | HAL_PCD_SetAddress (PCD_HandleTypeDef *hpcd, uint8_t address) |
| Set the USB Device address. | |
| HAL_StatusTypeDef | HAL_PCD_EP_Open (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type) |
| Open and configure an endpoint. | |
| HAL_StatusTypeDef | HAL_PCD_EP_Close (PCD_HandleTypeDef *hpcd, uint8_t ep_addr) |
| Deactivate an endpoint. | |
| HAL_StatusTypeDef | HAL_PCD_EP_Receive (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len) |
| Receive an amount of data. | |
| uint32_t | HAL_PCD_EP_GetRxCount (PCD_HandleTypeDef *hpcd, uint8_t ep_addr) |
| Get Received Data Size. | |
| HAL_StatusTypeDef | HAL_PCD_EP_Transmit (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len) |
| Send an amount of data. | |
| HAL_StatusTypeDef | HAL_PCD_EP_SetStall (PCD_HandleTypeDef *hpcd, uint8_t ep_addr) |
| Set a STALL condition over an endpoint. | |
| HAL_StatusTypeDef | HAL_PCD_EP_ClrStall (PCD_HandleTypeDef *hpcd, uint8_t ep_addr) |
| Clear a STALL condition over in an endpoint. | |
| HAL_StatusTypeDef | HAL_PCD_EP_Flush (PCD_HandleTypeDef *hpcd, uint8_t ep_addr) |
| Flush an endpoint. | |
| HAL_StatusTypeDef | HAL_PCD_ActivateRemoteWakeup (PCD_HandleTypeDef *hpcd) |
| Activate remote wakeup signalling. | |
| HAL_StatusTypeDef | HAL_PCD_DeActivateRemoteWakeup (PCD_HandleTypeDef *hpcd) |
| De-activate remote wakeup signalling. | |
| PCD_StateTypeDef | HAL_PCD_GetState (PCD_HandleTypeDef *hpcd) |
| Return the PCD handle state. | |
PCD HAL module driver. This file provides firmware functions to manage the following functionalities of the USB Peripheral Controller: + Initialization and de-initialization functions + IO operation functions + Peripheral Control functions + Peripheral State functions.
Copyright (c) 2016 STMicroelectronics. All rights reserved.
This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.
==============================================================================
##### How to use this driver #####
==============================================================================
[..]
The PCD HAL driver can be used as follows:
(#) Declare a PCD_HandleTypeDef handle structure, for example:
PCD_HandleTypeDef hpcd;
(#) Fill parameters of Init structure in HCD handle
(#) Call HAL_PCD_Init() API to initialize the PCD peripheral (Core, Device core, ...)
(#) Initialize the PCD low level resources through the HAL_PCD_MspInit() API:
(##) Enable the PCD/USB Low Level interface clock using
(+++) __HAL_RCC_USB_OTG_FS_CLK_ENABLE();
(+++) __HAL_RCC_USB_OTG_HS_CLK_ENABLE(); (For High Speed Mode)
(##) Initialize the related GPIO clocks
(##) Configure PCD pin-out
(##) Configure PCD NVIC interrupt
(#)Associate the Upper USB device stack to the HAL PCD Driver:
(##) hpcd.pData = pdev;
(#)Enable PCD transmission and reception:
(##) HAL_PCD_Start();
Definition in file stm32f4xx_hal_pcd.c.
1.7.6.1