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.

Committer:
AnnaBridge
Date:
Tue Mar 20 13:30:58 2018 +0000
Revision:
163:e59c8e839560
Parent:
156:ff21514d8981
mbed library. Release version 160

Who changed what in which revision?

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