1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-17 18:43:50 +01:00

Merge pull request #18679 from gschorcht/drivers/usbdev_synopsys_dwc2_hs

drivers/usbdev_synopsys_dwc2: add USB OTG HS peripheral support for external ULPI HS PHYs
This commit is contained in:
benpicco 2022-10-07 00:23:29 +02:00 committed by GitHub
commit d6d8f8dadb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 221 additions and 32 deletions

View File

@ -352,6 +352,7 @@ static const dwc2_usb_otg_fshs_config_t dwc2_usb_otg_fshs_config[] = {
{
.periph = USB_OTG_FS_PERIPH_BASE,
.type = DWC2_USB_OTG_FS,
.phy = DWC2_USB_OTG_PHY_BUILTIN,
}
};

View File

@ -352,6 +352,7 @@ static const dwc2_usb_otg_fshs_config_t dwc2_usb_otg_fshs_config[] = {
{
.periph = USB_OTG_FS_PERIPH_BASE,
.type = DWC2_USB_OTG_FS,
.phy = DWC2_USB_OTG_PHY_BUILTIN,
}
};

View File

@ -11,13 +11,17 @@
* @{
*
* @file
* @brief Common configuration for STM32 OTG HS peripheral with FS phy
* @brief Common configuration for STM32 OTG HS peripheral with on-chip FS PHY
*
* All STM32 boards which use the on-chip FS PHY for the USB OTG HS peripheral
* use the same configuration. Therefore a common configuration file can be
* used for these boards.
*
* @author Koen Zandberg <koen@bergzand.net>
*/
#ifndef CFG_USB_OTG_HS_FS_H
#define CFG_USB_OTG_HS_FS_H
#ifndef CFG_USB_OTG_HS_PHY_FS_H
#define CFG_USB_OTG_HS_PHY_FS_H
#include "periph_cpu.h"
#include "usbdev_synopsys_dwc2.h"
@ -57,5 +61,5 @@ static const dwc2_usb_otg_fshs_config_t dwc2_usb_otg_fshs_config[] = {
}
#endif
#endif /* CFG_USB_OTG_HS_FS_H */
#endif /* CFG_USB_OTG_HS_PHY_FS_H */
/** @} */

View File

@ -32,7 +32,7 @@
#include "periph_cpu.h"
#include "clk_conf.h"
#include "cfg_timer_tim5.h"
#include "cfg_usb_otg_hs_fs.h"
#include "cfg_usb_otg_hs_phy_fs.h"
#ifdef __cplusplus
extern "C" {

View File

@ -23,6 +23,7 @@ config BOARD_STM32F746G_DISCO
select HAS_PERIPH_TIMER
select HAS_PERIPH_UART
select HAS_PERIPH_USBDEV
select HAS_PERIPH_USBDEV_HS_ULPI
# Clock configuration
select BOARD_HAS_HSE

View File

@ -26,7 +26,7 @@ Current hardware support:
| I2C | X | I2C1 on PB8/PB9 |
| Ethernet | X | |
| USB OTG FS | X | |
| USB OTG HS | - | |
| USB OTG HS | X | |
| TFT LCD | X | |
| Capacitive touch screen | X | |
| User microphones | - | |

View File

@ -9,6 +9,7 @@ FEATURES_PROVIDED += periph_spi
FEATURES_PROVIDED += periph_timer
FEATURES_PROVIDED += periph_uart
FEATURES_PROVIDED += periph_usbdev
FEATURES_PROVIDED += periph_usbdev_hs_ulpi
# stm32f746g-disco provides a custom default Kconfig clock configuration
KCONFIG_BOARD_CONFIG += $(RIOTBOARD)/stm32f746g-disco/clock.config

View File

@ -38,7 +38,11 @@
#include "clk_conf.h"
#include "cfg_rtt_default.h"
#include "cfg_timer_tim2.h"
#if defined(MODULE_PERIPH_USBDEV_HS_ULPI)
#include "usbdev_synopsys_dwc2.h"
#else
#include "cfg_usb_otg_fs.h"
#endif
#include "mii.h"
#ifdef __cplusplus
@ -265,6 +269,56 @@ static const ltdc_conf_t ltdc_config = {
};
/** @} */
#if defined(MODULE_PERIPH_USBDEV_HS_ULPI) || DOXYGEN
/**
* @name USB OTG FS configuration using ULPI HS PHY
*
* The USB OTG HS peripheral uses a ULPI HS PHY. The configuration of the
* ULPI HS PHY interface is board-specific.
*
* @{
*/
/**
* @brief Enable the high speed USB OTG peripheral
*/
#define DWC2_USB_OTG_HS_ENABLED
/**
* @brief Common USB OTG HS configuration with ULPI HS PHY
*/
static const dwc2_usb_otg_fshs_config_t dwc2_usb_otg_fshs_config[] = {
{
.periph = USB_OTG_HS_PERIPH_BASE,
.type = DWC2_USB_OTG_HS,
.phy = DWC2_USB_OTG_PHY_ULPI,
.rcc_mask = RCC_AHB1ENR_OTGHSEN,
.irqn = OTG_HS_IRQn,
.ahb = AHB1,
.ulpi_af = GPIO_AF10,
.ulpi_clk = GPIO_PIN(PORT_A, 5),
.ulpi_d0 = GPIO_PIN(PORT_A, 3),
.ulpi_d1 = GPIO_PIN(PORT_B, 0),
.ulpi_d2 = GPIO_PIN(PORT_B, 1),
.ulpi_d3 = GPIO_PIN(PORT_B, 10),
.ulpi_d4 = GPIO_PIN(PORT_B, 11),
.ulpi_d5 = GPIO_PIN(PORT_B, 12),
.ulpi_d6 = GPIO_PIN(PORT_B, 13),
.ulpi_d7 = GPIO_PIN(PORT_B, 5),
.ulpi_dir = GPIO_PIN(PORT_C, 2),
.ulpi_stp = GPIO_PIN(PORT_C, 0),
.ulpi_nxt = GPIO_PIN(PORT_H, 4),
}
};
/**
* @brief Number of available USB OTG peripherals
*/
#define USBDEV_NUMOF ARRAY_SIZE(dwc2_usb_otg_fshs_config)
/** @} */
#endif /* defined(MODULE_PERIPH_USBDEV_HS_ULPI) || DOXYGEN */
#ifdef __cplusplus
}
#endif

View File

@ -23,6 +23,7 @@ config BOARD_STM32F7508_DK
select HAS_PERIPH_TIMER
select HAS_PERIPH_UART
select HAS_PERIPH_USBDEV
select HAS_PERIPH_USBDEV_HS_ULPI
# Clock configuration
select BOARD_HAS_HSE

View File

@ -141,6 +141,10 @@ ifneq (,$(filter periph_usbdev,$(USEMODULE)))
USEMODULE += periph_usbdev_clk
endif
ifneq (,$(filter periph_usbdev_hs_ulpi,$(USEMODULE)))
FEATURES_REQUIRED += periph_usbdev_hs_ulpi
endif
ifneq (,$(filter pn532_i2c,$(USEMODULE)))
FEATURES_REQUIRED += periph_i2c
USEMODULE += pn532

View File

@ -41,18 +41,30 @@ typedef enum {
DWC2_USB_OTG_HS = 1, /**< High speed peripheral */
} dwc2_usb_otg_fshs_type_t;
#if defined(MCU_STM32)
/**
* @brief Type of USB OTG peripheral phy.
* @brief Device speed used
*/
enum {
DWC2_USB_OTG_DSPD_HS = 0, /**< High speed */
DWC2_USB_OTG_DSPD_FS_PHY_HS = 1, /**< Full speed on HS PHY */
DWC2_USB_OTG_DSPD_LS = 2, /**< Low speed */
DWC2_USB_OTG_DSPD_FS = 3, /**< Full speed */
};
/**
* @brief Type of USB OTG peripheral PHY.
*
* The FS type only supports the built-in type, the HS phy can have either the
* FS built-in phy enabled or the HS ULPI interface enabled.
* The FS type only supports the built-in PHY, the HS type can have enabled
* either
* - the on-chip FS PHY,
* - the external ULPI HS PHY interface, or
* - the internal UTMI HS PHY.
*/
typedef enum {
DWC2_USB_OTG_PHY_BUILTIN,
DWC2_USB_OTG_PHY_ULPI,
DWC2_USB_OTG_PHY_BUILTIN, /**< on-chip FS PHY */
DWC2_USB_OTG_PHY_ULPI, /**< ULPI for external HS PHY */
DWC2_USB_OTG_PHY_UTMI, /**< UTMI for internal HS PHY */
} dwc2_usb_otg_fshs_phy_t;
#endif
/**
* @brief stm32 USB OTG configuration
@ -60,15 +72,30 @@ typedef enum {
typedef struct {
uintptr_t periph; /**< USB peripheral base address */
dwc2_usb_otg_fshs_type_t type; /**< FS or HS type */
#if defined(MCU_STM32)
dwc2_usb_otg_fshs_phy_t phy; /**< Built-in or ULPI phy */
dwc2_usb_otg_fshs_phy_t phy; /**< on-chip FS, ULPI HS or UTMI HS PHY */
#if defined(MODULE_PERIPH_USBDEV_HS_ULPI) || DOXYGEN
gpio_t ulpi_clk; /**< ULPI CLK gpio */
gpio_t ulpi_d0; /**< ULPI D0 gpio */
gpio_t ulpi_d1; /**< ULPI D1 gpio */
gpio_t ulpi_d2; /**< ULPI D2 gpio */
gpio_t ulpi_d3; /**< ULPI D3 gpio */
gpio_t ulpi_d4; /**< ULPI D4 gpio */
gpio_t ulpi_d5; /**< ULPI D5 gpio */
gpio_t ulpi_d6; /**< ULPI D6 gpio */
gpio_t ulpi_d7; /**< ULPI D7 gpio */
gpio_t ulpi_dir; /**< ULPI DIR gpio */
gpio_t ulpi_stp; /**< ULPI STP gpio */
gpio_t ulpi_nxt; /**< ULPI NXT gpio */
gpio_af_t ulpi_af; /**< Alternative function for ULPI */
#endif
#if defined(MCU_STM32) || DOXYGEN
uint32_t rcc_mask; /**< bit in clock enable register */
uint8_t irqn; /**< IRQ channel */
uint8_t ahb; /**< AHB bus */
gpio_t dm; /**< Data- gpio */
gpio_t dp; /**< Data+ gpio */
gpio_af_t af; /**< Alternative function */
#endif /* defined(MCU_STM32) */
#endif /* defined(MCU_STM32) || DOXYGEN */
} dwc2_usb_otg_fshs_config_t;
#ifdef __cplusplus

