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_STM32F1/device/stm32f1xx_hal_hcd.h@189:f392fc9709a3, 2019-02-20 (annotated)

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