stm32f4xx_hal_pcd.h File Reference

Header file of PCD HAL module. More...

#include "stm32f4xx_ll_usb.h"
#include "stm32f4xx_hal_pcd_ex.h"

Go to the source code of this file.

Data Structures
struct	PCD_HandleTypeDef
	PCD Handle Structure definition. More...
Defines
#define	PCD_SPEED_HIGH   0U
#define	PCD_SPEED_HIGH_IN_FULL   1U
#define	PCD_SPEED_FULL   2U
#define	PCD_PHY_ULPI   1U
#define	PCD_PHY_EMBEDDED   2U
#define	USBD_HS_TRDT_VALUE   9U
#define	USBD_FS_TRDT_VALUE   5U
#define	__HAL_PCD_ENABLE(__HANDLE__)   USB_EnableGlobalInt ((__HANDLE__)->Instance)
#define	__HAL_PCD_DISABLE(__HANDLE__)   USB_DisableGlobalInt ((__HANDLE__)->Instance)
#define	__HAL_PCD_GET_FLAG(__HANDLE__, __INTERRUPT__)   ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
#define	__HAL_PCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->GINTSTS) &= (__INTERRUPT__))
#define	__HAL_PCD_IS_INVALID_INTERRUPT(__HANDLE__)   (USB_ReadInterrupts((__HANDLE__)->Instance) == 0U)
#define	__HAL_PCD_UNGATE_PHYCLOCK(__HANDLE__)
#define	__HAL_PCD_GATE_PHYCLOCK(__HANDLE__)   *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) |= USB_OTG_PCGCCTL_STOPCLK
#define	__HAL_PCD_IS_PHY_SUSPENDED(__HANDLE__)   ((*(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE))&0x10U)
#define	USB_OTG_FS_WAKEUP_EXTI_RISING_EDGE   0x08U
#define	USB_OTG_FS_WAKEUP_EXTI_FALLING_EDGE   0x0CU
#define	USB_OTG_FS_WAKEUP_EXTI_RISING_FALLING_EDGE   0x10U
#define	USB_OTG_HS_WAKEUP_EXTI_RISING_EDGE   0x08U
#define	USB_OTG_HS_WAKEUP_EXTI_FALLING_EDGE   0x0CU
#define	USB_OTG_HS_WAKEUP_EXTI_RISING_FALLING_EDGE   0x10U
#define	USB_OTG_HS_WAKEUP_EXTI_LINE   0x00100000U
#define	USB_OTG_FS_WAKEUP_EXTI_LINE   0x00040000U
#define	__HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_IT()   EXTI->IMR |= (USB_OTG_HS_WAKEUP_EXTI_LINE)
#define	__HAL_USB_OTG_HS_WAKEUP_EXTI_DISABLE_IT()   EXTI->IMR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE)
#define	__HAL_USB_OTG_HS_WAKEUP_EXTI_GET_FLAG()   EXTI->PR & (USB_OTG_HS_WAKEUP_EXTI_LINE)
#define	__HAL_USB_OTG_HS_WAKEUP_EXTI_CLEAR_FLAG()   EXTI->PR = (USB_OTG_HS_WAKEUP_EXTI_LINE)
#define	__HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_EDGE()
#define	__HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_FALLING_EDGE()
#define	__HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE()
#define	__HAL_USB_OTG_HS_WAKEUP_EXTI_GENERATE_SWIT()   (EXTI->SWIER |= USB_OTG_FS_WAKEUP_EXTI_LINE)
#define	__HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_IT()   EXTI->IMR |= USB_OTG_FS_WAKEUP_EXTI_LINE
#define	__HAL_USB_OTG_FS_WAKEUP_EXTI_DISABLE_IT()   EXTI->IMR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE)
#define	__HAL_USB_OTG_FS_WAKEUP_EXTI_GET_FLAG()   EXTI->PR & (USB_OTG_FS_WAKEUP_EXTI_LINE)
#define	__HAL_USB_OTG_FS_WAKEUP_EXTI_CLEAR_FLAG()   EXTI->PR = USB_OTG_FS_WAKEUP_EXTI_LINE
#define	__HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_EDGE()
#define	__HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_FALLING_EDGE()
#define	__HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE()
#define	__HAL_USB_OTG_FS_WAKEUP_EXTI_GENERATE_SWIT()   (EXTI->SWIER |= USB_OTG_FS_WAKEUP_EXTI_LINE)
Typedefs
typedef USB_OTG_GlobalTypeDef	PCD_TypeDef
typedef USB_OTG_CfgTypeDef	PCD_InitTypeDef
typedef USB_OTG_EPTypeDef	PCD_EPTypeDef
Enumerations
enum	PCD_StateTypeDef {   HAL_PCD_STATE_RESET = 0x00U, HAL_PCD_STATE_READY = 0x01U, HAL_PCD_STATE_ERROR = 0x02U, HAL_PCD_STATE_BUSY = 0x03U,   HAL_PCD_STATE_TIMEOUT = 0x04U }
	PCD State structure definition. More...
Functions
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_Start (PCD_HandleTypeDef *hpcd)
	Start The USB OTG Device.
HAL_StatusTypeDef	HAL_PCD_Stop (PCD_HandleTypeDef *hpcd)
	Stop The USB OTG Device.
void	HAL_PCD_IRQHandler (PCD_HandleTypeDef *hpcd)
	Handles PCD 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.
HAL_StatusTypeDef	HAL_PCD_EP_Transmit (PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len)
	Send an amount of data.
uint16_t	HAL_PCD_EP_GetRxCount (PCD_HandleTypeDef *hpcd, uint8_t ep_addr)
	Get Received Data Size.
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.

---

Detailed Description

Header file of PCD HAL module.

Author:

MCD Application Team

Attention:

© COPYRIGHT(c) 2017 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_pcd.h.