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_F446RE/stm32f4xx_hal_hcd.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b 
.

Who changed what in which revision?

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