STM32F4xx HAL Driver master
STM32CubeF4 HAL / LL Drivers API Reference
Loading...
Searching...
No Matches
stm32f4xx_hal_pcd.h
Go to the documentation of this file.
1
18
19/* Define to prevent recursive inclusion -------------------------------------*/
20#ifndef STM32F4xx_HAL_PCD_H
21#define STM32F4xx_HAL_PCD_H
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27/* Includes ------------------------------------------------------------------*/
28#include "stm32f4xx_ll_usb.h"
29
30#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
31
35
39
40/* Exported types ------------------------------------------------------------*/
44
48typedef enum
49{
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
55} PCD_StateTypeDef;
56
57/* Device LPM suspend state */
58typedef enum
59{
60 LPM_L0 = 0x00, /* on */
61 LPM_L1 = 0x01, /* LPM L1 sleep */
62 LPM_L2 = 0x02, /* suspend */
63 LPM_L3 = 0x03, /* off */
64} PCD_LPM_StateTypeDef;
65
66typedef enum
67{
68 PCD_LPM_L0_ACTIVE = 0x00, /* on */
69 PCD_LPM_L1_ACTIVE = 0x01, /* LPM L1 sleep */
70} PCD_LPM_MsgTypeDef;
71
72typedef enum
73{
74 PCD_BCD_ERROR = 0xFF,
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,
80
81} PCD_BCD_MsgTypeDef;
82
83#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
84typedef USB_OTG_GlobalTypeDef PCD_TypeDef;
85typedef USB_OTG_CfgTypeDef PCD_InitTypeDef;
86typedef USB_OTG_EPTypeDef PCD_EPTypeDef;
87#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
88
92#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
93typedef struct __PCD_HandleTypeDef
94#else
95typedef struct
96#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
97{
98 PCD_TypeDef *Instance;
99 PCD_InitTypeDef Init;
100 __IO uint8_t USB_Address;
101 PCD_EPTypeDef IN_ep[16];
102 PCD_EPTypeDef OUT_ep[16];
103 HAL_LockTypeDef Lock;
104 __IO PCD_StateTypeDef State;
105 __IO uint32_t ErrorCode;
106 uint32_t Setup[12];
107 PCD_LPM_StateTypeDef LPM_State;
108 uint32_t BESL;
109 uint32_t FrameNumber;
110
111
112 uint32_t lpm_active;
114
115 uint32_t battery_charging_active;
117 void *pData;
118
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);
127
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);
134
135 void (* MspInitCallback)(struct __PCD_HandleTypeDef *hpcd);
136 void (* MspDeInitCallback)(struct __PCD_HandleTypeDef *hpcd);
137#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
138} PCD_HandleTypeDef;
139
143
144/* Include PCD HAL Extended module */
145#include "stm32f4xx_hal_pcd_ex.h"
146
147/* Exported constants --------------------------------------------------------*/
151
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
161
165#define PCD_PHY_ULPI 1U
166#define PCD_PHY_EMBEDDED 2U
167#define PCD_PHY_UTMI 3U
171
176#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
177#define HAL_PCD_ERROR_INVALID_CALLBACK (0x00000010U)
178#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
179
183
187
188/* Exported macros -----------------------------------------------------------*/
193#define __HAL_PCD_ENABLE(__HANDLE__) (void)USB_EnableGlobalInt ((__HANDLE__)->Instance)
194#define __HAL_PCD_DISABLE(__HANDLE__) (void)USB_DisableGlobalInt ((__HANDLE__)->Instance)
195
196#define __HAL_PCD_GET_FLAG(__HANDLE__, __INTERRUPT__) \
197 ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
198
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)
202
203#define __HAL_PCD_UNGATE_PHYCLOCK(__HANDLE__) \
204 *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) &= ~(USB_OTG_PCGCCTL_STOPCLK)
205
206#define __HAL_PCD_GATE_PHYCLOCK(__HANDLE__) \
207 *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) |= USB_OTG_PCGCCTL_STOPCLK
208
209#define __HAL_PCD_IS_PHY_SUSPENDED(__HANDLE__) \
210 ((*(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE)) & 0x10U)
211
212#define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_IT() EXTI->IMR |= (USB_OTG_HS_WAKEUP_EXTI_LINE)
213#define __HAL_USB_OTG_HS_WAKEUP_EXTI_DISABLE_IT() EXTI->IMR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE)
214#define __HAL_USB_OTG_HS_WAKEUP_EXTI_GET_FLAG() EXTI->PR & (USB_OTG_HS_WAKEUP_EXTI_LINE)
215#define __HAL_USB_OTG_HS_WAKEUP_EXTI_CLEAR_FLAG() EXTI->PR = (USB_OTG_HS_WAKEUP_EXTI_LINE)
216
217#define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_EDGE() \
218 do { \
219 EXTI->FTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE); \
220 EXTI->RTSR |= USB_OTG_HS_WAKEUP_EXTI_LINE; \
221 } while(0U)
222#define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_IT() EXTI->IMR |= USB_OTG_FS_WAKEUP_EXTI_LINE
223#define __HAL_USB_OTG_FS_WAKEUP_EXTI_DISABLE_IT() EXTI->IMR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE)
224#define __HAL_USB_OTG_FS_WAKEUP_EXTI_GET_FLAG() EXTI->PR & (USB_OTG_FS_WAKEUP_EXTI_LINE)
225#define __HAL_USB_OTG_FS_WAKEUP_EXTI_CLEAR_FLAG() EXTI->PR = USB_OTG_FS_WAKEUP_EXTI_LINE
226
227#define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_EDGE() \
228 do { \
229 EXTI->FTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE); \
230 EXTI->RTSR |= USB_OTG_FS_WAKEUP_EXTI_LINE; \
231 } while(0U)
232#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
233
234
238
239/* Exported functions --------------------------------------------------------*/
243
244/* Initialization/de-initialization functions ********************************/
248HAL_StatusTypeDef HAL_PCD_Init(PCD_HandleTypeDef *hpcd);
249HAL_StatusTypeDef HAL_PCD_DeInit(PCD_HandleTypeDef *hpcd);
250void HAL_PCD_MspInit(PCD_HandleTypeDef *hpcd);
251void HAL_PCD_MspDeInit(PCD_HandleTypeDef *hpcd);
252
253#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
258typedef enum
259{
260 HAL_PCD_SOF_CB_ID = 0x01,
261 HAL_PCD_SETUPSTAGE_CB_ID = 0x02,
262 HAL_PCD_RESET_CB_ID = 0x03,
263 HAL_PCD_SUSPEND_CB_ID = 0x04,
264 HAL_PCD_RESUME_CB_ID = 0x05,
265 HAL_PCD_CONNECT_CB_ID = 0x06,
266 HAL_PCD_DISCONNECT_CB_ID = 0x07,
267
268 HAL_PCD_MSPINIT_CB_ID = 0x08,
269 HAL_PCD_MSPDEINIT_CB_ID = 0x09
270
271} HAL_PCD_CallbackIDTypeDef;
275
280
281typedef void (*pPCD_CallbackTypeDef)(PCD_HandleTypeDef *hpcd);
282typedef void (*pPCD_DataOutStageCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
283typedef void (*pPCD_DataInStageCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
284typedef void (*pPCD_IsoOutIncpltCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
285typedef void (*pPCD_IsoInIncpltCallbackTypeDef)(PCD_HandleTypeDef *hpcd, uint8_t epnum);
286typedef void (*pPCD_LpmCallbackTypeDef)(PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg);
287typedef void (*pPCD_BcdCallbackTypeDef)(PCD_HandleTypeDef *hpcd, PCD_BCD_MsgTypeDef msg);
288
292
293HAL_StatusTypeDef HAL_PCD_RegisterCallback(PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID,
294 pPCD_CallbackTypeDef pCallback);
295
296HAL_StatusTypeDef HAL_PCD_UnRegisterCallback(PCD_HandleTypeDef *hpcd, HAL_PCD_CallbackIDTypeDef CallbackID);
297
298HAL_StatusTypeDef HAL_PCD_RegisterDataOutStageCallback(PCD_HandleTypeDef *hpcd,
299 pPCD_DataOutStageCallbackTypeDef pCallback);
300
301HAL_StatusTypeDef HAL_PCD_UnRegisterDataOutStageCallback(PCD_HandleTypeDef *hpcd);
302
303HAL_StatusTypeDef HAL_PCD_RegisterDataInStageCallback(PCD_HandleTypeDef *hpcd,
304 pPCD_DataInStageCallbackTypeDef pCallback);
305
306HAL_StatusTypeDef HAL_PCD_UnRegisterDataInStageCallback(PCD_HandleTypeDef *hpcd);
307
308HAL_StatusTypeDef HAL_PCD_RegisterIsoOutIncpltCallback(PCD_HandleTypeDef *hpcd,
309 pPCD_IsoOutIncpltCallbackTypeDef pCallback);
310
311HAL_StatusTypeDef HAL_PCD_UnRegisterIsoOutIncpltCallback(PCD_HandleTypeDef *hpcd);
312
313HAL_StatusTypeDef HAL_PCD_RegisterIsoInIncpltCallback(PCD_HandleTypeDef *hpcd,
314 pPCD_IsoInIncpltCallbackTypeDef pCallback);
315
316HAL_StatusTypeDef HAL_PCD_UnRegisterIsoInIncpltCallback(PCD_HandleTypeDef *hpcd);
317
318HAL_StatusTypeDef HAL_PCD_RegisterBcdCallback(PCD_HandleTypeDef *hpcd, pPCD_BcdCallbackTypeDef pCallback);
319HAL_StatusTypeDef HAL_PCD_UnRegisterBcdCallback(PCD_HandleTypeDef *hpcd);
320
321HAL_StatusTypeDef HAL_PCD_RegisterLpmCallback(PCD_HandleTypeDef *hpcd, pPCD_LpmCallbackTypeDef pCallback);
322HAL_StatusTypeDef HAL_PCD_UnRegisterLpmCallback(PCD_HandleTypeDef *hpcd);
323#endif /* USE_HAL_PCD_REGISTER_CALLBACKS */
327
328/* I/O operation functions ***************************************************/
329/* Non-Blocking mode: Interrupt */
333HAL_StatusTypeDef HAL_PCD_Start(PCD_HandleTypeDef *hpcd);
334HAL_StatusTypeDef HAL_PCD_Stop(PCD_HandleTypeDef *hpcd);
335void HAL_PCD_IRQHandler(PCD_HandleTypeDef *hpcd);
336void HAL_PCD_WKUP_IRQHandler(PCD_HandleTypeDef *hpcd);
337
338void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd);
339void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd);
340void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd);
341void HAL_PCD_SuspendCallback(PCD_HandleTypeDef *hpcd);
342void HAL_PCD_ResumeCallback(PCD_HandleTypeDef *hpcd);
343void HAL_PCD_ConnectCallback(PCD_HandleTypeDef *hpcd);
344void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd);
345
346void HAL_PCD_DataOutStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
347void HAL_PCD_DataInStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
348void HAL_PCD_ISOOUTIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
349void HAL_PCD_ISOINIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
353
354/* Peripheral Control functions **********************************************/
358HAL_StatusTypeDef HAL_PCD_DevConnect(PCD_HandleTypeDef *hpcd);
359HAL_StatusTypeDef HAL_PCD_DevDisconnect(PCD_HandleTypeDef *hpcd);
360HAL_StatusTypeDef HAL_PCD_SetAddress(PCD_HandleTypeDef *hpcd, uint8_t address);
361HAL_StatusTypeDef HAL_PCD_EP_Open(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type);
362HAL_StatusTypeDef HAL_PCD_EP_Close(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
363HAL_StatusTypeDef HAL_PCD_EP_Receive(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
364HAL_StatusTypeDef HAL_PCD_EP_Transmit(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
365HAL_StatusTypeDef HAL_PCD_EP_SetStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
366HAL_StatusTypeDef HAL_PCD_EP_ClrStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
367HAL_StatusTypeDef HAL_PCD_EP_Flush(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
368HAL_StatusTypeDef HAL_PCD_EP_Abort(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
369HAL_StatusTypeDef HAL_PCD_ActivateRemoteWakeup(PCD_HandleTypeDef *hpcd);
370HAL_StatusTypeDef HAL_PCD_DeActivateRemoteWakeup(PCD_HandleTypeDef *hpcd);
371#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
372HAL_StatusTypeDef HAL_PCD_SetTestMode(const PCD_HandleTypeDef *hpcd, uint8_t testmode);
373#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
374
375uint32_t HAL_PCD_EP_GetRxCount(PCD_HandleTypeDef const *hpcd, uint8_t ep_addr);
379
380/* Peripheral State functions ************************************************/
384PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef const *hpcd);
388
392
393/* Private constants ---------------------------------------------------------*/
400#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
401#define USB_OTG_FS_WAKEUP_EXTI_LINE (0x1U << 18)
402#define USB_OTG_HS_WAKEUP_EXTI_LINE (0x1U << 20)
403#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
404
405
412
413#if defined (USB_OTG_FS) || defined (USB_OTG_HS)
414#ifndef USB_OTG_DOEPINT_OTEPSPR
415#define USB_OTG_DOEPINT_OTEPSPR (0x1UL << 5)
416#endif /* defined USB_OTG_DOEPINT_OTEPSPR */
417
418#ifndef USB_OTG_DOEPMSK_OTEPSPRM
419#define USB_OTG_DOEPMSK_OTEPSPRM (0x1UL << 5)
420#endif /* defined USB_OTG_DOEPMSK_OTEPSPRM */
421
422#ifndef USB_OTG_DOEPINT_NAK
423#define USB_OTG_DOEPINT_NAK (0x1UL << 13)
424#endif /* defined USB_OTG_DOEPINT_NAK */
425
426#ifndef USB_OTG_DOEPMSK_NAKM
427#define USB_OTG_DOEPMSK_NAKM (0x1UL << 13)
428#endif /* defined USB_OTG_DOEPMSK_NAKM */
429
430#ifndef USB_OTG_DOEPINT_STPKTRX
431#define USB_OTG_DOEPINT_STPKTRX (0x1UL << 15)
432#endif /* defined USB_OTG_DOEPINT_STPKTRX */
433
434#ifndef USB_OTG_DOEPMSK_NYETM
435#define USB_OTG_DOEPMSK_NYETM (0x1UL << 14)
436#endif /* defined USB_OTG_DOEPMSK_NYETM */
437#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
438
439/* Private macros ------------------------------------------------------------*/
443
447
451
455#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
456
457#ifdef __cplusplus
458}
459#endif
460
461#endif /* STM32F4xx_HAL_PCD_H */
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition stm32f4xx_hal_def.h:39
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition.
Definition stm32f4xx_hal_def.h:50
stm32f4xx_hal_pcd_ex.h
Header file of PCD HAL Extension module.
stm32f4xx_ll_usb.h
Header file of USB Low Layer HAL module.