PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

targets/cmsis/TARGET_STM/TARGET_STM32F7/stm32f7xx_hal_hcd.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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