2020-05-06 06:03:37

by Vinod Koul

[permalink] [raw]
Subject: [PATCH v13 0/5] usb: xhci: Add support for Renesas USB controllers

This series add support for Renesas USB controllers uPD720201 and uPD720202.
These require firmware to be loaded and in case devices have ROM those can
also be programmed if empty. If ROM is programmed, it runs from ROM as well.

This includes patches from Christian which supported these controllers w/o
ROM and later my patches for ROM support and debugfs hook for rom erase and
export of xhci-pci functions.

Changes in v13:
- Make rensesas as independent module invoke by xhci-pci which can be
selected by users of such hardware

Changes in v12:
- Restore back module name for xhci-pci, so now renesas is a separate
module, export init/exit routines from renesas modules
- Update changelog on patch2

Changes in v11:
- update xhci->quirks and use that in remove function
- remove error return renesas_verify_fw_version()
- remove renesas_download_rom() and modify renesas_fw_download_image() for
reuse
Changes in v10:
remove renesas_xhci_pci_probe and call renesas_xhci_check_request_fw and
also cleanup exit code along with it.

Changes in v9:
Make fw load a sync call and have single instance of probe execute,
elimating probe/remove races
Add quirk for renesas and use that for loading

Changes in v8:
Fix compile error reported by Kbuild-bot by making usb_hcd_pci_probe() take
const struct hc_driver * as argument

Changes in v7:
Make a single module which removes issues with module loading
Keep the renesas code in renesas file
Add hc_driver as argument for usb_hcd_pci_probe and modify hdc drivers to
pass this and not use driver_data
Use driver data for fw name
Remove code to check if we need to load firmware or not
remove multiple fw version support, we can do that with symlink in
userspace

Changes in v6:
Move the renesas code into a separate driver which invokes xhci-pci functions.

Changes in v5:
Added a debugfs rom erase patch, helps in debugging
Squashed patch 1 & 2 as requested by Mathias

Changes in v4:
Rollback the delay values as we got device failures

Changes in v3:
Dropped patch 2 as discussed with Christian
Removed aligned 8 bytes check
Change order for firmware search from highest version to lowest
Added entry for new firmware for device 0x14 as well
Add tested by Christian

Changes in v2:
used macros for timeout count and delay
removed renesas_fw_alive_check
cleaned renesas_fw_callback
removed recurion for renesas_fw_download
added MODULE_FIRMWARE
added comment for multip


Christian Lamparter (1):
usb: renesas-xhci: Add the renesas xhci driver

Vinod Koul (4):
usb: hci: add hc_driver as argument for usb_hcd_pci_probe
usb: xhci: Add support for Renesas controller with memory
usb: renesas-xhci: Add ROM loader for uPD720201
usb: xhci: provide a debugfs hook for erasing rom

drivers/usb/core/hcd-pci.c | 7 +-
drivers/usb/host/Kconfig | 9 +
drivers/usb/host/Makefile | 1 +
drivers/usb/host/ehci-pci.c | 6 +-
drivers/usb/host/ohci-pci.c | 9 +-
drivers/usb/host/uhci-pci.c | 8 +-
drivers/usb/host/xhci-pci-renesas.c | 678 ++++++++++++++++++++++++++++
drivers/usb/host/xhci-pci.c | 47 +-
drivers/usb/host/xhci-pci.h | 28 ++
drivers/usb/host/xhci.h | 1 +
include/linux/usb/hcd.h | 3 +-
11 files changed, 775 insertions(+), 22 deletions(-)
create mode 100644 drivers/usb/host/xhci-pci-renesas.c
create mode 100644 drivers/usb/host/xhci-pci.h

--
2.25.4


2020-05-06 06:04:13

by Vinod Koul

[permalink] [raw]
Subject: [PATCH v13 1/5] usb: hci: add hc_driver as argument for usb_hcd_pci_probe

usb_hcd_pci_probe expects users to call this with driver_data set as
hc_driver, that limits the possibility of using the driver_data for
driver data.

Add hc_driver as argument to usb_hcd_pci_probe and modify the callers
ehci/ohci/xhci/uhci to pass hc_driver as argument and freeup the
driver_data used

Tested xhci driver on Dragon-board RB3, compile tested ehci, ohci and
uhci.

Suggested-by: Mathias Nyman <[email protected]>
[For all but the xHCI parts]
Acked-by: Alan Stern <[email protected]>
[For the xhci part]
Acked-by: Mathias Nyman <[email protected]>
Signed-off-by: Vinod Koul <[email protected]>
---
drivers/usb/core/hcd-pci.c | 7 ++++---
drivers/usb/host/ehci-pci.c | 6 ++----
drivers/usb/host/ohci-pci.c | 9 ++++++---
drivers/usb/host/uhci-pci.c | 8 ++++++--
drivers/usb/host/xhci-pci.c | 14 +++++---------
include/linux/usb/hcd.h | 3 ++-
6 files changed, 25 insertions(+), 22 deletions(-)

diff --git a/drivers/usb/core/hcd-pci.c b/drivers/usb/core/hcd-pci.c
index f0a259937da8..1547aa6e5314 100644
--- a/drivers/usb/core/hcd-pci.c
+++ b/drivers/usb/core/hcd-pci.c
@@ -159,6 +159,7 @@ static void ehci_wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd,
* usb_hcd_pci_probe - initialize PCI-based HCDs
* @dev: USB Host Controller being probed
* @id: pci hotplug id connecting controller to HCD framework
+ * @driver: USB HC driver handle
* Context: !in_interrupt()
*
* Allocates basic PCI resources for this USB host controller, and
@@ -169,9 +170,9 @@ static void ehci_wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd,
*
* Return: 0 if successful.
*/
-int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
+int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id,
+ const struct hc_driver *driver)
{
- struct hc_driver *driver;
struct usb_hcd *hcd;
int retval;
int hcd_irq = 0;
@@ -181,7 +182,7 @@ int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)

if (!id)
return -EINVAL;
- driver = (struct hc_driver *)id->driver_data;
+
if (!driver)
return -EINVAL;

diff --git a/drivers/usb/host/ehci-pci.c b/drivers/usb/host/ehci-pci.c
index 1a48ab1bd3b2..3c3820ad9092 100644
--- a/drivers/usb/host/ehci-pci.c
+++ b/drivers/usb/host/ehci-pci.c
@@ -360,23 +360,21 @@ static int ehci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
{
if (is_bypassed_id(pdev))
return -ENODEV;
- return usb_hcd_pci_probe(pdev, id);
+ return usb_hcd_pci_probe(pdev, id, &ehci_pci_hc_driver);
}

static void ehci_pci_remove(struct pci_dev *pdev)
{
pci_clear_mwi(pdev);
- usb_hcd_pci_remove(pdev);
+ usb_hcd_pci_remove(pdev);
}

/* PCI driver selection metadata; PCI hotplugging uses this */
static const struct pci_device_id pci_ids [] = { {
/* handle any USB 2.0 EHCI controller */
PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_EHCI, ~0),
- .driver_data = (unsigned long) &ehci_pci_hc_driver,
}, {
PCI_VDEVICE(STMICRO, PCI_DEVICE_ID_STMICRO_USB_HOST),
- .driver_data = (unsigned long) &ehci_pci_hc_driver,
},
{ /* end: all zeroes */ }
};
diff --git a/drivers/usb/host/ohci-pci.c b/drivers/usb/host/ohci-pci.c
index 22117a6aeb4a..585222af24ff 100644
--- a/drivers/usb/host/ohci-pci.c
+++ b/drivers/usb/host/ohci-pci.c
@@ -277,21 +277,24 @@ static const struct ohci_driver_overrides pci_overrides __initconst = {
static const struct pci_device_id pci_ids[] = { {
/* handle any USB OHCI controller */
PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_OHCI, ~0),
- .driver_data = (unsigned long) &ohci_pci_hc_driver,
}, {
/* The device in the ConneXT I/O hub has no class reg */
PCI_VDEVICE(STMICRO, PCI_DEVICE_ID_STMICRO_USB_OHCI),
- .driver_data = (unsigned long) &ohci_pci_hc_driver,
}, { /* end: all zeroes */ }
};
MODULE_DEVICE_TABLE (pci, pci_ids);

