Vladimir Vana / mbed

pro vyuku PSS v Jecne

TARGET_NUCLEO_F103RB/stm32f1xx_hal_hcd.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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