/**

******************************************************************************

* @file stm32f7xx_ll_usb.h

* @author MCD Application Team

* @brief Header file of USB Low Layer HAL module.

******************************************************************************

* @attention

*

* Copyright (c) 2017 STMicroelectronics.

* All rights reserved.

*

* This software is licensed under terms that can be found in the LICENSE file

* in the root directory of this software component.

* If no LICENSE file comes with this software, it is provided AS-IS.

*

******************************************************************************

*/

/* Define to prevent recursive inclusion -------------------------------------*/

#ifndef STM32F7xx_LL_USB_H

#define STM32F7xx_LL_USB_H

#ifdef __cplusplus

extern "C" {

#endif /* __cplusplus */

/* Includes ------------------------------------------------------------------*/

#include "stm32f7xx_hal_def.h"

#if defined (USB_OTG_FS) || defined (USB_OTG_HS)

/** @addtogroup STM32F7xx_HAL_Driver

* @{

*/

/** @addtogroup USB_LL

* @{

*/

/* Exported types ------------------------------------------------------------*/

/**

* @brief USB Mode definition

*/

#if defined (USB_OTG_FS) || defined (USB_OTG_HS)

typedef enum

{

USB_DEVICE_MODE = 0,

USB_HOST_MODE = 1,

USB_DRD_MODE = 2

} USB_OTG_ModeTypeDef;

/**

* @brief URB States definition

*/

typedef enum

{

URB_IDLE = 0,

URB_DONE,

URB_NOTREADY,

URB_NYET,

URB_ERROR,

URB_STALL

} USB_OTG_URBStateTypeDef;

/**

* @brief Host channel States definition

*/

typedef enum

{

HC_IDLE = 0,

HC_XFRC,

HC_HALTED,

HC_ACK,

HC_NAK,

HC_NYET,

HC_STALL,

HC_XACTERR,

HC_BBLERR,

HC_DATATGLERR

} USB_OTG_HCStateTypeDef;

/**

* @brief USB Instance Initialization Structure definition

*/

typedef struct

{

uint32_t dev_endpoints; /*!< Device Endpoints number.

This parameter depends on the used USB core.

This parameter must be a number between Min_Data = 1 and Max_Data = 15 */

uint32_t Host_channels; /*!< Host Channels number.

This parameter Depends on the used USB core.

This parameter must be a number between Min_Data = 1 and Max_Data = 15 */

uint32_t speed; /*!< USB Core speed.

This parameter can be any value of @ref PCD_Speed/HCD_Speed

(HCD_SPEED_xxx, HCD_SPEED_xxx) */

uint32_t dma_enable; /*!< Enable or disable of the USB embedded DMA used only for OTG HS. */

uint32_t ep0_mps; /*!< Set the Endpoint 0 Max Packet size. */

uint32_t phy_itface; /*!< Select the used PHY interface.

This parameter can be any value of @ref PCD_PHY_Module/HCD_PHY_Module */

uint32_t Sof_enable; /*!< Enable or disable the output of the SOF signal. */

uint32_t low_power_enable; /*!< Enable or disable the low power mode. */

uint32_t lpm_enable; /*!< Enable or disable Link Power Management. */

uint32_t battery_charging_enable; /*!< Enable or disable Battery charging. */

uint32_t vbus_sensing_enable; /*!< Enable or disable the VBUS Sensing feature. */

uint32_t use_dedicated_ep1; /*!< Enable or disable the use of the dedicated EP1 interrupt. */

uint32_t use_external_vbus; /*!< Enable or disable the use of the external VBUS. */

} USB_OTG_CfgTypeDef;

typedef struct

{

uint8_t num; /*!< Endpoint number

This parameter must be a number between Min_Data = 1 and Max_Data = 15 */

uint8_t is_in; /*!< Endpoint direction

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint8_t is_stall; /*!< Endpoint stall condition

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint8_t is_iso_incomplete; /*!< Endpoint isoc condition

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint8_t type; /*!< Endpoint type

This parameter can be any value of @ref USB_LL_EP_Type */

uint8_t data_pid_start; /*!< Initial data PID

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint8_t even_odd_frame; /*!< IFrame parity

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint16_t tx_fifo_num; /*!< Transmission FIFO number

This parameter must be a number between Min_Data = 1 and Max_Data = 15 */

uint32_t maxpacket; /*!< Endpoint Max packet size

This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */

uint8_t *xfer_buff; /*!< Pointer to transfer buffer */

uint32_t dma_addr; /*!< 32 bits aligned transfer buffer address */

uint32_t xfer_len; /*!< Current transfer length */

uint32_t xfer_size; /*!< requested transfer size */

uint32_t xfer_count; /*!< Partial transfer length in case of multi packet transfer */

} USB_OTG_EPTypeDef;

typedef struct

{

uint8_t dev_addr; /*!< USB device address.

This parameter must be a number between Min_Data = 1 and Max_Data = 255 */

uint8_t ch_num; /*!< Host channel number.

This parameter must be a number between Min_Data = 1 and Max_Data = 15 */

uint8_t ep_num; /*!< Endpoint number.

This parameter must be a number between Min_Data = 1 and Max_Data = 15 */

uint8_t ep_is_in; /*!< Endpoint direction

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint8_t speed; /*!< USB Host Channel speed.

This parameter can be any value of @ref HCD_Device_Speed:

(HCD_DEVICE_SPEED_xxx) */

uint8_t do_ping; /*!< Enable or disable the use of the PING protocol for HS mode. */

uint8_t process_ping; /*!< Execute the PING protocol for HS mode. */

uint8_t ep_type; /*!< Endpoint Type.

This parameter can be any value of @ref USB_LL_EP_Type */

uint16_t max_packet; /*!< Endpoint Max packet size.

This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */

uint8_t data_pid; /*!< Initial data PID.

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint8_t *xfer_buff; /*!< Pointer to transfer buffer. */

uint32_t XferSize; /*!< OTG Channel transfer size. */

uint32_t xfer_len; /*!< Current transfer length. */

uint32_t xfer_count; /*!< Partial transfer length in case of multi packet transfer. */

uint8_t toggle_in; /*!< IN transfer current toggle flag.

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint8_t toggle_out; /*!< OUT transfer current toggle flag

This parameter must be a number between Min_Data = 0 and Max_Data = 1 */

uint32_t dma_addr; /*!< 32 bits aligned transfer buffer address. */

uint32_t ErrCnt; /*!< Host channel error count. */

USB_OTG_URBStateTypeDef urb_state; /*!< URB state.

This parameter can be any value of @ref USB_OTG_URBStateTypeDef */

USB_OTG_HCStateTypeDef state; /*!< Host Channel state.

This parameter can be any value of @ref USB_OTG_HCStateTypeDef */

} USB_OTG_HCTypeDef;

#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */

/* Exported constants --------------------------------------------------------*/

/** @defgroup PCD_Exported_Constants PCD Exported Constants

* @{

*/

#if defined (USB_OTG_FS) || defined (USB_OTG_HS)

/** @defgroup USB_OTG_CORE VERSION ID

* @{

*/

#define USB_OTG_CORE_ID_300A 0x4F54300AU

#define USB_OTG_CORE_ID_310A 0x4F54310AU

/**

* @}

*/

/** @defgroup USB_Core_Mode_ USB Core Mode

* @{

*/

#define USB_OTG_MODE_DEVICE 0U

#define USB_OTG_MODE_HOST 1U

#define USB_OTG_MODE_DRD 2U

/**

* @}

*/

/** @defgroup USB_LL Device Speed

* @{

*/

#define USBD_HS_SPEED 0U

#define USBD_HSINFS_SPEED 1U

#define USBH_HS_SPEED 0U

#define USBD_FS_SPEED 2U

#define USBH_FSLS_SPEED 1U

/**

* @}

*/

/** @defgroup USB_LL_Core_Speed USB Low Layer Core Speed

* @{

*/

#define USB_OTG_SPEED_HIGH 0U

#define USB_OTG_SPEED_HIGH_IN_FULL 1U

#define USB_OTG_SPEED_FULL 3U

/**

* @}

*/

/** @defgroup USB_LL_Core_PHY USB Low Layer Core PHY

* @{

*/

#define USB_OTG_ULPI_PHY 1U

#define USB_OTG_EMBEDDED_PHY 2U

#define USB_OTG_HS_EMBEDDED_PHY 3U

#if !defined (USB_HS_PHYC_TUNE_VALUE)

#define USB_HS_PHYC_TUNE_VALUE 0x00000F13U /*!< Value of USB HS PHY Tune */

#endif /* USB_HS_PHYC_TUNE_VALUE */

/**

* @}

*/

/** @defgroup USB_LL_Turnaround_Timeout Turnaround Timeout Value

* @{

*/

#ifndef USBD_HS_TRDT_VALUE

#define USBD_HS_TRDT_VALUE 9U

#endif /* USBD_HS_TRDT_VALUE */

#ifndef USBD_FS_TRDT_VALUE

#define USBD_FS_TRDT_VALUE 5U

#define USBD_DEFAULT_TRDT_VALUE 9U

#endif /* USBD_HS_TRDT_VALUE */

/**

* @}

*/

/** @defgroup USB_LL_Core_MPS USB Low Layer Core MPS

* @{

*/

#define USB_OTG_HS_MAX_PACKET_SIZE 512U

#define USB_OTG_FS_MAX_PACKET_SIZE 64U

#define USB_OTG_MAX_EP0_SIZE 64U

/**

* @}

*/

/** @defgroup USB_LL_Core_PHY_Frequency USB Low Layer Core PHY Frequency

* @{

*/

#define DSTS_ENUMSPD_HS_PHY_30MHZ_OR_60MHZ (0U << 1)

#define DSTS_ENUMSPD_FS_PHY_30MHZ_OR_60MHZ (1U << 1)

#define DSTS_ENUMSPD_FS_PHY_48MHZ (3U << 1)

/**

* @}

*/

/** @defgroup USB_LL_CORE_Frame_Interval USB Low Layer Core Frame Interval

* @{

*/

#define DCFG_FRAME_INTERVAL_80 0U

#define DCFG_FRAME_INTERVAL_85 1U

#define DCFG_FRAME_INTERVAL_90 2U

#define DCFG_FRAME_INTERVAL_95 3U

/**

* @}

*/

/** @defgroup USB_LL_EP0_MPS USB Low Layer EP0 MPS

* @{

*/

#define EP_MPS_64 0U

#define EP_MPS_32 1U

#define EP_MPS_16 2U

#define EP_MPS_8 3U

/**

* @}

*/

/** @defgroup USB_LL_EP_Speed USB Low Layer EP Speed

* @{

*/

#define EP_SPEED_LOW 0U

#define EP_SPEED_FULL 1U

#define EP_SPEED_HIGH 2U

/**

* @}

*/

/** @defgroup USB_LL_EP_Type USB Low Layer EP Type

* @{

*/

#define EP_TYPE_CTRL 0U

#define EP_TYPE_ISOC 1U

#define EP_TYPE_BULK 2U

#define EP_TYPE_INTR 3U

#define EP_TYPE_MSK 3U

/**

* @}

*/

/** @defgroup USB_LL_STS_Defines USB Low Layer STS Defines

* @{

*/

#define STS_GOUT_NAK 1U

#define STS_DATA_UPDT 2U

#define STS_XFER_COMP 3U

#define STS_SETUP_COMP 4U

#define STS_SETUP_UPDT 6U

/**

* @}

*/

/** @defgroup USB_LL_HCFG_SPEED_Defines USB Low Layer HCFG Speed Defines

* @{

*/

#define HCFG_30_60_MHZ 0U

#define HCFG_48_MHZ 1U

#define HCFG_6_MHZ 2U

/**

* @}

*/

/** @defgroup USB_LL_HPRT0_PRTSPD_SPEED_Defines USB Low Layer HPRT0 PRTSPD Speed Defines

* @{

*/

#define HPRT0_PRTSPD_HIGH_SPEED 0U

#define HPRT0_PRTSPD_FULL_SPEED 1U

#define HPRT0_PRTSPD_LOW_SPEED 2U

/**

* @}

*/

#define HCCHAR_CTRL 0U

#define HCCHAR_ISOC 1U

#define HCCHAR_BULK 2U

#define HCCHAR_INTR 3U

#define HC_PID_DATA0 0U

#define HC_PID_DATA2 1U

#define HC_PID_DATA1 2U

#define HC_PID_SETUP 3U

#define GRXSTS_PKTSTS_IN 2U

#define GRXSTS_PKTSTS_IN_XFER_COMP 3U

#define GRXSTS_PKTSTS_DATA_TOGGLE_ERR 5U

#define GRXSTS_PKTSTS_CH_HALTED 7U

#define TEST_J 1U

#define TEST_K 2U

#define TEST_SE0_NAK 3U

#define TEST_PACKET 4U

#define TEST_FORCE_EN 5U

#define USBx_PCGCCTL *(__IO uint32_t *)((uint32_t)USBx_BASE + USB_OTG_PCGCCTL_BASE)

#define USBx_HPRT0 *(__IO uint32_t *)((uint32_t)USBx_BASE + USB_OTG_HOST_PORT_BASE)

#define USBx_DEVICE ((USB_OTG_DeviceTypeDef *)(USBx_BASE + USB_OTG_DEVICE_BASE))

#define USBx_INEP(i) ((USB_OTG_INEndpointTypeDef *)(USBx_BASE\

+ USB_OTG_IN_ENDPOINT_BASE + ((i) * USB_OTG_EP_REG_SIZE)))