+static int ohci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
+{
+ return usb_hcd_pci_probe(dev, id, &ohci_pci_hc_driver);
+}
+
/* pci driver glue; this is a "new style" PCI driver module */
static struct pci_driver ohci_pci_driver = {
.name = hcd_name,
.id_table = pci_ids,

- .probe = usb_hcd_pci_probe,
+ .probe = ohci_pci_probe,
.remove = usb_hcd_pci_remove,
.shutdown = usb_hcd_pci_shutdown,

diff --git a/drivers/usb/host/uhci-pci.c b/drivers/usb/host/uhci-pci.c
index 957c87efc746..9b88745d247f 100644
--- a/drivers/usb/host/uhci-pci.c
+++ b/drivers/usb/host/uhci-pci.c
@@ -287,17 +287,21 @@ static const struct hc_driver uhci_driver = {
static const struct pci_device_id uhci_pci_ids[] = { {
/* handle any USB UHCI controller */
PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_UHCI, ~0),
- .driver_data = (unsigned long) &uhci_driver,
}, { /* end: all zeroes */ }
};

MODULE_DEVICE_TABLE(pci, uhci_pci_ids);

+static int uhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
+{
+ return usb_hcd_pci_probe(dev, id, &uhci_driver);
+}
+
static struct pci_driver uhci_pci_driver = {
.name = hcd_name,
.id_table = uhci_pci_ids,

- .probe = usb_hcd_pci_probe,
+ .probe = uhci_pci_probe,
.remove = usb_hcd_pci_remove,
.shutdown = uhci_shutdown,

diff --git a/drivers/usb/host/xhci-pci.c b/drivers/usb/host/xhci-pci.c
index 766b74723e64..b6c2f5c530e3 100644
--- a/drivers/usb/host/xhci-pci.c
+++ b/drivers/usb/host/xhci-pci.c
@@ -327,11 +327,8 @@ static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
{
int retval;
struct xhci_hcd *xhci;
- struct hc_driver *driver;
struct usb_hcd *hcd;

- driver = (struct hc_driver *)id->driver_data;
-
/* Prevent runtime suspending between USB-2 and USB-3 initialization */
pm_runtime_get_noresume(&dev->dev);

@@ -341,7 +338,7 @@ static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
* to say USB 2.0, but I'm not sure what the implications would be in
* the other parts of the HCD code.
*/
- retval = usb_hcd_pci_probe(dev, id);
+ retval = usb_hcd_pci_probe(dev, id, &xhci_pci_hc_driver);

if (retval)
goto put_runtime_pm;
@@ -349,8 +346,8 @@ static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
/* USB 2.0 roothub is stored in the PCI device now. */
hcd = dev_get_drvdata(&dev->dev);
xhci = hcd_to_xhci(hcd);
- xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
- pci_name(dev), hcd);
+ xhci->shared_hcd = usb_create_shared_hcd(&xhci_pci_hc_driver, &dev->dev,
+ pci_name(dev), hcd);
if (!xhci->shared_hcd) {
retval = -ENOMEM;
goto dealloc_usb2_hcd;
@@ -544,10 +541,9 @@ static void xhci_pci_shutdown(struct usb_hcd *hcd)
/*-------------------------------------------------------------------------*/

/* PCI driver selection metadata; PCI hotplugging uses this */
-static const struct pci_device_id pci_ids[] = { {
+static const struct pci_device_id pci_ids[] = {
/* handle any USB 3.0 xHCI controller */
- PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
- .driver_data = (unsigned long) &xhci_pci_hc_driver,
+ { PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
},
{ /* end: all zeroes */ }
};
diff --git a/include/linux/usb/hcd.h b/include/linux/usb/hcd.h
index e12105ed3834..3dbb42c637c1 100644
--- a/include/linux/usb/hcd.h
+++ b/include/linux/usb/hcd.h
@@ -479,7 +479,8 @@ extern void usb_hcd_platform_shutdown(struct platform_device *dev);
struct pci_dev;
struct pci_device_id;
extern int usb_hcd_pci_probe(struct pci_dev *dev,
- const struct pci_device_id *id);
+ const struct pci_device_id *id,
+ const struct hc_driver *driver);
extern void usb_hcd_pci_remove(struct pci_dev *dev);
extern void usb_hcd_pci_shutdown(struct pci_dev *dev);

--
2.25.4

2020-05-06 06:04:22

by Vinod Koul

[permalink] [raw]
Subject: [PATCH v13 2/5] usb: renesas-xhci: Add the renesas xhci driver

From: Christian Lamparter <[email protected]>

This add a new driver for renesas xhci which is basically a firmware
loader for uPD720201 and uPD720202 w/o ROM. The xhci-pci driver will
invoke this driver for loading/unloading on relevant devices.

This patch adds a firmware loader for the uPD720201K8-711-BAC-A
and uPD720202K8-711-BAA-A variant. Both of these chips are listed
in Renesas' R19UH0078EJ0500 Rev.5.00 "User's Manual: Hardware" as
devices which need the firmware loader on page 2 in order to
work as they "do not support the External ROM".

The "Firmware Download Sequence" is describe in chapter
"7.1 FW Download Interface" R19UH0078EJ0500 Rev.5.00 page 131.

The firmware "K2013080.mem" is available from a USB3.0 Host to
PCIe Adapter (PP2U-E card) "Firmware download" archive. An
alternative version can be sourced from Netgear's WNDR4700 GPL
archives.

The release notes of the PP2U-E's "Firmware Download" ver 2.0.1.3
(2012-06-15) state that the firmware is for the following devices:
- uPD720201 ES 2.0 sample whose revision ID is 2.
- uPD720201 ES 2.1 sample & CS sample & Mass product, ID is 3.
- uPD720202 ES 2.0 sample & CS sample & Mass product, ID is 2.

Signed-off-by: Christian Lamparter <[email protected]>
Signed-off-by: Bjorn Andersson <[email protected]>
[vkoul: fixed comments:
used macros for timeout count and delay
removed renesas_fw_alive_check
cleaned renesas_fw_callback
removed recursion for renesas_fw_download
add register defines and field names
move to a separate file
make fw loader as sync probe so that we execute in probe and
prevent race
make xhci-pci-renesas a seprate module]
Signed-off-by: Vinod Koul <[email protected]>
---
drivers/usb/host/Kconfig | 9 +
drivers/usb/host/Makefile | 1 +
drivers/usb/host/xhci-pci-renesas.c | 365 ++++++++++++++++++++++++++++
drivers/usb/host/xhci-pci.h | 28 +++
4 files changed, 403 insertions(+)
create mode 100644 drivers/usb/host/xhci-pci-renesas.c
create mode 100644 drivers/usb/host/xhci-pci.h

diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
index 55bdfdf11e4c..b5c542d6a1c5 100644
--- a/drivers/usb/host/Kconfig
+++ b/drivers/usb/host/Kconfig
@@ -42,6 +42,15 @@ config USB_XHCI_PCI
depends on USB_PCI
default y

+config USB_XHCI_PCI_RENESAS
+ tristate "Support for additional Renesas xHCI controller with firwmare"
+ depends on USB_XHCI_PCI
+ ---help---
+ Say 'Y' to enable the support for the Renesas xHCI controller with
+ firwmare. Make sure you have the firwmare for the device and
+ installed on your system for this device to work.
+ If unsure, say 'N'.
+
config USB_XHCI_PLATFORM
tristate "Generic xHCI driver for a platform device"
select USB_XHCI_RCAR if ARCH_RENESAS
diff --git a/drivers/usb/host/Makefile b/drivers/usb/host/Makefile
index b191361257cc..f9a99187b436 100644
--- a/drivers/usb/host/Makefile
+++ b/drivers/usb/host/Makefile
@@ -71,6 +71,7 @@ obj-$(CONFIG_USB_UHCI_HCD) += uhci-hcd.o
obj-$(CONFIG_USB_FHCI_HCD) += fhci.o
obj-$(CONFIG_USB_XHCI_HCD) += xhci-hcd.o
obj-$(CONFIG_USB_XHCI_PCI) += xhci-pci.o
+obj-$(CONFIG_USB_XHCI_PCI_RENESAS) += xhci-pci-renesas.o
obj-$(CONFIG_USB_XHCI_PLATFORM) += xhci-plat-hcd.o
obj-$(CONFIG_USB_XHCI_HISTB) += xhci-histb.o
obj-$(CONFIG_USB_XHCI_MTK) += xhci-mtk.o
diff --git a/drivers/usb/host/xhci-pci-renesas.c b/drivers/usb/host/xhci-pci-renesas.c
new file mode 100644
index 000000000000..88341d79b651
--- /dev/null
+++ b/drivers/usb/host/xhci-pci-renesas.c
@@ -0,0 +1,365 @@
+// SPDX-License-Identifier: GPL-2.0
+/* Copyright (C) 2019-2020 Linaro Limited */
+
+#include <linux/acpi.h>
+#include <linux/firmware.h>
+#include <linux/module.h>
+#include <linux/pci.h>
+#include <linux/slab.h>
+#include <linux/unaligned/access_ok.h>
+
+#include "xhci.h"
+#include "xhci-trace.h"
+#include "xhci-pci.h"
+
+#define RENESAS_FW_VERSION 0x6C
+#define RENESAS_ROM_CONFIG 0xF0
+#define RENESAS_FW_STATUS 0xF4
+#define RENESAS_FW_STATUS_MSB 0xF5
+#define RENESAS_ROM_STATUS 0xF6
+#define RENESAS_ROM_STATUS_MSB 0xF7
+#define RENESAS_DATA0 0xF8
+#define RENESAS_DATA1 0xFC
+
+#define RENESAS_FW_VERSION_FIELD GENMASK(23, 7)
+#define RENESAS_FW_VERSION_OFFSET 8
+
+#define RENESAS_FW_STATUS_DOWNLOAD_ENABLE BIT(0)
+#define RENESAS_FW_STATUS_LOCK BIT(1)
+#define RENESAS_FW_STATUS_RESULT GENMASK(6, 4)
+ #define RENESAS_FW_STATUS_INVALID 0
+ #define RENESAS_FW_STATUS_SUCCESS BIT(4)
+ #define RENESAS_FW_STATUS_ERROR BIT(5)
+#define RENESAS_FW_STATUS_SET_DATA0 BIT(8)
+#define RENESAS_FW_STATUS_SET_DATA1 BIT(9)
+
+#define RENESAS_ROM_STATUS_ACCESS BIT(0)
+#define RENESAS_ROM_STATUS_ERASE BIT(1)
+#define RENESAS_ROM_STATUS_RELOAD BIT(2)
+#define RENESAS_ROM_STATUS_RESULT GENMASK(6, 4)
+ #define RENESAS_ROM_STATUS_NO_RESULT 0
+ #define RENESAS_ROM_STATUS_SUCCESS BIT(4)
+ #define RENESAS_ROM_STATUS_ERROR BIT(5)
+#define RENESAS_ROM_STATUS_SET_DATA0 BIT(8)
+#define RENESAS_ROM_STATUS_SET_DATA1 BIT(9)
+#define RENESAS_ROM_STATUS_ROM_EXISTS BIT(15)
+
+#define RENESAS_ROM_ERASE_MAGIC 0x5A65726F
+#define RENESAS_ROM_WRITE_MAGIC 0x53524F4D
+
+#define RENESAS_RETRY 10000
+#define RENESAS_DELAY 10
+
+static int renesas_fw_download_image(struct pci_dev *dev,
+ const u32 *fw, size_t step)
+{
+ size_t i;
+ int err;
+ u8 fw_status;
+ bool data0_or_data1;
+
+ /*
+ * The hardware does alternate between two 32-bit pages.
+ * (This is because each row of the firmware is 8 bytes).
+ *
+ * for even steps we use DATA0, for odd steps DATA1.
+ */
+ data0_or_data1 = (step & 1) == 1;
+
+ /* step+1. Read "Set DATAX" and confirm it is cleared. */
+ for (i = 0; i < RENESAS_RETRY; i++) {
+ err = pci_read_config_byte(dev, RENESAS_FW_STATUS_MSB,
+ &fw_status);
+ if (err) {
+ dev_err(&dev->dev, "Read Status failed: %d\n",
+ pcibios_err_to_errno(err));
+ return pcibios_err_to_errno(err);
+ }
+ if (!(fw_status & BIT(data0_or_data1)))
+ break;
+
+ udelay(RENESAS_DELAY);
+ }
+ if (i == RENESAS_RETRY) {
+ dev_err(&dev->dev, "Timeout for Set DATAX step: %zd\n", step);
+ return -ETIMEDOUT;
+ }
+
+ /*
+ * step+2. Write FW data to "DATAX".
+ * "LSB is left" => force little endian
+ */
+ err = pci_write_config_dword(dev, data0_or_data1 ?
+ RENESAS_DATA1 : RENESAS_DATA0,
+ (__force u32)cpu_to_le32(fw[step]));
+ if (err) {
+ dev_err(&dev->dev, "Write to DATAX failed: %d\n",
+ pcibios_err_to_errno(err));
+ return pcibios_err_to_errno(err);
+ }
+
+ udelay(100);
+
+ /* step+3. Set "Set DATAX". */
+ err = pci_write_config_byte(dev, RENESAS_FW_STATUS_MSB,
+ BIT(data0_or_data1));
+ if (err) {
+ dev_err(&dev->dev, "Write config for DATAX failed: %d\n",
+ pcibios_err_to_errno(err));
+ return pcibios_err_to_errno(err);
+ }
+
+ return 0;
+}
+
+static int renesas_fw_verify(const void *fw_data,
+ size_t length)
+{
+ u16 fw_version_pointer;
+ u16 fw_version;
+
+ /*
+ * The Firmware's Data Format is describe in
+ * "6.3 Data Format" R19UH0078EJ0500 Rev.5.00 page 124
+ */
+
+ /*
+ * The bootrom chips of the big brother have sizes up to 64k, let's
+ * assume that's the biggest the firmware can get.
+ */
+ if (length < 0x1000 || length >= 0x10000) {
+ pr_err("firmware is size %zd is not (4k - 64k).",
+ length);
+ return -EINVAL;
+ }
+
+ /* The First 2 bytes are fixed value (55aa). "LSB on Left" */
+ if (get_unaligned_le16(fw_data) != 0x55aa) {
+ pr_err("no valid firmware header found.");
+ return -EINVAL;
+ }
+
+ /* verify the firmware version position and print it. */
+ fw_version_pointer = get_unaligned_le16(fw_data + 4);
+ if (fw_version_pointer + 2 >= length) {
+ pr_err("fw ver pointer is outside of the firmware image");
+ return -EINVAL;
+ }
+
+ fw_version = get_unaligned_le16(fw_data + fw_version_pointer);
+ pr_err("got firmware version: %02x.", fw_version);
+
+ return 0;
+}
+
+static int renesas_fw_check_running(struct pci_dev *pdev)
+{
+ int err;
+ u8 fw_state;
+
+ /*
+ * Test if the device is actually needing the firmware. As most
+ * BIOSes will initialize the device for us. If the device is
+ * initialized.
+ */
+ err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_state);
+ if (err)
+ return pcibios_err_to_errno(err);
+
+ /*
+ * Check if "FW Download Lock" is locked. If it is and the FW is
+ * ready we can simply continue. If the FW is not ready, we have
+ * to give up.
+ */
+ if (fw_state & RENESAS_FW_STATUS_LOCK) {
+ dev_dbg(&pdev->dev, "FW Download Lock is engaged.");
+
+ if (fw_state & RENESAS_FW_STATUS_SUCCESS)
+ return 0;
+
+ dev_err(&pdev->dev,
+ "FW Download Lock is set and FW is not ready. Giving Up.");
+ return -EIO;
+ }
+
+ /*
+ * Check if "FW Download Enable" is set. If someone (us?) tampered
+ * with it and it can't be reset, we have to give up too... and
+ * ask for a forgiveness and a reboot.
+ */
+ if (fw_state & RENESAS_FW_STATUS_DOWNLOAD_ENABLE) {
+ dev_err(&pdev->dev,
+ "FW Download Enable is stale. Giving Up (poweroff/reboot needed).");
+ return -EIO;
+ }
+
+ /* Otherwise, Check the "Result Code" Bits (6:4) and act accordingly */
+ switch (fw_state & RENESAS_FW_STATUS_RESULT) {
+ case 0: /* No result yet */
+ dev_dbg(&pdev->dev, "FW is not ready/loaded yet.");
+
+ /* tell the caller, that this device needs the firmware. */
+ return 1;
+
+ case RENESAS_FW_STATUS_SUCCESS: /* Success, device should be working. */
+ dev_dbg(&pdev->dev, "FW is ready.");
+ return 0;
+
+ case RENESAS_FW_STATUS_ERROR: /* Error State */
+ dev_err(&pdev->dev,
+ "hardware is in an error state. Giving up (poweroff/reboot needed).");
+ return -ENODEV;
+
+ default: /* All other states are marked as "Reserved states" */
+ dev_err(&pdev->dev,
+ "hardware is in an invalid state %lx. Giving up (poweroff/reboot needed).",
+ (fw_state & RENESAS_FW_STATUS_RESULT) >> 4);
+ return -EINVAL;
+ }
+}
+
+static int renesas_fw_download(struct pci_dev *pdev,
+ const struct firmware *fw)
+{
+ const u32 *fw_data = (const u32 *)fw->data;
+ size_t i;
+ int err;
+ u8 fw_status;
+
+ /*
+ * For more information and the big picture: please look at the
+ * "Firmware Download Sequence" in "7.1 FW Download Interface"
+ * of R19UH0078EJ0500 Rev.5.00 page 131
+ */
+
+ /*
+ * 0. Set "FW Download Enable" bit in the
+ * "FW Download Control & Status Register" at 0xF4
+ */
+ err = pci_write_config_byte(pdev, RENESAS_FW_STATUS,
+ RENESAS_FW_STATUS_DOWNLOAD_ENABLE);
+ if (err)
+ return pcibios_err_to_errno(err);
+
+ /* 1 - 10 follow one step after the other. */
+ for (i = 0; i < fw->size / 4; i++) {
+ err = renesas_fw_download_image(pdev, fw_data, i);
+ if (err) {
+ dev_err(&pdev->dev,
+ "Firmware Download Step %zd failed at position %zd bytes with (%d).",
+ i, i * 4, err);
+ return err;
+ }
+ }
+
+ /*
+ * This sequence continues until the last data is written to
+ * "DATA0" or "DATA1". Naturally, we wait until "SET DATA0/1"
+ * is cleared by the hardware beforehand.
+ */
+ for (i = 0; i < RENESAS_RETRY; i++) {
+ err = pci_read_config_byte(pdev, RENESAS_FW_STATUS_MSB,
+ &fw_status);
+ if (err)
+ return pcibios_err_to_errno(err);
+ if (!(fw_status & (BIT(0) | BIT(1))))
+ break;
+
+ udelay(RENESAS_DELAY);
+ }
+ if (i == RENESAS_RETRY)
+ dev_warn(&pdev->dev, "Final Firmware Download step timed out.");
+
+ /*
+ * 11. After finishing writing the last data of FW, the
+ * System Software must clear "FW Download Enable"
+ */
+ err = pci_write_config_byte(pdev, RENESAS_FW_STATUS, 0);
+ if (err)
+ return pcibios_err_to_errno(err);
+
+ /* 12. Read "Result Code" and confirm it is good. */
+ for (i = 0; i < RENESAS_RETRY; i++) {
+ err = pci_read_config_byte(pdev, RENESAS_FW_STATUS, &fw_status);
+ if (err)
+ return pcibios_err_to_errno(err);
+ if (fw_status & RENESAS_FW_STATUS_SUCCESS)
+ break;
+
+ udelay(RENESAS_DELAY);
+ }
+ if (i == RENESAS_RETRY) {
+ /* Timed out / Error - let's see if we can fix this */
+ err = renesas_fw_check_running(pdev);
+ switch (err) {
+ case 0: /*
+ * we shouldn't end up here.
+ * maybe it took a little bit longer.
+ * But all should be well?
+ */
+ break;
+
+ case 1: /* (No result yet! */
+ dev_err(&pdev->dev, "FW Load timedout");
+ return -ETIMEDOUT;
+
+ default:
+ return err;
+ }
+ }
+
+ return 0;
+}
+
+static int renesas_load_fw(struct pci_dev *pdev, const struct firmware *fw)
+{
+ int err = 0;
+
+ err = renesas_fw_download(pdev, fw);
+ if (err)
+ dev_err(&pdev->dev, "firmware failed to download (%d).", err);
+ return err;
+}
+
+int renesas_xhci_check_request_fw(struct pci_dev *pdev,
+ const struct pci_device_id *id)
+{
+ struct xhci_driver_data *driver_data =
+ (struct xhci_driver_data *)id->driver_data;
+ const char *fw_name = driver_data->firmware;
+ const struct firmware *fw;
+ int err;
+
+ err = renesas_fw_check_running(pdev);
+ /* Continue ahead, if the firmware is already running. */
+ if (err == 0)
+ return 0;
+
+ if (err != 1)
+ return err;
+
+ pci_dev_get(pdev);
+ err = request_firmware(&fw, fw_name, &pdev->dev);
+ pci_dev_put(pdev);
+ if (err) {
+ dev_err(&pdev->dev, "request_firmware failed: %d\n", err);
+ return err;
+ }
+
+ err = renesas_fw_verify(fw->data, fw->size);
+ if (err)
+ goto exit;
+
+ err = renesas_load_fw(pdev, fw);
+exit:
+ release_firmware(fw);
+ return err;
+}
+EXPORT_SYMBOL_GPL(renesas_xhci_check_request_fw);
+
+void renesas_xhci_pci_exit(struct pci_dev *dev)
+{
+}
+EXPORT_SYMBOL_GPL(renesas_xhci_pci_exit);
+
+MODULE_LICENSE("GPL v2");
diff --git a/drivers/usb/host/xhci-pci.h b/drivers/usb/host/xhci-pci.h
new file mode 100644
index 000000000000..4d749556e350
--- /dev/null
+++ b/drivers/usb/host/xhci-pci.h
@@ -0,0 +1,28 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/* Copyright (C) 2019-2020 Linaro Limited */
+
+#ifndef XHCI_PCI_H
+#define XHCI_PCI_H
+
+#if IS_ENABLED(CONFIG_USB_XHCI_PCI_RENESAS)
+int renesas_xhci_check_request_fw(struct pci_dev *dev,
+ const struct pci_device_id *id);
+void renesas_xhci_pci_exit(struct pci_dev *dev);
+
+#else
+int renesas_xhci_check_request_fw(struct pci_dev *dev,
+ const struct pci_device_id *id)
+{
+ return 0;
+}
+
+void renesas_xhci_pci_exit(struct pci_dev *dev) { };
+
+#endif
+
+struct xhci_driver_data {
+ u64 quirks;
+ const char *firmware;
+};
+
+#endif
--
2.25.4

2020-05-06 06:04:24

by Vinod Koul

[permalink] [raw]
Subject: [PATCH v13 3/5] usb: xhci: Add support for Renesas controller with memory

Some rensas controller like uPD720201 and uPD720202 need firmware to be
loaded. Add these devices in pci table and invoke renesas firmware loader
functions to check and load the firmware into device memory when
required.

Signed-off-by: Vinod Koul <[email protected]>
---
drivers/usb/host/xhci-pci.c | 35 ++++++++++++++++++++++++++++++++++-
drivers/usb/host/xhci.h | 1 +
2 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/drivers/usb/host/xhci-pci.c b/drivers/usb/host/xhci-pci.c
index b6c2f5c530e3..ef513c2fb843 100644
--- a/drivers/usb/host/xhci-pci.c
+++ b/drivers/usb/host/xhci-pci.c
@@ -15,6 +15,7 @@

#include "xhci.h"
#include "xhci-trace.h"
+#include "xhci-pci.h"

#define SSIC_PORT_NUM 2
#define SSIC_PORT_CFG2 0x880c
@@ -87,7 +88,16 @@ static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)

static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
{
- struct pci_dev *pdev = to_pci_dev(dev);
+ struct pci_dev *pdev = to_pci_dev(dev);
+ struct xhci_driver_data *driver_data;
+ const struct pci_device_id *id;
+
+ id = pci_match_id(pdev->driver->id_table, pdev);
+
+ if (id && id->driver_data) {
+ driver_data = (struct xhci_driver_data *)id->driver_data;
+ xhci->quirks |= driver_data->quirks;
+ }

/* Look for vendor-specific quirks */
if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
@@ -328,6 +338,14 @@ static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
int retval;
struct xhci_hcd *xhci;
struct usb_hcd *hcd;
+ struct xhci_driver_data *driver_data;
+
+ driver_data = (struct xhci_driver_data *)id->driver_data;
+ if (driver_data && driver_data->quirks & XHCI_RENESAS_FW_QUIRK) {
+ retval = renesas_xhci_check_request_fw(dev, id);
+ if (retval)
+ return retval;
+ }

/* Prevent runtime suspending between USB-2 and USB-3 initialization */
pm_runtime_get_noresume(&dev->dev);
@@ -389,6 +407,9 @@ static void xhci_pci_remove(struct pci_dev *dev)
struct xhci_hcd *xhci;

xhci = hcd_to_xhci(pci_get_drvdata(dev));
+ if (xhci->quirks & XHCI_RENESAS_FW_QUIRK)
+ renesas_xhci_pci_exit(dev);
+
xhci->xhc_state |= XHCI_STATE_REMOVING;

if (xhci->quirks & XHCI_DEFAULT_PM_RUNTIME_ALLOW)
@@ -540,14 +561,26 @@ static void xhci_pci_shutdown(struct usb_hcd *hcd)

/*-------------------------------------------------------------------------*/

+static const struct xhci_driver_data reneses_data = {
+ .quirks = XHCI_RENESAS_FW_QUIRK,
+ .firmware = "renesas_usb_fw.mem",
+};
+
/* PCI driver selection metadata; PCI hotplugging uses this */
static const struct pci_device_id pci_ids[] = {
+ { PCI_DEVICE(0x1912, 0x0014),
+ .driver_data = (unsigned long)&reneses_data,
+ },
+ { PCI_DEVICE(0x1912, 0x0015),
+ .driver_data = (unsigned long)&reneses_data,
+ },
/* handle any USB 3.0 xHCI controller */
{ PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
},
{ /* end: all zeroes */ }
};
MODULE_DEVICE_TABLE(pci, pci_ids);
+MODULE_FIRMWARE("renesas_usb_fw.mem");

/* pci driver glue; this is a "new style" PCI driver module */
static struct pci_driver xhci_pci_driver = {
diff --git a/drivers/usb/host/xhci.h b/drivers/usb/host/xhci.h
index 3289bb516201..4047363c7423 100644
--- a/drivers/usb/host/xhci.h
+++ b/drivers/usb/host/xhci.h
@@ -1873,6 +1873,7 @@ struct xhci_hcd {
#define XHCI_DEFAULT_PM_RUNTIME_ALLOW BIT_ULL(33)
#define XHCI_RESET_PLL_ON_DISCONNECT BIT_ULL(34)
#define XHCI_SNPS_BROKEN_SUSPEND BIT_ULL(35)
+#define XHCI_RENESAS_FW_QUIRK BIT_ULL(36)

unsigned int num_active_eps;
unsigned int limit_active_eps;
--
2.25.4

2020-05-06 06:04:28

by Vinod Koul

[permalink] [raw]
Subject: [PATCH v13 4/5] usb: renesas-xhci: Add ROM loader for uPD720201

uPD720201 supports ROM and allows software to program the ROM and boot
from it. Add support for detecting if ROM is present, if so load the ROM
if not programmed earlier.

Signed-off-by: Vinod Koul <[email protected]>
---
drivers/usb/host/xhci-pci-renesas.c | 294 +++++++++++++++++++++++++++-
1 file changed, 287 insertions(+), 7 deletions(-)

diff --git a/drivers/usb/host/xhci-pci-renesas.c b/drivers/usb/host/xhci-pci-renesas.c
index 88341d79b651..f7d2445d30ec 100644
--- a/drivers/usb/host/xhci-pci-renesas.c
+++ b/drivers/usb/host/xhci-pci-renesas.c
@@ -50,13 +50,33 @@
#define RENESAS_RETRY 10000
#define RENESAS_DELAY 10

+#define ROM_VALID_01 0x2013
+#define ROM_VALID_02 0x2026
+
+static int renesas_verify_fw_version(struct pci_dev *pdev, u32 version)
+{
+ switch (version) {
+ case ROM_VALID_01:
+ case ROM_VALID_02:
+ return 0;
+ }
+ dev_err(&pdev->dev, "FW has invalid version :%d\n", version);
+ return -EINVAL;
+}
+
static int renesas_fw_download_image(struct pci_dev *dev,
- const u32 *fw, size_t step)
+ const u32 *fw, size_t step, bool rom)
{
size_t i;
int err;
u8 fw_status;
bool data0_or_data1;
+ u32 status_reg;
+
+ if (rom)
+ status_reg = RENESAS_ROM_STATUS_MSB;
+ else
+ status_reg = RENESAS_FW_STATUS_MSB;

/*
* The hardware does alternate between two 32-bit pages.
@@ -68,8 +88,7 @@ static int renesas_fw_download_image(struct pci_dev *dev,

/* step+1. Read "Set DATAX" and confirm it is cleared. */
for (i = 0; i < RENESAS_RETRY; i++) {
- err = pci_read_config_byte(dev, RENESAS_FW_STATUS_MSB,
- &fw_status);
+ err = pci_read_config_byte(dev, status_reg, &fw_status);
if (err) {
dev_err(&dev->dev, "Read Status failed: %d\n",
pcibios_err_to_errno(err));
@@ -101,8 +120,7 @@ static int renesas_fw_download_image(struct pci_dev *dev,
udelay(100);

/* step+3. Set "Set DATAX". */
- err = pci_write_config_byte(dev, RENESAS_FW_STATUS_MSB,
- BIT(data0_or_data1));
+ err = pci_write_config_byte(dev, status_reg, BIT(data0_or_data1));
if (err) {
dev_err(&dev->dev, "Write config for DATAX failed: %d\n",
pcibios_err_to_errno(err));
@@ -152,10 +170,84 @@ static int renesas_fw_verify(const void *fw_data,
return 0;
}

-static int renesas_fw_check_running(struct pci_dev *pdev)
+static bool renesas_check_rom(struct pci_dev *pdev)
+{
+ u16 rom_status;
+ int retval;
+
+ /* Check if external ROM exists */
+ retval = pci_read_config_word(pdev, RENESAS_ROM_STATUS, &rom_status);
+ if (retval)
+ return false;
+
+ rom_status &= RENESAS_ROM_STATUS_ROM_EXISTS;
+ if (rom_status) {
+ dev_dbg(&pdev->dev, "External ROM exists\n");
+ return true; /* External ROM exists */
+ }
+
+ return false;
+}
+
+static int renesas_check_rom_state(struct pci_dev *pdev)
{
+ u16 rom_state;
+ u32 version;
int err;
+
+ /* check FW version */
+ err = pci_read_config_dword(pdev, RENESAS_FW_VERSION, &version);
+ if (err)
+ return pcibios_err_to_errno(err);
+
+ version &= RENESAS_FW_VERSION_FIELD;
+ version = version >> RENESAS_FW_VERSION_OFFSET;
+
+ err = renesas_verify_fw_version(pdev, version);
+ if (err)
+ return err;
+
+ /*
+ * Test if ROM is present and loaded, if so we can skip everything
+ */
+ err = pci_read_config_word(pdev, RENESAS_ROM_STATUS, &rom_state);
+ if (err)
+ return pcibios_err_to_errno(err);
+
+ if (rom_state & BIT(15)) {
+ /* ROM exists */
+ dev_dbg(&pdev->dev, "ROM exists\n");
+
+ /* Check the "Result Code" Bits (6:4) and act accordingly */
+ switch (rom_state & RENESAS_ROM_STATUS_RESULT) {
+ case RENESAS_ROM_STATUS_SUCCESS:
+ return 0;
+
+ case RENESAS_ROM_STATUS_NO_RESULT: /* No result yet */
+ return 0;
+
+ case RENESAS_ROM_STATUS_ERROR: /* Error State */
+ default: /* All other states are marked as "Reserved states" */
+ dev_err(&pdev->dev, "Invalid ROM..");
+ break;
+ }
+ }
+
+ return -EIO;
+}
+
+static int renesas_fw_check_running(struct pci_dev *pdev)
+{
u8 fw_state;
+ int err;
+
+ /* Check if device has ROM and loaded, if so skip everything */
+ err = renesas_check_rom(pdev);
+ if (err) { /* we have rom */
+ err = renesas_check_rom_state(pdev);
+ if (!err)
+ return err;
+ }

/*
* Test if the device is actually needing the firmware. As most
@@ -243,7 +335,7 @@ static int renesas_fw_download(struct pci_dev *pdev,

/* 1 - 10 follow one step after the other. */
for (i = 0; i < fw->size / 4; i++) {
- err = renesas_fw_download_image(pdev, fw_data, i);
+ err = renesas_fw_download_image(pdev, fw_data, i, false);
if (err) {
dev_err(&pdev->dev,
"Firmware Download Step %zd failed at position %zd bytes with (%d).",
@@ -311,11 +403,199 @@ static int renesas_fw_download(struct pci_dev *pdev,
return 0;
}

+static void renesas_rom_erase(struct pci_dev *pdev)
+{
+ int retval, i;
+ u8 status;
+
+ dev_dbg(&pdev->dev, "Performing ROM Erase...\n");
+ retval = pci_write_config_dword(pdev, RENESAS_DATA0,
+ RENESAS_ROM_ERASE_MAGIC);
+ if (retval) {
+ dev_err(&pdev->dev, "ROM erase, magic word write failed: %d\n",
+ pcibios_err_to_errno(retval));
+ return;
+ }
+
+ retval = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
+ if (retval) {
+ dev_err(&pdev->dev, "ROM status read failed: %d\n",
+ pcibios_err_to_errno(retval));
+ return;
+ }
+ status |= RENESAS_ROM_STATUS_ERASE;
+ retval = pci_write_config_byte(pdev, RENESAS_ROM_STATUS, status);
+ if (retval) {
+ dev_err(&pdev->dev, "ROM erase set word write failed\n");
+ return;
+ }
+
+ /* sleep a bit while ROM is erased */
+ msleep(20);
+
+ for (i = 0; i < RENESAS_RETRY; i++) {
+ retval = pci_read_config_byte(pdev, RENESAS_ROM_STATUS,
+ &status);
+ status &= RENESAS_ROM_STATUS_ERASE;
+ if (!status)
+ break;
+
+ mdelay(RENESAS_DELAY);
+ }
+
+ if (i == RENESAS_RETRY)
+ dev_dbg(&pdev->dev, "Chip erase timedout: %x\n", status);
+
+ dev_dbg(&pdev->dev, "ROM Erase... Done success\n");
+}
+
+static bool renesas_setup_rom(struct pci_dev *pdev, const struct firmware *fw)
+{
+ const u32 *fw_data = (const u32 *)fw->data;
+ int err, i;
+ u8 status;
+
+ /* 2. Write magic word to Data0 */
+ err = pci_write_config_dword(pdev, RENESAS_DATA0,
+ RENESAS_ROM_WRITE_MAGIC);
+ if (err)
+ return false;
+
+ /* 3. Set External ROM access */
+ err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS,
+ RENESAS_ROM_STATUS_ACCESS);
+ if (err)
+ goto remove_bypass;
+
+ /* 4. Check the result */
+ err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
+ if (err)
+ goto remove_bypass;
+ status &= GENMASK(6, 4);
+ if (status) {
+ dev_err(&pdev->dev,
+ "setting external rom failed: %x\n", status);
+ goto remove_bypass;
+ }
+
+ /* 5 to 16 Write FW to DATA0/1 while checking SetData0/1 */
+ for (i = 0; i < fw->size / 4; i++) {
+ err = renesas_fw_download_image(pdev, fw_data, i, true);
+ if (err) {
+ dev_err(&pdev->dev,
+ "ROM Download Step %d failed at position %d bytes with (%d)\n",
+ i, i * 4, err);
+ goto remove_bypass;
+ }
+ }
+
+ /*
+ * wait till DATA0/1 is cleared
+ */
+ for (i = 0; i < RENESAS_RETRY; i++) {
+ err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS_MSB,
+ &status);
+ if (err)
+ goto remove_bypass;
+ if (!(status & (BIT(0) | BIT(1))))
+ break;
+
+ udelay(RENESAS_DELAY);
+ }
+ if (i == RENESAS_RETRY) {
+ dev_err(&pdev->dev, "Final Firmware ROM Download step timed out\n");
+ goto remove_bypass;
+ }
+
+ /* 17. Remove bypass */
+ err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS, 0);
+ if (err)
+ return false;
+
+ udelay(10);
+
+ /* 18. check result */
+ for (i = 0; i < RENESAS_RETRY; i++) {
+ err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
+ if (err) {
+ dev_err(&pdev->dev, "Read ROM status failed:%d\n",
+ pcibios_err_to_errno(err));
+ return false;
+ }
+ status &= RENESAS_ROM_STATUS_RESULT;
+ if (status == RENESAS_ROM_STATUS_SUCCESS) {
+ dev_dbg(&pdev->dev, "Download ROM success\n");
+ break;
+ }
+ udelay(RENESAS_DELAY);
+ }
+ if (i == RENESAS_RETRY) { /* Timed out */
+ dev_err(&pdev->dev,
+ "Download to external ROM TO: %x\n", status);
+ return false;
+ }
+
+ dev_dbg(&pdev->dev, "Download to external ROM succeeded\n");
+
+ /* Last step set Reload */
+ err = pci_write_config_byte(pdev, RENESAS_ROM_STATUS,
+ RENESAS_ROM_STATUS_RELOAD);
+ if (err) {
+ dev_err(&pdev->dev, "Set ROM execute failed: %d\n",
+ pcibios_err_to_errno(err));
+ return false;
+ }
+
+ /*
+ * wait till Reload is cleared
+ */
+ for (i = 0; i < RENESAS_RETRY; i++) {
+ err = pci_read_config_byte(pdev, RENESAS_ROM_STATUS, &status);
+ if (err)
+ return false;
+ if (!(status & RENESAS_ROM_STATUS_RELOAD))
+ break;
+
+ udelay(RENESAS_DELAY);
+ }
+ if (i == RENESAS_RETRY) {
+ dev_err(&pdev->dev, "ROM Exec timed out: %x\n", status);
+ return false;
+ }
+
+ return true;
+
+remove_bypass:
+ pci_write_config_byte(pdev, RENESAS_ROM_STATUS, 0);
+ return false;
+}
+
static int renesas_load_fw(struct pci_dev *pdev, const struct firmware *fw)
{
int err = 0;
+ bool rom;
+
+ /* Check if the device has external ROM */
+ rom = renesas_check_rom(pdev);
+ if (rom) {
+ /* perform chip erase first */
+ renesas_rom_erase(pdev);
+
+ /* lets try loading fw on ROM first */
+ rom = renesas_setup_rom(pdev, fw);
+ if (!rom) {
+ dev_dbg(&pdev->dev,
+ "ROM load failed, falling back on FW load\n");
+ } else {
+ dev_dbg(&pdev->dev,
+ "ROM load success\n");
+ goto exit;
+ }
+ }

err = renesas_fw_download(pdev, fw);
+
+exit:
if (err)
dev_err(&pdev->dev, "firmware failed to download (%d).", err);
return err;
--
2.25.4

2020-05-06 10:42:42

by Vinod Koul

[permalink] [raw]
Subject: [PATCH v13 5/5] usb: xhci: provide a debugfs hook for erasing rom

run "echo 1 > /sys/kernel/debug/renesas-usb/rom_erase" to erase
firmware when driver is loaded.

Subsequent init of driver shall reload the firmware

Signed-off-by: Vinod Koul <[email protected]>
---
drivers/usb/host/xhci-pci-renesas.c | 33 +++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)

diff --git a/drivers/usb/host/xhci-pci-renesas.c b/drivers/usb/host/xhci-pci-renesas.c
index f7d2445d30ec..fa32ec352dc8 100644
--- a/drivers/usb/host/xhci-pci-renesas.c
+++ b/drivers/usb/host/xhci-pci-renesas.c
@@ -2,6 +2,7 @@
/* Copyright (C) 2019-2020 Linaro Limited */

#include <linux/acpi.h>
+#include <linux/debugfs.h>
#include <linux/firmware.h>
#include <linux/module.h>
#include <linux/pci.h>
@@ -170,6 +171,8 @@ static int renesas_fw_verify(const void *fw_data,
return 0;
}

+static void debugfs_init(struct pci_dev *pdev);
+
static bool renesas_check_rom(struct pci_dev *pdev)
{
u16 rom_status;
@@ -183,6 +186,7 @@ static bool renesas_check_rom(struct pci_dev *pdev)
rom_status &= RENESAS_ROM_STATUS_ROM_EXISTS;
if (rom_status) {
dev_dbg(&pdev->dev, "External ROM exists\n");
+ debugfs_init(pdev);
return true; /* External ROM exists */
}

@@ -449,6 +453,34 @@ static void renesas_rom_erase(struct pci_dev *pdev)
dev_dbg(&pdev->dev, "ROM Erase... Done success\n");
}

+static int debugfs_rom_erase(void *data, u64 value)
+{
+ struct pci_dev *pdev = data;
+
+ if (value == 1) {
+ dev_dbg(&pdev->dev, "Userspace requested ROM erase\n");
+ renesas_rom_erase(pdev);
+ return 0;
+ }
+ return -EINVAL;
+}
+DEFINE_DEBUGFS_ATTRIBUTE(rom_erase_ops, NULL, debugfs_rom_erase, "%llu\n");
+
+static struct dentry *debugfs_root;
+
+static void debugfs_init(struct pci_dev *pdev)
+{
+ debugfs_root = debugfs_create_dir("renesas_usb", NULL);
+
+ debugfs_create_file("rom_erase", 0200, debugfs_root,
+ pdev, &rom_erase_ops);
+}
+
+static void debugfs_exit(void)
+{
+ debugfs_remove_recursive(debugfs_root);
+}
+
static bool renesas_setup_rom(struct pci_dev *pdev, const struct firmware *fw)
{
const u32 *fw_data = (const u32 *)fw->data;
@@ -639,6 +671,7 @@ EXPORT_SYMBOL_GPL(renesas_xhci_check_request_fw);

void renesas_xhci_pci_exit(struct pci_dev *dev)
{
+ debugfs_exit();
}
EXPORT_SYMBOL_GPL(renesas_xhci_pci_exit);

--
2.25.4

2020-05-13 12:21:41

by Mathias Nyman

[permalink] [raw]
Subject: Re: [PATCH v13 0/5] usb: xhci: Add support for Renesas USB controllers

On 6.5.2020 9.00, Vinod Koul wrote:
> This series add support for Renesas USB controllers uPD720201 and uPD720202.
> These require firmware to be loaded and in case devices have ROM those can
> also be programmed if empty. If ROM is programmed, it runs from ROM as well.
>
> This includes patches from Christian which supported these controllers w/o
> ROM and later my patches for ROM support and debugfs hook for rom erase and
> export of xhci-pci functions.
>

First four patches look ok to me, but 5/5 that adds rom erase debugfs support
still needs some work.

If you prefer I can take the first four, maybe we can get them to 5.8, and then
later add that debugs rom erase support.

Let me know what you prefer

-Mathias

2020-05-13 12:35:19

by Mathias Nyman

[permalink] [raw]
Subject: Re: [PATCH v13 5/5] usb: xhci: provide a debugfs hook for erasing rom

On 6.5.2020 9.00, Vinod Koul wrote:
> run "echo 1 > /sys/kernel/debug/renesas-usb/rom_erase" to erase
> firmware when driver is loaded.
>
> Subsequent init of driver shall reload the firmware
>
> Signed-off-by: Vinod Koul <[email protected]>
> ---
> drivers/usb/host/xhci-pci-renesas.c | 33 +++++++++++++++++++++++++++++
> 1 file changed, 33 insertions(+)
>
> diff --git a/drivers/usb/host/xhci-pci-renesas.c b/drivers/usb/host/xhci-pci-renesas.c
> index f7d2445d30ec..fa32ec352dc8 100644
> --- a/drivers/usb/host/xhci-pci-renesas.c
> +++ b/drivers/usb/host/xhci-pci-renesas.c
> @@ -2,6 +2,7 @@
> /* Copyright (C) 2019-2020 Linaro Limited */
>
> #include <linux/acpi.h>
> +#include <linux/debugfs.h>
> #include <linux/firmware.h>
> #include <linux/module.h>
> #include <linux/pci.h>
> @@ -170,6 +171,8 @@ static int renesas_fw_verify(const void *fw_data,
> return 0;
> }
>
> +static void debugfs_init(struct pci_dev *pdev);
> +
> static bool renesas_check_rom(struct pci_dev *pdev)
> {
> u16 rom_status;
> @@ -183,6 +186,7 @@ static bool renesas_check_rom(struct pci_dev *pdev)
> rom_status &= RENESAS_ROM_STATUS_ROM_EXISTS;
> if (rom_status) {
> dev_dbg(&pdev->dev, "External ROM exists\n");
> + debugfs_init(pdev);
> return true; /* External ROM exists */
> }
>
> @@ -449,6 +453,34 @@ static void renesas_rom_erase(struct pci_dev *pdev)
> dev_dbg(&pdev->dev, "ROM Erase... Done success\n");
> }
>
> +static int debugfs_rom_erase(void *data, u64 value)
> +{
> + struct pci_dev *pdev = data;
> +
> + if (value == 1) {
> + dev_dbg(&pdev->dev, "Userspace requested ROM erase\n");
> + renesas_rom_erase(pdev);
> + return 0;
> + }
> + return -EINVAL;
> +}
> +DEFINE_DEBUGFS_ATTRIBUTE(rom_erase_ops, NULL, debugfs_rom_erase, "%llu\n");
> +
> +static struct dentry *debugfs_root;
> +
> +static void debugfs_init(struct pci_dev *pdev)
> +{
> + debugfs_root = debugfs_create_dir("renesas_usb", NULL);

This will create a renesas_usb directory right under debugfs root.
xhci has its own struct dentry xhci_debugfs_root;
Use that as parent instead

Also note that debugs_create_dir() can fail, for example if debugfs isn't supported.

- Mathias

2020-05-13 12:51:04

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v13 5/5] usb: xhci: provide a debugfs hook for erasing rom

On Wed, May 13, 2020 at 03:36:19PM +0300, Mathias Nyman wrote:
> On 6.5.2020 9.00, Vinod Koul wrote:
> > run "echo 1 > /sys/kernel/debug/renesas-usb/rom_erase" to erase
> > firmware when driver is loaded.
> >
> > Subsequent init of driver shall reload the firmware
> >
> > Signed-off-by: Vinod Koul <[email protected]>
> > ---
> > drivers/usb/host/xhci-pci-renesas.c | 33 +++++++++++++++++++++++++++++
> > 1 file changed, 33 insertions(+)
> >
> > diff --git a/drivers/usb/host/xhci-pci-renesas.c b/drivers/usb/host/xhci-pci-renesas.c
> > index f7d2445d30ec..fa32ec352dc8 100644
> > --- a/drivers/usb/host/xhci-pci-renesas.c
> > +++ b/drivers/usb/host/xhci-pci-renesas.c
> > @@ -2,6 +2,7 @@
> > /* Copyright (C) 2019-2020 Linaro Limited */
> >
> > #include <linux/acpi.h>
> > +#include <linux/debugfs.h>
> > #include <linux/firmware.h>
> > #include <linux/module.h>
> > #include <linux/pci.h>
> > @@ -170,6 +171,8 @@ static int renesas_fw_verify(const void *fw_data,
> > return 0;
> > }
> >
> > +static void debugfs_init(struct pci_dev *pdev);
> > +
> > static bool renesas_check_rom(struct pci_dev *pdev)
> > {
> > u16 rom_status;
> > @@ -183,6 +186,7 @@ static bool renesas_check_rom(struct pci_dev *pdev)
> > rom_status &= RENESAS_ROM_STATUS_ROM_EXISTS;
> > if (rom_status) {
> > dev_dbg(&pdev->dev, "External ROM exists\n");
> > + debugfs_init(pdev);
> > return true; /* External ROM exists */
> > }
> >
> > @@ -449,6 +453,34 @@ static void renesas_rom_erase(struct pci_dev *pdev)
> > dev_dbg(&pdev->dev, "ROM Erase... Done success\n");
> > }
> >
> > +static int debugfs_rom_erase(void *data, u64 value)
> > +{
> > + struct pci_dev *pdev = data;
> > +
> > + if (value == 1) {
> > + dev_dbg(&pdev->dev, "Userspace requested ROM erase\n");
> > + renesas_rom_erase(pdev);
> > + return 0;
> > + }
> > + return -EINVAL;
> > +}
> > +DEFINE_DEBUGFS_ATTRIBUTE(rom_erase_ops, NULL, debugfs_rom_erase, "%llu\n");
> > +
> > +static struct dentry *debugfs_root;
> > +
> > +static void debugfs_init(struct pci_dev *pdev)
> > +{
> > + debugfs_root = debugfs_create_dir("renesas_usb", NULL);
>
> This will create a renesas_usb directory right under debugfs root.
> xhci has its own struct dentry xhci_debugfs_root;
> Use that as parent instead

Ah, I misssed that, a follow-on patch can do this, right?

> Also note that debugs_create_dir() can fail, for example if debugfs isn't supported.

Doesn't matter, never check the result, just move on and all is fine :)

This logic is correct, no need for it to be changed.

thanks,

greg k-h

2020-05-13 12:54:57

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v13 0/5] usb: xhci: Add support for Renesas USB controllers

On Wed, May 13, 2020 at 03:51:28PM +0300, Mathias Nyman wrote:
> On 13.5.2020 15.40, Greg Kroah-Hartman wrote:
> > On Wed, May 13, 2020 at 03:19:29PM +0300, Mathias Nyman wrote:
> >> On 6.5.2020 9.00, Vinod Koul wrote:
> >>> This series add support for Renesas USB controllers uPD720201 and uPD720202.
> >>> These require firmware to be loaded and in case devices have ROM those can
> >>> also be programmed if empty. If ROM is programmed, it runs from ROM as well.
> >>>
> >>> This includes patches from Christian which supported these controllers w/o
> >>> ROM and later my patches for ROM support and debugfs hook for rom erase and
> >>> export of xhci-pci functions.
> >>>
> >>
> >> First four patches look ok to me, but 5/5 that adds rom erase debugfs support
> >> still needs some work.
> >>
> >> If you prefer I can take the first four, maybe we can get them to 5.8, and then
> >> later add that debugs rom erase support.
> >>
> >> Let me know what you prefer
> >
> > Oops, I just added all of these to my testing tree :)
> >
> > What's wrong with the debugfs patch? I can drop it, but it seemed
> > simple enough to me.
>
> Added "usb_renesas" directory under debugfs root when we have easily accessible
> debugfs/usb/xhci directory to use as parent.

I've responded to the patch now, sorry I missed that.

> Also not checking if adding directory failed (if debufs not supported)

That's fine and encouraged to do :)

thanks,

greg k-h

2020-05-13 20:40:47

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v13 0/5] usb: xhci: Add support for Renesas USB controllers

On Wed, May 13, 2020 at 03:19:29PM +0300, Mathias Nyman wrote:
> On 6.5.2020 9.00, Vinod Koul wrote:
> > This series add support for Renesas USB controllers uPD720201 and uPD720202.
> > These require firmware to be loaded and in case devices have ROM those can
> > also be programmed if empty. If ROM is programmed, it runs from ROM as well.
> >
> > This includes patches from Christian which supported these controllers w/o
> > ROM and later my patches for ROM support and debugfs hook for rom erase and
> > export of xhci-pci functions.
> >
>
> First four patches look ok to me, but 5/5 that adds rom erase debugfs support
> still needs some work.
>
> If you prefer I can take the first four, maybe we can get them to 5.8, and then
> later add that debugs rom erase support.
>
> Let me know what you prefer

Oops, I just added all of these to my testing tree :)

What's wrong with the debugfs patch? I can drop it, but it seemed
simple enough to me.

thanks,

greg k-h

2020-05-13 20:41:10

by Mathias Nyman

[permalink] [raw]
Subject: Re: [PATCH v13 0/5] usb: xhci: Add support for Renesas USB controllers

On 13.5.2020 15.40, Greg Kroah-Hartman wrote:
> On Wed, May 13, 2020 at 03:19:29PM +0300, Mathias Nyman wrote:
>> On 6.5.2020 9.00, Vinod Koul wrote:
>>> This series add support for Renesas USB controllers uPD720201 and uPD720202.
>>> These require firmware to be loaded and in case devices have ROM those can
>>> also be programmed if empty. If ROM is programmed, it runs from ROM as well.
>>>
>>> This includes patches from Christian which supported these controllers w/o
>>> ROM and later my patches for ROM support and debugfs hook for rom erase and
>>> export of xhci-pci functions.
>>>
>>
>> First four patches look ok to me, but 5/5 that adds rom erase debugfs support
>> still needs some work.
>>
>> If you prefer I can take the first four, maybe we can get them to 5.8, and then
>> later add that debugs rom erase support.
>>
>> Let me know what you prefer
>
> Oops, I just added all of these to my testing tree :)
>
> What's wrong with the debugfs patch? I can drop it, but it seemed
> simple enough to me.

Added "usb_renesas" directory under debugfs root when we have easily accessible
debugfs/usb/xhci directory to use as parent.

Also not checking if adding directory failed (if debufs not supported)

-Mathias

2020-05-13 20:43:14

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH v13 0/5] usb: xhci: Add support for Renesas USB controllers

On 13-05-20, 14:52, Greg Kroah-Hartman wrote:
> On Wed, May 13, 2020 at 03:51:28PM +0300, Mathias Nyman wrote:
> > On 13.5.2020 15.40, Greg Kroah-Hartman wrote:
> > > On Wed, May 13, 2020 at 03:19:29PM +0300, Mathias Nyman wrote:
> > >> On 6.5.2020 9.00, Vinod Koul wrote:
> > >>> This series add support for Renesas USB controllers uPD720201 and uPD720202.
> > >>> These require firmware to be loaded and in case devices have ROM those can
> > >>> also be programmed if empty. If ROM is programmed, it runs from ROM as well.
> > >>>
> > >>> This includes patches from Christian which supported these controllers w/o
> > >>> ROM and later my patches for ROM support and debugfs hook for rom erase and
> > >>> export of xhci-pci functions.
> > >>>
> > >>
> > >> First four patches look ok to me, but 5/5 that adds rom erase debugfs support
> > >> still needs some work.
> > >>
> > >> If you prefer I can take the first four, maybe we can get them to 5.8, and then
> > >> later add that debugs rom erase support.
> > >>
> > >> Let me know what you prefer
> > >
> > > Oops, I just added all of these to my testing tree :)
> > >
> > > What's wrong with the debugfs patch? I can drop it, but it seemed
> > > simple enough to me.
> >
> > Added "usb_renesas" directory under debugfs root when we have easily accessible
> > debugfs/usb/xhci directory to use as parent.
>
> I've responded to the patch now, sorry I missed that.

I can send an update on top of this to use xhci root, or respin this
patch, either ways is fine by me.

> > Also not checking if adding directory failed (if debufs not supported)
>
> That's fine and encouraged to do :)

Yes, I have known you 'encouraging' folks for that, hence coded it :)

Thanks
--
~Vinod

2020-05-14 10:29:48

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v13 5/5] usb: xhci: provide a debugfs hook for erasing rom

On Wed, May 13, 2020 at 02:45:54PM +0200, Greg Kroah-Hartman wrote:
> On Wed, May 13, 2020 at 03:36:19PM +0300, Mathias Nyman wrote:
> > On 6.5.2020 9.00, Vinod Koul wrote:
> > > run "echo 1 > /sys/kernel/debug/renesas-usb/rom_erase" to erase
> > > firmware when driver is loaded.
> > >
> > > Subsequent init of driver shall reload the firmware
> > >
> > > Signed-off-by: Vinod Koul <[email protected]>
> > > ---
> > > drivers/usb/host/xhci-pci-renesas.c | 33 +++++++++++++++++++++++++++++
> > > 1 file changed, 33 insertions(+)
> > >
> > > diff --git a/drivers/usb/host/xhci-pci-renesas.c b/drivers/usb/host/xhci-pci-renesas.c
> > > index f7d2445d30ec..fa32ec352dc8 100644
> > > --- a/drivers/usb/host/xhci-pci-renesas.c
> > > +++ b/drivers/usb/host/xhci-pci-renesas.c
> > > @@ -2,6 +2,7 @@
> > > /* Copyright (C) 2019-2020 Linaro Limited */
> > >
> > > #include <linux/acpi.h>
> > > +#include <linux/debugfs.h>
> > > #include <linux/firmware.h>
> > > #include <linux/module.h>
> > > #include <linux/pci.h>
> > > @@ -170,6 +171,8 @@ static int renesas_fw_verify(const void *fw_data,
> > > return 0;
> > > }
> > >
> > > +static void debugfs_init(struct pci_dev *pdev);
> > > +
> > > static bool renesas_check_rom(struct pci_dev *pdev)
> > > {
> > > u16 rom_status;
> > > @@ -183,6 +186,7 @@ static bool renesas_check_rom(struct pci_dev *pdev)
> > > rom_status &= RENESAS_ROM_STATUS_ROM_EXISTS;
> > > if (rom_status) {
> > > dev_dbg(&pdev->dev, "External ROM exists\n");
> > > + debugfs_init(pdev);
> > > return true; /* External ROM exists */
> > > }
> > >
> > > @@ -449,6 +453,34 @@ static void renesas_rom_erase(struct pci_dev *pdev)
> > > dev_dbg(&pdev->dev, "ROM Erase... Done success\n");
> > > }
> > >
> > > +static int debugfs_rom_erase(void *data, u64 value)
> > > +{
> > > + struct pci_dev *pdev = data;
> > > +
> > > + if (value == 1) {
> > > + dev_dbg(&pdev->dev, "Userspace requested ROM erase\n");
> > > + renesas_rom_erase(pdev);
> > > + return 0;
> > > + }
> > > + return -EINVAL;
> > > +}
> > > +DEFINE_DEBUGFS_ATTRIBUTE(rom_erase_ops, NULL, debugfs_rom_erase, "%llu\n");
> > > +
> > > +static struct dentry *debugfs_root;
> > > +
> > > +static void debugfs_init(struct pci_dev *pdev)
> > > +{
> > > + debugfs_root = debugfs_create_dir("renesas_usb", NULL);
> >
> > This will create a renesas_usb directory right under debugfs root.
> > xhci has its own struct dentry xhci_debugfs_root;
> > Use that as parent instead
>
> Ah, I misssed that, a follow-on patch can do this, right?

Actually, a whole new series with this changed is good, I didn't take
these for now, for some reason I thought I had.

thanks,

greg k-h

2020-05-14 11:28:37

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH v13 5/5] usb: xhci: provide a debugfs hook for erasing rom

On 14-05-20, 11:24, Greg Kroah-Hartman wrote:
> On Wed, May 13, 2020 at 02:45:54PM +0200, Greg Kroah-Hartman wrote:

> > Ah, I misssed that, a follow-on patch can do this, right?
>
> Actually, a whole new series with this changed is good, I didn't take
> these for now, for some reason I thought I had.

Do you mind taking these except this patch (last). I will spin this
later

Debugfs was for my own testing to be able to erase so that I can test
load :) No hurry for users to have that yet...

Thanks
--
~Vinod

2020-05-14 11:48:05

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v13 5/5] usb: xhci: provide a debugfs hook for erasing rom

On Thu, May 14, 2020 at 04:56:18PM +0530, Vinod Koul wrote:
> On 14-05-20, 11:24, Greg Kroah-Hartman wrote:
> > On Wed, May 13, 2020 at 02:45:54PM +0200, Greg Kroah-Hartman wrote:
>
> > > Ah, I misssed that, a follow-on patch can do this, right?
> >
> > Actually, a whole new series with this changed is good, I didn't take
> > these for now, for some reason I thought I had.
>
> Do you mind taking these except this patch (last). I will spin this
> later

Can you resend, they are not in my patch queue anymore.

thanks,

greg k-h

2020-05-14 12:17:00

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH v13 5/5] usb: xhci: provide a debugfs hook for erasing rom

