Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_hcd.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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