#define USBx_OUTEP(i) ((USB_OTG_OUTEndpointTypeDef *)(USBx_BASE\

+ USB_OTG_OUT_ENDPOINT_BASE + ((i) * USB_OTG_EP_REG_SIZE)))

#define USBx_DFIFO(i) *(__IO uint32_t *)(USBx_BASE + USB_OTG_FIFO_BASE + ((i) * USB_OTG_FIFO_SIZE))

#define USBx_HOST ((USB_OTG_HostTypeDef *)(USBx_BASE + USB_OTG_HOST_BASE))

#define USBx_HC(i) ((USB_OTG_HostChannelTypeDef *)(USBx_BASE\

+ USB_OTG_HOST_CHANNEL_BASE\

+ ((i) * USB_OTG_HOST_CHANNEL_SIZE)))

#ifdef USB_HS_PHYC /* Legacy name for USBPHYC defined in CMSIS device but USBCPHYC used in USB driver to determine if peripheral is present or not */

#define USBPHYC USB_HS_PHYC

#endif /* USB_HS_PHYC */

#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */

#define EP_ADDR_MSK 0xFU

#ifndef USE_USB_DOUBLE_BUFFER

#define USE_USB_DOUBLE_BUFFER 1U

#endif /* USE_USB_DOUBLE_BUFFER */