On 14-05-20, 13:46, Greg Kroah-Hartman wrote:
> On Thu, May 14, 2020 at 04:56:18PM +0530, Vinod Koul wrote:
> > On 14-05-20, 11:24, Greg Kroah-Hartman wrote:
> > > On Wed, May 13, 2020 at 02:45:54PM +0200, Greg Kroah-Hartman wrote:
> >
> > > > Ah, I misssed that, a follow-on patch can do this, right?
> > >
> > > Actually, a whole new series with this changed is good, I didn't take
> > > these for now, for some reason I thought I had.
> >
> > Do you mind taking these except this patch (last). I will spin this
> > later
>
> Can you resend, they are not in my patch queue anymore.

Sure, will resend dropping patch 5.

--
~Vinod

2020-05-18 18:22:39

by Anders Roxell

[permalink] [raw]
Subject: Re: [PATCH v13 3/5] usb: xhci: Add support for Renesas controller with memory

On Wed, 6 May 2020 at 08:01, Vinod Koul <[email protected]> wrote:
>
> Some rensas controller like uPD720201 and uPD720202 need firmware to be
> loaded. Add these devices in pci table and invoke renesas firmware loader
> functions to check and load the firmware into device memory when
> required.
>
> Signed-off-by: Vinod Koul <[email protected]>

