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_L4R5ZI_P/TOOLCHAIN_ARM_STD/stm32l4xx_hal_hcd.h@172:65be27845400, 2019-02-20 (annotated)

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

Who changed what in which revision?

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