2 ******************************************************************************
3 * @file stm32f4xx_ll_usb.h
4 * @author MCD Application Team
7 * @brief Header file of USB Core HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_LL_USB_H
40 #define __STM32F4xx_LL_USB_H
45 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
46 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
47 defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F446xx) || \
48 defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || \
49 defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
50 /* Includes ------------------------------------------------------------------*/
51 #include "stm32f4xx_hal_def.h"
53 /** @addtogroup STM32F4xx_HAL
57 /** @addtogroup USB_Core
61 /* Exported types ------------------------------------------------------------*/
64 * @brief USB Mode definition
68 USB_OTG_DEVICE_MODE
= 0U,
69 USB_OTG_HOST_MODE
= 1U,
75 * @brief URB States definition
85 }USB_OTG_URBStateTypeDef
;
88 * @brief Host channel States definition
101 }USB_OTG_HCStateTypeDef
;
104 * @brief PCD Initialization Structure definition
108 uint32_t dev_endpoints
; /*!< Device Endpoints number.
109 This parameter depends on the used USB core.
110 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
112 uint32_t Host_channels
; /*!< Host Channels number.
113 This parameter Depends on the used USB core.
114 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
116 uint32_t speed
; /*!< USB Core speed.
117 This parameter can be any value of @ref USB_Core_Speed_ */
119 uint32_t dma_enable
; /*!< Enable or disable of the USB embedded DMA. */
121 uint32_t ep0_mps
; /*!< Set the Endpoint 0 Max Packet size.
122 This parameter can be any value of @ref USB_EP0_MPS_ */
124 uint32_t phy_itface
; /*!< Select the used PHY interface.
125 This parameter can be any value of @ref USB_Core_PHY_ */
127 uint32_t Sof_enable
; /*!< Enable or disable the output of the SOF signal. */
129 uint32_t low_power_enable
; /*!< Enable or disable the low power mode. */
131 uint32_t lpm_enable
; /*!< Enable or disable Link Power Management. */
133 uint32_t battery_charging_enable
; /*!< Enable or disable Battery charging. */
135 uint32_t vbus_sensing_enable
; /*!< Enable or disable the VBUS Sensing feature. */
137 uint32_t use_dedicated_ep1
; /*!< Enable or disable the use of the dedicated EP1 interrupt. */
139 uint32_t use_external_vbus
; /*!< Enable or disable the use of the external VBUS. */
144 * @brief OTG End Point Initialization Structure definition
148 uint8_t num
; /*!< Endpoint number
149 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
151 uint8_t is_in
; /*!< Endpoint direction
152 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
154 uint8_t is_stall
; /*!< Endpoint stall condition
155 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
157 uint8_t type
; /*!< Endpoint type
158 This parameter can be any value of @ref USB_EP_Type_ */
160 uint8_t data_pid_start
; /*!< Initial data PID
161 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
163 uint8_t even_odd_frame
; /*!< IFrame parity
164 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
166 uint16_t tx_fifo_num
; /*!< Transmission FIFO number
167 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
169 uint32_t maxpacket
; /*!< Endpoint Max packet size
170 This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */
172 uint8_t *xfer_buff
; /*!< Pointer to transfer buffer */
174 uint32_t dma_addr
; /*!< 32 bits aligned transfer buffer address */
176 uint32_t xfer_len
; /*!< Current transfer length */
178 uint32_t xfer_count
; /*!< Partial transfer length in case of multi packet transfer */
183 * @brief OTG HC Initialization Structure definition
187 uint8_t dev_addr
; /*!< USB device address.
188 This parameter must be a number between Min_Data = 1 and Max_Data = 255 */
190 uint8_t ch_num
; /*!< Host channel number.
191 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
193 uint8_t ep_num
; /*!< Endpoint number.
194 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
196 uint8_t ep_is_in
; /*!< Endpoint direction
197 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
199 uint8_t speed
; /*!< USB Host speed.
200 This parameter can be any value of @ref USB_Core_Speed_ */
202 uint8_t do_ping
; /*!< Enable or disable the use of the PING protocol for HS mode. */
204 uint8_t process_ping
; /*!< Execute the PING protocol for HS mode. */
206 uint8_t ep_type
; /*!< Endpoint Type.
207 This parameter can be any value of @ref USB_EP_Type_ */
209 uint16_t max_packet
; /*!< Endpoint Max packet size.
210 This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */
212 uint8_t data_pid
; /*!< Initial data PID.
213 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
215 uint8_t *xfer_buff
; /*!< Pointer to transfer buffer. */
217 uint32_t xfer_len
; /*!< Current transfer length. */
219 uint32_t xfer_count
; /*!< Partial transfer length in case of multi packet transfer. */
221 uint8_t toggle_in
; /*!< IN transfer current toggle flag.
222 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
224 uint8_t toggle_out
; /*!< OUT transfer current toggle flag
225 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
227 uint32_t dma_addr
; /*!< 32 bits aligned transfer buffer address. */
229 uint32_t ErrCnt
; /*!< Host channel error count.*/
231 USB_OTG_URBStateTypeDef urb_state
; /*!< URB state.
232 This parameter can be any value of @ref USB_OTG_URBStateTypeDef */
234 USB_OTG_HCStateTypeDef state
; /*!< Host Channel state.
235 This parameter can be any value of @ref USB_OTG_HCStateTypeDef */
239 /* Exported constants --------------------------------------------------------*/
241 /** @defgroup PCD_Exported_Constants PCD Exported Constants
245 /** @defgroup USB_Core_Mode_ USB Core Mode
248 #define USB_OTG_MODE_DEVICE 0U
249 #define USB_OTG_MODE_HOST 1U
250 #define USB_OTG_MODE_DRD 2U
255 /** @defgroup USB_Core_Speed_ USB Core Speed
258 #define USB_OTG_SPEED_HIGH 0U
259 #define USB_OTG_SPEED_HIGH_IN_FULL 1U
260 #define USB_OTG_SPEED_LOW 2U
261 #define USB_OTG_SPEED_FULL 3U
266 /** @defgroup USB_Core_PHY_ USB Core PHY
269 #define USB_OTG_ULPI_PHY 1U
270 #define USB_OTG_EMBEDDED_PHY 2U
275 /** @defgroup USB_Core_MPS_ USB Core MPS
278 #define USB_OTG_HS_MAX_PACKET_SIZE 512U
279 #define USB_OTG_FS_MAX_PACKET_SIZE 64U
280 #define USB_OTG_MAX_EP0_SIZE 64U
285 /** @defgroup USB_Core_Phy_Frequency_ USB Core Phy Frequency
288 #define DSTS_ENUMSPD_HS_PHY_30MHZ_OR_60MHZ (0U << 1U)
289 #define DSTS_ENUMSPD_FS_PHY_30MHZ_OR_60MHZ (1U << 1U)
290 #define DSTS_ENUMSPD_LS_PHY_6MHZ (2U << 1U)
291 #define DSTS_ENUMSPD_FS_PHY_48MHZ (3U << 1U)
296 /** @defgroup USB_CORE_Frame_Interval_ USB CORE Frame Interval
299 #define DCFG_FRAME_INTERVAL_80 0U
300 #define DCFG_FRAME_INTERVAL_85 1U
301 #define DCFG_FRAME_INTERVAL_90 2U
302 #define DCFG_FRAME_INTERVAL_95 3U
307 /** @defgroup USB_EP0_MPS_ USB EP0 MPS
310 #define DEP0CTL_MPS_64 0U
311 #define DEP0CTL_MPS_32 1U
312 #define DEP0CTL_MPS_16 2U
313 #define DEP0CTL_MPS_8 3U
318 /** @defgroup USB_EP_Speed_ USB EP Speed
321 #define EP_SPEED_LOW 0U
322 #define EP_SPEED_FULL 1U
323 #define EP_SPEED_HIGH 2U
328 /** @defgroup USB_EP_Type_ USB EP Type
331 #define EP_TYPE_CTRL 0U
332 #define EP_TYPE_ISOC 1U
333 #define EP_TYPE_BULK 2U
334 #define EP_TYPE_INTR 3U
335 #define EP_TYPE_MSK 3U
340 /** @defgroup USB_STS_Defines_ USB STS Defines
343 #define STS_GOUT_NAK 1U
344 #define STS_DATA_UPDT 2U
345 #define STS_XFER_COMP 3U
346 #define STS_SETUP_COMP 4U
347 #define STS_SETUP_UPDT 6U
352 /** @defgroup HCFG_SPEED_Defines_ HCFG SPEED Defines
355 #define HCFG_30_60_MHZ 0U
356 #define HCFG_48_MHZ 1U
357 #define HCFG_6_MHZ 2U
362 /** @defgroup HPRT0_PRTSPD_SPEED_Defines_ HPRT0 PRTSPD SPEED Defines
365 #define HPRT0_PRTSPD_HIGH_SPEED 0U
366 #define HPRT0_PRTSPD_FULL_SPEED 1U
367 #define HPRT0_PRTSPD_LOW_SPEED 2U
372 #define HCCHAR_CTRL 0U
373 #define HCCHAR_ISOC 1U
374 #define HCCHAR_BULK 2U
375 #define HCCHAR_INTR 3U
377 #define HC_PID_DATA0 0U
378 #define HC_PID_DATA2 1U
379 #define HC_PID_DATA1 2U
380 #define HC_PID_SETUP 3U
382 #define GRXSTS_PKTSTS_IN 2U
383 #define GRXSTS_PKTSTS_IN_XFER_COMP 3U
384 #define GRXSTS_PKTSTS_DATA_TOGGLE_ERR 5U
385 #define GRXSTS_PKTSTS_CH_HALTED 7U
387 #define USBx_PCGCCTL *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_PCGCCTL_BASE)
388 #define USBx_HPRT0 *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_HOST_PORT_BASE)
390 #define USBx_DEVICE ((USB_OTG_DeviceTypeDef *)((uint32_t )USBx + USB_OTG_DEVICE_BASE))
391 #define USBx_INEP(i) ((USB_OTG_INEndpointTypeDef *)((uint32_t)USBx + USB_OTG_IN_ENDPOINT_BASE + (i)*USB_OTG_EP_REG_SIZE))
392 #define USBx_OUTEP(i) ((USB_OTG_OUTEndpointTypeDef *)((uint32_t)USBx + USB_OTG_OUT_ENDPOINT_BASE + (i)*USB_OTG_EP_REG_SIZE))
393 #define USBx_DFIFO(i) *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_FIFO_BASE + (i) * USB_OTG_FIFO_SIZE)
395 #define USBx_HOST ((USB_OTG_HostTypeDef *)((uint32_t )USBx + USB_OTG_HOST_BASE))
396 #define USBx_HC(i) ((USB_OTG_HostChannelTypeDef *)((uint32_t)USBx + USB_OTG_HOST_CHANNEL_BASE + (i)*USB_OTG_HOST_CHANNEL_SIZE))
400 /* Exported macro ------------------------------------------------------------*/
401 #define USB_MASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK &= ~(__INTERRUPT__))
402 #define USB_UNMASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK |= (__INTERRUPT__))
404 #define CLEAR_IN_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_INEP(__EPNUM__)->DIEPINT = (__INTERRUPT__))
405 #define CLEAR_OUT_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_OUTEP(__EPNUM__)->DOEPINT = (__INTERRUPT__))
407 /* Exported functions --------------------------------------------------------*/
408 HAL_StatusTypeDef
USB_CoreInit(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_CfgTypeDef Init
);
409 HAL_StatusTypeDef
USB_DevInit(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_CfgTypeDef Init
);
410 HAL_StatusTypeDef
USB_EnableGlobalInt(USB_OTG_GlobalTypeDef
*USBx
);
411 HAL_StatusTypeDef
USB_DisableGlobalInt(USB_OTG_GlobalTypeDef
*USBx
);
412 HAL_StatusTypeDef
USB_SetCurrentMode(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_ModeTypeDef mode
);
413 HAL_StatusTypeDef
USB_SetDevSpeed(USB_OTG_GlobalTypeDef
*USBx
, uint8_t speed
);
414 HAL_StatusTypeDef
USB_FlushRxFifo (USB_OTG_GlobalTypeDef
*USBx
);
415 HAL_StatusTypeDef
USB_FlushTxFifo (USB_OTG_GlobalTypeDef
*USBx
, uint32_t num
);
416 HAL_StatusTypeDef
USB_ActivateEndpoint(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
417 HAL_StatusTypeDef
USB_DeactivateEndpoint(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
418 HAL_StatusTypeDef
USB_ActivateDedicatedEndpoint(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
419 HAL_StatusTypeDef
USB_DeactivateDedicatedEndpoint(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
420 HAL_StatusTypeDef
USB_EPStartXfer(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
, uint8_t dma
);
421 HAL_StatusTypeDef
USB_EP0StartXfer(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
, uint8_t dma
);
422 HAL_StatusTypeDef
USB_WritePacket(USB_OTG_GlobalTypeDef
*USBx
, uint8_t *src
, uint8_t ch_ep_num
, uint16_t len
, uint8_t dma
);
423 void * USB_ReadPacket(USB_OTG_GlobalTypeDef
*USBx
, uint8_t *dest
, uint16_t len
);
424 HAL_StatusTypeDef
USB_EPSetStall(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
425 HAL_StatusTypeDef
USB_EPClearStall(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
426 HAL_StatusTypeDef
USB_SetDevAddress (USB_OTG_GlobalTypeDef
*USBx
, uint8_t address
);
427 HAL_StatusTypeDef
USB_DevConnect (USB_OTG_GlobalTypeDef
*USBx
);
428 HAL_StatusTypeDef
USB_DevDisconnect (USB_OTG_GlobalTypeDef
*USBx
);
429 HAL_StatusTypeDef
USB_StopDevice(USB_OTG_GlobalTypeDef
*USBx
);
430 HAL_StatusTypeDef
USB_ActivateSetup (USB_OTG_GlobalTypeDef
*USBx
);
431 HAL_StatusTypeDef
USB_EP0_OutStart(USB_OTG_GlobalTypeDef
*USBx
, uint8_t dma
, uint8_t *psetup
);
432 uint8_t USB_GetDevSpeed(USB_OTG_GlobalTypeDef
*USBx
);
433 uint32_t USB_GetMode(USB_OTG_GlobalTypeDef
*USBx
);
434 uint32_t USB_ReadInterrupts (USB_OTG_GlobalTypeDef
*USBx
);
435 uint32_t USB_ReadDevAllOutEpInterrupt (USB_OTG_GlobalTypeDef
*USBx
);
436 uint32_t USB_ReadDevOutEPInterrupt (USB_OTG_GlobalTypeDef
*USBx
, uint8_t epnum
);
437 uint32_t USB_ReadDevAllInEpInterrupt (USB_OTG_GlobalTypeDef
*USBx
);
438 uint32_t USB_ReadDevInEPInterrupt (USB_OTG_GlobalTypeDef
*USBx
, uint8_t epnum
);
439 void USB_ClearInterrupts (USB_OTG_GlobalTypeDef
*USBx
, uint32_t interrupt
);
441 HAL_StatusTypeDef
USB_HostInit (USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_CfgTypeDef cfg
);
442 HAL_StatusTypeDef
USB_InitFSLSPClkSel(USB_OTG_GlobalTypeDef
*USBx
, uint8_t freq
);
443 HAL_StatusTypeDef
USB_ResetPort(USB_OTG_GlobalTypeDef
*USBx
);
444 HAL_StatusTypeDef
USB_DriveVbus (USB_OTG_GlobalTypeDef
*USBx
, uint8_t state
);
445 uint32_t USB_GetHostSpeed (USB_OTG_GlobalTypeDef
*USBx
);
446 uint32_t USB_GetCurrentFrame (USB_OTG_GlobalTypeDef
*USBx
);
447 HAL_StatusTypeDef
USB_HC_Init(USB_OTG_GlobalTypeDef
*USBx
,
454 HAL_StatusTypeDef
USB_HC_StartXfer(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_HCTypeDef
*hc
, uint8_t dma
);
455 uint32_t USB_HC_ReadInterrupt (USB_OTG_GlobalTypeDef
*USBx
);
456 HAL_StatusTypeDef
USB_HC_Halt(USB_OTG_GlobalTypeDef
*USBx
, uint8_t hc_num
);
457 HAL_StatusTypeDef
USB_DoPing(USB_OTG_GlobalTypeDef
*USBx
, uint8_t ch_num
);
458 HAL_StatusTypeDef
USB_StopHost(USB_OTG_GlobalTypeDef
*USBx
);
467 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
468 STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx || STM32F412Rx ||
469 STM32F412Vx || STM32F412Cx || STM32F413xx || STM32F423xx */
475 #endif /* __STM32F4xx_LL_USB_H */
477 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/