Hi, I got a build error when I built an arm64 allmodconfig kernel.

building obj-arm64-next-20200518

aarch64-linux-gnu-ld: drivers/usb/host/xhci-pci.o: in function
`xhci_pci_remove':
/srv/src/kernel/next/obj-arm64-next-20200518/../drivers/usb/host/xhci-pci.c:411:
undefined reference to `renesas_xhci_pci_exit'
aarch64-linux-gnu-ld:
/srv/src/kernel/next/obj-arm64-next-20200518/../drivers/usb/host/xhci-pci.c:411:(.text+0xd8):
relocation truncated to fit: R_AARCH64_CALL26 against undefined symbol
`renesas_xhci_pci_exit'
aarch64-linux-gnu-ld: drivers/usb/host/xhci-pci.o: in function `xhci_pci_probe':
/srv/src/kernel/next/obj-arm64-next-20200518/../drivers/usb/host/xhci-pci.c:345:
undefined reference to `renesas_xhci_check_request_fw'
aarch64-linux-gnu-ld:
/srv/src/kernel/next/obj-arm64-next-20200518/../drivers/usb/host/xhci-pci.c:345:(.text+0x2298):
relocation truncated to fit: R_AARCH64_CALL26 against undefined symbol
`renesas_xhci_check_request_fw'
make[1]: *** [/srv/src/kernel/next/Makefile:1126: vmlinux] Error 1
make[1]: Target 'Image' not remade because of errors.
make: *** [Makefile:185: __sub-make] Error 2
make: Target 'Image' not remade because of errors.

