1 /** 2 ****************************************************************************** 3 * @file stm32f4xx_ll_usb.h 4 * @author MCD Application Team 5 * @brief Header file of USB Low Layer HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * <h2><center>© Copyright (c) 2016 STMicroelectronics. 10 * All rights reserved.</center></h2> 11 * 12 * This software component is licensed by ST under BSD 3-Clause license, 13 * the "License"; You may not use this file except in compliance with the 14 * License. You may obtain a copy of the License at: 15 * opensource.org/licenses/BSD-3-Clause 16 * 17 ****************************************************************************** 18 */ 19 20 /* Define to prevent recursive inclusion -------------------------------------*/ 21 #ifndef STM32F4xx_LL_USB_H 22 #define STM32F4xx_LL_USB_H 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 /* Includes ------------------------------------------------------------------*/ 29 #include "stm32f4xx_hal_def.h" 30 31 #if defined (USB_OTG_FS) || defined (USB_OTG_HS) 32 /** @addtogroup STM32F4xx_HAL_Driver 33 * @{ 34 */ 35 36 /** @addtogroup USB_LL 37 * @{ 38 */ 39 40 /* Exported types ------------------------------------------------------------*/ 41 42 /** 43 * @brief USB Mode definition 44 */ 45 #if defined (USB_OTG_FS) || defined (USB_OTG_HS) 46 47 typedef enum 48 { 49 USB_DEVICE_MODE = 0, 50 USB_HOST_MODE = 1, 51 USB_DRD_MODE = 2 52 } USB_OTG_ModeTypeDef; 53 54 /** 55 * @brief URB States definition 56 */ 57 typedef enum 58 { 59 URB_IDLE = 0, 60 URB_DONE, 61 URB_NOTREADY, 62 URB_NYET, 63 URB_ERROR, 64 URB_STALL 65 } USB_OTG_URBStateTypeDef; 66 67 /** 68 * @brief Host channel States definition 69 */ 70 typedef enum 71 { 72 HC_IDLE = 0, 73 HC_XFRC, 74 HC_HALTED, 75 HC_NAK, 76 HC_NYET, 77 HC_STALL, 78 HC_XACTERR, 79 HC_BBLERR, 80 HC_DATATGLERR 81 } USB_OTG_HCStateTypeDef; 82 83 /** 84 * @brief USB Instance Initialization Structure definition 85 */ 86 typedef struct 87 { 88 uint32_t dev_endpoints; /*!< Device Endpoints number. 89 This parameter depends on the used USB core. 90 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */ 91 92 uint32_t Host_channels; /*!< Host Channels number. 93 This parameter Depends on the used USB core. 94 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */ 95 96 uint32_t speed; /*!< USB Core speed. 97 This parameter can be any value of @ref USB_Core_Speed */ 98 99 uint32_t dma_enable; /*!< Enable or disable of the USB embedded DMA used only for OTG HS. */ 100 101 uint32_t ep0_mps; /*!< Set the Endpoint 0 Max Packet size. */ 102 103 uint32_t phy_itface; /*!< Select the used PHY interface. 104 This parameter can be any value of @ref USB_Core_PHY */ 105 106 uint32_t Sof_enable; /*!< Enable or disable the output of the SOF signal. */ 107 108 uint32_t low_power_enable; /*!< Enable or disable the low power mode. */ 109 110 uint32_t lpm_enable; /*!< Enable or disable Link Power Management. */ 111 112 uint32_t battery_charging_enable; /*!< Enable or disable Battery charging. */ 113 114 uint32_t vbus_sensing_enable; /*!< Enable or disable the VBUS Sensing feature. */ 115 116 uint32_t use_dedicated_ep1; /*!< Enable or disable the use of the dedicated EP1 interrupt. */ 117 118 uint32_t use_external_vbus; /*!< Enable or disable the use of the external VBUS. */ 119 120 } USB_OTG_CfgTypeDef; 121 122 typedef struct 123 { 124 uint8_t num; /*!< Endpoint number 125 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */ 126 127 uint8_t is_in; /*!< Endpoint direction 128 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */ 129 130 uint8_t is_stall; /*!< Endpoint stall condition 131 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */ 132 133 uint8_t type; /*!< Endpoint type 134 This parameter can be any value of @ref USB_EP_Type_ */ 135 136 uint8_t data_pid_start; /*!< Initial data PID 137 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */ 138 139 uint8_t even_odd_frame; /*!< IFrame parity 140 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */ 141 142 uint16_t tx_fifo_num; /*!< Transmission FIFO number 143 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */ 144 145 uint32_t maxpacket; /*!< Endpoint Max packet size 146 This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */ 147 148 uint8_t *xfer_buff; /*!< Pointer to transfer buffer */ 149 150 uint32_t dma_addr; /*!< 32 bits aligned transfer buffer address */ 151 152 uint32_t xfer_len; /*!< Current transfer length */ 153 154 uint32_t xfer_count; /*!< Partial transfer length in case of multi packet transfer */ 155 } USB_OTG_EPTypeDef; 156 157 typedef struct 158 { 159 uint8_t dev_addr; /*!< USB device address. 160 This parameter must be a number between Min_Data = 1 and Max_Data = 255 */ 161 162 uint8_t ch_num; /*!< Host channel number. 163 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */ 164 165 uint8_t ep_num; /*!< Endpoint number. 166 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */ 167 168 uint8_t ep_is_in; /*!< Endpoint direction 169 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */ 170 171 uint8_t speed; /*!< USB Host speed. 172 This parameter can be any value of @ref USB_Core_Speed_ */ 173 174 uint8_t do_ping; /*!< Enable or disable the use of the PING protocol for HS mode. */ 175 176 uint8_t process_ping; /*!< Execute the PING protocol for HS mode. */ 177 178 uint8_t ep_type; /*!< Endpoint Type. 179 This parameter can be any value of @ref USB_EP_Type_ */ 180 181 uint16_t max_packet; /*!< Endpoint Max packet size. 182 This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */ 183 184 uint8_t data_pid; /*!< Initial data PID. 185 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */ 186 187 uint8_t *xfer_buff; /*!< Pointer to transfer buffer. */ 188 189 uint32_t xfer_len; /*!< Current transfer length. */ 190 191 uint32_t xfer_count; /*!< Partial transfer length in case of multi packet transfer. */ 192 193 uint8_t toggle_in; /*!< IN transfer current toggle flag. 194 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */ 195 196 uint8_t toggle_out; /*!< OUT transfer current toggle flag 197 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */ 198 199 uint32_t dma_addr; /*!< 32 bits aligned transfer buffer address. */ 200 201 uint32_t ErrCnt; /*!< Host channel error count. */ 202 203 USB_OTG_URBStateTypeDef urb_state; /*!< URB state. 204 This parameter can be any value of @ref USB_OTG_URBStateTypeDef */ 205 206 USB_OTG_HCStateTypeDef state; /*!< Host Channel state. 207 This parameter can be any value of @ref USB_OTG_HCStateTypeDef */ 208 } USB_OTG_HCTypeDef; 209 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */ 210 211 212 /* Exported constants --------------------------------------------------------*/ 213 214 /** @defgroup PCD_Exported_Constants PCD Exported Constants 215 * @{ 216 */ 217 218 #if defined (USB_OTG_FS) || defined (USB_OTG_HS) 219 /** @defgroup USB_OTG_CORE VERSION ID 220 * @{ 221 */ 222 #define USB_OTG_CORE_ID_300A 0x4F54300AU 223 #define USB_OTG_CORE_ID_310A 0x4F54310AU 224 /** 225 * @} 226 */ 227 228 /** @defgroup USB_Core_Mode_ USB Core Mode 229 * @{ 230 */ 231 #define USB_OTG_MODE_DEVICE 0U 232 #define USB_OTG_MODE_HOST 1U 233 #define USB_OTG_MODE_DRD 2U 234 /** 235 * @} 236 */ 237 238 /** @defgroup USB_LL Device Speed 239 * @{ 240 */ 241 #define USBD_HS_SPEED 0U 242 #define USBD_HSINFS_SPEED 1U 243 #define USBH_HS_SPEED 0U 244 #define USBD_FS_SPEED 2U 245 #define USBH_FSLS_SPEED 1U 246 /** 247 * @} 248 */ 249 250 /** @defgroup USB_LL_Core_Speed USB Low Layer Core Speed 251 * @{ 252 */ 253 #define USB_OTG_SPEED_HIGH 0U 254 #define USB_OTG_SPEED_HIGH_IN_FULL 1U 255 #define USB_OTG_SPEED_FULL 3U 256 /** 257 * @} 258 */ 259 260 /** @defgroup USB_LL_Core_PHY USB Low Layer Core PHY 261 * @{ 262 */ 263 #define USB_OTG_ULPI_PHY 1U 264 #define USB_OTG_EMBEDDED_PHY 2U 265 /** 266 * @} 267 */ 268 269 /** @defgroup USB_LL_Turnaround_Timeout Turnaround Timeout Value 270 * @{ 271 */ 272 #ifndef USBD_HS_TRDT_VALUE 273 #define USBD_HS_TRDT_VALUE 9U 274 #endif /* USBD_HS_TRDT_VALUE */ 275 #ifndef USBD_FS_TRDT_VALUE 276 #define USBD_FS_TRDT_VALUE 5U 277 #define USBD_DEFAULT_TRDT_VALUE 9U 278 #endif /* USBD_HS_TRDT_VALUE */ 279 /** 280 * @} 281 */ 282 283 /** @defgroup USB_LL_Core_MPS USB Low Layer Core MPS 284 * @{ 285 */ 286 #define USB_OTG_HS_MAX_PACKET_SIZE 512U 287 #define USB_OTG_FS_MAX_PACKET_SIZE 64U 288 #define USB_OTG_MAX_EP0_SIZE 64U 289 /** 290 * @} 291 */ 292 293 /** @defgroup USB_LL_Core_PHY_Frequency USB Low Layer Core PHY Frequency 294 * @{ 295 */ 296 #define DSTS_ENUMSPD_HS_PHY_30MHZ_OR_60MHZ (0U << 1) 297 #define DSTS_ENUMSPD_FS_PHY_30MHZ_OR_60MHZ (1U << 1) 298 #define DSTS_ENUMSPD_FS_PHY_48MHZ (3U << 1) 299 /** 300 * @} 301 */ 302 303 /** @defgroup USB_LL_CORE_Frame_Interval USB Low Layer Core Frame Interval 304 * @{ 305 */ 306 #define DCFG_FRAME_INTERVAL_80 0U 307 #define DCFG_FRAME_INTERVAL_85 1U 308 #define DCFG_FRAME_INTERVAL_90 2U 309 #define DCFG_FRAME_INTERVAL_95 3U 310 /** 311 * @} 312 */ 313 314 /** @defgroup USB_LL_EP0_MPS USB Low Layer EP0 MPS 315 * @{ 316 */ 317 #define EP_MPS_64 0U 318 #define EP_MPS_32 1U 319 #define EP_MPS_16 2U 320 #define EP_MPS_8 3U 321 /** 322 * @} 323 */ 324 325 /** @defgroup USB_LL_EP_Speed USB Low Layer EP Speed 326 * @{ 327 */ 328 #define EP_SPEED_LOW 0U 329 #define EP_SPEED_FULL 1U 330 #define EP_SPEED_HIGH 2U 331 /** 332 * @} 333 */ 334 335 /** @defgroup USB_LL_EP_Type USB Low Layer EP Type 336 * @{ 337 */ 338 #define EP_TYPE_CTRL 0U 339 #define EP_TYPE_ISOC 1U 340 #define EP_TYPE_BULK 2U 341 #define EP_TYPE_INTR 3U 342 #define EP_TYPE_MSK 3U 343 /** 344 * @} 345 */ 346 347 /** @defgroup USB_LL_STS_Defines USB Low Layer STS Defines 348 * @{ 349 */ 350 #define STS_GOUT_NAK 1U 351 #define STS_DATA_UPDT 2U 352 #define STS_XFER_COMP 3U 353 #define STS_SETUP_COMP 4U 354 #define STS_SETUP_UPDT 6U 355 /** 356 * @} 357 */ 358 359 /** @defgroup USB_LL_HCFG_SPEED_Defines USB Low Layer HCFG Speed Defines 360 * @{ 361 */ 362 #define HCFG_30_60_MHZ 0U 363 #define HCFG_48_MHZ 1U 364 #define HCFG_6_MHZ 2U 365 /** 366 * @} 367 */ 368 369 /** @defgroup USB_LL_HPRT0_PRTSPD_SPEED_Defines USB Low Layer HPRT0 PRTSPD Speed Defines 370 * @{ 371 */ 372 #define HPRT0_PRTSPD_HIGH_SPEED 0U 373 #define HPRT0_PRTSPD_FULL_SPEED 1U 374 #define HPRT0_PRTSPD_LOW_SPEED 2U 375 /** 376 * @} 377 */ 378 379 #define HCCHAR_CTRL 0U 380 #define HCCHAR_ISOC 1U 381 #define HCCHAR_BULK 2U 382 #define HCCHAR_INTR 3U 383 384 #define HC_PID_DATA0 0U 385 #define HC_PID_DATA2 1U 386 #define HC_PID_DATA1 2U 387 #define HC_PID_SETUP 3U 388 389 #define GRXSTS_PKTSTS_IN 2U 390 #define GRXSTS_PKTSTS_IN_XFER_COMP 3U 391 #define GRXSTS_PKTSTS_DATA_TOGGLE_ERR 5U 392 #define GRXSTS_PKTSTS_CH_HALTED 7U 393 394 #define USBx_PCGCCTL *(__IO uint32_t *)((uint32_t)USBx_BASE + USB_OTG_PCGCCTL_BASE) 395 #define USBx_HPRT0 *(__IO uint32_t *)((uint32_t)USBx_BASE + USB_OTG_HOST_PORT_BASE) 396 397 #define USBx_DEVICE ((USB_OTG_DeviceTypeDef *)(USBx_BASE + USB_OTG_DEVICE_BASE)) 398 #define USBx_INEP(i) ((USB_OTG_INEndpointTypeDef *)(USBx_BASE + USB_OTG_IN_ENDPOINT_BASE + ((i) * USB_OTG_EP_REG_SIZE))) 399 #define USBx_OUTEP(i) ((USB_OTG_OUTEndpointTypeDef *)(USBx_BASE + USB_OTG_OUT_ENDPOINT_BASE + ((i) * USB_OTG_EP_REG_SIZE))) 400 #define USBx_DFIFO(i) *(__IO uint32_t *)(USBx_BASE + USB_OTG_FIFO_BASE + ((i) * USB_OTG_FIFO_SIZE)) 401 402 #define USBx_HOST ((USB_OTG_HostTypeDef *)(USBx_BASE + USB_OTG_HOST_BASE)) 403 #define USBx_HC(i) ((USB_OTG_HostChannelTypeDef *)(USBx_BASE + USB_OTG_HOST_CHANNEL_BASE + ((i) * USB_OTG_HOST_CHANNEL_SIZE))) 404 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */ 405 406 #define EP_ADDR_MSK 0xFU 407 /** 408 * @} 409 */ 410 411 /* Exported macro ------------------------------------------------------------*/ 412 /** @defgroup USB_LL_Exported_Macros USB Low Layer Exported Macros 413 * @{ 414 */ 415 #if defined (USB_OTG_FS) || defined (USB_OTG_HS) 416 #define USB_MASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK &= ~(__INTERRUPT__)) 417 #define USB_UNMASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK |= (__INTERRUPT__)) 418 419 #define CLEAR_IN_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_INEP(__EPNUM__)->DIEPINT = (__INTERRUPT__)) 420 #define CLEAR_OUT_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_OUTEP(__EPNUM__)->DOEPINT = (__INTERRUPT__)) 421 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */ 422 /** 423 * @} 424 */ 425 426 /* Exported functions --------------------------------------------------------*/ 427 /** @addtogroup USB_LL_Exported_Functions USB Low Layer Exported Functions 428 * @{ 429 */ 430 #if defined (USB_OTG_FS) || defined (USB_OTG_HS) 431 HAL_StatusTypeDef USB_CoreInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef cfg); 432 HAL_StatusTypeDef USB_DevInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef cfg); 433 HAL_StatusTypeDef USB_EnableGlobalInt(USB_OTG_GlobalTypeDef *USBx); 434 HAL_StatusTypeDef USB_DisableGlobalInt(USB_OTG_GlobalTypeDef *USBx); 435 HAL_StatusTypeDef USB_SetTurnaroundTime(USB_OTG_GlobalTypeDef *USBx, uint32_t hclk, uint8_t speed); 436 HAL_StatusTypeDef USB_SetCurrentMode(USB_OTG_GlobalTypeDef *USBx, USB_OTG_ModeTypeDef mode); 437 HAL_StatusTypeDef USB_SetDevSpeed(USB_OTG_GlobalTypeDef *USBx, uint8_t speed); 438 HAL_StatusTypeDef USB_FlushRxFifo(USB_OTG_GlobalTypeDef *USBx); 439 HAL_StatusTypeDef USB_FlushTxFifo(USB_OTG_GlobalTypeDef *USBx, uint32_t num); 440 HAL_StatusTypeDef USB_ActivateEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep); 441 HAL_StatusTypeDef USB_DeactivateEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep); 442 HAL_StatusTypeDef USB_ActivateDedicatedEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep); 443 HAL_StatusTypeDef USB_DeactivateDedicatedEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep); 444 HAL_StatusTypeDef USB_EPStartXfer(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep, uint8_t dma); 445 HAL_StatusTypeDef USB_EP0StartXfer(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep, uint8_t dma); 446 HAL_StatusTypeDef USB_WritePacket(USB_OTG_GlobalTypeDef *USBx, uint8_t *src, 447 uint8_t ch_ep_num, uint16_t len, uint8_t dma); 448 449 void *USB_ReadPacket(USB_OTG_GlobalTypeDef *USBx, uint8_t *dest, uint16_t len); 450 HAL_StatusTypeDef USB_EPSetStall(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep); 451 HAL_StatusTypeDef USB_EPClearStall(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep); 452 HAL_StatusTypeDef USB_SetDevAddress(USB_OTG_GlobalTypeDef *USBx, uint8_t address); 453 HAL_StatusTypeDef USB_DevConnect(USB_OTG_GlobalTypeDef *USBx); 454 HAL_StatusTypeDef USB_DevDisconnect(USB_OTG_GlobalTypeDef *USBx); 455 HAL_StatusTypeDef USB_StopDevice(USB_OTG_GlobalTypeDef *USBx); 456 HAL_StatusTypeDef USB_ActivateSetup(USB_OTG_GlobalTypeDef *USBx); 457 HAL_StatusTypeDef USB_EP0_OutStart(USB_OTG_GlobalTypeDef *USBx, uint8_t dma, uint8_t *psetup); 458 uint8_t USB_GetDevSpeed(USB_OTG_GlobalTypeDef *USBx); 459 uint32_t USB_GetMode(USB_OTG_GlobalTypeDef *USBx); 460 uint32_t USB_ReadInterrupts(USB_OTG_GlobalTypeDef *USBx); 461 uint32_t USB_ReadDevAllOutEpInterrupt(USB_OTG_GlobalTypeDef *USBx); 462 uint32_t USB_ReadDevOutEPInterrupt(USB_OTG_GlobalTypeDef *USBx, uint8_t epnum); 463 uint32_t USB_ReadDevAllInEpInterrupt(USB_OTG_GlobalTypeDef *USBx); 464 uint32_t USB_ReadDevInEPInterrupt(USB_OTG_GlobalTypeDef *USBx, uint8_t epnum); 465 void USB_ClearInterrupts(USB_OTG_GlobalTypeDef *USBx, uint32_t interrupt); 466 467 HAL_StatusTypeDef USB_HostInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef cfg); 468 HAL_StatusTypeDef USB_InitFSLSPClkSel(USB_OTG_GlobalTypeDef *USBx, uint8_t freq); 469 HAL_StatusTypeDef USB_ResetPort(USB_OTG_GlobalTypeDef *USBx); 470 HAL_StatusTypeDef USB_DriveVbus(USB_OTG_GlobalTypeDef *USBx, uint8_t state); 471 uint32_t USB_GetHostSpeed(USB_OTG_GlobalTypeDef *USBx); 472 uint32_t USB_GetCurrentFrame(USB_OTG_GlobalTypeDef *USBx); 473 HAL_StatusTypeDef USB_HC_Init(USB_OTG_GlobalTypeDef *USBx, uint8_t ch_num, 474 uint8_t epnum, uint8_t dev_address, uint8_t speed, 475 uint8_t ep_type, uint16_t mps); 476 HAL_StatusTypeDef USB_HC_StartXfer(USB_OTG_GlobalTypeDef *USBx, 477 USB_OTG_HCTypeDef *hc, uint8_t dma); 478 479 uint32_t USB_HC_ReadInterrupt(USB_OTG_GlobalTypeDef *USBx); 480 HAL_StatusTypeDef USB_HC_Halt(USB_OTG_GlobalTypeDef *USBx, uint8_t hc_num); 481 HAL_StatusTypeDef USB_DoPing(USB_OTG_GlobalTypeDef *USBx, uint8_t ch_num); 482 HAL_StatusTypeDef USB_StopHost(USB_OTG_GlobalTypeDef *USBx); 483 HAL_StatusTypeDef USB_ActivateRemoteWakeup(USB_OTG_GlobalTypeDef *USBx); 484 HAL_StatusTypeDef USB_DeActivateRemoteWakeup(USB_OTG_GlobalTypeDef *USBx); 485 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */ 486 487 /** 488 * @} 489 */ 490 491 /** 492 * @} 493 */ 494 495 /** 496 * @} 497 */ 498 499 /** 500 * @} 501 */ 502 #endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */ 503 504 #ifdef __cplusplus 505 } 506 #endif 507 508 509 #endif /* STM32F4xx_LL_USB_H */ 510 511 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 512