mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

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

Last commit 20 Feb 2019 by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_hcd.h@613:bc40b8d2aec4, 2015-08-20 (annotated)

Committer:
mbed_official
Date:
Thu Aug 20 10:45:13 2015 +0100
Revision:
613:bc40b8d2aec4
Parent:
532:fe11edbda85c 
Synchronized with git revision 92ca8c7b60a283b6bb60eb65b183dac1599f0ade



Full URL: https://github.com/mbedmicro/mbed/commit/92ca8c7b60a283b6bb60eb65b183dac1599f0ade/



Nordic: update application start address in GCC linker script

Who changed what in which revision?

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