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_B96B_F446VE/stm32f4xx_hal_hcd.h@112:6f327212ef96, 2016-01-13 (annotated)

Committer:
Kojto
Date:
Wed Jan 13 09:48:29 2016 +0000
Revision:
112:6f327212ef96
Release 112 of the mbed library



Changes:

- new platforms - STM32 B96B F446, MOTE_L152RC

- nrf51 - fix serial init bug (character sent)

- stm all devices - fix RTC clocking in the init

- stm f0 - SystemInit clock fix, for SetVector()

- RawSerial - fix for microlib (vsnprintf with size 0)

Who changed what in which revision?

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