mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_F103RB/TOOLCHAIN_ARM_MICRO/stm32f1xx_hal_hcd.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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