Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_MTS_MDOT_F405RG/stm32f4xx_hal_hcd.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
92:4fc01daae5a5
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

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