stm32f7xx_hal_pcd.h
Go to the documentation of this file.
1 
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef STM32F7xx_HAL_PCD_H
22 #define STM32F7xx_HAL_PCD_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32f7xx_ll_usb.h"
30 
31 #if defined (USB_OTG_FS) || defined (USB_OTG_HS)
32 
41 /* Exported types ------------------------------------------------------------*/
49 typedef enum
50 {
51  HAL_PCD_STATE_RESET = 0x00,
52  HAL_PCD_STATE_READY = 0x01,
53  HAL_PCD_STATE_ERROR = 0x02,
54  HAL_PCD_STATE_BUSY = 0x03,
55  HAL_PCD_STATE_TIMEOUT = 0x04
56 } PCD_StateTypeDef;
57 
58 /* Device LPM suspend state */
59 typedef enum
60 {
61  LPM_L0 = 0x00, /* on */
62  LPM_L1 = 0x01, /* LPM L1 sleep */
63  LPM_L2 = 0x02, /* suspend */
64  LPM_L3 = 0x03, /* off */
65 } PCD_LPM_StateTypeDef;
66 
67 typedef enum
68 {
69  PCD_LPM_L0_ACTIVE = 0x00, /* on */
70  PCD_LPM_L1_ACTIVE = 0x01, /* LPM L1 sleep */
71 } PCD_LPM_MsgTypeDef;
72 
73 typedef enum
74 {
75  PCD_BCD_ERROR = 0xFF,
76  PCD_BCD_CONTACT_DETECTION = 0xFE,
77  PCD_BCD_STD_DOWNSTREAM_PORT = 0xFD,
78  PCD_BCD_CHARGING_DOWNSTREAM_PORT = 0xFC,
79  PCD_BCD_DEDICATED_CHARGING_PORT = 0xFB,
80  PCD_BCD_DISCOVERY_COMPLETED = 0x00,
81 
82 } PCD_BCD_MsgTypeDef;
83 
84 #if defined (USB_OTG_FS) || defined (USB_OTG_HS)
85 typedef USB_OTG_GlobalTypeDef PCD_TypeDef;
86 typedef USB_OTG_CfgTypeDef PCD_InitTypeDef;
87 typedef USB_OTG_EPTypeDef PCD_EPTypeDef;
88 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
89 
93 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
94 typedef struct __PCD_HandleTypeDef
95 #else
96 typedef struct
97 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
98 {
99  PCD_TypeDef *Instance;
100  PCD_InitTypeDef Init;
101  __IO uint8_t USB_Address;
102  PCD_EPTypeDef IN_ep[16];
103  PCD_EPTypeDef OUT_ep[16];
104  HAL_LockTypeDef Lock;
105  __IO PCD_StateTypeDef State;
106  __IO uint32_t ErrorCode;
107  uint32_t Setup[12];
108  PCD_LPM_StateTypeDef LPM_State;
109  uint32_t BESL;
110 
111 
112  uint32_t lpm_active;
114  void *pData;
116 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
117  void (* SOFCallback)(struct __PCD_HandleTypeDef *hpcd);
118  void (* SetupStageCallback)(struct __PCD_HandleTypeDef *hpcd);
119  void (* ResetCallback)(struct __PCD_HandleTypeDef *hpcd);
120  void (* SuspendCallback)(struct __PCD_HandleTypeDef *hpcd);
121  void (* ResumeCallback)(struct __PCD_HandleTypeDef *hpcd);
122  void (* ConnectCallback)(struct __PCD_HandleTypeDef *hpcd);
123  void (* DisconnectCallback)(struct __PCD_HandleTypeDef *hpcd);
125  void (* DataOutStageCallback)(struct __PCD_HandleTypeDef *hpcd, uint8_t epnum);
126  void (* DataInStageCallback)(struct __PCD_HandleTypeDef *hpcd, uint8_t epnum);
127  void (* ISOOUTIncompleteCallback)(struct __PCD_HandleTypeDef *hpcd, uint8_t epnum);
128  void (* ISOINIncompleteCallback)(struct __PCD_HandleTypeDef *hpcd, uint8_t epnum);
129  void (* LPMCallback)(struct __PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg);
131  void (* MspInitCallback)(struct __PCD_HandleTypeDef *hpcd);
132  void (* MspDeInitCallback)(struct __PCD_HandleTypeDef *hpcd);
133 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
134 } PCD_HandleTypeDef;
135 
140 /* Include PCD HAL Extended module */
141 #include "stm32f7xx_hal_pcd_ex.h"
142 
143 /* Exported constants --------------------------------------------------------*/
151 #define PCD_SPEED_HIGH USBD_HS_SPEED
152 #define PCD_SPEED_HIGH_IN_FULL USBD_HSINFS_SPEED
153 #define PCD_SPEED_FULL USBD_FS_SPEED
154 
161 #define PCD_PHY_ULPI 1U
162 #define PCD_PHY_EMBEDDED 2U
163 #define PCD_PHY_UTMI 3U
164 
172 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
173 #define HAL_PCD_ERROR_INVALID_CALLBACK (0x00000010U)
174 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
175 
184 /* Exported macros -----------------------------------------------------------*/
189 #if defined (USB_OTG_FS) || defined (USB_OTG_HS)
190 #define __HAL_PCD_ENABLE(__HANDLE__) (void)USB_EnableGlobalInt ((__HANDLE__)->Instance)
191 #define __HAL_PCD_DISABLE(__HANDLE__) (void)USB_DisableGlobalInt ((__HANDLE__)->Instance)
192 
193 #define __HAL_PCD_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
194 #define __HAL_PCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) &= (__INTERRUPT__))
195 #define __HAL_PCD_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0U)
196 
197 
198 #define __HAL_PCD_UNGATE_PHYCLOCK(__HANDLE__) *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) &= \
199  ~(USB_OTG_PCGCCTL_STOPCLK)
200 
201 #define __HAL_PCD_GATE_PHYCLOCK(__HANDLE__) *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) |= USB_OTG_PCGCCTL_STOPCLK
202 
203 #define __HAL_PCD_IS_PHY_SUSPENDED(__HANDLE__) ((*(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE)) & 0x10U)
204 
205 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_IT() EXTI->IMR |= (USB_OTG_HS_WAKEUP_EXTI_LINE)
206 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_DISABLE_IT() EXTI->IMR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE)
207 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_GET_FLAG() EXTI->PR & (USB_OTG_HS_WAKEUP_EXTI_LINE)
208 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_CLEAR_FLAG() EXTI->PR = (USB_OTG_HS_WAKEUP_EXTI_LINE)
209 
210 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_EDGE() \
211  do { \
212  EXTI->FTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE); \
213  EXTI->RTSR |= USB_OTG_HS_WAKEUP_EXTI_LINE; \
214  } while(0U)
215 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_IT() EXTI->IMR |= USB_OTG_FS_WAKEUP_EXTI_LINE
216 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_DISABLE_IT() EXTI->IMR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE)
217 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_GET_FLAG() EXTI->PR & (USB_OTG_FS_WAKEUP_EXTI_LINE)
218 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_CLEAR_FLAG() EXTI->PR = USB_OTG_FS_WAKEUP_EXTI_LINE
219 
220 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_EDGE() \
221  do { \
222  EXTI->FTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE); \
223  EXTI->RTSR |= USB_OTG_FS_WAKEUP_EXTI_LINE; \
224  } while(0U)
225 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
226 
227 
232 /* Exported functions --------------------------------------------------------*/
237 /* Initialization/de-initialization functions ********************************/
241 HAL_StatusTypeDef HAL_PCD_Init(PCD_HandleTypeDef *hpcd);
242 HAL_StatusTypeDef HAL_PCD_DeInit(PCD_HandleTypeDef *hpcd);
243 void HAL_PCD_MspInit(PCD_HandleTypeDef *hpcd);
244 void HAL_PCD_MspDeInit(PCD_HandleTypeDef *hpcd);
245 
246 #if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
247 
251 typedef enum
252 {
253  HAL_PCD_SOF_CB_ID = 0x01,
254  HAL_PCD_SETUPSTAGE_CB_ID = 0x02,
255  HAL_PCD_RESET_CB_ID = 0x03,
256  HAL_PCD_SUSPEND_CB_ID = 0x04,
257  HAL_PCD_RESUME_CB_ID = 0x05,
258  HAL_PCD_CONNECT_CB_ID = 0x06,
259  HAL_PCD_DISCONNECT_CB_ID = 0x07,
261  HAL_PCD_MSPINIT_CB_ID = 0x08,
262  HAL_PCD_MSPDEINIT_CB_ID = 0x09
264 } HAL_PCD_CallbackIDTypeDef;
274 typedef void (*pPCD_CallbackTypeDef)(PCD_HandleTypeDef *hpcd);
275 typedef void (*pPCD_DataOutStageCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
276 typedef void (*pPCD_DataInStageCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
277 typedef void (*pPCD_IsoOutIncpltCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
278 typedef void (*pPCD_IsoInIncpltCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
279 typedef void (*pPCD_LpmCallbackTypeDef)(PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg);
285 HAL_StatusTypeDef HAL_PCD_RegisterCallback(PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID, pPCD_CallbackTypeDef pCallback);
286 HAL_StatusTypeDef HAL_PCD_UnRegisterCallback(PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID);
287 
288 HAL_StatusTypeDef HAL_PCD_RegisterDataOutStageCallback(PCD_HandleTypeDef *hpcd, pPCD_DataOutStageCallbackTypeDef pCallback);
289 HAL_StatusTypeDef HAL_PCD_UnRegisterDataOutStageCallback(PCD_HandleTypeDef *hpcd);
290 
291 HAL_StatusTypeDef HAL_PCD_RegisterDataInStageCallback(PCD_HandleTypeDef *hpcd, pPCD_DataInStageCallbackTypeDef pCallback);
292 HAL_StatusTypeDef HAL_PCD_UnRegisterDataInStageCallback(PCD_HandleTypeDef *hpcd);
293 
294 HAL_StatusTypeDef HAL_PCD_RegisterIsoOutIncpltCallback(PCD_HandleTypeDef *hpcd, pPCD_IsoOutIncpltCallbackTypeDef pCallback);
295 HAL_StatusTypeDef HAL_PCD_UnRegisterIsoOutIncpltCallback(PCD_HandleTypeDef *hpcd);
296 
297 HAL_StatusTypeDef HAL_PCD_RegisterIsoInIncpltCallback(PCD_HandleTypeDef *hpcd, pPCD_IsoInIncpltCallbackTypeDef pCallback);
298 HAL_StatusTypeDef HAL_PCD_UnRegisterIsoInIncpltCallback(PCD_HandleTypeDef *hpcd);
299 
300 HAL_StatusTypeDef HAL_PCD_RegisterLpmCallback(PCD_HandleTypeDef *hpcd, pPCD_LpmCallbackTypeDef pCallback);
301 HAL_StatusTypeDef HAL_PCD_UnRegisterLpmCallback(PCD_HandleTypeDef *hpcd);
302 #endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
303 
307 /* I/O operation functions ***************************************************/
308 /* Non-Blocking mode: Interrupt */
312 HAL_StatusTypeDef HAL_PCD_Start(PCD_HandleTypeDef *hpcd);
313 HAL_StatusTypeDef HAL_PCD_Stop(PCD_HandleTypeDef *hpcd);
314 void HAL_PCD_IRQHandler(PCD_HandleTypeDef *hpcd);
315 
316 void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd);
317 void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd);
318 void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd);
319 void HAL_PCD_SuspendCallback(PCD_HandleTypeDef *hpcd);
320 void HAL_PCD_ResumeCallback(PCD_HandleTypeDef *hpcd);
321 void HAL_PCD_ConnectCallback(PCD_HandleTypeDef *hpcd);
322 void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd);
323 
324 void HAL_PCD_DataOutStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
325 void HAL_PCD_DataInStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
326 void HAL_PCD_ISOOUTIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
327 void HAL_PCD_ISOINIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
332 /* Peripheral Control functions **********************************************/
336 HAL_StatusTypeDef HAL_PCD_DevConnect(PCD_HandleTypeDef *hpcd);
337 HAL_StatusTypeDef HAL_PCD_DevDisconnect(PCD_HandleTypeDef *hpcd);
338 HAL_StatusTypeDef HAL_PCD_SetAddress(PCD_HandleTypeDef *hpcd, uint8_t address);
339 HAL_StatusTypeDef HAL_PCD_EP_Open(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type);
340 HAL_StatusTypeDef HAL_PCD_EP_Close(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
341 HAL_StatusTypeDef HAL_PCD_EP_Receive(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
342 HAL_StatusTypeDef HAL_PCD_EP_Transmit(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
343 uint32_t HAL_PCD_EP_GetRxCount(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
344 HAL_StatusTypeDef HAL_PCD_EP_SetStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
345 HAL_StatusTypeDef HAL_PCD_EP_ClrStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
346 HAL_StatusTypeDef HAL_PCD_EP_Flush(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
347 HAL_StatusTypeDef HAL_PCD_ActivateRemoteWakeup(PCD_HandleTypeDef *hpcd);
348 HAL_StatusTypeDef HAL_PCD_DeActivateRemoteWakeup(PCD_HandleTypeDef *hpcd);
353 /* Peripheral State functions ************************************************/
357 PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef *hpcd);
366 /* Private constants ---------------------------------------------------------*/
373 #if defined (USB_OTG_FS) || defined (USB_OTG_HS)
374 #define USB_OTG_FS_WAKEUP_EXTI_LINE (0x1U << 18)
375 #define USB_OTG_HS_WAKEUP_EXTI_LINE (0x1U << 20)
376 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
377 
378 
386 #if defined (USB_OTG_FS) || defined (USB_OTG_HS)
387 #ifndef USB_OTG_DOEPINT_OTEPSPR
388 #define USB_OTG_DOEPINT_OTEPSPR (0x1UL << 5)
389 #endif
390 
391 #ifndef USB_OTG_DOEPMSK_OTEPSPRM
392 #define USB_OTG_DOEPMSK_OTEPSPRM (0x1UL << 5)
393 #endif
394 
395 #ifndef USB_OTG_DOEPINT_NAK
396 #define USB_OTG_DOEPINT_NAK (0x1UL << 13)
397 #endif
398 
399 #ifndef USB_OTG_DOEPMSK_NAKM
400 #define USB_OTG_DOEPMSK_NAKM (0x1UL << 13)
401 #endif
402 
403 #ifndef USB_OTG_DOEPINT_STPKTRX
404 #define USB_OTG_DOEPINT_STPKTRX (0x1UL << 15)
405 #endif
406 
407 #ifndef USB_OTG_DOEPMSK_NYETM
408 #define USB_OTG_DOEPMSK_NYETM (0x1UL << 14)
409 #endif
410 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
411 
412 /* Private macros ------------------------------------------------------------*/
428 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
429 
430 #ifdef __cplusplus
431 }
432 #endif
433 
434 #endif /* STM32F7xx_HAL_PCD_H */
435 
436 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
__IO
#define __IO
Definition: imxrt1050/imxrt1050-evkb/CMSIS/core_cm7.h:237
Init
napi_value Init(napi_env env, napi_value exports)
Definition: porcupine/demo/c/pvrecorder/node/pv_recorder_napi.c:197
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h:40
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h:51
USB_OTG_GlobalTypeDef
USB_OTG_Core_Registers.
Definition: stm32f407xx.h:794
stm32f7xx_hal_pcd_ex.h
Header file of PCD HAL Extension module.

picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:14:53