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_L496ZG_P/TOOLCHAIN_IAR/stm32l4xx_hal_hcd.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_DISCO_L475VG_IOT01A/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_hcd.h@161:aa5281ff4a02 
mbed library. Release version 164

Who changed what in which revision?

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