When I reverted this patch from todays next tag next-20200518 I
managed to build.


Cheers,
Anders

> ---
> drivers/usb/host/xhci-pci.c | 35 ++++++++++++++++++++++++++++++++++-
> drivers/usb/host/xhci.h | 1 +
> 2 files changed, 35 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/usb/host/xhci-pci.c b/drivers/usb/host/xhci-pci.c
> index b6c2f5c530e3..ef513c2fb843 100644
> --- a/drivers/usb/host/xhci-pci.c
> +++ b/drivers/usb/host/xhci-pci.c
> @@ -15,6 +15,7 @@
>
> #include "xhci.h"
> #include "xhci-trace.h"
> +#include "xhci-pci.h"
>
> #define SSIC_PORT_NUM 2
> #define SSIC_PORT_CFG2 0x880c
> @@ -87,7 +88,16 @@ static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
>
> static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
> {
> - struct pci_dev *pdev = to_pci_dev(dev);
> + struct pci_dev *pdev = to_pci_dev(dev);
> + struct xhci_driver_data *driver_data;
> + const struct pci_device_id *id;
> +
> + id = pci_match_id(pdev->driver->id_table, pdev);
> +
> + if (id && id->driver_data) {
> + driver_data = (struct xhci_driver_data *)id->driver_data;
> + xhci->quirks |= driver_data->quirks;
> + }
>
> /* Look for vendor-specific quirks */
> if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
> @@ -328,6 +338,14 @@ static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
> int retval;
> struct xhci_hcd *xhci;
> struct usb_hcd *hcd;
> + struct xhci_driver_data *driver_data;
> +
> + driver_data = (struct xhci_driver_data *)id->driver_data;
> + if (driver_data && driver_data->quirks & XHCI_RENESAS_FW_QUIRK) {
> + retval = renesas_xhci_check_request_fw(dev, id);
> + if (retval)
> + return retval;
> + }
>
> /* Prevent runtime suspending between USB-2 and USB-3 initialization */
> pm_runtime_get_noresume(&dev->dev);
> @@ -389,6 +407,9 @@ static void xhci_pci_remove(struct pci_dev *dev)
> struct xhci_hcd *xhci;
>
> xhci = hcd_to_xhci(pci_get_drvdata(dev));
> + if (xhci->quirks & XHCI_RENESAS_FW_QUIRK)
> + renesas_xhci_pci_exit(dev);
> +
> xhci->xhc_state |= XHCI_STATE_REMOVING;
>
> if (xhci->quirks & XHCI_DEFAULT_PM_RUNTIME_ALLOW)
> @@ -540,14 +561,26 @@ static void xhci_pci_shutdown(struct usb_hcd *hcd)
>
> /*-------------------------------------------------------------------------*/
>
> +static const struct xhci_driver_data reneses_data = {
> + .quirks = XHCI_RENESAS_FW_QUIRK,
> + .firmware = "renesas_usb_fw.mem",
> +};
> +
> /* PCI driver selection metadata; PCI hotplugging uses this */
> static const struct pci_device_id pci_ids[] = {
> + { PCI_DEVICE(0x1912, 0x0014),
> + .driver_data = (unsigned long)&reneses_data,
> + },
> + { PCI_DEVICE(0x1912, 0x0015),
> + .driver_data = (unsigned long)&reneses_data,
> + },
> /* handle any USB 3.0 xHCI controller */
> { PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
> },
> { /* end: all zeroes */ }
> };
> MODULE_DEVICE_TABLE(pci, pci_ids);
> +MODULE_FIRMWARE("renesas_usb_fw.mem");
>
> /* pci driver glue; this is a "new style" PCI driver module */
> static struct pci_driver xhci_pci_driver = {
> diff --git a/drivers/usb/host/xhci.h b/drivers/usb/host/xhci.h
> index 3289bb516201..4047363c7423 100644
> --- a/drivers/usb/host/xhci.h
> +++ b/drivers/usb/host/xhci.h
> @@ -1873,6 +1873,7 @@ struct xhci_hcd {
> #define XHCI_DEFAULT_PM_RUNTIME_ALLOW BIT_ULL(33)
> #define XHCI_RESET_PLL_ON_DISCONNECT BIT_ULL(34)
> #define XHCI_SNPS_BROKEN_SUSPEND BIT_ULL(35)
> +#define XHCI_RENESAS_FW_QUIRK BIT_ULL(36)
>
> unsigned int num_active_eps;
> unsigned int limit_active_eps;
> --
> 2.25.4
>

2020-05-18 20:05:43

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH v13 3/5] usb: xhci: Add support for Renesas controller with memory

Hi Anders,

On 18-05-20, 19:53, Anders Roxell wrote:
> On Wed, 6 May 2020 at 08:01, Vinod Koul <[email protected]> wrote:
> >
> > Some rensas controller like uPD720201 and uPD720202 need firmware to be
> > loaded. Add these devices in pci table and invoke renesas firmware loader
> > functions to check and load the firmware into device memory when
> > required.
> >
> > Signed-off-by: Vinod Koul <[email protected]>
>
> Hi, I got a build error when I built an arm64 allmodconfig kernel.

Thanks for this. This is happening as we have default y for USB_XHCI_PCI
and then we make USB_XHCI_PCI_RENESAS=m. That should be not allowed as
we export as symbol so both can be inbuilt or modules but USB_XHCI_PCI=y
and USB_XHCI_PCI_RENESAS=m cant. While it is valid that USB_XHCI_PCI=y|m
and USB_XHCI_PCI_RENESAS=n

So this seems to get fixed by below for me. I have tested with
- both y and m (easy)
- make USB_XHCI_PCI_RENESAS=n, USB_XHCI_PCI=y|m works
- try making USB_XHCI_PCI=y and USB_XHCI_PCI_RENESAS=m, then
USB_XHCI_PCI=m by kbuild :)
- try making USB_XHCI_PCI=m and USB_XHCI_PCI_RENESAS=y, kbuild gives
error prompt that it will be m due to depends

Thanks to all the fixes done by Arnd which pointed me to this. Pls
verify and I will send the fix with you as reported :)

