You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

328 lines
12 KiB

9 months ago
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_hcd.h
  4. * @author MCD Application Team
  5. * @brief Header file of HCD HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2016 STMicroelectronics.
  10. * All rights reserved.
  11. *
  12. * This software is licensed under terms that can be found in the LICENSE file
  13. * in the root directory of this software component.
  14. * If no LICENSE file comes with this software, it is provided AS-IS.
  15. *
  16. ******************************************************************************
  17. */
  18. /* Define to prevent recursive inclusion -------------------------------------*/
  19. #ifndef STM32F4xx_HAL_HCD_H
  20. #define STM32F4xx_HAL_HCD_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32f4xx_ll_usb.h"
  26. #if defined (USB_OTG_FS) || defined (USB_OTG_HS)
  27. /** @addtogroup STM32F4xx_HAL_Driver
  28. * @{
  29. */
  30. /** @addtogroup HCD HCD
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. /** @defgroup HCD_Exported_Types HCD Exported Types
  35. * @{
  36. */
  37. /** @defgroup HCD_Exported_Types_Group1 HCD State Structure definition
  38. * @{
  39. */
  40. typedef enum
  41. {
  42. HAL_HCD_STATE_RESET = 0x00,
  43. HAL_HCD_STATE_READY = 0x01,
  44. HAL_HCD_STATE_ERROR = 0x02,
  45. HAL_HCD_STATE_BUSY = 0x03,
  46. HAL_HCD_STATE_TIMEOUT = 0x04
  47. } HCD_StateTypeDef;
  48. typedef USB_OTG_GlobalTypeDef HCD_TypeDef;
  49. typedef USB_OTG_CfgTypeDef HCD_InitTypeDef;
  50. typedef USB_OTG_HCTypeDef HCD_HCTypeDef;
  51. typedef USB_OTG_URBStateTypeDef HCD_URBStateTypeDef;
  52. typedef USB_OTG_HCStateTypeDef HCD_HCStateTypeDef;
  53. /**
  54. * @}
  55. */
  56. /** @defgroup HCD_Exported_Types_Group2 HCD Handle Structure definition
  57. * @{
  58. */
  59. #if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
  60. typedef struct __HCD_HandleTypeDef
  61. #else
  62. typedef struct
  63. #endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
  64. {
  65. HCD_TypeDef *Instance; /*!< Register base address */
  66. HCD_InitTypeDef Init; /*!< HCD required parameters */
  67. HCD_HCTypeDef hc[16]; /*!< Host channels parameters */
  68. HAL_LockTypeDef Lock; /*!< HCD peripheral status */
  69. __IO HCD_StateTypeDef State; /*!< HCD communication state */
  70. __IO uint32_t ErrorCode; /*!< HCD Error code */
  71. void *pData; /*!< Pointer Stack Handler */
  72. #if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
  73. void (* SOFCallback)(struct __HCD_HandleTypeDef *hhcd); /*!< USB OTG HCD SOF callback */
  74. void (* ConnectCallback)(struct __HCD_HandleTypeDef *hhcd); /*!< USB OTG HCD Connect callback */
  75. void (* DisconnectCallback)(struct __HCD_HandleTypeDef *hhcd); /*!< USB OTG HCD Disconnect callback */
  76. void (* PortEnabledCallback)(struct __HCD_HandleTypeDef *hhcd); /*!< USB OTG HCD Port Enable callback */
  77. void (* PortDisabledCallback)(struct __HCD_HandleTypeDef *hhcd); /*!< USB OTG HCD Port Disable callback */
  78. void (* HC_NotifyURBChangeCallback)(struct __HCD_HandleTypeDef *hhcd, uint8_t chnum,
  79. HCD_URBStateTypeDef urb_state); /*!< USB OTG HCD Host Channel Notify URB Change callback */
  80. void (* MspInitCallback)(struct __HCD_HandleTypeDef *hhcd); /*!< USB OTG HCD Msp Init callback */
  81. void (* MspDeInitCallback)(struct __HCD_HandleTypeDef *hhcd); /*!< USB OTG HCD Msp DeInit callback */
  82. #endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
  83. } HCD_HandleTypeDef;
  84. /**
  85. * @}
  86. */
  87. /**
  88. * @}
  89. */
  90. /* Exported constants --------------------------------------------------------*/
  91. /** @defgroup HCD_Exported_Constants HCD Exported Constants
  92. * @{
  93. */
  94. /** @defgroup HCD_Speed HCD Speed
  95. * @{
  96. */
  97. #define HCD_SPEED_HIGH USBH_HS_SPEED
  98. #define HCD_SPEED_FULL USBH_FSLS_SPEED
  99. #define HCD_SPEED_LOW USBH_FSLS_SPEED
  100. /**
  101. * @}
  102. */
  103. /** @defgroup HCD_Device_Speed HCD Device Speed
  104. * @{
  105. */
  106. #define HCD_DEVICE_SPEED_HIGH 0U
  107. #define HCD_DEVICE_SPEED_FULL 1U
  108. #define HCD_DEVICE_SPEED_LOW 2U
  109. /**
  110. * @}
  111. */
  112. /** @defgroup HCD_PHY_Module HCD PHY Module
  113. * @{
  114. */
  115. #define HCD_PHY_ULPI 1U
  116. #define HCD_PHY_EMBEDDED 2U
  117. /**
  118. * @}
  119. */
  120. /** @defgroup HCD_Error_Code_definition HCD Error Code definition
  121. * @brief HCD Error Code definition
  122. * @{
  123. */
  124. #if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
  125. #define HAL_HCD_ERROR_INVALID_CALLBACK (0x00000010U) /*!< Invalid Callback error */
  126. #endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
  127. /**
  128. * @}
  129. */
  130. /**
  131. * @}
  132. */
  133. /* Exported macro ------------------------------------------------------------*/
  134. /** @defgroup HCD_Exported_Macros HCD Exported Macros
  135. * @brief macros to handle interrupts and specific clock configurations
  136. * @{
  137. */
  138. #define __HAL_HCD_ENABLE(__HANDLE__) (void)USB_EnableGlobalInt ((__HANDLE__)->Instance)
  139. #define __HAL_HCD_DISABLE(__HANDLE__) (void)USB_DisableGlobalInt ((__HANDLE__)->Instance)
  140. #define __HAL_HCD_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance)\
  141. & (__INTERRUPT__)) == (__INTERRUPT__))
  142. #define __HAL_HCD_GET_CH_FLAG(__HANDLE__, __chnum__, __INTERRUPT__) \
  143. ((USB_ReadChInterrupts((__HANDLE__)->Instance, (__chnum__)) & (__INTERRUPT__)) == (__INTERRUPT__))
  144. #define __HAL_HCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
  145. #define __HAL_HCD_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0U)
  146. #define __HAL_HCD_CLEAR_HC_INT(chnum, __INTERRUPT__) (USBx_HC(chnum)->HCINT = (__INTERRUPT__))
  147. #define __HAL_HCD_MASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_CHHM)
  148. #define __HAL_HCD_UNMASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_CHHM)
  149. #define __HAL_HCD_MASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_ACKM)
  150. #define __HAL_HCD_UNMASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_ACKM)
  151. #define __HAL_HCD_SET_HC_CSPLT(chnum) (USBx_HC(chnum)->HCSPLT |= USB_OTG_HCSPLT_COMPLSPLT)
  152. #define __HAL_HCD_CLEAR_HC_CSPLT(chnum) (USBx_HC(chnum)->HCSPLT &= ~USB_OTG_HCSPLT_COMPLSPLT)
  153. #define __HAL_HCD_CLEAR_HC_SSPLT(chnum) (USBx_HC(chnum)->HCSPLT &= ~USB_OTG_HCSPLT_SPLITEN)
  154. /**
  155. * @}
  156. */
  157. /* Exported functions --------------------------------------------------------*/
  158. /** @addtogroup HCD_Exported_Functions HCD Exported Functions
  159. * @{
  160. */
  161. /** @defgroup HCD_Exported_Functions_Group1 Initialization and de-initialization functions
  162. * @{
  163. */
  164. HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
  165. HAL_StatusTypeDef HAL_HCD_DeInit(HCD_HandleTypeDef *hhcd);
  166. HAL_StatusTypeDef HAL_HCD_HC_Init(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
  167. uint8_t epnum, uint8_t dev_address,
  168. uint8_t speed, uint8_t ep_type, uint16_t mps);
  169. HAL_StatusTypeDef HAL_HCD_HC_Halt(HCD_HandleTypeDef *hhcd, uint8_t ch_num);
  170. void HAL_HCD_MspInit(HCD_HandleTypeDef *hhcd);
  171. void HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd);
  172. #if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
  173. /** @defgroup HAL_HCD_Callback_ID_enumeration_definition HAL USB OTG HCD Callback ID enumeration definition
  174. * @brief HAL USB OTG HCD Callback ID enumeration definition
  175. * @{
  176. */
  177. typedef enum
  178. {
  179. HAL_HCD_SOF_CB_ID = 0x01, /*!< USB HCD SOF callback ID */
  180. HAL_HCD_CONNECT_CB_ID = 0x02, /*!< USB HCD Connect callback ID */
  181. HAL_HCD_DISCONNECT_CB_ID = 0x03, /*!< USB HCD Disconnect callback ID */
  182. HAL_HCD_PORT_ENABLED_CB_ID = 0x04, /*!< USB HCD Port Enable callback ID */
  183. HAL_HCD_PORT_DISABLED_CB_ID = 0x05, /*!< USB HCD Port Disable callback ID */
  184. HAL_HCD_MSPINIT_CB_ID = 0x06, /*!< USB HCD MspInit callback ID */
  185. HAL_HCD_MSPDEINIT_CB_ID = 0x07 /*!< USB HCD MspDeInit callback ID */
  186. } HAL_HCD_CallbackIDTypeDef;
  187. /**
  188. * @}
  189. */
  190. /** @defgroup HAL_HCD_Callback_pointer_definition HAL USB OTG HCD Callback pointer definition
  191. * @brief HAL USB OTG HCD Callback pointer definition
  192. * @{
  193. */
  194. typedef void (*pHCD_CallbackTypeDef)(HCD_HandleTypeDef *hhcd); /*!< pointer to a common USB OTG HCD callback function */
  195. typedef void (*pHCD_HC_NotifyURBChangeCallbackTypeDef)(HCD_HandleTypeDef *hhcd,
  196. uint8_t epnum,
  197. HCD_URBStateTypeDef urb_state); /*!< pointer to USB OTG HCD host channel callback */
  198. /**
  199. * @}
  200. */
  201. HAL_StatusTypeDef HAL_HCD_RegisterCallback(HCD_HandleTypeDef *hhcd,
  202. HAL_HCD_CallbackIDTypeDef CallbackID,
  203. pHCD_CallbackTypeDef pCallback);
  204. HAL_StatusTypeDef HAL_HCD_UnRegisterCallback(HCD_HandleTypeDef *hhcd,
  205. HAL_HCD_CallbackIDTypeDef CallbackID);
  206. HAL_StatusTypeDef HAL_HCD_RegisterHC_NotifyURBChangeCallback(HCD_HandleTypeDef *hhcd,
  207. pHCD_HC_NotifyURBChangeCallbackTypeDef pCallback);
  208. HAL_StatusTypeDef HAL_HCD_UnRegisterHC_NotifyURBChangeCallback(HCD_HandleTypeDef *hhcd);
  209. #endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
  210. /**
  211. * @}
  212. */
  213. /* I/O operation functions ***************************************************/
  214. /** @addtogroup HCD_Exported_Functions_Group2 Input and Output operation functions
  215. * @{
  216. */
  217. HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
  218. uint8_t direction, uint8_t ep_type,
  219. uint8_t token, uint8_t *pbuff,
  220. uint16_t length, uint8_t do_ping);
  221. HAL_StatusTypeDef HAL_HCD_HC_SetHubInfo(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
  222. uint8_t addr, uint8_t PortNbr);
  223. HAL_StatusTypeDef HAL_HCD_HC_ClearHubInfo(HCD_HandleTypeDef *hhcd, uint8_t ch_num);
  224. /* Non-Blocking mode: Interrupt */
  225. void HAL_HCD_IRQHandler(HCD_HandleTypeDef *hhcd);
  226. void HAL_HCD_WKUP_IRQHandler(HCD_HandleTypeDef *hhcd);
  227. void HAL_HCD_SOF_Callback(HCD_HandleTypeDef *hhcd);
  228. void HAL_HCD_Connect_Callback(HCD_HandleTypeDef *hhcd);
  229. void HAL_HCD_Disconnect_Callback(HCD_HandleTypeDef *hhcd);
  230. void HAL_HCD_PortEnabled_Callback(HCD_HandleTypeDef *hhcd);
  231. void HAL_HCD_PortDisabled_Callback(HCD_HandleTypeDef *hhcd);
  232. void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd, uint8_t chnum,
  233. HCD_URBStateTypeDef urb_state);
  234. /**
  235. * @}
  236. */
  237. /* Peripheral Control functions **********************************************/
  238. /** @addtogroup HCD_Exported_Functions_Group3 Peripheral Control functions
  239. * @{
  240. */
  241. HAL_StatusTypeDef HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd);
  242. HAL_StatusTypeDef HAL_HCD_Start(HCD_HandleTypeDef *hhcd);
  243. HAL_StatusTypeDef HAL_HCD_Stop(HCD_HandleTypeDef *hhcd);
  244. /**
  245. * @}
  246. */
  247. /* Peripheral State functions ************************************************/
  248. /** @addtogroup HCD_Exported_Functions_Group4 Peripheral State functions
  249. * @{
  250. */
  251. HCD_StateTypeDef HAL_HCD_GetState(HCD_HandleTypeDef const *hhcd);
  252. HCD_URBStateTypeDef HAL_HCD_HC_GetURBState(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
  253. HCD_HCStateTypeDef HAL_HCD_HC_GetState(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
  254. uint32_t HAL_HCD_HC_GetXferCount(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
  255. uint32_t HAL_HCD_GetCurrentFrame(HCD_HandleTypeDef *hhcd);
  256. uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd);
  257. /**
  258. * @}
  259. */
  260. /* Private macros ------------------------------------------------------------*/
  261. /** @defgroup HCD_Private_Macros HCD Private Macros
  262. * @{
  263. */
  264. /**
  265. * @}
  266. */
  267. /* Private functions prototypes ----------------------------------------------*/
  268. /**
  269. * @}
  270. */
  271. /**
  272. * @}
  273. */
  274. /**
  275. * @}
  276. */
  277. #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
  278. #ifdef __cplusplus
  279. }
  280. #endif
  281. #endif /* STM32F4xx_HAL_HCD_H */