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