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_L486RG/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_hcd.h@140:97feb9bacc10, 2017-04-12 (annotated)

Committer:
<>
Date:
Wed Apr 12 16:07:08 2017 +0100
Revision:
140:97feb9bacc10
Parent:
128:9bcdf88f62b0
Child:
145:64910690c574
Release 140 of the mbed library



Ports for Upcoming Targets



3841: Add nRf52840 target https://github.com/ARMmbed/mbed-os/pull/3841

3992: Introducing UBLOX_C030 platform. https://github.com/ARMmbed/mbed-os/pull/3992



Fixes and Changes



3951: [NUCLEO_F303ZE] Correct ARDUINO pin https://github.com/ARMmbed/mbed-os/pull/3951

4021: Fixing a macro to detect when RTOS was in use for the NRF52840_DK https://github.com/ARMmbed/mbed-os/pull/4021

3979: KW24D: Add missing SPI defines and Arduino connector definitions https://github.com/ARMmbed/mbed-os/pull/3979

3990: UBLOX_C027: construct a ticker-based wait, rather than calling wait_ms(), in the  https://github.com/ARMmbed/mbed-os/pull/3990

4003: Fixed OBOE in async serial tx for NRF52 target, fixes #4002 https://github.com/ARMmbed/mbed-os/pull/4003

4012: STM32: Correct I2C master error handling https://github.com/ARMmbed/mbed-os/pull/4012

4020: NUCLEO_L011K4 remove unsupported tool chain files https://github.com/ARMmbed/mbed-os/pull/4020

4065: K66F: Move bss section to m_data_2 Section https://github.com/ARMmbed/mbed-os/pull/4065

4014: Issue 3763: Reduce heap allocation in the GCC linker file https://github.com/ARMmbed/mbed-os/pull/4014

4030: [STM32L0] reduce IAR heap and stack size for small targets https://github.com/ARMmbed/mbed-os/pull/4030

4109: NUCLEO_L476RG : minor serial pin update https://github.com/ARMmbed/mbed-os/pull/4109

3982: Ticker - kl25z bugfix for handling events in the past https://github.com/ARMmbed/mbed-os/pull/3982

Who changed what in which revision?

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