/**

* @}

*/

/* Exported macro ------------------------------------------------------------*/

/** @defgroup USB_LL_Exported_Macros USB Low Layer Exported Macros

* @{

*/

#if defined (USB_OTG_FS) || defined (USB_OTG_HS)

#define USB_MASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK &= ~(__INTERRUPT__))

#define USB_UNMASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK |= (__INTERRUPT__))

#define CLEAR_IN_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_INEP(__EPNUM__)->DIEPINT = (__INTERRUPT__))

#define CLEAR_OUT_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_OUTEP(__EPNUM__)->DOEPINT = (__INTERRUPT__))

#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */

/**

* @}

*/

/* Exported functions --------------------------------------------------------*/

/** @addtogroup USB_LL_Exported_Functions USB Low Layer Exported Functions

* @{

*/

#if defined (USB_OTG_FS) || defined (USB_OTG_HS)

HAL_StatusTypeDef USB_CoreInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef cfg);

HAL_StatusTypeDef USB_DevInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef cfg);

HAL_StatusTypeDef USB_EnableGlobalInt(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_DisableGlobalInt(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_SetTurnaroundTime(USB_OTG_GlobalTypeDef *USBx, uint32_t hclk, uint8_t speed);

HAL_StatusTypeDef USB_SetCurrentMode(USB_OTG_GlobalTypeDef *USBx, USB_OTG_ModeTypeDef mode);

HAL_StatusTypeDef USB_SetDevSpeed(USB_OTG_GlobalTypeDef *USBx, uint8_t speed);

HAL_StatusTypeDef USB_FlushRxFifo(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_FlushTxFifo(USB_OTG_GlobalTypeDef *USBx, uint32_t num);

HAL_StatusTypeDef USB_ActivateEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);

HAL_StatusTypeDef USB_DeactivateEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);

HAL_StatusTypeDef USB_ActivateDedicatedEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);

