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

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
107:4f6c30876dfa 
.

Who changed what in which revision?

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