Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F746ZG/stm32f7xx_hal_hcd.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
116:c0f6e94411f5 
.

Who changed what in which revision?

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