HAL_StatusTypeDef USB_DeactivateDedicatedEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);

HAL_StatusTypeDef USB_EPStartXfer(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep, uint8_t dma);

HAL_StatusTypeDef USB_EP0StartXfer(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep, uint8_t dma);

HAL_StatusTypeDef USB_WritePacket(USB_OTG_GlobalTypeDef *USBx, uint8_t *src,

uint8_t ch_ep_num, uint16_t len, uint8_t dma);

void *USB_ReadPacket(USB_OTG_GlobalTypeDef *USBx, uint8_t *dest, uint16_t len);

HAL_StatusTypeDef USB_EPSetStall(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);

HAL_StatusTypeDef USB_EPClearStall(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);

HAL_StatusTypeDef USB_EPStopXfer(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);

HAL_StatusTypeDef USB_SetDevAddress(USB_OTG_GlobalTypeDef *USBx, uint8_t address);

HAL_StatusTypeDef USB_DevConnect(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_DevDisconnect(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_StopDevice(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_ActivateSetup(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_EP0_OutStart(USB_OTG_GlobalTypeDef *USBx, uint8_t dma, uint8_t *psetup);

uint8_t USB_GetDevSpeed(USB_OTG_GlobalTypeDef *USBx);

uint32_t USB_GetMode(USB_OTG_GlobalTypeDef *USBx);

uint32_t USB_ReadInterrupts(USB_OTG_GlobalTypeDef *USBx);

uint32_t USB_ReadChInterrupts(USB_OTG_GlobalTypeDef *USBx, uint8_t chnum);

uint32_t USB_ReadDevAllOutEpInterrupt(USB_OTG_GlobalTypeDef *USBx);

uint32_t USB_ReadDevOutEPInterrupt(USB_OTG_GlobalTypeDef *USBx, uint8_t epnum);

uint32_t USB_ReadDevAllInEpInterrupt(USB_OTG_GlobalTypeDef *USBx);

uint32_t USB_ReadDevInEPInterrupt(USB_OTG_GlobalTypeDef *USBx, uint8_t epnum);

void USB_ClearInterrupts(USB_OTG_GlobalTypeDef *USBx, uint32_t interrupt);

HAL_StatusTypeDef USB_HostInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef cfg);

HAL_StatusTypeDef USB_InitFSLSPClkSel(USB_OTG_GlobalTypeDef *USBx, uint8_t freq);

HAL_StatusTypeDef USB_ResetPort(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_DriveVbus(USB_OTG_GlobalTypeDef *USBx, uint8_t state);

uint32_t USB_GetHostSpeed(USB_OTG_GlobalTypeDef *USBx);

uint32_t USB_GetCurrentFrame(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_HC_Init(USB_OTG_GlobalTypeDef *USBx, uint8_t ch_num,

uint8_t epnum, uint8_t dev_address, uint8_t speed,

uint8_t ep_type, uint16_t mps);

HAL_StatusTypeDef USB_HC_StartXfer(USB_OTG_GlobalTypeDef *USBx,

USB_OTG_HCTypeDef *hc, uint8_t dma);

uint32_t USB_HC_ReadInterrupt(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_HC_Halt(USB_OTG_GlobalTypeDef *USBx, uint8_t hc_num);

HAL_StatusTypeDef USB_DoPing(USB_OTG_GlobalTypeDef *USBx, uint8_t ch_num);

HAL_StatusTypeDef USB_StopHost(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_ActivateRemoteWakeup(USB_OTG_GlobalTypeDef *USBx);

HAL_StatusTypeDef USB_DeActivateRemoteWakeup(USB_OTG_GlobalTypeDef *USBx);

#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */

/**

* @}

*/

/**

* @}

*/

/**

* @}

*/

/**

* @}

*/

#endif /* defined (USB_OTG_FS) || defined (USB_OTG_HS) */

#ifdef __cplusplus

}

#endif /* __cplusplus */

#endif /* STM32F7xx_LL_USB_H */