20#ifndef STM32H7xx_HAL_PCD_H
21#define STM32H7xx_HAL_PCD_H
30#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
50 HAL_PCD_STATE_RESET = 0x00,
51 HAL_PCD_STATE_READY = 0x01,
52 HAL_PCD_STATE_ERROR = 0x02,
53 HAL_PCD_STATE_BUSY = 0x03,
54 HAL_PCD_STATE_TIMEOUT = 0x04
64} PCD_LPM_StateTypeDef;
68 PCD_LPM_L0_ACTIVE = 0x00,
69 PCD_LPM_L1_ACTIVE = 0x01,
75 PCD_BCD_CONTACT_DETECTION = 0xFE,
76 PCD_BCD_STD_DOWNSTREAM_PORT = 0xFD,
77 PCD_BCD_CHARGING_DOWNSTREAM_PORT = 0xFC,
78 PCD_BCD_DEDICATED_CHARGING_PORT = 0xFB,
79 PCD_BCD_DISCOVERY_COMPLETED = 0x00,
83#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
85typedef USB_OTG_CfgTypeDef PCD_InitTypeDef;
86typedef USB_OTG_EPTypeDef PCD_EPTypeDef;
92#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
93typedef struct __PCD_HandleTypeDef
98 PCD_TypeDef *Instance;
100 __IO uint8_t USB_Address;
101 PCD_EPTypeDef IN_ep[16];
102 PCD_EPTypeDef OUT_ep[16];
105 __IO uint32_t ErrorCode;
107 PCD_LPM_StateTypeDef LPM_State;
109 uint32_t FrameNumber;
115 uint32_t battery_charging_active;
119#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
120 void (* SOFCallback)(
struct __PCD_HandleTypeDef *hpcd);
121 void (* SetupStageCallback)(
struct __PCD_HandleTypeDef *hpcd);
122 void (* ResetCallback)(
struct __PCD_HandleTypeDef *hpcd);
123 void (* SuspendCallback)(
struct __PCD_HandleTypeDef *hpcd);
124 void (* ResumeCallback)(
struct __PCD_HandleTypeDef *hpcd);
125 void (* ConnectCallback)(
struct __PCD_HandleTypeDef *hpcd);
126 void (* DisconnectCallback)(
struct __PCD_HandleTypeDef *hpcd);
128 void (* DataOutStageCallback)(
struct __PCD_HandleTypeDef *hpcd, uint8_t epnum);
129 void (* DataInStageCallback)(
struct __PCD_HandleTypeDef *hpcd, uint8_t epnum);
130 void (* ISOOUTIncompleteCallback)(
struct __PCD_HandleTypeDef *hpcd, uint8_t epnum);
131 void (* ISOINIncompleteCallback)(
struct __PCD_HandleTypeDef *hpcd, uint8_t epnum);
132 void (* BCDCallback)(
struct __PCD_HandleTypeDef *hpcd, PCD_BCD_MsgTypeDef msg);
133 void (* LPMCallback)(
struct __PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg);
135 void (* MspInitCallback)(
struct __PCD_HandleTypeDef *hpcd);
136 void (* MspDeInitCallback)(
struct __PCD_HandleTypeDef *hpcd);
155#define PCD_SPEED_HIGH USBD_HS_SPEED
156#define PCD_SPEED_HIGH_IN_FULL USBD_HSINFS_SPEED
157#define PCD_SPEED_FULL USBD_FS_SPEED
165#define PCD_PHY_ULPI 1U
166#define PCD_PHY_EMBEDDED 2U
167#define PCD_PHY_UTMI 3U
176#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
177#define HAL_PCD_ERROR_INVALID_CALLBACK (0x00000010U)
193#define __HAL_PCD_ENABLE(__HANDLE__) (void)USB_EnableGlobalInt ((__HANDLE__)->Instance)
194#define __HAL_PCD_DISABLE(__HANDLE__) (void)USB_DisableGlobalInt ((__HANDLE__)->Instance)
196#define __HAL_PCD_GET_FLAG(__HANDLE__, __INTERRUPT__) \
197 ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
199#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
200#define __HAL_PCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) &= (__INTERRUPT__))
201#define __HAL_PCD_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0U)
203#define __HAL_PCD_UNGATE_PHYCLOCK(__HANDLE__) \
204 *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) &= ~(USB_OTG_PCGCCTL_STOPCLK)
206#define __HAL_PCD_GATE_PHYCLOCK(__HANDLE__) \
207 *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) |= USB_OTG_PCGCCTL_STOPCLK
209#define __HAL_PCD_IS_PHY_SUSPENDED(__HANDLE__) \
210 ((*(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE)) & 0x10U)
212#define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_IT() EXTI_D1->IMR2 |= (USB_OTG_HS_WAKEUP_EXTI_LINE)
213#define __HAL_USB_OTG_HS_WAKEUP_EXTI_DISABLE_IT() EXTI_D1->IMR2 &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE)
214#define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_IT() EXTI_D1->IMR2 |= (USB_OTG_FS_WAKEUP_EXTI_LINE)
215#define __HAL_USB_OTG_FS_WAKEUP_EXTI_DISABLE_IT() EXTI_D1->IMR2 &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE)
237#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
244 HAL_PCD_SOF_CB_ID = 0x01,
245 HAL_PCD_SETUPSTAGE_CB_ID = 0x02,
246 HAL_PCD_RESET_CB_ID = 0x03,
247 HAL_PCD_SUSPEND_CB_ID = 0x04,
248 HAL_PCD_RESUME_CB_ID = 0x05,
249 HAL_PCD_CONNECT_CB_ID = 0x06,
250 HAL_PCD_DISCONNECT_CB_ID = 0x07,
252 HAL_PCD_MSPINIT_CB_ID = 0x08,
253 HAL_PCD_MSPDEINIT_CB_ID = 0x09
255} HAL_PCD_CallbackIDTypeDef;
265typedef void (*pPCD_CallbackTypeDef)(PCD_HandleTypeDef *hpcd);
266typedef void (*pPCD_DataOutStageCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
267typedef void (*pPCD_DataInStageCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
268typedef void (*pPCD_IsoOutIncpltCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
269typedef void (*pPCD_IsoInIncpltCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
270typedef void (*pPCD_LpmCallbackTypeDef)(PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg);
271typedef void (*pPCD_BcdCallbackTypeDef)(PCD_HandleTypeDef *hpcd, PCD_BCD_MsgTypeDef msg);
277HAL_StatusTypeDef HAL_PCD_RegisterCallback(PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID,
278 pPCD_CallbackTypeDef pCallback);
280HAL_StatusTypeDef HAL_PCD_UnRegisterCallback(PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID);
283 pPCD_DataOutStageCallbackTypeDef pCallback);
285HAL_StatusTypeDef HAL_PCD_UnRegisterDataOutStageCallback(PCD_HandleTypeDef *hpcd);
288 pPCD_DataInStageCallbackTypeDef pCallback);
293 pPCD_IsoOutIncpltCallbackTypeDef pCallback);
295HAL_StatusTypeDef HAL_PCD_UnRegisterIsoOutIncpltCallback(PCD_HandleTypeDef *hpcd);
298 pPCD_IsoInIncpltCallbackTypeDef pCallback);
302HAL_StatusTypeDef HAL_PCD_RegisterBcdCallback(PCD_HandleTypeDef *hpcd, pPCD_BcdCallbackTypeDef pCallback);
305HAL_StatusTypeDef HAL_PCD_RegisterLpmCallback(PCD_HandleTypeDef *hpcd, pPCD_LpmCallbackTypeDef pCallback);
319void HAL_PCD_IRQHandler(PCD_HandleTypeDef *hpcd);
344HAL_StatusTypeDef HAL_PCD_EP_Open(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type);
346HAL_StatusTypeDef HAL_PCD_EP_Receive(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
347HAL_StatusTypeDef HAL_PCD_EP_Transmit(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
354#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
355HAL_StatusTypeDef HAL_PCD_SetTestMode(
const PCD_HandleTypeDef *hpcd, uint8_t testmode);
358uint32_t HAL_PCD_EP_GetRxCount(PCD_HandleTypeDef
const *hpcd, uint8_t ep_addr);
367PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef
const *hpcd);
383#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
384#define USB_OTG_FS_WAKEUP_EXTI_LINE (0x1UL << 12)
385#define USB_OTG_HS_WAKEUP_EXTI_LINE (0x1UL << 11)
396#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
397#ifndef USB_OTG_DOEPINT_OTEPSPR
398#define USB_OTG_DOEPINT_OTEPSPR (0x1UL << 5)
401#ifndef USB_OTG_DOEPMSK_OTEPSPRM
402#define USB_OTG_DOEPMSK_OTEPSPRM (0x1UL << 5)
405#ifndef USB_OTG_DOEPINT_NAK
406#define USB_OTG_DOEPINT_NAK (0x1UL << 13)
409#ifndef USB_OTG_DOEPMSK_NAKM
410#define USB_OTG_DOEPMSK_NAKM (0x1UL << 13)
413#ifndef USB_OTG_DOEPINT_STPKTRX
414#define USB_OTG_DOEPINT_STPKTRX (0x1UL << 15)
417#ifndef USB_OTG_DOEPMSK_NYETM
418#define USB_OTG_DOEPMSK_NYETM (0x1UL << 14)
#define __IO
Defines 'read / write' permissions.
HAL_StatusTypeDef
HAL Status structures definition.
HAL_LockTypeDef
HAL Lock structures definition.
Header file of PCD HAL Extension module.
Header file of USB Low Layer HAL module.
void HAL_PCD_ResumeCallback(PCD_HandleTypeDef *hpcd)
Resume callback.
void HAL_PCD_MspDeInit(PCD_HandleTypeDef *pcdHandle)
void HAL_PCD_ConnectCallback(PCD_HandleTypeDef *hpcd)
Connect callback.
void HAL_PCD_SuspendCallback(PCD_HandleTypeDef *hpcd)
Suspend callback.
void HAL_PCD_DataInStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum)
Data In stage callback.
void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd)
Disconnect callback.
void HAL_PCD_DataOutStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum)
Data Out stage callback.
void HAL_PCD_ISOOUTIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum)
ISOOUTIncomplete callback.
void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd)
SOF callback.
void HAL_PCD_ISOINIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum)
ISOINIncomplete callback.
void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd)
Setup stage callback.
void HAL_PCD_MspInit(PCD_HandleTypeDef *pcdHandle)
void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd)
Reset callback.