mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32F2/device/stm32f2xx_hal_hcd.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
167:e84263d55307 
mbed library release version 165

Who changed what in which revision?

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