[PATCH] PCI: rcar-gen4: Add a document about the firmware

[PATCH] PCI: rcar-gen4: Add a document about the firmware

[Yoshihiro Shimoda]

Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires
specific firmwre downloading. So, add a document about the firmware
how to get.

Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
---
 Krzysztof-san suggests writing a document about this [1]. So, I submit
 this patch.

 [1]
 https://lore.kernel.org/linux-pci/20240701204333.GB412915@rocinante/

 .../admin-guide/rcar-pcie-firmware.rst        | 20 +++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 Documentation/admin-guide/rcar-pcie-firmware.rst

diff --git a/Documentation/admin-guide/rcar-pcie-firmware.rst b/Documentation/admin-guide/rcar-pcie-firmware.rst
new file mode 100644
index 000000000000..75c0d086dcc5
--- /dev/null
+++ b/Documentation/admin-guide/rcar-pcie-firmware.rst
@@ -0,0 +1,20 @@
+Firmware of PCIe controller for Renesas R-Car V4H
+=================================================
+
+Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires specific
+firmwre 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, we require converting the text file to
+a binary 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
-- 
2.25.1

Re: [PATCH] PCI: rcar-gen4: Add a document about the firmware

[Sergei Shtylyov]

On 7/3/24 1:12 PM, Yoshihiro Shimoda wrote:

> Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires
> specific firmwre downloading. So, add a document about the firmware

   Firmware. :-)

> how to get.
> 
> Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
> ---
>  Krzysztof-san suggests writing a document about this [1]. So, I submit
>  this patch.
> 
>  [1]
>  https://lore.kernel.org/linux-pci/20240701204333.GB412915@rocinante/
> 
>  .../admin-guide/rcar-pcie-firmware.rst        | 20 +++++++++++++++++++
>  1 file changed, 20 insertions(+)
>  create mode 100644 Documentation/admin-guide/rcar-pcie-firmware.rst
> 
> diff --git a/Documentation/admin-guide/rcar-pcie-firmware.rst b/Documentation/admin-guide/rcar-pcie-firmware.rst
> new file mode 100644
> index 000000000000..75c0d086dcc5
> --- /dev/null
> +++ b/Documentation/admin-guide/rcar-pcie-firmware.rst
> @@ -0,0 +1,20 @@
> +Firmware of PCIe controller for Renesas R-Car V4H
> +=================================================
> +
> +Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires specific
> +firmwre downloading. The firmware file "104_PCIe_fw_addr_data_ver1.05.txt"

   Again, firmware...

[...]

MBR, Sergey

RE: [PATCH] PCI: rcar-gen4: Add a document about the firmware

[Yoshihiro Shimoda]

Hello Sergei,

> From: Sergei Shtylyov, Sent: Wednesday, July 3, 2024 7:22 PM
> 
> On 7/3/24 1:12 PM, Yoshihiro Shimoda wrote:
> 
> > Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires
> > specific firmwre downloading. So, add a document about the firmware
> 
>    Firmware. :-)
<snip>
> > +Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires specific
> > +firmwre downloading. The firmware file "104_PCIe_fw_addr_data_ver1.05.txt"
> 
>    Again, firmware...

Oops. I'll fix them soon.

Best regards,
Yoshihiro Shimoda

> [...]
> 
> MBR, Sergey

Re: [PATCH] PCI: rcar-gen4: Add a document about the firmware

[Sergey Shtylyov]

On 7/3/24 1:12 PM, Yoshihiro Shimoda wrote:

> Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires
> specific firmwre downloading. So, add a document about the firmware

   Firmware. :-)

> how to get.
> 
> Signed-off-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
> ---
>  Krzysztof-san suggests writing a document about this [1]. So, I submit
>  this patch.
> 
>  [1]
>  https://lore.kernel.org/linux-pci/20240701204333.GB412915@rocinante/
> 
>  .../admin-guide/rcar-pcie-firmware.rst        | 20 +++++++++++++++++++
>  1 file changed, 20 insertions(+)
>  create mode 100644 Documentation/admin-guide/rcar-pcie-firmware.rst
> 
> diff --git a/Documentation/admin-guide/rcar-pcie-firmware.rst b/Documentation/admin-guide/rcar-pcie-firmware.rst
> new file mode 100644
> index 000000000000..75c0d086dcc5
> --- /dev/null
> +++ b/Documentation/admin-guide/rcar-pcie-firmware.rst
> @@ -0,0 +1,20 @@
> +Firmware of PCIe controller for Renesas R-Car V4H
> +=================================================
> +
> +Renesas R-Car V4H (r8a779g0) has PCIe controller, and it requires specific
> +firmwre downloading. The firmware file "104_PCIe_fw_addr_data_ver1.05.txt"

   Again, firmware...

[...]

MBR, Sergey