Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_ARCH_MAX/stm32f4xx_hal_hcd.h@89:552587b429a1, 2014-09-12 (annotated)

Committer:
bogdanm
Date:
Fri Sep 12 16:41:52 2014 +0100
Revision:
89:552587b429a1
Child:
92:4fc01daae5a5
Release 89 of the mbed library



Main changes:



- low power optimizations for Nordic targets

- code structure changes for Freescale K64F targets

- bug fixes in various backends

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
bogdanm 89:552587b429a1 5 * @version V1.1.0RC2
bogdanm 89:552587b429a1 6 * @date 14-May-2014
bogdanm 89:552587b429a1 7 * @brief Header file of HCD HAL module.
bogdanm 89:552587b429a1 8 ******************************************************************************
bogdanm 89:552587b429a1 9 * @attention
bogdanm 89:552587b429a1 10 *
bogdanm 89:552587b429a1 11 * <h2><center>&copy; COPYRIGHT(c) 2014 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
bogdanm 89:552587b429a1 45
bogdanm 89:552587b429a1 46 /* Includes ------------------------------------------------------------------*/
bogdanm 89:552587b429a1 47 #include "stm32f4xx_ll_usb.h"
bogdanm 89:552587b429a1 48
bogdanm 89:552587b429a1 49 /** @addtogroup STM32F4xx_HAL_Driver
bogdanm 89:552587b429a1 50 * @{
bogdanm 89:552587b429a1 51 */
bogdanm 89:552587b429a1 52
bogdanm 89:552587b429a1 53 /** @addtogroup HCD
bogdanm 89:552587b429a1 54 * @{
bogdanm 89:552587b429a1 55 */
bogdanm 89:552587b429a1 56
bogdanm 89:552587b429a1 57 /* Exported types ------------------------------------------------------------*/
bogdanm 89:552587b429a1 58
bogdanm 89:552587b429a1 59 /**
bogdanm 89:552587b429a1 60 * @brief HCD Status structures structure definition
bogdanm 89:552587b429a1 61 */
bogdanm 89:552587b429a1 62 typedef enum
bogdanm 89:552587b429a1 63 {
bogdanm 89:552587b429a1 64 HCD_READY = 0x00,
bogdanm 89:552587b429a1 65 HCD_ERROR = 0x01,
bogdanm 89:552587b429a1 66 HCD_BUSY = 0x02,
bogdanm 89:552587b429a1 67 HCD_TIMEOUT = 0x03
bogdanm 89:552587b429a1 68 } HCD_StateTypeDef;
bogdanm 89:552587b429a1 69
bogdanm 89:552587b429a1 70 typedef USB_OTG_GlobalTypeDef HCD_TypeDef;
bogdanm 89:552587b429a1 71 typedef USB_OTG_CfgTypeDef HCD_InitTypeDef;
bogdanm 89:552587b429a1 72 typedef USB_OTG_HCTypeDef HCD_HCTypeDef ;
bogdanm 89:552587b429a1 73 typedef USB_OTG_URBStateTypeDef HCD_URBStateTypeDef ;
bogdanm 89:552587b429a1 74 typedef USB_OTG_HCStateTypeDef HCD_HCStateTypeDef ;
bogdanm 89:552587b429a1 75
bogdanm 89:552587b429a1 76 /**
bogdanm 89:552587b429a1 77 * @brief HCD Handle Structure definition
bogdanm 89:552587b429a1 78 */
bogdanm 89:552587b429a1 79 typedef struct
bogdanm 89:552587b429a1 80 {
bogdanm 89:552587b429a1 81 HCD_TypeDef *Instance; /*!< Register base address */
bogdanm 89:552587b429a1 82 HCD_InitTypeDef Init; /*!< HCD required parameters */
bogdanm 89:552587b429a1 83 HCD_HCTypeDef hc[15]; /*!< Host channels parameters */
bogdanm 89:552587b429a1 84 HAL_LockTypeDef Lock; /*!< HCD peripheral status */
bogdanm 89:552587b429a1 85 __IO HCD_StateTypeDef State; /*!< HCD communication state */
bogdanm 89:552587b429a1 86 void *pData; /*!< Pointer Stack Handler */
bogdanm 89:552587b429a1 87
bogdanm 89:552587b429a1 88 } HCD_HandleTypeDef;
bogdanm 89:552587b429a1 89
bogdanm 89:552587b429a1 90 /* Exported constants --------------------------------------------------------*/
bogdanm 89:552587b429a1 91 /** @defgroup HCD_Exported_Constants
bogdanm 89:552587b429a1 92 * @{
bogdanm 89:552587b429a1 93 */
bogdanm 89:552587b429a1 94
bogdanm 89:552587b429a1 95 /** @defgroup HCD_Instance_definition
bogdanm 89:552587b429a1 96 * @{
bogdanm 89:552587b429a1 97 */
bogdanm 89:552587b429a1 98
bogdanm 89:552587b429a1 99 #define __HAL_HCD_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
bogdanm 89:552587b429a1 100 #define __HAL_HCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) |= (__INTERRUPT__))
bogdanm 89:552587b429a1 101 #define __HAL_HCD_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0)
bogdanm 89:552587b429a1 102
bogdanm 89:552587b429a1 103
bogdanm 89:552587b429a1 104 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
bogdanm 89:552587b429a1 105 #define IS_HCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS) || \
bogdanm 89:552587b429a1 106 ((INSTANCE) == USB_OTG_HS))
bogdanm 89:552587b429a1 107 #elif defined(STM32F401xC) || defined(STM32F401xE)
bogdanm 89:552587b429a1 108 #define IS_HCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS))
bogdanm 89:552587b429a1 109 #endif
bogdanm 89:552587b429a1 110
bogdanm 89:552587b429a1 111 /**
bogdanm 89:552587b429a1 112 * @}
bogdanm 89:552587b429a1 113 */
bogdanm 89:552587b429a1 114
bogdanm 89:552587b429a1 115 /** @defgroup HCD_Speed
bogdanm 89:552587b429a1 116 * @{
bogdanm 89:552587b429a1 117 */
bogdanm 89:552587b429a1 118 #define HCD_SPEED_HIGH 0
bogdanm 89:552587b429a1 119 #define HCD_SPEED_LOW 2
bogdanm 89:552587b429a1 120 #define HCD_SPEED_FULL 3
bogdanm 89:552587b429a1 121
bogdanm 89:552587b429a1 122 /**
bogdanm 89:552587b429a1 123 * @}
bogdanm 89:552587b429a1 124 */
bogdanm 89:552587b429a1 125
bogdanm 89:552587b429a1 126 /** @defgroup HCD_PHY_Module
bogdanm 89:552587b429a1 127 * @{
bogdanm 89:552587b429a1 128 */
bogdanm 89:552587b429a1 129 #define HCD_PHY_ULPI 1
bogdanm 89:552587b429a1 130 #define HCD_PHY_EMBEDDED 2
bogdanm 89:552587b429a1 131 /**
bogdanm 89:552587b429a1 132 * @}
bogdanm 89:552587b429a1 133 */
bogdanm 89:552587b429a1 134 /**
bogdanm 89:552587b429a1 135 * @}
bogdanm 89:552587b429a1 136 */
bogdanm 89:552587b429a1 137
bogdanm 89:552587b429a1 138 /* Exported macro ------------------------------------------------------------*/
bogdanm 89:552587b429a1 139
bogdanm 89:552587b429a1 140 /** @defgroup HCD_Interrupt_Clock
bogdanm 89:552587b429a1 141 * @brief macros to handle interrupts and specific clock configurations
bogdanm 89:552587b429a1 142 * @{
bogdanm 89:552587b429a1 143 */
bogdanm 89:552587b429a1 144 #define __HAL_HCD_ENABLE(__HANDLE__) USB_EnableGlobalInt ((__HANDLE__)->Instance)
bogdanm 89:552587b429a1 145 #define __HAL_HCD_DISABLE(__HANDLE__) USB_DisableGlobalInt ((__HANDLE__)->Instance)
bogdanm 89:552587b429a1 146
bogdanm 89:552587b429a1 147 #define __HAL_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
bogdanm 89:552587b429a1 148 #define __HAL_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) |= (__INTERRUPT__))
bogdanm 89:552587b429a1 149 #define __HAL_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0)
bogdanm 89:552587b429a1 150
bogdanm 89:552587b429a1 151
bogdanm 89:552587b429a1 152 #define __HAL_HCD_CLEAR_HC_INT(chnum, __INTERRUPT__) (USBx_HC(chnum)->HCINT = (__INTERRUPT__))
bogdanm 89:552587b429a1 153 #define __HAL_HCD_MASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_CHHM)
bogdanm 89:552587b429a1 154 #define __HAL_HCD_UNMASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_CHHM)
bogdanm 89:552587b429a1 155 #define __HAL_HCD_MASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_ACKM)
bogdanm 89:552587b429a1 156 #define __HAL_HCD_UNMASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_ACKM)
bogdanm 89:552587b429a1 157
bogdanm 89:552587b429a1 158 /**
bogdanm 89:552587b429a1 159 * @}
bogdanm 89:552587b429a1 160 */
bogdanm 89:552587b429a1 161
bogdanm 89:552587b429a1 162 /* Exported functions --------------------------------------------------------*/
bogdanm 89:552587b429a1 163
bogdanm 89:552587b429a1 164 /* Initialization/de-initialization functions **********************************/
bogdanm 89:552587b429a1 165 HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 166 HAL_StatusTypeDef HAL_HCD_DeInit (HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 167 HAL_StatusTypeDef HAL_HCD_HC_Init(HCD_HandleTypeDef *hhcd,
bogdanm 89:552587b429a1 168 uint8_t ch_num,
bogdanm 89:552587b429a1 169 uint8_t epnum,
bogdanm 89:552587b429a1 170 uint8_t dev_address,
bogdanm 89:552587b429a1 171 uint8_t speed,
bogdanm 89:552587b429a1 172 uint8_t ep_type,
bogdanm 89:552587b429a1 173 uint16_t mps);
bogdanm 89:552587b429a1 174
bogdanm 89:552587b429a1 175 HAL_StatusTypeDef HAL_HCD_HC_Halt(HCD_HandleTypeDef *hhcd,
bogdanm 89:552587b429a1 176 uint8_t ch_num);
bogdanm 89:552587b429a1 177
bogdanm 89:552587b429a1 178 void HAL_HCD_MspInit(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 179 void HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 180
bogdanm 89:552587b429a1 181 /* I/O operation functions *****************************************************/
bogdanm 89:552587b429a1 182 HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest(HCD_HandleTypeDef *hhcd,
bogdanm 89:552587b429a1 183 uint8_t pipe,
bogdanm 89:552587b429a1 184 uint8_t direction ,
bogdanm 89:552587b429a1 185 uint8_t ep_type,
bogdanm 89:552587b429a1 186 uint8_t token,
bogdanm 89:552587b429a1 187 uint8_t* pbuff,
bogdanm 89:552587b429a1 188 uint16_t length,
bogdanm 89:552587b429a1 189 uint8_t do_ping);
bogdanm 89:552587b429a1 190
bogdanm 89:552587b429a1 191 /* Non-Blocking mode: Interrupt */
bogdanm 89:552587b429a1 192 void HAL_HCD_IRQHandler(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 193 void HAL_HCD_SOF_Callback(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 194 void HAL_HCD_Connect_Callback(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 195 void HAL_HCD_Disconnect_Callback(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 196 void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd,
bogdanm 89:552587b429a1 197 uint8_t chnum,
bogdanm 89:552587b429a1 198 HCD_URBStateTypeDef urb_state);
bogdanm 89:552587b429a1 199
bogdanm 89:552587b429a1 200 /* Peripheral Control functions ************************************************/
bogdanm 89:552587b429a1 201 HAL_StatusTypeDef HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 202 HAL_StatusTypeDef HAL_HCD_Start(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 203 HAL_StatusTypeDef HAL_HCD_Stop(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 204
bogdanm 89:552587b429a1 205 /* Peripheral State functions **************************************************/
bogdanm 89:552587b429a1 206 HCD_StateTypeDef HAL_HCD_GetState(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 207 HCD_URBStateTypeDef HAL_HCD_HC_GetURBState(HCD_HandleTypeDef *hhcd, uint8_t chnum);
bogdanm 89:552587b429a1 208 uint32_t HAL_HCD_HC_GetXferCount(HCD_HandleTypeDef *hhcd, uint8_t chnum);
bogdanm 89:552587b429a1 209 HCD_HCStateTypeDef HAL_HCD_HC_GetState(HCD_HandleTypeDef *hhcd, uint8_t chnum);
bogdanm 89:552587b429a1 210 uint32_t HAL_HCD_GetCurrentFrame(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 211 uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd);
bogdanm 89:552587b429a1 212
bogdanm 89:552587b429a1 213 /**
bogdanm 89:552587b429a1 214 * @}
bogdanm 89:552587b429a1 215 */
bogdanm 89:552587b429a1 216
bogdanm 89:552587b429a1 217 /**
bogdanm 89:552587b429a1 218 * @}
bogdanm 89:552587b429a1 219 */
bogdanm 89:552587b429a1 220
bogdanm 89:552587b429a1 221 #ifdef __cplusplus
bogdanm 89:552587b429a1 222 }
bogdanm 89:552587b429a1 223 #endif
bogdanm 89:552587b429a1 224
bogdanm 89:552587b429a1 225 #endif /* __STM32F4xx_HAL_HCD_H */
bogdanm 89:552587b429a1 226
bogdanm 89:552587b429a1 227 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/