STM32F4xx HAL Driver master
STM32CubeF4 HAL / LL Drivers API Reference
Loading...
Searching...
No Matches
stm32f4xx_hal_hcd.h
Go to the documentation of this file.
1
18
19/* Define to prevent recursive inclusion -------------------------------------*/
20#ifndef STM32F4xx_HAL_HCD_H
21#define STM32F4xx_HAL_HCD_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)
34
38
39/* Exported types ------------------------------------------------------------*/
43
47typedef enum
48{
49 HAL_HCD_STATE_RESET = 0x00,
50 HAL_HCD_STATE_READY = 0x01,
51 HAL_HCD_STATE_ERROR = 0x02,
52 HAL_HCD_STATE_BUSY = 0x03,
53 HAL_HCD_STATE_TIMEOUT = 0x04
54} HCD_StateTypeDef;
55
56typedef USB_OTG_GlobalTypeDef HCD_TypeDef;
57typedef USB_OTG_CfgTypeDef HCD_InitTypeDef;
58typedef USB_OTG_HCTypeDef HCD_HCTypeDef;
59typedef USB_OTG_URBStateTypeDef HCD_URBStateTypeDef;
60typedef USB_OTG_HCStateTypeDef HCD_HCStateTypeDef;
64
68#if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
69typedef struct __HCD_HandleTypeDef
70#else
71typedef struct
72#endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
73{
74 HCD_TypeDef *Instance;
75 HCD_InitTypeDef Init;
76 HCD_HCTypeDef hc[16];
77 HAL_LockTypeDef Lock;
78 __IO HCD_StateTypeDef State;
79 __IO uint32_t ErrorCode;
80 void *pData;
81#if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
82 void (* SOFCallback)(struct __HCD_HandleTypeDef *hhcd);
83 void (* ConnectCallback)(struct __HCD_HandleTypeDef *hhcd);
84 void (* DisconnectCallback)(struct __HCD_HandleTypeDef *hhcd);
85 void (* PortEnabledCallback)(struct __HCD_HandleTypeDef *hhcd);
86 void (* PortDisabledCallback)(struct __HCD_HandleTypeDef *hhcd);
87 void (* HC_NotifyURBChangeCallback)(struct __HCD_HandleTypeDef *hhcd, uint8_t chnum,
88 HCD_URBStateTypeDef urb_state);
89
90 void (* MspInitCallback)(struct __HCD_HandleTypeDef *hhcd);
91 void (* MspDeInitCallback)(struct __HCD_HandleTypeDef *hhcd);
92#endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
93} HCD_HandleTypeDef;
97
101
102/* Exported constants --------------------------------------------------------*/
106
110#define HCD_SPEED_HIGH USBH_HS_SPEED
111#define HCD_SPEED_FULL USBH_FSLS_SPEED
112#define HCD_SPEED_LOW USBH_FSLS_SPEED
116
120#define HCD_DEVICE_SPEED_HIGH 0U
121#define HCD_DEVICE_SPEED_FULL 1U
122#define HCD_DEVICE_SPEED_LOW 2U
126
130#define HCD_PHY_ULPI 1U
131#define HCD_PHY_EMBEDDED 2U
135
140#if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
141#define HAL_HCD_ERROR_INVALID_CALLBACK (0x00000010U)
142#endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
143
147
151
152/* Exported macro ------------------------------------------------------------*/
157#define __HAL_HCD_ENABLE(__HANDLE__) (void)USB_EnableGlobalInt ((__HANDLE__)->Instance)
158#define __HAL_HCD_DISABLE(__HANDLE__) (void)USB_DisableGlobalInt ((__HANDLE__)->Instance)
159
160#define __HAL_HCD_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance)\
161 & (__INTERRUPT__)) == (__INTERRUPT__))
162
163#define __HAL_HCD_GET_CH_FLAG(__HANDLE__, __chnum__, __INTERRUPT__) \
164 ((USB_ReadChInterrupts((__HANDLE__)->Instance, (__chnum__)) & (__INTERRUPT__)) == (__INTERRUPT__))
165
166#define __HAL_HCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
167#define __HAL_HCD_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0U)
168
169#define __HAL_HCD_CLEAR_HC_INT(chnum, __INTERRUPT__) (USBx_HC(chnum)->HCINT = (__INTERRUPT__))
170#define __HAL_HCD_MASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_CHHM)
171#define __HAL_HCD_UNMASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_CHHM)
172#define __HAL_HCD_MASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_ACKM)
173#define __HAL_HCD_UNMASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_ACKM)
174#define __HAL_HCD_SET_HC_CSPLT(chnum) (USBx_HC(chnum)->HCSPLT |= USB_OTG_HCSPLT_COMPLSPLT)
175#define __HAL_HCD_CLEAR_HC_CSPLT(chnum) (USBx_HC(chnum)->HCSPLT &= ~USB_OTG_HCSPLT_COMPLSPLT)
176#define __HAL_HCD_CLEAR_HC_SSPLT(chnum) (USBx_HC(chnum)->HCSPLT &= ~USB_OTG_HCSPLT_SPLITEN)
180
181/* Exported functions --------------------------------------------------------*/
185
189HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
190HAL_StatusTypeDef HAL_HCD_DeInit(HCD_HandleTypeDef *hhcd);
191HAL_StatusTypeDef HAL_HCD_HC_Init(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
192 uint8_t epnum, uint8_t dev_address,
193 uint8_t speed, uint8_t ep_type, uint16_t mps);
194
195HAL_StatusTypeDef HAL_HCD_HC_Halt(HCD_HandleTypeDef *hhcd, uint8_t ch_num);
196void HAL_HCD_MspInit(HCD_HandleTypeDef *hhcd);
197void HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd);
198
199#if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
204typedef enum
205{
206 HAL_HCD_SOF_CB_ID = 0x01,
207 HAL_HCD_CONNECT_CB_ID = 0x02,
208 HAL_HCD_DISCONNECT_CB_ID = 0x03,
209 HAL_HCD_PORT_ENABLED_CB_ID = 0x04,
210 HAL_HCD_PORT_DISABLED_CB_ID = 0x05,
211
212 HAL_HCD_MSPINIT_CB_ID = 0x06,
213 HAL_HCD_MSPDEINIT_CB_ID = 0x07
214
215} HAL_HCD_CallbackIDTypeDef;
219
224
225typedef void (*pHCD_CallbackTypeDef)(HCD_HandleTypeDef *hhcd);
226typedef void (*pHCD_HC_NotifyURBChangeCallbackTypeDef)(HCD_HandleTypeDef *hhcd,
227 uint8_t epnum,
228 HCD_URBStateTypeDef urb_state);
232
233HAL_StatusTypeDef HAL_HCD_RegisterCallback(HCD_HandleTypeDef *hhcd,
234 HAL_HCD_CallbackIDTypeDef CallbackID,
235 pHCD_CallbackTypeDef pCallback);
236
237HAL_StatusTypeDef HAL_HCD_UnRegisterCallback(HCD_HandleTypeDef *hhcd,
238 HAL_HCD_CallbackIDTypeDef CallbackID);
239
240HAL_StatusTypeDef HAL_HCD_RegisterHC_NotifyURBChangeCallback(HCD_HandleTypeDef *hhcd,
241 pHCD_HC_NotifyURBChangeCallbackTypeDef pCallback);
242
243HAL_StatusTypeDef HAL_HCD_UnRegisterHC_NotifyURBChangeCallback(HCD_HandleTypeDef *hhcd);
244#endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
248
249/* I/O operation functions ***************************************************/
253HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
254 uint8_t direction, uint8_t ep_type,
255 uint8_t token, uint8_t *pbuff,
256 uint16_t length, uint8_t do_ping);
257
258HAL_StatusTypeDef HAL_HCD_HC_SetHubInfo(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
259 uint8_t addr, uint8_t PortNbr);
260
261HAL_StatusTypeDef HAL_HCD_HC_ClearHubInfo(HCD_HandleTypeDef *hhcd, uint8_t ch_num);
262
263/* Non-Blocking mode: Interrupt */
264void HAL_HCD_IRQHandler(HCD_HandleTypeDef *hhcd);
265void HAL_HCD_WKUP_IRQHandler(HCD_HandleTypeDef *hhcd);
266void HAL_HCD_SOF_Callback(HCD_HandleTypeDef *hhcd);
267void HAL_HCD_Connect_Callback(HCD_HandleTypeDef *hhcd);
268void HAL_HCD_Disconnect_Callback(HCD_HandleTypeDef *hhcd);
269void HAL_HCD_PortEnabled_Callback(HCD_HandleTypeDef *hhcd);
270void HAL_HCD_PortDisabled_Callback(HCD_HandleTypeDef *hhcd);
271void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd, uint8_t chnum,
272 HCD_URBStateTypeDef urb_state);
276
277/* Peripheral Control functions **********************************************/
281HAL_StatusTypeDef HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd);
282HAL_StatusTypeDef HAL_HCD_Start(HCD_HandleTypeDef *hhcd);
283HAL_StatusTypeDef HAL_HCD_Stop(HCD_HandleTypeDef *hhcd);
287
288/* Peripheral State functions ************************************************/
292HCD_StateTypeDef HAL_HCD_GetState(HCD_HandleTypeDef const *hhcd);
293HCD_URBStateTypeDef HAL_HCD_HC_GetURBState(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
294HCD_HCStateTypeDef HAL_HCD_HC_GetState(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
295uint32_t HAL_HCD_HC_GetXferCount(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
296uint32_t HAL_HCD_GetCurrentFrame(HCD_HandleTypeDef *hhcd);
297uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd);
298
299
303
304/* Private macros ------------------------------------------------------------*/
311/* Private functions prototypes ----------------------------------------------*/
312
322#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
323
324#ifdef __cplusplus
325}
326#endif
327
328#endif /* STM32F4xx_HAL_HCD_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_ll_usb.h
Header file of USB Low Layer HAL module.