shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F407VG/stm32f4xx_hal_hcd.h@296:ec1b66a3d094, 2014-08-21 (annotated)

Committer:
mbed_official
Date:
Thu Aug 21 15:00:08 2014 +0100
Revision:
296:ec1b66a3d094
Parent:
targets/cmsis/TARGET_STM/TARGET_DISCO_F407VG/stm32f4xx_hal_hcd.h@242:7074e42da0b2 
Synchronized with git revision bbc120c4786e99dfa586e7a13f8638064f1e5938



Full URL: https://github.com/mbedmicro/mbed/commit/bbc120c4786e99dfa586e7a13f8638064f1e5938/



DISCO_F407VG - add USBDevice support and a variant - ARCH_MAX

Who changed what in which revision?

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