usb: xhci: Add support for Renesas USB controllers
Subsystems (6)
v12 cover 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 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 multiple fw order
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/Makefile | 2 +- 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 | 16 + drivers/usb/host/xhci.h | 1 + include/linux/usb/hcd.h | 3 +- 10 files changed, 754 insertions(+), 23 deletions(-) create mode 100644 drivers/usb/host/xhci-pci-renesas.c create mode 100644 drivers/usb/host/xhci-pci.h
Signature · 1 line
2.25.3
PATCH v12 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.
--- 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(-)
drivers/usb/core/hcd-pci.c +4 -3
@@ -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 ;
drivers/usb/host/ehci-pci.c +2 -4
@@ -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 */ } };
drivers/usb/host/ohci-pci.c +6 -3
@@ -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,
drivers/usb/host/uhci-pci.c +6 -2
@@ -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,
drivers/usb/host/xhci-pci.c +5 -9
@@ -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 */ } };
include/linux/usb/hcd.h +2 -1
@@ -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);
Signature · 1 line
2.25.3
PATCH v12 2/5 usb: renesas-xhci: Add the renesas xhci driver
In reply to Vinod KoulFrom: 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.
[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
export symbols for xhci-pci to use]
--- drivers/usb/host/Makefile | 2 +- drivers/usb/host/xhci-pci-renesas.c | 365 ++++++++++++++++++++++++++++ drivers/usb/host/xhci-pci.h | 16 ++ 3 files changed, 382 insertions(+), 1 deletion(-) create mode 100644 drivers/usb/host/xhci-pci-renesas.c create mode 100644 drivers/usb/host/xhci-pci.h
drivers/usb/host/Makefile +1 -1
@@ -70,7 +70,7 @@ obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o 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) += xhci-pci.o 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
drivers/usb/host/xhci-pci-renesas.c new file +365 -0
365 lines not on this page · raw message
drivers/usb/host/xhci-pci.h new file +16 -0
@@ -0,0 +1,16 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* Copyright (C) 2019-2020 Linaro Limited */ + +#ifndef XHCI_PCI_H +#define XHCI_PCI_H + +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); + +struct xhci_driver_data { +u64 quirks; +const char *firmware; +}; + +#endif
Signature · 1 line
2.25.3
Re: [PATCH v12 2/5] usb: renesas-xhci: Add the renesas xhci driver
Quoted 52 lines · Vinod Koul
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
removedrenesas_fw_alive_check
cleanedrenesas_fw_callback
removed recursion forrenesas_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
export symbols for xhci-pci to use]Signed-off-by Vinod Koul <[email protected]>--- drivers/usb/host/Makefile | 2 +- drivers/usb/host/xhci-pci-renesas.c | 365 ++++++++++++++++++++++++++++ drivers/usb/host/xhci-pci.h | 16 ++ 3 files changed, 382 insertions(+), 1 deletion(-) create mode 100644 drivers/usb/host/xhci-pci-renesas.c create mode 100644 drivers/usb/host/xhci-pci.hdrivers/usb/host/Makefile +0
-0
drivers/usb/host/Makefile obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o · line 73
Quoted 5 lines
drivers/usb/host/Makefile +1
-1@@ -70,7 +70,7 @@ obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o 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) += xhci-pci.o xhci-pci-renesas.o
Hmm, now we end up with two modules, xhci-pci and xhci-pci-renesas, even if xhci-pci-renesas just includes helper functions to load firmware for renesas.
My kbuild knowledge is limited, but one way to solve this would be to rename xhci-pci.c to xhci-pci-core.c and add:
xhci-pci-y := xhci-pci-core.o xhci-pci-renesas.o
unless someone can suggest a better way to solve this
-Mathias
Re: [PATCH v12 2/5] usb: renesas-xhci: Add the renesas xhci driver
Hi Mathias,
Quoted 48 lines · Mathias Nyman
Quoted 47 lines · Vinod Koul
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
removedrenesas_fw_alive_check
cleanedrenesas_fw_callback
removed recursion forrenesas_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
export symbols for xhci-pci to use]Signed-off-by Vinod Koul <[email protected]>--- drivers/usb/host/Makefile | 2 +- drivers/usb/host/xhci-pci-renesas.c | 365 ++++++++++++++++++++++++++++ drivers/usb/host/xhci-pci.h | 16 ++ 3 files changed, 382 insertions(+), 1 deletion(-) create mode 100644 drivers/usb/host/xhci-pci-renesas.c create mode 100644 drivers/usb/host/xhci-pci.h
Quoted 13 lines
drivers/usb/host/Makefile obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o · line 73
Quoted 10 lines
drivers/usb/host/Makefile +1
-1@@ -70,7 +70,7 @@ obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o 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) += xhci-pci.o xhci-pci-renesas.oHmm, now we end up with two modules, xhci-pci and xhci-pci-renesas, even if xhci-pci-renesas just includes helper functions to load firmware for renesas.
Right, these are two modules. Do you forsee an issue with two ko's
Quoted 3 lines
My kbuild knowledge is limited, but one way to solve this would be to rename
xhci-pci.ctoxhci-pci-core.cand add:
Yeah i wanted to avoid the rename (stopped short of suggesting that)..
Quoted 4 lines
xhci-pci-y := xhci-pci-core.o xhci-pci-renesas.o
unless someone can suggest a better way to solve this
I dont have any better idea atm!
So if you are okay with rename of file, I can do that first and then these patches
Thanks
Signature · 1 line
~Vinod
Greg Kroah-Hartman
maintainerRe: [PATCH v12 2/5] usb: renesas-xhci: Add the renesas xhci driver
Quoted 65 lines · Vinod Koul
Hi Mathias,
Quoted 48 lines · Mathias Nyman
Quoted 47 lines · Vinod Koul
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
removedrenesas_fw_alive_check
cleanedrenesas_fw_callback
removed recursion forrenesas_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
export symbols for xhci-pci to use]Signed-off-by Vinod Koul <[email protected]>--- drivers/usb/host/Makefile | 2 +- drivers/usb/host/xhci-pci-renesas.c | 365 ++++++++++++++++++++++++++++ drivers/usb/host/xhci-pci.h | 16 ++ 3 files changed, 382 insertions(+), 1 deletion(-) create mode 100644 drivers/usb/host/xhci-pci-renesas.c create mode 100644 drivers/usb/host/xhci-pci.hQuoted 13 lines
drivers/usb/host/Makefile obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o · line 73
Quoted 10 lines
drivers/usb/host/Makefile +1
-1@@ -70,7 +70,7 @@ obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o 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) += xhci-pci.o xhci-pci-renesas.oHmm, now we end up with two modules, xhci-pci and xhci-pci-renesas, even if xhci-pci-renesas just includes helper functions to load firmware for renesas.
Quoted 1 line
Right, these are two modules. Do you forsee an issue with two ko's
Two kos should be fine, but as you aren't giving people the option to not select this, it's a bit harsh to add it.
Can this be a separate module/config option? Why force everyone to need this additional code if they do not have this hardware?
thanks,
greg k-h
Re: [PATCH v12 2/5] usb: renesas-xhci: Add the renesas xhci driver
Quoted 14 lines · Greg Kroah-Hartman
Quoted 12 lines · Vinod Koul
Quoted 11 lines
drivers/usb/host/Makefile obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o · line 73
Quoted 8 lines
drivers/usb/host/Makefile +1
-1@@ -70,7 +70,7 @@ obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o 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) += xhci-pci.o xhci-pci-renesas.oHmm, now we end up with two modules, xhci-pci and xhci-pci-renesas, even if xhci-pci-renesas just includes helper functions to load firmware for renesas.
Quoted 7 lines
Quoted 1 line
Right, these are two modules. Do you forsee an issue with two ko's
Two kos should be fine, but as you aren't giving people the option to not select this, it's a bit harsh to add it.
Can this be a separate module/config option? Why force everyone to need this additional code if they do not have this hardware?
Since the code is moved out and is based on PCI ID of the device, this wont be invoked at all for folks not having this hardware. But adding a config option would work too and avoid renaming file.
I think this looks as a better option to me atm. We no longer have load order issue with current approach so we dont care about that as well.
Mathias, let me know if you are okay with approach, I can respin this, or if you have better idea do let us know
Thanks
Signature · 1 line
~Vinod
Greg Kroah-Hartman
maintainerRe: [PATCH v12 2/5] usb: renesas-xhci: Add the renesas xhci driver
Quoted 20 lines · Vinod Koul
Quoted 19 lines · Greg Kroah-Hartman
Quoted 12 lines · Vinod Koul
Quoted 11 lines
drivers/usb/host/Makefile obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o · line 73
Quoted 8 lines
drivers/usb/host/Makefile +1
-1@@ -70,7 +70,7 @@ obj-$(CONFIG_USB_OHCI_HCD_DAVINCI) += ohci-da8xx.o 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) += xhci-pci.o xhci-pci-renesas.oHmm, now we end up with two modules, xhci-pci and xhci-pci-renesas, even if xhci-pci-renesas just includes helper functions to load firmware for renesas.
Quoted 1 line
Right, these are two modules. Do you forsee an issue with two ko's
Two kos should be fine, but as you aren't giving people the option to not select this, it's a bit harsh to add it.
Quoted 6 lines
Quoted 2 lines
Can this be a separate module/config option? Why force everyone to need this additional code if they do not have this hardware?
Since the code is moved out and is based on PCI ID of the device, this wont be invoked at all for folks not having this hardware. But adding a config option would work too and avoid renaming file.
Yes, it would not be "invoked", but it still would always be loaded into memory. Please only load this code if the hardware is present in the system.
thanks,
greg k-h
PATCH v12 3/5 usb: xhci: Add support for Renesas controller with memory
In reply to Vinod KoulSome rensas controller like uPD720201 and uPD720202 need firmware to be loaded. Add these devices in table and invoke renesas firmware loader functions to check and load the firmware into device memory when required.
--- drivers/usb/host/xhci-pci.c | 35 ++++++++++++++++++++++++++++++++++- drivers/usb/host/xhci.h | 1 + 2 files changed, 35 insertions(+), 1 deletion(-)
drivers/usb/host/xhci-pci.c +34 -1
@@ -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 = {
drivers/usb/host/xhci.h +1 -0
@@ -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;
Signature · 1 line
2.25.3
PATCH v12 4/5 usb: renesas-xhci: Add ROM loader for uPD720201
In reply to Vinod KouluPD720201 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.
--- drivers/usb/host/xhci-pci-renesas.c | 294 +++++++++++++++++++++++++++- 1 file changed, 287 insertions(+), 7 deletions(-)
drivers/usb/host/xhci-pci-renesas.c +287 -7
@@ -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;
Signature · 1 line
2.25.3
PATCH v12 5/5 usb: xhci: provide a debugfs hook for erasing rom
In reply to Vinod Koulrun "echo 1 > /sys/kernel/debug/renesas-usb/rom_erase" to erase firmware when driver is loaded.
Subsequent init of driver shall reload the firmware
--- drivers/usb/host/xhci-pci-renesas.c | 33 +++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+)
drivers/usb/host/xhci-pci-renesas.c +33 -0
@@ -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);
Signature · 1 line
2.25.3