1.. SPDX-License-Identifier: GPL-2.0
2
3=================================================
4Firmware of PCIe controller for Renesas R-Car V4H
5=================================================
6
7Renesas R-Car V4H (r8a779g0) has a PCIe controller, requiring a specific
8firmware download during startup.
9
10However, Renesas currently cannot distribute the firmware free of charge.
11
12The firmware file "104_PCIe_fw_addr_data_ver1.05.txt" (note that the file name
13might be different between different datasheet revisions) can be found in the
14datasheet encoded as text, and as such, the file's content must be converted
15back to binary form. This can be achieved using the following example script:
16
17.. code-block:: sh
18
19	$ awk '/^\s*0x[0-9A-Fa-f]{4}\s+0x[0-9A-Fa-f]{4}/ { print substr($2,5,2) substr($2,3,2) }' \
20		104_PCIe_fw_addr_data_ver1.05.txt | \
21			xxd -p -r > rcar_gen4_pcie.bin
22
23Once the text content has been converted into a binary firmware file, verify
24its checksum as follows:
25
26.. code-block:: sh
27
28	$ sha1sum rcar_gen4_pcie.bin
29	1d0bd4b189b4eb009f5d564b1f93a79112994945  rcar_gen4_pcie.bin
30
31The resulting binary file called "rcar_gen4_pcie.bin" should be placed in the
32"/lib/firmware" directory before the driver runs.
33