From patchwork Mon Jan 13 08:40:01 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vinod Koul X-Patchwork-Id: 190692 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 69B47C33CA8 for ; Mon, 13 Jan 2020 08:40:32 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 40C61207E0 for ; Mon, 13 Jan 2020 08:40:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1578904832; bh=ZiXD4t/VqVmgHwtWL5sGCo6h0K9E6wwR6VpH1Q/ypHI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=oMNE40Lr6X4LitSVzLPHSklMDHqQsCux4MzwBwhNi+3dVg83uwMYsevnjkNwh+5HY rpFWArfMlI0QnF0i2pGc2e8P8xJ30sJzOCFoX3hZvwkCziOksS2SCFhVvCS4uWufE2 oEufoKBMbda9bfQm1Fpvr/5nvFDz2NoE8zuY9hsU= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728855AbgAMIk1 (ORCPT ); Mon, 13 Jan 2020 03:40:27 -0500 Received: from mail.kernel.org ([198.145.29.99]:43044 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727231AbgAMIk1 (ORCPT ); Mon, 13 Jan 2020 03:40:27 -0500 Received: from localhost.localdomain (unknown [106.200.247.255]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 9BB3A2082E; Mon, 13 Jan 2020 08:40:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1578904826; bh=ZiXD4t/VqVmgHwtWL5sGCo6h0K9E6wwR6VpH1Q/ypHI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=vO0NXykK9nnRLs8R5RBkXnZXpO9Ddhyq8qdEq2EYcC/KayfyEAi5uOP7tZFGRT8D0 6KhS0OUrpo0RGfA+7PVnjwGwx1DojB1zoCIepv4+53XFhO2sjDWkceZjWaamZe2qy+ QU2I/U4B3pAqR7WmeLambh2tdpnwhQmJ26jxRguI= From: Vinod Koul To: Mathias Nyman , Greg Kroah-Hartman Cc: linux-arm-msm@vger.kernel.org, Bjorn Andersson , Vinod Koul , Yoshihiro Shimoda , Christian Lamparter , linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v6 1/5] usb: xhci: export few functions Date: Mon, 13 Jan 2020 14:10:01 +0530 Message-Id: <20200113084005.849071-2-vkoul@kernel.org> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200113084005.849071-1-vkoul@kernel.org> References: <20200113084005.849071-1-vkoul@kernel.org> MIME-Version: 1.0 Sender: linux-arm-msm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org Export the xhci_pci_setup(), xhci_pci_probe() xhci_pci_remove(), xhci_pci_suspend() and xhci_pci_resume() functions as they would be used by renesas-xhci driver. Signed-off-by: Vinod Koul --- drivers/usb/host/xhci-pci.c | 18 +++++++++++------- drivers/usb/host/xhci-pci.h | 18 ++++++++++++++++++ 2 files changed, 29 insertions(+), 7 deletions(-) create mode 100644 drivers/usb/host/xhci-pci.h diff --git a/drivers/usb/host/xhci-pci.c b/drivers/usb/host/xhci-pci.c index a0025d23b257..5115871b50af 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 @@ -60,8 +61,6 @@ static const char hcd_name[] = "xhci_hcd"; static struct hc_driver __read_mostly xhci_pci_hc_driver; -static int xhci_pci_setup(struct usb_hcd *hcd); - static const struct xhci_driver_overrides xhci_pci_overrides __initconst = { .reset = xhci_pci_setup, }; @@ -282,7 +281,7 @@ static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) { } #endif /* CONFIG_ACPI */ /* called during probe() after chip reset completes */ -static int xhci_pci_setup(struct usb_hcd *hcd) +int xhci_pci_setup(struct usb_hcd *hcd) { struct xhci_hcd *xhci; struct pci_dev *pdev = to_pci_dev(hcd->self.controller); @@ -307,12 +306,13 @@ static int xhci_pci_setup(struct usb_hcd *hcd) /* Find any debug ports */ return xhci_pci_reinit(xhci, pdev); } +EXPORT_SYMBOL_GPL(xhci_pci_setup); /* * We need to register our own PCI probe function (instead of the USB core's * function) in order to create a second roothub under xHCI. */ -static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) +int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) { int retval; struct xhci_hcd *xhci; @@ -378,8 +378,9 @@ static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id) pm_runtime_put_noidle(&dev->dev); return retval; } +EXPORT_SYMBOL_GPL(xhci_pci_probe); -static void xhci_pci_remove(struct pci_dev *dev) +void xhci_pci_remove(struct pci_dev *dev) { struct xhci_hcd *xhci; @@ -401,6 +402,7 @@ static void xhci_pci_remove(struct pci_dev *dev) usb_hcd_pci_remove(dev); } +EXPORT_SYMBOL_GPL(xhci_pci_remove); #ifdef CONFIG_PM /* @@ -457,7 +459,7 @@ static void xhci_pme_quirk(struct usb_hcd *hcd) readl(reg); } -static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup) +int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup) { struct xhci_hcd *xhci = hcd_to_xhci(hcd); struct pci_dev *pdev = to_pci_dev(hcd->self.controller); @@ -482,8 +484,9 @@ static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup) return ret; } +EXPORT_SYMBOL_GPL(xhci_pci_suspend); -static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated) +int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated) { struct xhci_hcd *xhci = hcd_to_xhci(hcd); struct pci_dev *pdev = to_pci_dev(hcd->self.controller); @@ -519,6 +522,7 @@ static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated) retval = xhci_resume(xhci, hibernated); return retval; } +EXPORT_SYMBOL_GPL(xhci_pci_resume); #endif /* CONFIG_PM */ /*-------------------------------------------------------------------------*/ diff --git a/drivers/usb/host/xhci-pci.h b/drivers/usb/host/xhci-pci.h new file mode 100644 index 000000000000..587f71dc5e35 --- /dev/null +++ b/drivers/usb/host/xhci-pci.h @@ -0,0 +1,18 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* Copyright (C) 2008 Intel Corp. */ + +#ifndef XHCI_PCI_H +#define XHCI_PCI_H + +int xhci_pci_setup(struct usb_hcd *hcd); + +int xhci_pci_probe(struct pci_dev *pdev, + const struct pci_device_id *id); + +void xhci_pci_remove(struct pci_dev *dev); + +int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup); + +int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated); + +#endif From patchwork Mon Jan 13 08:40:02 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vinod Koul X-Patchwork-Id: 190690 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5BB7EC33CAB for ; Mon, 13 Jan 2020 08:40:54 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 27E6A206DA for ; Mon, 13 Jan 2020 08:40:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1578904854; bh=0bNgTn6WS6/xZy6lOxkstb5WVqjPEhelDUKzEbkYCPs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=ZwFHPnu/8CI5ZQqtP1X+Xz+QrasrIVbRQMqYlN5eHz9lbsl9KKLUYq6/y3Qix97je NZrLeyXvWSCrThPJMiF4awlK325S2sHdNVHVzuWmCJejXayHuw+2VRo6cfYXPFrdbj XDFR5Yp/INOoZ62rpXDbVBbn/IRzJlN0LxxNNhBU= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728883AbgAMIkb (ORCPT ); Mon, 13 Jan 2020 03:40:31 -0500 Received: from mail.kernel.org ([198.145.29.99]:43180 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727231AbgAMIkb (ORCPT ); Mon, 13 Jan 2020 03:40:31 -0500 Received: from localhost.localdomain (unknown [106.200.247.255]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 1D3F9207E0; Mon, 13 Jan 2020 08:40:26 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1578904830; bh=0bNgTn6WS6/xZy6lOxkstb5WVqjPEhelDUKzEbkYCPs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=QqQcraA3aZ99VEzCmAMemA8Vrm0TZmQ+C7MawxX/kQNCxxJYAZ/AwkDpXcQswhc0z EWLyV2/sFkP3mu4e6x49w2wZkpGbfx9F3AdKtKumyA1FCWzh6bXZ65ArPq+iFzrWh3 2aBg0IJ8HyQIDQGHBjxq+qJSm5gQGi8hTvzEdjSA= From: Vinod Koul To: Mathias Nyman , Greg Kroah-Hartman Cc: linux-arm-msm@vger.kernel.org, Bjorn Andersson , Christian Lamparter , Yoshihiro Shimoda , linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, Vinod Koul Subject: [PATCH v6 2/5] usb: renesas-xhci: Add the renesas xhci driver Date: Mon, 13 Jan 2020 14:10:02 +0530 Message-Id: <20200113084005.849071-3-vkoul@kernel.org> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200113084005.849071-1-vkoul@kernel.org> References: <20200113084005.849071-1-vkoul@kernel.org> MIME-Version: 1.0 Sender: linux-arm-msm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org From: Christian Lamparter This add a new driver for renesas xhci which is basically a firmware loader for uPD720201 and uPD720202 w/o ROM. It uses xhci-pci driver for most of the work. This is added in Makefile before the xhci-pci driver so that it first get probed for renesas devices before the xhci-pci driver has a chance to claim any device. 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. Cc: Yoshihiro Shimoda Signed-off-by: Christian Lamparter Signed-off-by: Bjorn Andersson [vkoul: fixed comments: 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 add register defines and field names move to a separate driver] Signed-off-by: Vinod Koul --- drivers/usb/host/Kconfig | 9 + drivers/usb/host/Makefile | 1 + drivers/usb/host/xhci-pci-renesas.c | 557 ++++++++++++++++++++++++++++ 3 files changed, 567 insertions(+) create mode 100644 drivers/usb/host/xhci-pci-renesas.c diff --git a/drivers/usb/host/Kconfig b/drivers/usb/host/Kconfig index 8d730180db06..77466b51bc7c 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 "Renesas USB XHCI Driver" + depends on USB_XHCI_PCI + ---help--- + Say 'Y' to enable the support for renesas USB XHCI Driver if + you have such a device. These devices need additional firmware, + make sure that is available. + 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..b6955d5235b0 100644 --- a/drivers/usb/host/Makefile +++ b/drivers/usb/host/Makefile @@ -70,6 +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_RENESAS) += xhci-pci-renesas.o obj-$(CONFIG_USB_XHCI_PCI) += xhci-pci.o obj-$(CONFIG_USB_XHCI_PLATFORM) += xhci-plat-hcd.o obj-$(CONFIG_USB_XHCI_HISTB) += xhci-histb.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..110c914ea7ef --- /dev/null +++ b/drivers/usb/host/xhci-pci-renesas.c @@ -0,0 +1,557 @@ +// SPDX-License-Identifier: GPL-2.0 +/* Copyright (C) 2019-2020 Linaro Limited */ + +#include +#include +#include +#include +#include +#include + +#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_RETRY 10000 +#define RENESAS_DELAY 10 + +static struct hc_driver __read_mostly xhci_pci_hc_driver; + +static const struct xhci_driver_overrides xhci_pci_overrides __initconst = { + .reset = xhci_pci_setup, +}; + +static const struct renesas_fw_entry { + const char *firmware_name; + u16 device; + u8 revision; + u16 expected_version; +} renesas_fw_table[] = { + /* + * Only the uPD720201K8-711-BAC-A or uPD720202K8-711-BAA-A + * are listed in R19UH0078EJ0500 Rev.5.00 as devices which + * need the software loader. + * + * PP2U/ReleaseNote_USB3-201-202-FW.txt: + * + * Note: This 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. + */ + { "K2013080.mem", 0x0014, 0x02, 0x2013 }, + { "K2013080.mem", 0x0014, 0x03, 0x2013 }, + { "K2013080.mem", 0x0015, 0x02, 0x2013 }, +}; + +MODULE_FIRMWARE("K2013080.mem"); + +static const struct renesas_fw_entry *renesas_needs_fw_dl(struct pci_dev *dev) +{ + const struct renesas_fw_entry *entry; + size_t i; + + /* This loader will only work with a RENESAS device. */ + if (!(dev->vendor == PCI_VENDOR_ID_RENESAS)) + return NULL; + + for (i = 0; i < ARRAY_SIZE(renesas_fw_table); i++) { + entry = &renesas_fw_table[i]; + if (entry->device == dev->device && + entry->revision == dev->revision) + return entry; + } + + return NULL; +} + +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) + return pcibios_err_to_errno(err); + if (!(fw_status & BIT(data0_or_data1))) + break; + + udelay(RENESAS_DELAY); + } + if (i == RENESAS_RETRY) + 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) + 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) + return pcibios_err_to_errno(err); + + return 0; +} + +static int renesas_fw_verify(struct pci_dev *dev, + const void *fw_data, + size_t length) +{ + const struct renesas_fw_entry *entry = renesas_needs_fw_dl(dev); + u16 fw_version_pointer; + u16 fw_version; + + if (!entry) + return -EINVAL; + + /* + * 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) { + dev_err(&dev->dev, "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) { + dev_err(&dev->dev, "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) { + dev_err(&dev->dev, + "firmware version pointer is outside of the firmware image."); + return -EINVAL; + } + + fw_version = get_unaligned_le16(fw_data + fw_version_pointer); + dev_dbg(&dev->dev, "got firmware version: %02x.", fw_version); + + if (fw_version != entry->expected_version) { + dev_err(&dev->dev, + "firmware version mismatch, expected version: %02x.", + entry->expected_version); + return -EINVAL; + } + + 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 resetted, 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! */ + return -ETIMEDOUT; + + default: + return err; + } + } + /* + * Optional last step: Engage Firmware Lock + * + * err = pci_write_config_byte(pdev, 0xF4, BIT(2)); + * if (err) + * return pcibios_err_to_errno(err); + */ + + return 0; +} + +struct renesas_fw_ctx { + struct pci_dev *pdev; + const struct pci_device_id *id; + bool resume; + const struct renesas_fw_entry *entry; +}; + +static void renesas_fw_callback(const struct firmware *fw, + void *context) +{ + struct renesas_fw_ctx *ctx = context; + struct pci_dev *pdev = ctx->pdev; + struct device *parent = pdev->dev.parent; + int err; + + if (!fw) { + dev_err(&pdev->dev, "firmware failed to load\n"); + + goto cleanup; + } + + err = renesas_fw_verify(pdev, fw->data, fw->size); + if (err) + goto cleanup; + + err = renesas_fw_download(pdev, fw); + release_firmware(fw); + if (err) { + dev_err(&pdev->dev, "firmware failed to download (%d).", err); + goto cleanup; + } + + if (ctx->resume) + return; + + err = xhci_pci_probe(pdev, ctx->id); + if (!err) { + /* everything worked */ + devm_kfree(&pdev->dev, ctx); + return; + } + +cleanup: + /* in case of an error - fall through */ + dev_info(&pdev->dev, "Unloading driver"); + + if (parent) + device_lock(parent); + + device_release_driver(&pdev->dev); + + if (parent) + device_unlock(parent); + + pci_dev_put(pdev); +} + +static int renesas_fw_alive_check(struct pci_dev *pdev) +{ + const struct renesas_fw_entry *entry; + + /* check if we have a eligible RENESAS' uPD720201/2 w/o FW. */ + entry = renesas_needs_fw_dl(pdev); + if (!entry) + return 0; + + return renesas_fw_check_running(pdev); +} + +static int renesas_fw_download_to_hw(struct pci_dev *pdev, + const struct pci_device_id *id, + bool do_resume) +{ + const struct renesas_fw_entry *entry; + struct renesas_fw_ctx *ctx; + int err; + + /* check if we have a eligible RENESAS' uPD720201/2 w/o FW. */ + entry = renesas_needs_fw_dl(pdev); + if (!entry) + return 0; + + err = renesas_fw_check_running(pdev); + /* Continue ahead, if the firmware is already running. */ + if (err == 0) + return 0; + + if (err != 1) + return err; + + ctx = devm_kzalloc(&pdev->dev, sizeof(*ctx), GFP_KERNEL); + if (!ctx) + return -ENOMEM; + ctx->pdev = pdev; + ctx->resume = do_resume; + ctx->id = id; + ctx->entry = entry; + + pci_dev_get(pdev); + err = request_firmware_nowait(THIS_MODULE, 1, entry->firmware_name, + &pdev->dev, GFP_KERNEL, + ctx, renesas_fw_callback); + if (err) { + pci_dev_put(pdev); + return err; + } + + /* + * The renesas_fw_callback() callback will continue the probe + * process, once it aquires the firmware. + */ + return 1; +} + +static int renesas_xhci_pci_probe(struct pci_dev *dev, + const struct pci_device_id *id) +{ + int retval; + + /* + * Check if this device is a RENESAS uPD720201/2 device. + * Otherwise, we can continue with xhci_pci_probe as usual. + */ + retval = renesas_fw_download_to_hw(dev, id, false); + switch (retval) { + case 0: + break; + + case 1: /* let it load the firmware and recontinue the probe. */ + return 0; + + default: + return retval; + }; + + return xhci_pci_probe(dev, id); +} + +static void renesas_xhci_pci_remove(struct pci_dev *dev) +{ + if (renesas_fw_alive_check(dev)) { + /* + * bail out early, if this was a renesas device w/o FW. + * Else we might hit the NMI watchdog in xhci_handsake + * during xhci_reset as part of the driver's unloading. + * which we forced in the renesas_fw_callback(). + */ + return; + } + + xhci_pci_remove(dev); +} + +static const struct pci_device_id pci_ids[] = { + { PCI_DEVICE(0x1912, 0x0014), + .driver_data = (unsigned long)&xhci_pci_hc_driver, + }, + { PCI_DEVICE(0x1912, 0x0015), + .driver_data = (unsigned long)&xhci_pci_hc_driver, + }, + { /* sentinal */ } +}; +MODULE_DEVICE_TABLE(pci, pci_ids); + +static struct pci_driver renesas_xhci_pci_driver = { + .name = "renesas xhci", + .id_table = pci_ids, + + .probe = renesas_xhci_pci_probe, + .remove = renesas_xhci_pci_remove, + /* suspend and resume implemented later */ + + .shutdown = usb_hcd_pci_shutdown, +#ifdef CONFIG_PM + .driver = { + .pm = &usb_hcd_pci_pm_ops + }, +#endif +}; + +static int __init xhci_pci_init(void) +{ + xhci_init_driver(&xhci_pci_hc_driver, &xhci_pci_overrides); +#ifdef CONFIG_PM + xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend; + xhci_pci_hc_driver.pci_resume = xhci_pci_resume; +#endif + return pci_register_driver(&renesas_xhci_pci_driver); +} +module_init(xhci_pci_init); + +static void __exit xhci_pci_exit(void) +{ + pci_unregister_driver(&renesas_xhci_pci_driver); +} +module_exit(xhci_pci_exit); + +MODULE_DESCRIPTION("xHCI PCI Host Controller Driver"); +MODULE_LICENSE("GPL"); From patchwork Mon Jan 13 08:40:04 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vinod Koul X-Patchwork-Id: 190691 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 25D48C33CAA for ; Mon, 13 Jan 2020 08:40:52 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id EE5452072B for ; Mon, 13 Jan 2020 08:40:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1578904852; bh=1qv/uiqU+lvGy4vNbaTZDSE+L9LCBmyo2jSjlXzCaFY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=OS97fxV3khtZWaMHeNT5Ipozc9n7izyNQl1AXbv/yiT/qSarRgu4YzuQZbgJ5I0xB jiMMA7fHtAN+NJVsNoE1GiAm2nnXf9QHnphyCv/SGBKw4xtBLuQ8/KVcV8Z/hk+fq+ M1lrWRFpM7cSmBAv1n52S6cMM18qIokQUNhc1Ees= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728933AbgAMIkj (ORCPT ); Mon, 13 Jan 2020 03:40:39 -0500 Received: from mail.kernel.org ([198.145.29.99]:43482 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727231AbgAMIki (ORCPT ); Mon, 13 Jan 2020 03:40:38 -0500 Received: from localhost.localdomain (unknown [106.200.247.255]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id A4C5D207E0; Mon, 13 Jan 2020 08:40:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1578904837; bh=1qv/uiqU+lvGy4vNbaTZDSE+L9LCBmyo2jSjlXzCaFY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=LE2FTxi8KP8KWNCs7FOLql20SYThhwNY5bp18tlM/U2vFrjt3J882AzBQsZdewcQK GF7hDywxp2IdeiIK8yO1BgSwVCSJ8FV7uyFGkurQ52xbxrdZsY1h9ac5BEYfXAhSV/ N3XywRwbmQ64mcf2vuAXcRfJ9viEPIEI8zd1GYNY= From: Vinod Koul To: Mathias Nyman , Greg Kroah-Hartman Cc: linux-arm-msm@vger.kernel.org, Bjorn Andersson , Vinod Koul , Yoshihiro Shimoda , Christian Lamparter , linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v6 4/5] usb: renesas-xhci: allow multiple firmware versions Date: Mon, 13 Jan 2020 14:10:04 +0530 Message-Id: <20200113084005.849071-5-vkoul@kernel.org> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200113084005.849071-1-vkoul@kernel.org> References: <20200113084005.849071-1-vkoul@kernel.org> MIME-Version: 1.0 Sender: linux-arm-msm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org Allow multiple firmware file versions in table and load them in increasing order as we find them in the file system. Signed-off-by: Vinod Koul Cc: Yoshihiro Shimoda Cc: Christian Lamparter --- drivers/usb/host/xhci-pci-renesas.c | 45 +++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/drivers/usb/host/xhci-pci-renesas.c b/drivers/usb/host/xhci-pci-renesas.c index 1d073c5637c4..fe95487ca888 100644 --- a/drivers/usb/host/xhci-pci-renesas.c +++ b/drivers/usb/host/xhci-pci-renesas.c @@ -73,13 +73,20 @@ static const struct renesas_fw_entry { * - 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. + * + * Entry expected_version should be kept in decreasing order for a + * chip, so that driver will pick latest version and if that fails + * then next one will be picked */ { "K2013080.mem", 0x0014, 0x02, 0x2013 }, + { "K2026090.mem", 0x0014, 0x03, 0x2026 }, { "K2013080.mem", 0x0014, 0x03, 0x2013 }, + { "K2026090.mem", 0x0015, 0x02, 0x2026 }, { "K2013080.mem", 0x0015, 0x02, 0x2013 }, }; MODULE_FIRMWARE("K2013080.mem"); +MODULE_FIRMWARE("K2026090.mem"); static const struct renesas_fw_entry *renesas_needs_fw_dl(struct pci_dev *dev) { @@ -100,6 +107,24 @@ static const struct renesas_fw_entry *renesas_needs_fw_dl(struct pci_dev *dev) return NULL; } +static const struct +renesas_fw_entry *renesas_get_next_entry(struct pci_dev *dev, + const struct renesas_fw_entry *entry) +{ + const struct renesas_fw_entry *next_entry; + size_t i; + + for (i = 0; i < ARRAY_SIZE(renesas_fw_table); i++) { + next_entry = &renesas_fw_table[i]; + if (next_entry->device == dev->device && + next_entry->revision == dev->revision && + next_entry->expected_version < entry->expected_version) + return next_entry; + } + + return NULL; +} + static int renesas_fw_download_image(struct pci_dev *dev, const u32 *fw, size_t step) @@ -700,13 +725,29 @@ static void renesas_fw_callback(const struct firmware *fw, struct renesas_fw_ctx *ctx = context; struct pci_dev *pdev = ctx->pdev; struct device *parent = pdev->dev.parent; + const struct renesas_fw_entry *next_entry; bool rom; int err; if (!fw) { dev_err(&pdev->dev, "firmware failed to load\n"); - - goto cleanup; + /* + * we didn't find firmware, check if we have another + * entry for this device + */ + next_entry = renesas_get_next_entry(ctx->pdev, ctx->entry); + if (next_entry) { + ctx->entry = next_entry; + dev_dbg(&pdev->dev, "Found next entry, requesting: %s\n", + next_entry->firmware_name); + request_firmware_nowait(THIS_MODULE, 1, + next_entry->firmware_name, + &pdev->dev, GFP_KERNEL, + ctx, renesas_fw_callback); + return; + } else { + goto cleanup; + } } err = renesas_fw_verify(pdev, fw->data, fw->size);