tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_hcd.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_hcd.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    19-June-2014
   7   * @brief   Header file of HCD HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F4xx_HAL_HCD_H
  40 #define __STM32F4xx_HAL_HCD_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f4xx_ll_usb.h"
  48
  49 /** @addtogroup STM32F4xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup HCD
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58
  59    /**
  60   * @brief  HCD Status structures structure definition
  61   */
  62 typedef enum
  63 {
  64   HAL_HCD_STATE_RESET    = 0x00,
  65   HAL_HCD_STATE_READY    = 0x01,
  66   HAL_HCD_STATE_ERROR    = 0x02,
  67   HAL_HCD_STATE_BUSY     = 0x03,
  68   HAL_HCD_STATE_TIMEOUT  = 0x04
  69 } HCD_StateTypeDef;
  70
  71 typedef USB_OTG_GlobalTypeDef   HCD_TypeDef;
  72 typedef USB_OTG_CfgTypeDef      HCD_InitTypeDef;
  73 typedef USB_OTG_HCTypeDef       HCD_HCTypeDef ;
  74 typedef USB_OTG_URBStateTypeDef HCD_URBStateTypeDef ;
  75 typedef USB_OTG_HCStateTypeDef  HCD_HCStateTypeDef ;
  76
  77 /**
  78   * @brief  HCD Handle Structure definition
  79   */
  80 typedef struct
  81 {
  82   HCD_TypeDef               *Instance;  /*!< Register base address    */
  83   HCD_InitTypeDef           Init;       /*!< HCD required parameters  */
  84   HCD_HCTypeDef             hc[15];     /*!< Host channels parameters */
  85   HAL_LockTypeDef           Lock;       /*!< HCD peripheral status    */
  86   __IO HCD_StateTypeDef     State;      /*!< HCD communication state  */
  87   void                      *pData;     /*!< Pointer Stack Handler    */
  88
  89 } HCD_HandleTypeDef;
  90
  91 /* Exported constants --------------------------------------------------------*/
  92 /** @defgroup HCD_Exported_Constants
  93   * @{
  94   */
  95
  96 /** @defgroup HCD_Instance_definition
  97   * @{
  98   */
  99
 100 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
 101  #define IS_HCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS) || \
 102                                         ((INSTANCE) == USB_OTG_HS))
 103 #elif defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE)
 104  #define IS_HCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS))
 105 #endif
 106
 107 /**
 108   * @}
 109   */
 110
 111 /** @defgroup HCD_Speed
 112   * @{
 113   */
 114 #define HCD_SPEED_HIGH               0
 115 #define HCD_SPEED_LOW                2
 116 #define HCD_SPEED_FULL               3
 117
 118 /**
 119   * @}
 120   */
 121
 122   /** @defgroup HCD_PHY_Module
 123   * @{
 124   */
 125 #define HCD_PHY_ULPI                 1
 126 #define HCD_PHY_EMBEDDED             2
 127 /**
 128   * @}
 129   */
 130 /**
 131   * @}
 132   */
 133
 134 /* Exported macro ------------------------------------------------------------*/
 135
 136 /** @defgroup HCD_Interrupt_Clock
 137  *  @brief macros to handle interrupts and specific clock configurations
 138  * @{
 139  */
 140 #define __HAL_HCD_ENABLE(__HANDLE__)                   USB_EnableGlobalInt ((__HANDLE__)->Instance)
 141 #define __HAL_HCD_DISABLE(__HANDLE__)                  USB_DisableGlobalInt ((__HANDLE__)->Instance)
 142
 143
 144 #define __HAL_HCD_GET_FLAG(__HANDLE__, __INTERRUPT__)      ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
 145 #define __HAL_HCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__)    (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
 146 #define __HAL_HCD_IS_INVALID_INTERRUPT(__HANDLE__)         (USB_ReadInterrupts((__HANDLE__)->Instance) == 0)
 147
 148
 149 #define __HAL_HCD_CLEAR_HC_INT(chnum, __INTERRUPT__)  (USBx_HC(chnum)->HCINT = (__INTERRUPT__))
 150 #define __HAL_HCD_MASK_HALT_HC_INT(chnum)             (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_CHHM)
 151 #define __HAL_HCD_UNMASK_HALT_HC_INT(chnum)           (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_CHHM)
 152 #define __HAL_HCD_MASK_ACK_HC_INT(chnum)              (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_ACKM)
 153 #define __HAL_HCD_UNMASK_ACK_HC_INT(chnum)            (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_ACKM)
 154
 155 /**
 156   * @}
 157   */
 158
 159 /* Exported functions --------------------------------------------------------*/
 160
 161 /* Initialization/de-initialization functions  **********************************/
 162 HAL_StatusTypeDef      HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
 163 HAL_StatusTypeDef      HAL_HCD_DeInit (HCD_HandleTypeDef *hhcd);
 164 HAL_StatusTypeDef      HAL_HCD_HC_Init(HCD_HandleTypeDef *hhcd,
 165                                   uint8_t ch_num,
 166                                   uint8_t epnum,
 167                                   uint8_t dev_address,
 168                                   uint8_t speed,
 169                                   uint8_t ep_type,
 170                                   uint16_t mps);
 171
 172 HAL_StatusTypeDef       HAL_HCD_HC_Halt(HCD_HandleTypeDef *hhcd,
 173                                   uint8_t ch_num);
 174
 175 void            HAL_HCD_MspInit(HCD_HandleTypeDef *hhcd);
 176 void            HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd);
 177
 178 /* I/O operation functions  *****************************************************/
 179 HAL_StatusTypeDef       HAL_HCD_HC_SubmitRequest(HCD_HandleTypeDef *hhcd,
 180                                                  uint8_t pipe,
 181                                                  uint8_t direction ,
 182                                                  uint8_t ep_type,
 183                                                  uint8_t token,
 184                                                  uint8_t* pbuff,
 185                                                  uint16_t length,
 186                                                  uint8_t do_ping);
 187
 188  /* Non-Blocking mode: Interrupt */
 189 void                    HAL_HCD_IRQHandler(HCD_HandleTypeDef *hhcd);
 190 void             HAL_HCD_SOF_Callback(HCD_HandleTypeDef *hhcd);
 191 void             HAL_HCD_Connect_Callback(HCD_HandleTypeDef *hhcd);
 192 void             HAL_HCD_Disconnect_Callback(HCD_HandleTypeDef *hhcd);
 193 void             HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd,
 194                                                             uint8_t chnum,
 195                                                             HCD_URBStateTypeDef urb_state);
 196
 197 /* Peripheral Control functions  ************************************************/
 198 HAL_StatusTypeDef       HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd);
 199 HAL_StatusTypeDef       HAL_HCD_Start(HCD_HandleTypeDef *hhcd);
 200 HAL_StatusTypeDef       HAL_HCD_Stop(HCD_HandleTypeDef *hhcd);
 201
 202 /* Peripheral State functions  **************************************************/
 203 HCD_StateTypeDef        HAL_HCD_GetState(HCD_HandleTypeDef *hhcd);
 204 HCD_URBStateTypeDef     HAL_HCD_HC_GetURBState(HCD_HandleTypeDef *hhcd, uint8_t chnum);
 205 uint32_t                HAL_HCD_HC_GetXferCount(HCD_HandleTypeDef *hhcd, uint8_t chnum);
 206 HCD_HCStateTypeDef      HAL_HCD_HC_GetState(HCD_HandleTypeDef *hhcd, uint8_t chnum);
 207 uint32_t                HAL_HCD_GetCurrentFrame(HCD_HandleTypeDef *hhcd);
 208 uint32_t                HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd);
 209
 210 /**
 211   * @}
 212   */
 213
 214 /**
 215   * @}
 216   */
 217
 218 #ifdef __cplusplus
 219 }
 220 #endif
 221
 222 #endif /* __STM32F4xx_HAL_HCD_H */
 223
 224 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/