---- >8 ----

diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
index b5c542d6a1c5..92783d175b3f 100644
--- a/drivers/usb/host/Kconfig
+++ b/drivers/usb/host/Kconfig
@@ -40,11 +40,11 @@ config USB_XHCI_DBGCAP
config USB_XHCI_PCI
tristate
depends on USB_PCI
+ depends on USB_XHCI_PCI_RENESAS || !USB_XHCI_PCI_RENESAS
default y

config USB_XHCI_PCI_RENESAS
tristate "Support for additional Renesas xHCI controller with firwmare"
- depends on USB_XHCI_PCI
---help---
Say 'Y' to enable the support for the Renesas xHCI controller with
firwmare. Make sure you have the firwmare for the device and

--
~Vinod

2020-05-18 22:42:43

by Anders Roxell

[permalink] [raw]
Subject: Re: [PATCH v13 3/5] usb: xhci: Add support for Renesas controller with memory

On Mon, 18 May 2020 at 21:57, Vinod Koul <[email protected]> wrote:
>
> Hi Anders,

Hi Vinod,

>
> On 18-05-20, 19:53, Anders Roxell wrote:
> > On Wed, 6 May 2020 at 08:01, Vinod Koul <[email protected]> wrote:
> > >
> > > Some rensas controller like uPD720201 and uPD720202 need firmware to be
> > > loaded. Add these devices in pci table and invoke renesas firmware loader
> > > functions to check and load the firmware into device memory when
> > > required.
> > >
> > > Signed-off-by: Vinod Koul <[email protected]>
> >
> > Hi, I got a build error when I built an arm64 allmodconfig kernel.
>
> Thanks for this. This is happening as we have default y for USB_XHCI_PCI
> and then we make USB_XHCI_PCI_RENESAS=m. That should be not allowed as
> we export as symbol so both can be inbuilt or modules but USB_XHCI_PCI=y
> and USB_XHCI_PCI_RENESAS=m cant. While it is valid that USB_XHCI_PCI=y|m
> and USB_XHCI_PCI_RENESAS=n
>
> So this seems to get fixed by below for me. I have tested with
> - both y and m (easy)
> - make USB_XHCI_PCI_RENESAS=n, USB_XHCI_PCI=y|m works
> - try making USB_XHCI_PCI=y and USB_XHCI_PCI_RENESAS=m, then
> USB_XHCI_PCI=m by kbuild :)
> - try making USB_XHCI_PCI=m and USB_XHCI_PCI_RENESAS=y, kbuild gives
> error prompt that it will be m due to depends
>
> Thanks to all the fixes done by Arnd which pointed me to this. Pls
> verify

