Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires specific firmware downloading. So, add a document about the firmware how to get. Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@xxxxxxxxxxx> --- Changes from v3: https://lore.kernel.org/linux-pci/20241024120525.291885-1-yoshihiro.shimoda.uh@xxxxxxxxxxx/ - Rebase on v6.15-rc1. - Revise some descriptions (reviewed from Manivannan Sadhasivam). - Add the doc file entry into the MAINTAINER. Changes from v2: https://lore.kernel.org/linux-pci/20240703102937.1403905-1-yoshihiro.shimoda.uh@xxxxxxxxxxx/ - Rebase on v6.12-rc1. - Move the document file on Documentation/PCI/. - Add SPDX-License-Identifier. Documentation/PCI/rcar-pcie-firmware.rst | 24 ++++++++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 25 insertions(+) create mode 100644 Documentation/PCI/rcar-pcie-firmware.rst diff --git a/Documentation/PCI/rcar-pcie-firmware.rst b/Documentation/PCI/rcar-pcie-firmware.rst new file mode 100644 index 0000000000000..0e285c4a7cd72 --- /dev/null +++ b/Documentation/PCI/rcar-pcie-firmware.rst @@ -0,0 +1,24 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================================================= +Firmware of PCIe controller for Renesas R-Car V4H +================================================= + +Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires specific +firmware downloading. The firmware file "104_PCIe_fw_addr_data_ver1.05.txt" +is available in the datasheet as a text file. But, Renesas is not able to +distribute the firmware freely. So, it is required to convert the text file +to a binary, and the binary should be placed in /lib/firmware before +the driver runs by using the following script: + +.. code-block:: sh + + $ awk '/^\s*0x[0-9A-Fa-f]{4}\s+0x[0-9A-Fa-f]{4}/ \ + { print substr($2,5,2) substr($2,3,2) }' \ + 104_PCIe_fw_addr_data_ver1.05.txt | xxd -p -r > \ + rcar_gen4_pcie.bin + + $ sha1sum rcar_gen4_pcie.bin + + # Example output of the sha1sum: + 1d0bd4b189b4eb009f5d564b1f93a79112994945 rcar_gen4_pcie.bin diff --git a/MAINTAINERS b/MAINTAINERS index 1ccb83716bf28..9ad5c565595d5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -18531,6 +18531,7 @@ M: Yoshihiro Shimoda <yoshihiro.shimoda.uh@xxxxxxxxxxx> L: linux-pci@xxxxxxxxxxxxxxx L: linux-renesas-soc@xxxxxxxxxxxxxxx S: Maintained +F: Documentation/PCI/rcar-pcie-firmware.rst F: Documentation/devicetree/bindings/pci/*rcar* F: drivers/pci/controller/*rcar* F: drivers/pci/controller/dwc/*rcar* -- 2.25.1
