PHung Tung / DISCO-F746_WAV_PLAYER

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 21:37:21 2019 +0000
Revision:
0:8ede47d38d10
SPKT

Who changed what in which revision?

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