View File

@ -168,6 +168,17 @@ config MODULE_PERIPH_INIT_USBDEV
default y if MODULE_PERIPH_INIT
depends on MODULE_PERIPH_USBDEV
config MODULE_PERIPH_USBDEV_HS_ULPI
bool "Use USB HS pripheral with UPLI HS PHY"
depends on HAS_PERIPH_USBDEV_HS_ULPI
depends on MODULE_PERIPH_USBDEV
config MODULE_PERIPH_INIT_USBDEV_HS_ULPI
bool
default y if MODULE_PERIPH_INIT && MODULE_PERIPH_USBDEV_HS_ULPI
depends on HAS_PERIPH_USBDEV_HS_ULPI
depends on MODULE_PERIPH_USBDEV
config MODULE_PERIPH_USBDEV_CLK
bool
depends on HAS_PERIPH_USBDEV

View File

@ -392,11 +392,11 @@ static void _ep_deactivate(usbdev_ep_t *ep)
if (ep->dir == USB_EP_DIR_IN) {
_ep_in_disable(conf, ep->num);
_in_regs(conf, ep->num)->DIEPCTL &= USB_OTG_DIEPCTL_USBAEP;
_in_regs(conf, ep->num)->DIEPCTL &= ~USB_OTG_DIEPCTL_USBAEP;
}
else {
_ep_out_disable(conf, ep->num);
_out_regs(conf, ep->num)->DOEPCTL &= USB_OTG_DOEPCTL_USBAEP;
_out_regs(conf, ep->num)->DOEPCTL &= ~USB_OTG_DOEPCTL_USBAEP;
}
}
@ -690,17 +690,74 @@ static void _usbdev_init(usbdev_t *dev)
#error "MCU not supported"
#endif
/* TODO: implement ULPI mode when a board is available */
#ifdef DWC2_USB_OTG_HS_ENABLED
if (conf->type == DWC2_USB_OTG_HS) {
/* Disable the ULPI clock in low power mode, this is essential for the
* peripheral when using the built-in phy */
periph_lpclk_dis(conf->ahb, RCC_AHB1LPENR_OTGHSULPILPEN);
/* Only the built-in phy supported for now */
assert(conf->phy == DWC2_USB_OTG_PHY_BUILTIN);
_global_regs(conf)->GUSBCFG |= USB_OTG_GUSBCFG_PHYSEL;
if (conf->phy == DWC2_USB_OTG_PHY_BUILTIN) {
/* Disable the ULPI clock in low power mode, this is essential for the
* peripheral when using the built-in phy or UTMI phy */
periph_lpclk_dis(conf->ahb, RCC_AHB1LPENR_OTGHSULPILPEN);
/* select on-chip builtin PHY */
_global_regs(usbdev->config)->GUSBCFG |= USB_OTG_GUSBCFG_PHYSEL;
}
#ifdef MODULE_PERIPH_USBDEV_HS_ULPI
else if (conf->phy == DWC2_USB_OTG_PHY_ULPI) {
/* initialize ULPI interface */
gpio_init(conf->ulpi_clk, GPIO_IN);
gpio_init(conf->ulpi_d0, GPIO_IN);
gpio_init(conf->ulpi_d1, GPIO_IN);
gpio_init(conf->ulpi_d2, GPIO_IN);
gpio_init(conf->ulpi_d3, GPIO_IN);
gpio_init(conf->ulpi_d4, GPIO_IN);
gpio_init(conf->ulpi_d5, GPIO_IN);
gpio_init(conf->ulpi_d6, GPIO_IN);
gpio_init(conf->ulpi_d7, GPIO_IN);
gpio_init(conf->ulpi_stp, GPIO_IN);
gpio_init(conf->ulpi_dir, GPIO_IN);
gpio_init(conf->ulpi_nxt, GPIO_IN);
gpio_init_af(conf->ulpi_clk, conf->ulpi_af);
gpio_init_af(conf->ulpi_d0, conf->ulpi_af);
gpio_init_af(conf->ulpi_d1, conf->ulpi_af);
gpio_init_af(conf->ulpi_d2, conf->ulpi_af);
gpio_init_af(conf->ulpi_d3, conf->ulpi_af);
gpio_init_af(conf->ulpi_d4, conf->ulpi_af);
gpio_init_af(conf->ulpi_d5, conf->ulpi_af);
gpio_init_af(conf->ulpi_d6, conf->ulpi_af);
gpio_init_af(conf->ulpi_d7, conf->ulpi_af);
gpio_init_af(conf->ulpi_stp, conf->ulpi_af);
gpio_init_af(conf->ulpi_dir, conf->ulpi_af);
gpio_init_af(conf->ulpi_nxt, conf->ulpi_af);
/* enable ULPI clock */
periph_clk_en(conf->ahb, RCC_AHB1ENR_OTGHSULPIEN);
#if !defined(MCU_STM32)
/* TODO following settings are required for DWC2 HS but are not
* defined for STM32 MCUs where these settings correspond to the
* reset value of the GUSBCFG register */
/* select ULPI PHY */
_global_regs(usbdev->config)->GUSBCFG |= USB_OTG_GUSBCFG_ULPI_UTMI_SEL
/* use the 8-bit interface and single data rate */
_global_regs(usbdev->config)->GUSBCFG &= ~(USB_OTG_GUSBCFG_PHYIF16 |
USB_OTG_GUSBCFG_DDRSEL);
#endif /* !defined(MCU_STM32) */
/* disable the on-chip FS transceiver */
_global_regs(usbdev->config)->GUSBCFG &= ~USB_OTG_GUSBCFG_PHYSEL;
/* use internal V_BUS valid indicator and internal charge pump */
_global_regs(usbdev->config)->GUSBCFG &= ~(USB_OTG_GUSBCFG_ULPIEVBUSD |
USB_OTG_GUSBCFG_ULPIEVBUSI);
/* disable ULPI FS/LS serial interface */
_global_regs(usbdev->config)->GUSBCFG &= ~USB_OTG_GUSBCFG_ULPIFSLS;
}
#else /* MODULE_PERIPH_USBDEV_HS_ULPI */
else {
/* only on-chip PHY support enabled */
assert(conf->phy == DWC2_USB_OTG_PHY_BUILTIN);
}
#endif /* MODULE_PERIPH_USBDEV_HS_ULPI */
}
#endif
#endif /* DWC2_USB_OTG_HS_ENABLED */
/* Reset the peripheral after phy selection */
_reset_periph(usbdev);
@ -711,20 +768,31 @@ static void _usbdev_init(usbdev_t *dev)
/* Force the peripheral to device mode */
_set_mode_device(usbdev);
#if defined(MCU_STM32)
/* Disable Vbus detection and force the pull-up on, GCCFG is STM32 specific */
#if defined(STM32_USB_OTG_CID_1x)
/* Enable no Vbus sensing and enable 'Power Down Disable */
_global_regs(usbdev->config)->GCCFG |= USB_OTG_GCCFG_NOVBUSSENS |
USB_OTG_GCCFG_PWRDWN;
/* Enable no Vbus sensing */
_global_regs(usbdev->config)->GCCFG |= USB_OTG_GCCFG_NOVBUSSENS;
#elif defined(STM32_USB_OTG_CID_2x)
/* Enable no Vbus Detect enable and enable 'Power Down Disable */
_global_regs(usbdev->config)->GCCFG |= USB_OTG_GCCFG_VBDEN |
USB_OTG_GCCFG_PWRDWN;
_global_regs(usbdev->config)->GCCFG |= USB_OTG_GCCFG_VBDEN;
/* Force Vbus Detect values and ID detect values to device mode */
_global_regs(usbdev->config)->GOTGCTL |= USB_OTG_GOTGCTL_VBVALOVAL |
USB_OTG_GOTGCTL_VBVALOEN |
USB_OTG_GOTGCTL_BVALOEN |
USB_OTG_GOTGCTL_BVALOVAL;
#endif /* defined(STM32_USB_OTG_CID_1x) */
if (conf->phy == DWC2_USB_OTG_PHY_BUILTIN) {
/* set `Power Down Disable` to activate the on-chip FS transceiver */
_global_regs(usbdev->config)->GCCFG |= USB_OTG_GCCFG_PWRDWN;
}
else if (IS_USED(MODULE_PERIPH_USBDEV_HS_ULPI) && (conf->phy == DWC2_USB_OTG_PHY_ULPI)) {
/* clear `Power Down Disable` to deactivate the on-chip FS transceiver */
_global_regs(usbdev->config)->GCCFG &= USB_OTG_GCCFG_PWRDWN;
}
#elif defined(MCU_ESP32)
/* Force Vbus Detect values and ID detect values to device mode */
_global_regs(usbdev->config)->GOTGCTL |= USB_OTG_GOTGCTL_VBVALOVAL |
@ -739,8 +807,19 @@ static void _usbdev_init(usbdev_t *dev)
_global_regs(conf)->GUSBCFG &=
~(USB_OTG_GUSBCFG_HNPCAP | USB_OTG_GUSBCFG_SRPCAP);
#ifdef DWC2_USB_OTG_HS_ENABLED
if ((conf->type == DWC2_USB_OTG_FS) || (conf->phy == DWC2_USB_OTG_PHY_BUILTIN)) {
/* Device mode init */
_device_regs(conf)->DCFG |= DWC2_USB_OTG_DSPD_FS; /* Full speed is */
}
else {
/* Device mode init */
_device_regs(conf)->DCFG |= DWC2_USB_OTG_DSPD_HS; /* High speed! */
}
#else
/* Device mode init */
_device_regs(conf)->DCFG |= USB_OTG_DCFG_DSPD_Msk; /* Full speed! */
_device_regs(conf)->DCFG |= DWC2_USB_OTG_DSPD_FS; /* Full speed! */
#endif
_configure_fifo(usbdev);

View File

@ -424,6 +424,11 @@ config HAS_PERIPH_USBDEV
help
Indicates that an USBDEV peripheral is present.
config HAS_PERIPH_USBDEV_HS_ULPI
bool
help
Indicates that an USBDEV HS peripheral with ULPI HS PHY is present.
config HAS_PERIPH_VBAT
bool
help