I was able to build an arm64 allmodconfig kernel with this change.

Cheers,
Anders

> and I will send the fix with you as reported :)
>
> ---- >8 ----
>
> diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
> index b5c542d6a1c5..92783d175b3f 100644
> --- a/drivers/usb/host/Kconfig
> +++ b/drivers/usb/host/Kconfig
> @@ -40,11 +40,11 @@ config USB_XHCI_DBGCAP
> config USB_XHCI_PCI
> tristate
> depends on USB_PCI
> + depends on USB_XHCI_PCI_RENESAS || !USB_XHCI_PCI_RENESAS
> default y
>
> config USB_XHCI_PCI_RENESAS
> tristate "Support for additional Renesas xHCI controller with firwmare"
> - depends on USB_XHCI_PCI
> ---help---
> Say 'Y' to enable the support for the Renesas xHCI controller with
> firwmare. Make sure you have the firwmare for the device and
>
> --
> ~Vinod

2020-05-18 22:48:04

by Bjorn Andersson

[permalink] [raw]
Subject: Re: [PATCH v13 3/5] usb: xhci: Add support for Renesas controller with memory

On Mon 18 May 12:57 PDT 2020, Vinod Koul wrote:

> Hi Anders,
>
> On 18-05-20, 19:53, Anders Roxell wrote:
> > On Wed, 6 May 2020 at 08:01, Vinod Koul <[email protected]> wrote:
> > >
> > > Some rensas controller like uPD720201 and uPD720202 need firmware to be
> > > loaded. Add these devices in pci table and invoke renesas firmware loader
> > > functions to check and load the firmware into device memory when
> > > required.
> > >
> > > Signed-off-by: Vinod Koul <[email protected]>
> >
> > Hi, I got a build error when I built an arm64 allmodconfig kernel.
>
> Thanks for this. This is happening as we have default y for USB_XHCI_PCI
> and then we make USB_XHCI_PCI_RENESAS=m. That should be not allowed as
> we export as symbol so both can be inbuilt or modules but USB_XHCI_PCI=y
> and USB_XHCI_PCI_RENESAS=m cant. While it is valid that USB_XHCI_PCI=y|m
> and USB_XHCI_PCI_RENESAS=n
>
> So this seems to get fixed by below for me. I have tested with
> - both y and m (easy)
> - make USB_XHCI_PCI_RENESAS=n, USB_XHCI_PCI=y|m works
> - try making USB_XHCI_PCI=y and USB_XHCI_PCI_RENESAS=m, then
> USB_XHCI_PCI=m by kbuild :)
> - try making USB_XHCI_PCI=m and USB_XHCI_PCI_RENESAS=y, kbuild gives
> error prompt that it will be m due to depends
>
> Thanks to all the fixes done by Arnd which pointed me to this. Pls
> verify and I will send the fix with you as reported :)
>
> ---- >8 ----
>
> diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
> index b5c542d6a1c5..92783d175b3f 100644
> --- a/drivers/usb/host/Kconfig
> +++ b/drivers/usb/host/Kconfig
> @@ -40,11 +40,11 @@ config USB_XHCI_DBGCAP
> config USB_XHCI_PCI
> tristate
> depends on USB_PCI
> + depends on USB_XHCI_PCI_RENESAS || !USB_XHCI_PCI_RENESAS

This correctly captures the variations you describe above.

Regards,
Bjorn

> default y
>
> config USB_XHCI_PCI_RENESAS
> tristate "Support for additional Renesas xHCI controller with firwmare"
> - depends on USB_XHCI_PCI
> ---help---
> Say 'Y' to enable the support for the Renesas xHCI controller with
> firwmare. Make sure you have the firwmare for the device and
>
> --
> ~Vinod

2020-05-19 04:55:34

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH v13 3/5] usb: xhci: Add support for Renesas controller with memory

On 19-05-20, 00:37, Anders Roxell wrote:
> On Mon, 18 May 2020 at 21:57, Vinod Koul <[email protected]> wrote:
> >
> > Hi Anders,
>
> Hi Vinod,
>
> >
> > On 18-05-20, 19:53, Anders Roxell wrote:
> > > On Wed, 6 May 2020 at 08:01, Vinod Koul <[email protected]> wrote:
> > > >
> > > > Some rensas controller like uPD720201 and uPD720202 need firmware to be
> > > > loaded. Add these devices in pci table and invoke renesas firmware loader
> > > > functions to check and load the firmware into device memory when
> > > > required.
> > > >
> > > > Signed-off-by: Vinod Koul <[email protected]>
> > >
> > > Hi, I got a build error when I built an arm64 allmodconfig kernel.
> >
> > Thanks for this. This is happening as we have default y for USB_XHCI_PCI
> > and then we make USB_XHCI_PCI_RENESAS=m. That should be not allowed as
> > we export as symbol so both can be inbuilt or modules but USB_XHCI_PCI=y
> > and USB_XHCI_PCI_RENESAS=m cant. While it is valid that USB_XHCI_PCI=y|m
> > and USB_XHCI_PCI_RENESAS=n
> >
> > So this seems to get fixed by below for me. I have tested with
> > - both y and m (easy)
> > - make USB_XHCI_PCI_RENESAS=n, USB_XHCI_PCI=y|m works
> > - try making USB_XHCI_PCI=y and USB_XHCI_PCI_RENESAS=m, then
> > USB_XHCI_PCI=m by kbuild :)
> > - try making USB_XHCI_PCI=m and USB_XHCI_PCI_RENESAS=y, kbuild gives
> > error prompt that it will be m due to depends
> >
> > Thanks to all the fixes done by Arnd which pointed me to this. Pls
> > verify
>
> I was able to build an arm64 allmodconfig kernel with this change.

I will send the formal patch and add your name in reported and
tested. Thanks for the quick verification

>
> Cheers,
> Anders
>
> > and I will send the fix with you as reported :)
> >
> > ---- >8 ----
> >
> > diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
> > index b5c542d6a1c5..92783d175b3f 100644
> > --- a/drivers/usb/host/Kconfig
> > +++ b/drivers/usb/host/Kconfig
> > @@ -40,11 +40,11 @@ config USB_XHCI_DBGCAP
> > config USB_XHCI_PCI
> > tristate
> > depends on USB_PCI
> > + depends on USB_XHCI_PCI_RENESAS || !USB_XHCI_PCI_RENESAS
> > default y
> >
> > config USB_XHCI_PCI_RENESAS
> > tristate "Support for additional Renesas xHCI controller with firwmare"
> > - depends on USB_XHCI_PCI
> > ---help---
> > Say 'Y' to enable the support for the Renesas xHCI controller with
> > firwmare. Make sure you have the firwmare for the device and
> >
> > --
> > ~Vinod

--
~Vinod

2020-05-19 07:46:25

by Arnd Bergmann

[permalink] [raw]
Subject: Re: [PATCH v13 3/5] usb: xhci: Add support for Renesas controller with memory

On Tue, May 19, 2020 at 6:53 AM Vinod Koul <[email protected]> wrote:
> On 19-05-20, 00:37, Anders Roxell wrote:
> > On Mon, 18 May 2020 at 21:57, Vinod Koul <[email protected]> wrote:
> > > On 18-05-20, 19:53, Anders Roxell wrote:
> > > > On Wed, 6 May 2020 at 08:01, Vinod Koul <[email protected]> wrote:
> > > > >
> > > > > Some rensas controller like uPD720201 and uPD720202 need firmware to be
> > > > > loaded. Add these devices in pci table and invoke renesas firmware loader
> > > > > functions to check and load the firmware into device memory when
> > > > > required.
> > > > >
> > > > > Signed-off-by: Vinod Koul <[email protected]>
> > > >
> > > > Hi, I got a build error when I built an arm64 allmodconfig kernel.
> > >
> > > Thanks for this. This is happening as we have default y for USB_XHCI_PCI
> > > and then we make USB_XHCI_PCI_RENESAS=m. That should be not allowed as
> > > we export as symbol so both can be inbuilt or modules but USB_XHCI_PCI=y
> > > and USB_XHCI_PCI_RENESAS=m cant. While it is valid that USB_XHCI_PCI=y|m
> > > and USB_XHCI_PCI_RENESAS=n
> > >
> > > So this seems to get fixed by below for me. I have tested with
> > > - both y and m (easy)
> > > - make USB_XHCI_PCI_RENESAS=n, USB_XHCI_PCI=y|m works
> > > - try making USB_XHCI_PCI=y and USB_XHCI_PCI_RENESAS=m, then
> > > USB_XHCI_PCI=m by kbuild :)
> > > - try making USB_XHCI_PCI=m and USB_XHCI_PCI_RENESAS=y, kbuild gives
> > > error prompt that it will be m due to depends
> > >
> > > Thanks to all the fixes done by Arnd which pointed me to this. Pls
> > > verify
> >
> > I was able to build an arm64 allmodconfig kernel with this change.
>
> I will send the formal patch and add your name in reported and
> tested. Thanks for the quick verification

I just checked the patch and I think this will work correctly in all cases,
but it still seems a bit backwards:

> > > diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
> > > index b5c542d6a1c5..92783d175b3f 100644
> > > --- a/drivers/usb/host/Kconfig
> > > +++ b/drivers/usb/host/Kconfig
> > > @@ -40,11 +40,11 @@ config USB_XHCI_DBGCAP
> > > config USB_XHCI_PCI
> > > tristate
> > > depends on USB_PCI
> > > + depends on USB_XHCI_PCI_RENESAS || !USB_XHCI_PCI_RENESAS
> > > default y
> > >
> > > config USB_XHCI_PCI_RENESAS
> > > tristate "Support for additional Renesas xHCI controller with firwmare"
> > > - depends on USB_XHCI_PCI
> > > ---help---
> > > Say 'Y' to enable the support for the Renesas xHCI controller with
> > > firwmare. Make sure you have the firwmare for the device and
> > >

I think it would have been better to follow the normal driver abstraction here
and make the renesas xhci a specialized version of the xhci driver with
its own platform_driver instance that calls into the generic xhci_pci module,
rather than having the generic code treat it as a quirk.

That would be more like how we handle all the ehci and ohci variants, though
I'm not sure how exactly it would work with two drivers having pci_device_id
tables with non-exclusive members. Presumably the generic driver would
still have to know that it needs to fail its probe() function on devices that
need the firmware.

Arnd

2020-05-19 11:47:26

by Heikki Krogerus

[permalink] [raw]
Subject: Re: [PATCH v13 2/5] usb: renesas-xhci: Add the renesas xhci driver

Hi guys,

On Wed, May 06, 2020 at 11:30:22AM +0530, Vinod Koul wrote:
> From: Christian Lamparter <[email protected]>
>
> This add a new driver for renesas xhci which is basically a firmware
> loader for uPD720201 and uPD720202 w/o ROM. The xhci-pci driver will
> invoke this driver for loading/unloading on relevant devices.
>
> This patch adds a firmware loader for the uPD720201K8-711-BAC-A
> and uPD720202K8-711-BAA-A variant. Both of these chips are listed
> in Renesas' R19UH0078EJ0500 Rev.5.00 "User's Manual: Hardware" as
> devices which need the firmware loader on page 2 in order to
> work as they "do not support the External ROM".
>
> The "Firmware Download Sequence" is describe in chapter
> "7.1 FW Download Interface" R19UH0078EJ0500 Rev.5.00 page 131.
>
> The firmware "K2013080.mem" is available from a USB3.0 Host to
> PCIe Adapter (PP2U-E card) "Firmware download" archive. An
> alternative version can be sourced from Netgear's WNDR4700 GPL
> archives.
>
> The release notes of the PP2U-E's "Firmware Download" ver 2.0.1.3
> (2012-06-15) state that the firmware is for the following devices:
> - uPD720201 ES 2.0 sample whose revision ID is 2.
> - uPD720201 ES 2.1 sample & CS sample & Mass product, ID is 3.
> - uPD720202 ES 2.0 sample & CS sample & Mass product, ID is 2.

You wouldn't happen to have access to the documentation of the
"original" uPD720200 USB 3.0 controller?

It would be cool if we could support that too with this driver.

thanks,

--
heikki

2020-05-19 12:06:19

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH v13 2/5] usb: renesas-xhci: Add the renesas xhci driver

Hi Heikki

