Back to home page

LXR
 
 

    

File indexing completed on 2025-05-11 08:23:35 

0001 /**
0002   ******************************************************************************
0003   * @file    stm32h7xx_hal_hcd.h
0004   * @author  MCD Application Team
0005   * @brief   Header file of HCD HAL module.
0006   ******************************************************************************
0007   * @attention
0008   *
0009   * Copyright (c) 2017 STMicroelectronics.
0010   * All rights reserved.
0011   *
0012   * This software is licensed under terms that can be found in the LICENSE file
0013   * in the root directory of this software component.
0014   * If no LICENSE file comes with this software, it is provided AS-IS.
0015   *
0016   ******************************************************************************
0017   */
0018 
0019 /* Define to prevent recursive inclusion -------------------------------------*/
0020 #ifndef STM32H7xx_HAL_HCD_H
0021 #define STM32H7xx_HAL_HCD_H
0022 
0023 #ifdef __cplusplus
0024 extern "C" {
0025 #endif
0026 
0027 /* Includes ------------------------------------------------------------------*/
0028 #include "stm32h7xx_ll_usb.h"
0029 
0030 #if defined (USB_OTG_FS) || defined (USB_OTG_HS)
0031 /** @addtogroup STM32H7xx_HAL_Driver
0032   * @{
0033   */
0034 
0035 /** @addtogroup HCD HCD
0036   * @{
0037   */
0038 
0039 /* Exported types ------------------------------------------------------------*/
0040 /** @defgroup HCD_Exported_Types HCD Exported Types
0041   * @ingroup RTEMSBSPsARMSTM32H7
0042   * @{
0043   */
0044 
0045 /** @defgroup HCD_Exported_Types_Group1 HCD State Structure definition
0046   * @ingroup RTEMSBSPsARMSTM32H7
0047   * @{
0048   */
0049 typedef enum
0050 {
0051   HAL_HCD_STATE_RESET    = 0x00,
0052   HAL_HCD_STATE_READY    = 0x01,
0053   HAL_HCD_STATE_ERROR    = 0x02,
0054   HAL_HCD_STATE_BUSY     = 0x03,
0055   HAL_HCD_STATE_TIMEOUT  = 0x04
0056 } HCD_StateTypeDef;
0057 
0058 typedef USB_OTG_GlobalTypeDef   HCD_TypeDef;
0059 typedef USB_OTG_CfgTypeDef      HCD_InitTypeDef;
0060 typedef USB_OTG_HCTypeDef       HCD_HCTypeDef;
0061 typedef USB_OTG_URBStateTypeDef HCD_URBStateTypeDef;
0062 typedef USB_OTG_HCStateTypeDef  HCD_HCStateTypeDef;
0063 /**
0064   * @}
0065   */
0066 
0067 /** @defgroup HCD_Exported_Types_Group2 HCD Handle Structure definition
0068   * @ingroup RTEMSBSPsARMSTM32H7
0069   * @{
0070   */
0071 #if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
0072 typedef struct __HCD_HandleTypeDef
0073 #else
0074 typedef struct
0075 #endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
0076 {
0077   HCD_TypeDef               *Instance;  /*!< Register base address    */
0078   HCD_InitTypeDef           Init;       /*!< HCD required parameters  */
0079   HCD_HCTypeDef             hc[16];     /*!< Host channels parameters */
0080   HAL_LockTypeDef           Lock;       /*!< HCD peripheral status    */
0081   __IO HCD_StateTypeDef     State;      /*!< HCD communication state  */
0082   __IO  uint32_t            ErrorCode;  /*!< HCD Error code           */
0083   void                      *pData;     /*!< Pointer Stack Handler    */
0084 #if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
0085   void (* SOFCallback)(struct __HCD_HandleTypeDef *hhcd);                               /*!< USB OTG HCD SOF callback                */
0086   void (* ConnectCallback)(struct __HCD_HandleTypeDef *hhcd);                           /*!< USB OTG HCD Connect callback            */
0087   void (* DisconnectCallback)(struct __HCD_HandleTypeDef *hhcd);                        /*!< USB OTG HCD Disconnect callback         */
0088   void (* PortEnabledCallback)(struct __HCD_HandleTypeDef *hhcd);                       /*!< USB OTG HCD Port Enable callback        */
0089   void (* PortDisabledCallback)(struct __HCD_HandleTypeDef *hhcd);                      /*!< USB OTG HCD Port Disable callback       */
0090   void (* HC_NotifyURBChangeCallback)(struct __HCD_HandleTypeDef *hhcd, uint8_t chnum,
0091                                       HCD_URBStateTypeDef urb_state);                   /*!< USB OTG HCD Host Channel Notify URB Change callback  */
0092 
0093   void (* MspInitCallback)(struct __HCD_HandleTypeDef *hhcd);                           /*!< USB OTG HCD Msp Init callback           */
0094   void (* MspDeInitCallback)(struct __HCD_HandleTypeDef *hhcd);                         /*!< USB OTG HCD Msp DeInit callback         */
0095 #endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
0096 } HCD_HandleTypeDef;
0097 /**
0098   * @}
0099   */
0100 
0101 /**
0102   * @}
0103   */
0104 
0105 /* Exported constants --------------------------------------------------------*/
0106 /** @defgroup HCD_Exported_Constants HCD Exported Constants
0107   * @ingroup RTEMSBSPsARMSTM32H7
0108   * @{
0109   */
0110 
0111 /** @defgroup HCD_Speed HCD Speed
0112   * @ingroup RTEMSBSPsARMSTM32H7
0113   * @{
0114   */
0115 #define HCD_SPEED_HIGH               USBH_HS_SPEED
0116 #define HCD_SPEED_FULL               USBH_FSLS_SPEED
0117 #define HCD_SPEED_LOW                USBH_FSLS_SPEED
0118 /**
0119   * @}
0120   */
0121 
0122 /** @defgroup HCD_Device_Speed HCD Device Speed
0123   * @ingroup RTEMSBSPsARMSTM32H7
0124   * @{
0125   */
0126 #define HCD_DEVICE_SPEED_HIGH               0U
0127 #define HCD_DEVICE_SPEED_FULL               1U
0128 #define HCD_DEVICE_SPEED_LOW                2U
0129 /**
0130   * @}
0131   */
0132 
0133 /** @defgroup HCD_PHY_Module HCD PHY Module
0134   * @ingroup RTEMSBSPsARMSTM32H7
0135   * @{
0136   */
0137 #define HCD_PHY_ULPI                 1U
0138 #define HCD_PHY_EMBEDDED             2U
0139 /**
0140   * @}
0141   */
0142 
0143 /** @defgroup HCD_Error_Code_definition HCD Error Code definition
0144   * @ingroup RTEMSBSPsARMSTM32H7
0145   * @brief  HCD Error Code definition
0146   * @{
0147   */
0148 #if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
0149 #define  HAL_HCD_ERROR_INVALID_CALLBACK                        (0x00000010U)    /*!< Invalid Callback error  */
0150 #endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
0151 
0152 /**
0153   * @}
0154   */
0155 
0156 /**
0157   * @}
0158   */
0159 
0160 /* Exported macro ------------------------------------------------------------*/
0161 /** @defgroup HCD_Exported_Macros HCD Exported Macros
0162   * @ingroup RTEMSBSPsARMSTM32H7
0163   *  @brief macros to handle interrupts and specific clock configurations
0164   * @{
0165   */
0166 #define __HAL_HCD_ENABLE(__HANDLE__)                   (void)USB_EnableGlobalInt ((__HANDLE__)->Instance)
0167 #define __HAL_HCD_DISABLE(__HANDLE__)                  (void)USB_DisableGlobalInt ((__HANDLE__)->Instance)
0168 
0169 #define __HAL_HCD_GET_FLAG(__HANDLE__, __INTERRUPT__)      ((USB_ReadInterrupts((__HANDLE__)->Instance)\
0170                                                              & (__INTERRUPT__)) == (__INTERRUPT__))
0171 
0172 #define __HAL_HCD_GET_CH_FLAG(__HANDLE__, __chnum__, __INTERRUPT__) \
0173   ((USB_ReadChInterrupts((__HANDLE__)->Instance, (__chnum__)) & (__INTERRUPT__)) == (__INTERRUPT__))
0174 
0175 #define __HAL_HCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__)    (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
0176 #define __HAL_HCD_IS_INVALID_INTERRUPT(__HANDLE__)         (USB_ReadInterrupts((__HANDLE__)->Instance) == 0U)
0177 
0178 #define __HAL_HCD_CLEAR_HC_INT(chnum, __INTERRUPT__)  (USBx_HC(chnum)->HCINT = (__INTERRUPT__))
0179 #define __HAL_HCD_MASK_HALT_HC_INT(chnum)             (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_CHHM)
0180 #define __HAL_HCD_UNMASK_HALT_HC_INT(chnum)           (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_CHHM)
0181 #define __HAL_HCD_MASK_ACK_HC_INT(chnum)              (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_ACKM)
0182 #define __HAL_HCD_UNMASK_ACK_HC_INT(chnum)            (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_ACKM)
0183 #define __HAL_HCD_SET_HC_CSPLT(chnum)                 (USBx_HC(chnum)->HCSPLT   |= USB_OTG_HCSPLT_COMPLSPLT)
0184 #define __HAL_HCD_CLEAR_HC_CSPLT(chnum)               (USBx_HC(chnum)->HCSPLT   &= ~USB_OTG_HCSPLT_COMPLSPLT)
0185 #define __HAL_HCD_CLEAR_HC_SSPLT(chnum)               (USBx_HC(chnum)->HCSPLT   &= ~USB_OTG_HCSPLT_SPLITEN)
0186 /**
0187   * @}
0188   */
0189 
0190 /* Exported functions --------------------------------------------------------*/
0191 /** @addtogroup HCD_Exported_Functions HCD Exported Functions
0192   * @{
0193   */
0194 
0195 /** @defgroup HCD_Exported_Functions_Group1 Initialization and de-initialization functions
0196   * @ingroup RTEMSBSPsARMSTM32H7
0197   * @{
0198   */
0199 HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
0200 HAL_StatusTypeDef HAL_HCD_DeInit(HCD_HandleTypeDef *hhcd);
0201 HAL_StatusTypeDef HAL_HCD_HC_Init(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
0202                                   uint8_t epnum, uint8_t dev_address,
0203                                   uint8_t speed, uint8_t ep_type, uint16_t mps);
0204 
0205 HAL_StatusTypeDef HAL_HCD_HC_Halt(HCD_HandleTypeDef *hhcd, uint8_t ch_num);
0206 void              HAL_HCD_MspInit(HCD_HandleTypeDef *hhcd);
0207 void              HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd);
0208 
0209 #if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
0210 /** @defgroup HAL_HCD_Callback_ID_enumeration_definition HAL USB OTG HCD Callback ID enumeration definition
0211   * @ingroup RTEMSBSPsARMSTM32H7
0212   * @brief  HAL USB OTG HCD Callback ID enumeration definition
0213   * @{
0214   */
0215 typedef enum
0216 {
0217   HAL_HCD_SOF_CB_ID            = 0x01,       /*!< USB HCD SOF callback ID           */
0218   HAL_HCD_CONNECT_CB_ID        = 0x02,       /*!< USB HCD Connect callback ID       */
0219   HAL_HCD_DISCONNECT_CB_ID     = 0x03,       /*!< USB HCD Disconnect callback ID    */
0220   HAL_HCD_PORT_ENABLED_CB_ID   = 0x04,       /*!< USB HCD Port Enable callback ID   */
0221   HAL_HCD_PORT_DISABLED_CB_ID  = 0x05,       /*!< USB HCD Port Disable callback ID  */
0222 
0223   HAL_HCD_MSPINIT_CB_ID        = 0x06,       /*!< USB HCD MspInit callback ID       */
0224   HAL_HCD_MSPDEINIT_CB_ID      = 0x07        /*!< USB HCD MspDeInit callback ID     */
0225 
0226 } HAL_HCD_CallbackIDTypeDef;
0227 /**
0228   * @}
0229   */
0230 
0231 /** @defgroup HAL_HCD_Callback_pointer_definition HAL USB OTG HCD Callback pointer definition
0232   * @ingroup RTEMSBSPsARMSTM32H7
0233   * @brief  HAL USB OTG HCD Callback pointer definition
0234   * @{
0235   */
0236 
0237 typedef void (*pHCD_CallbackTypeDef)(HCD_HandleTypeDef *hhcd);                   /*!< pointer to a common USB OTG HCD callback function  */
0238 typedef void (*pHCD_HC_NotifyURBChangeCallbackTypeDef)(HCD_HandleTypeDef *hhcd,
0239                                                        uint8_t epnum,
0240                                                        HCD_URBStateTypeDef urb_state);   /*!< pointer to USB OTG HCD host channel  callback */
0241 /**
0242   * @}
0243   */
0244 
0245 HAL_StatusTypeDef HAL_HCD_RegisterCallback(HCD_HandleTypeDef *hhcd,
0246                                            HAL_HCD_CallbackIDTypeDef CallbackID,
0247                                            pHCD_CallbackTypeDef pCallback);
0248 
0249 HAL_StatusTypeDef HAL_HCD_UnRegisterCallback(HCD_HandleTypeDef *hhcd,
0250                                              HAL_HCD_CallbackIDTypeDef CallbackID);
0251 
0252 HAL_StatusTypeDef HAL_HCD_RegisterHC_NotifyURBChangeCallback(HCD_HandleTypeDef *hhcd,
0253                                                              pHCD_HC_NotifyURBChangeCallbackTypeDef pCallback);
0254 
0255 HAL_StatusTypeDef HAL_HCD_UnRegisterHC_NotifyURBChangeCallback(HCD_HandleTypeDef *hhcd);
0256 #endif /* USE_HAL_HCD_REGISTER_CALLBACKS */
0257 /**
0258   * @}
0259   */
0260 
0261 /* I/O operation functions  ***************************************************/
0262 /** @addtogroup HCD_Exported_Functions_Group2 Input and Output operation functions
0263   * @{
0264   */
0265 HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
0266                                            uint8_t direction, uint8_t ep_type,
0267                                            uint8_t token, uint8_t *pbuff,
0268                                            uint16_t length, uint8_t do_ping);
0269 
0270 HAL_StatusTypeDef HAL_HCD_HC_SetHubInfo(HCD_HandleTypeDef *hhcd, uint8_t ch_num,
0271                                         uint8_t addr, uint8_t PortNbr);
0272 
0273 HAL_StatusTypeDef HAL_HCD_HC_ClearHubInfo(HCD_HandleTypeDef *hhcd, uint8_t ch_num);
0274 
0275 /* Non-Blocking mode: Interrupt */
0276 void HAL_HCD_IRQHandler(HCD_HandleTypeDef *hhcd);
0277 void HAL_HCD_SOF_Callback(HCD_HandleTypeDef *hhcd);
0278 void HAL_HCD_Connect_Callback(HCD_HandleTypeDef *hhcd);
0279 void HAL_HCD_Disconnect_Callback(HCD_HandleTypeDef *hhcd);
0280 void HAL_HCD_PortEnabled_Callback(HCD_HandleTypeDef *hhcd);
0281 void HAL_HCD_PortDisabled_Callback(HCD_HandleTypeDef *hhcd);
0282 void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd, uint8_t chnum,
0283                                          HCD_URBStateTypeDef urb_state);
0284 /**
0285   * @}
0286   */
0287 
0288 /* Peripheral Control functions  **********************************************/
0289 /** @addtogroup HCD_Exported_Functions_Group3 Peripheral Control functions
0290   * @{
0291   */
0292 HAL_StatusTypeDef HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd);
0293 HAL_StatusTypeDef HAL_HCD_Start(HCD_HandleTypeDef *hhcd);
0294 HAL_StatusTypeDef HAL_HCD_Stop(HCD_HandleTypeDef *hhcd);
0295 /**
0296   * @}
0297   */
0298 
0299 /* Peripheral State functions  ************************************************/
0300 /** @addtogroup HCD_Exported_Functions_Group4 Peripheral State functions
0301   * @{
0302   */
0303 HCD_StateTypeDef        HAL_HCD_GetState(HCD_HandleTypeDef const *hhcd);
0304 HCD_URBStateTypeDef     HAL_HCD_HC_GetURBState(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
0305 HCD_HCStateTypeDef      HAL_HCD_HC_GetState(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
0306 uint32_t                HAL_HCD_HC_GetXferCount(HCD_HandleTypeDef const *hhcd, uint8_t chnum);
0307 uint32_t                HAL_HCD_GetCurrentFrame(HCD_HandleTypeDef *hhcd);
0308 uint32_t                HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd);
0309 
0310 
0311 /**
0312   * @}
0313   */
0314 
0315 /* Private macros ------------------------------------------------------------*/
0316 /** @defgroup HCD_Private_Macros HCD Private Macros
0317   * @ingroup RTEMSBSPsARMSTM32H7
0318   * @{
0319   */
0320 /**
0321   * @}
0322   */
0323 /* Private functions prototypes ----------------------------------------------*/
0324 
0325 /**
0326   * @}
0327   */
0328 /**
0329   * @}
0330   */
0331 /**
0332   * @}
0333   */
0334 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */
0335 
0336 #ifdef __cplusplus
0337 }
0338 #endif
0339 
0340 #endif /* STM32H7xx_HAL_HCD_H */
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.3.7 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!