Paul Paterson / mbed-src-CanNucleoF0

mbed library sources, include can_api for nucleo-f091rc

Dependents:   CanNucleoF0_example

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F7/stm32f7xx_hal_hcd.h@645:13c87cbecd54, 2016-01-07 (annotated)

Committer:
ptpaterson
Date:
Thu Jan 07 05:49:05 2016 +0000
Revision:
645:13c87cbecd54
Parent:
610:813dcc80987e 
corrected freeze on CAN_RECEIVE_IT

Who changed what in which revision?

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