On 19-05-20, 14:45, Heikki Krogerus wrote:
> Hi guys,
>
> On Wed, May 06, 2020 at 11:30:22AM +0530, Vinod Koul wrote:
> > From: Christian Lamparter <[email protected]>
> >
> > This add a new driver for renesas xhci which is basically a firmware
> > loader for uPD720201 and uPD720202 w/o ROM. The xhci-pci driver will
> > invoke this driver for loading/unloading on relevant devices.
> >
> > This patch adds a firmware loader for the uPD720201K8-711-BAC-A
> > and uPD720202K8-711-BAA-A variant. Both of these chips are listed
> > in Renesas' R19UH0078EJ0500 Rev.5.00 "User's Manual: Hardware" as
> > devices which need the firmware loader on page 2 in order to
> > work as they "do not support the External ROM".
> >
> > The "Firmware Download Sequence" is describe in chapter
> > "7.1 FW Download Interface" R19UH0078EJ0500 Rev.5.00 page 131.
> >
> > The firmware "K2013080.mem" is available from a USB3.0 Host to
> > PCIe Adapter (PP2U-E card) "Firmware download" archive. An
> > alternative version can be sourced from Netgear's WNDR4700 GPL
> > archives.
> >
> > The release notes of the PP2U-E's "Firmware Download" ver 2.0.1.3
> > (2012-06-15) state that the firmware is for the following devices:
> > - uPD720201 ES 2.0 sample whose revision ID is 2.
> > - uPD720201 ES 2.1 sample & CS sample & Mass product, ID is 3.
> > - uPD720202 ES 2.0 sample & CS sample & Mass product, ID is 2.
>
> You wouldn't happen to have access to the documentation of the
> "original" uPD720200 USB 3.0 controller?
>
> It would be cool if we could support that too with this driver.

Not me. does it also require firmware? If so you can try with this
driver and see if it works for you?

Thanks
--
~Vinod

2020-05-19 12:44:14

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH v13 3/5] usb: xhci: Add support for Renesas controller with memory

HI Arnd,

On 19-05-20, 09:44, Arnd Bergmann wrote:
> On Tue, May 19, 2020 at 6:53 AM Vinod Koul <[email protected]> wrote:
> > On 19-05-20, 00:37, Anders Roxell wrote:
> > > On Mon, 18 May 2020 at 21:57, Vinod Koul <[email protected]> wrote:
> > > > On 18-05-20, 19:53, Anders Roxell wrote:
> > > > > On Wed, 6 May 2020 at 08:01, Vinod Koul <[email protected]> wrote:
> > > > > >
> > > > > > Some rensas controller like uPD720201 and uPD720202 need firmware to be
> > > > > > loaded. Add these devices in pci table and invoke renesas firmware loader
> > > > > > functions to check and load the firmware into device memory when
> > > > > > required.
> > > > > >
> > > > > > Signed-off-by: Vinod Koul <[email protected]>
> > > > >
> > > > > Hi, I got a build error when I built an arm64 allmodconfig kernel.
> > > >
> > > > Thanks for this. This is happening as we have default y for USB_XHCI_PCI
> > > > and then we make USB_XHCI_PCI_RENESAS=m. That should be not allowed as
> > > > we export as symbol so both can be inbuilt or modules but USB_XHCI_PCI=y
> > > > and USB_XHCI_PCI_RENESAS=m cant. While it is valid that USB_XHCI_PCI=y|m
> > > > and USB_XHCI_PCI_RENESAS=n
> > > >
> > > > So this seems to get fixed by below for me. I have tested with
> > > > - both y and m (easy)
> > > > - make USB_XHCI_PCI_RENESAS=n, USB_XHCI_PCI=y|m works
> > > > - try making USB_XHCI_PCI=y and USB_XHCI_PCI_RENESAS=m, then
> > > > USB_XHCI_PCI=m by kbuild :)
> > > > - try making USB_XHCI_PCI=m and USB_XHCI_PCI_RENESAS=y, kbuild gives
> > > > error prompt that it will be m due to depends
> > > >
> > > > Thanks to all the fixes done by Arnd which pointed me to this. Pls
> > > > verify
> > >
> > > I was able to build an arm64 allmodconfig kernel with this change.
> >
> > I will send the formal patch and add your name in reported and
> > tested. Thanks for the quick verification
>
> I just checked the patch and I think this will work correctly in all cases,
> but it still seems a bit backwards:
>
> > > > diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig
> > > > index b5c542d6a1c5..92783d175b3f 100644
> > > > --- a/drivers/usb/host/Kconfig
> > > > +++ b/drivers/usb/host/Kconfig
> > > > @@ -40,11 +40,11 @@ config USB_XHCI_DBGCAP
> > > > config USB_XHCI_PCI
> > > > tristate
> > > > depends on USB_PCI
> > > > + depends on USB_XHCI_PCI_RENESAS || !USB_XHCI_PCI_RENESAS
> > > > default y
> > > >
> > > > config USB_XHCI_PCI_RENESAS
> > > > tristate "Support for additional Renesas xHCI controller with firwmare"
> > > > - depends on USB_XHCI_PCI
> > > > ---help---
> > > > Say 'Y' to enable the support for the Renesas xHCI controller with
> > > > firwmare. Make sure you have the firwmare for the device and
> > > >
>
> I think it would have been better to follow the normal driver abstraction here
> and make the renesas xhci a specialized version of the xhci driver with
> its own platform_driver instance that calls into the generic xhci_pci module,
> rather than having the generic code treat it as a quirk.
>
> That would be more like how we handle all the ehci and ohci variants, though
> I'm not sure how exactly it would work with two drivers having pci_device_id
> tables with non-exclusive members. Presumably the generic driver would
> still have to know that it needs to fail its probe() function on devices that
> need the firmware.

Yeah one of the earlier versions did try this and it wasn't nice. The
xhci driver claims the devices as it registers for the class. Now only
solution is to ensure we load the renesas first and resort to makefile
hacks..

--
~Vinod

2020-05-19 12:53:36

by Heikki Krogerus

[permalink] [raw]
Subject: Re: [PATCH v13 2/5] usb: renesas-xhci: Add the renesas xhci driver

On Tue, May 19, 2020 at 05:31:30PM +0530, Vinod Koul wrote:
> Hi Heikki
>
> On 19-05-20, 14:45, Heikki Krogerus wrote:
> > Hi guys,
> >
> > On Wed, May 06, 2020 at 11:30:22AM +0530, Vinod Koul wrote:
> > > From: Christian Lamparter <[email protected]>
> > >
> > > This add a new driver for renesas xhci which is basically a firmware
> > > loader for uPD720201 and uPD720202 w/o ROM. The xhci-pci driver will
> > > invoke this driver for loading/unloading on relevant devices.
> > >
> > > This patch adds a firmware loader for the uPD720201K8-711-BAC-A
> > > and uPD720202K8-711-BAA-A variant. Both of these chips are listed
> > > in Renesas' R19UH0078EJ0500 Rev.5.00 "User's Manual: Hardware" as
> > > devices which need the firmware loader on page 2 in order to
> > > work as they "do not support the External ROM".
> > >
> > > The "Firmware Download Sequence" is describe in chapter
> > > "7.1 FW Download Interface" R19UH0078EJ0500 Rev.5.00 page 131.
> > >
> > > The firmware "K2013080.mem" is available from a USB3.0 Host to
> > > PCIe Adapter (PP2U-E card) "Firmware download" archive. An
> > > alternative version can be sourced from Netgear's WNDR4700 GPL
> > > archives.
> > >
> > > The release notes of the PP2U-E's "Firmware Download" ver 2.0.1.3
> > > (2012-06-15) state that the firmware is for the following devices:
> > > - uPD720201 ES 2.0 sample whose revision ID is 2.
> > > - uPD720201 ES 2.1 sample & CS sample & Mass product, ID is 3.
> > > - uPD720202 ES 2.0 sample & CS sample & Mass product, ID is 2.
> >
> > You wouldn't happen to have access to the documentation of the
> > "original" uPD720200 USB 3.0 controller?
> >
> > It would be cool if we could support that too with this driver.
>
> Not me. does it also require firmware? If so you can try with this
> driver and see if it works for you?

It does require firmware, and yes I can test this driver at some
point.

thanks,

--
heikki

2020-05-19 20:21:08

by Christian Lamparter

[permalink] [raw]
Subject: Re: [PATCH v13 2/5] usb: renesas-xhci: Add the renesas xhci driver

Hello,

On Tue, May 19, 2020 at 1:45 PM Heikki Krogerus
<[email protected]> wrote:
> On Wed, May 06, 2020 at 11:30:22AM +0530, Vinod Koul wrote:
> > From: Christian Lamparter <[email protected]>
> >
> > This add a new driver for renesas xhci which is basically a firmware
> > loader for uPD720201 and uPD720202 w/o ROM. The xhci-pci driver will
> > invoke this driver for loading/unloading on relevant devices.
> >
> > This patch adds a firmware loader for the uPD720201K8-711-BAC-A
> > and uPD720202K8-711-BAA-A variant. Both of these chips are listed
> > in Renesas' R19UH0078EJ0500 Rev.5.00 "User's Manual: Hardware" as
> > devices which need the firmware loader on page 2 in order to
> > work as they "do not support the External ROM".
> >
> > The "Firmware Download Sequence" is describe in chapter
> > "7.1 FW Download Interface" R19UH0078EJ0500 Rev.5.00 page 131.
> >
> > The firmware "K2013080.mem" is available from a USB3.0 Host to
> > PCIe Adapter (PP2U-E card) "Firmware download" archive. An
> > alternative version can be sourced from Netgear's WNDR4700 GPL
> > archives.
> >
> > The release notes of the PP2U-E's "Firmware Download" ver 2.0.1.3
> > (2012-06-15) state that the firmware is for the following devices:
> > - uPD720201 ES 2.0 sample whose revision ID is 2.
> > - uPD720201 ES 2.1 sample & CS sample & Mass product, ID is 3.
> > - uPD720202 ES 2.0 sample & CS sample & Mass product, ID is 2.
>
> You wouldn't happen to have access to the documentation of the
> "original" uPD720200 USB 3.0 controller?
>
> It would be cool if we could support that too with this driver.

???. I have one of those "original" uPD720200(A) working "just fine"
in my Laptop currently.
It's an really old HP dv6-6003eg from around 2011 that came with two
USB 3.0 Ports, which
are driven by a "NEC Corporation uPD720200 USB 3.0 Host Controller"
1033:0194 (Rev 04).

As for supporting the uPD720200 (flasher) with this serises.... There
are some bad news:

"In addition, the programming interface for the uPD720200 and uPD720200A
is different from the uPD720202, needs different programming tools, and relies
on proprietary chip features that cannot be disclosed outside of Renesas."
<https://mail.coreboot.org/pipermail/flashrom/2013-February/010498.html> :-(

Regards,
Christian

2020-05-20 13:32:05

by Heikki Krogerus

[permalink] [raw]
Subject: Re: [PATCH v13 2/5] usb: renesas-xhci: Add the renesas xhci driver

On Tue, May 19, 2020 at 10:19:03PM +0200, Christian Lamparter wrote:
> Hello,
>
> On Tue, May 19, 2020 at 1:45 PM Heikki Krogerus
> <[email protected]> wrote:
> > On Wed, May 06, 2020 at 11:30:22AM +0530, Vinod Koul wrote:
> > > From: Christian Lamparter <[email protected]>
> > >
> > > This add a new driver for renesas xhci which is basically a firmware
> > > loader for uPD720201 and uPD720202 w/o ROM. The xhci-pci driver will
> > > invoke this driver for loading/unloading on relevant devices.
> > >
> > > This patch adds a firmware loader for the uPD720201K8-711-BAC-A
> > > and uPD720202K8-711-BAA-A variant. Both of these chips are listed
> > > in Renesas' R19UH0078EJ0500 Rev.5.00 "User's Manual: Hardware" as
> > > devices which need the firmware loader on page 2 in order to
> > > work as they "do not support the External ROM".
> > >
> > > The "Firmware Download Sequence" is describe in chapter
> > > "7.1 FW Download Interface" R19UH0078EJ0500 Rev.5.00 page 131.
> > >
> > > The firmware "K2013080.mem" is available from a USB3.0 Host to
> > > PCIe Adapter (PP2U-E card) "Firmware download" archive. An
> > > alternative version can be sourced from Netgear's WNDR4700 GPL
> > > archives.
> > >
> > > The release notes of the PP2U-E's "Firmware Download" ver 2.0.1.3
> > > (2012-06-15) state that the firmware is for the following devices:
> > > - uPD720201 ES 2.0 sample whose revision ID is 2.
> > > - uPD720201 ES 2.1 sample & CS sample & Mass product, ID is 3.
> > > - uPD720202 ES 2.0 sample & CS sample & Mass product, ID is 2.
> >
> > You wouldn't happen to have access to the documentation of the
> > "original" uPD720200 USB 3.0 controller?
> >
> > It would be cool if we could support that too with this driver.
>
> ???. I have one of those "original" uPD720200(A) working "just fine"
> in my Laptop currently.
> It's an really old HP dv6-6003eg from around 2011 that came with two
> USB 3.0 Ports, which
> are driven by a "NEC Corporation uPD720200 USB 3.0 Host Controller"
> 1033:0194 (Rev 04).
>
> As for supporting the uPD720200 (flasher) with this serises.... There
> are some bad news:
>
> "In addition, the programming interface for the uPD720200 and uPD720200A
> is different from the uPD720202, needs different programming tools, and relies
> on proprietary chip features that cannot be disclosed outside of Renesas."
> <https://mail.coreboot.org/pipermail/flashrom/2013-February/010498.html> :-(

Too bad. That's what I was hoping to do with this driver. There are
still boards out there equipped with uPD720200/uPD720200A that have
older firmware. If you don't have the latest firmware (which is also
from 2012), then PME and a few other things will not work (so resume
from D3 does not work for example).

thanks,

--
heikki