Commit fa14fa71f7d432ae564edac55f24f50b371a14df

Authored by Igor Opaniuk
Committed by Bin Meng
1 parent 3f59fa0761

doc: board: verdin-imx8mm: convert readme to reST

Convert README to reStructuredText format.

Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
Reviewed-by: Oleksandr Suvorov <oleksandr.suvorov@toradex.com>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Tested-by: Bin Meng <bmeng.cn@gmail.com>
[bmeng: spell out U-Boot correctly]
Signed-off-by: Bin Meng <bmeng.cn@gmail.com>

Showing 3 changed files with 113 additions and 88 deletions Side-by-side Diff

board/toradex/verdin-imx8mm/README
1   -U-Boot for the Toradex Verdin iMX8M Mini Module
2   -
3   -Quick Start
4   -===========
5   -
6   -- Build the ARM trusted firmware binary
7   -- Get the DDR firmware
8   -- Build U-Boot
9   -- Flash to eMMC
10   -- Boot
11   -
12   -Get and Build the ARM Trusted Firmware (Trusted Firmware A)
13   -===========================================================
14   -
15   -$ echo "Downloading and building TF-A..."
16   -$ git clone -b imx_4.14.98_2.3.0 https://source.codeaurora.org/external/imx/imx-atf
17   -$ cd imx-atf
18   -
19   -Please edit `plat/imx/imx8mm/include/platform_def.h` so it contains proper
20   -values for UART configuration and BL31 base address (correct values listed
21   -below):
22   -#define BL31_BASE 0x910000
23   -#define IMX_BOOT_UART_BASE 0x30860000
24   -#define DEBUG_CONSOLE 1
25   -
26   -Then build ATF (TF-A):
27   -$ make PLAT=imx8mm bl31
28   -
29   -Get the DDR Firmware
30   -====================
31   -
32   -$ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.4.1.bin
33   -$ chmod +x firmware-imx-8.4.1.bin
34   -$ ./firmware-imx-8.4.1.bin
35   -$ cp firmware-imx-8.4.1/firmware/ddr/synopsys/lpddr4*.bin ./
36   -
37   -Build U-Boot
38   -============
39   -
40   -$ export CROSS_COMPILE=aarch64-linux-gnu-
41   -$ make verdin-imx8mm_defconfig
42   -$ make flash.bin
43   -
44   -Flash to eMMC
45   -=============
46   -
47   -> tftpboot ${loadaddr} flash.bin
48   -> setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
49   -> mmc dev 0 1 && mmc write ${loadaddr} 0x2 ${blkcnt}
50   -
51   -As a convenience, instead of the last two commands one may also use the update
52   -U-Boot wrapper:
53   -> run update_uboot
54   -
55   -Boot
56   -====
57   -
58   -ATF, U-boot proper and u-boot.dtb images are packed into FIT image,
59   -which is loaded and parsed by SPL.
60   -
61   -Boot sequence is:
62   -SPL ---> ATF (TF-A) ---> U-boot proper
63   -
64   -Output:
65   -U-Boot SPL 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
66   -Normal Boot
67   -Trying to boot from MMC1
68   -NOTICE: Configuring TZASC380
69   -NOTICE: RDC off
70   -NOTICE: BL31: v2.0(release):rel_imx_4.14.98_2.3.0-0-g09c5cc994-dirty
71   -NOTICE: BL31: Built : 01:11:41, Jan 25 2020
72   -NOTICE: sip svc init
73   -
74   -
75   -U-Boot 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
76   -
77   -CPU: Freescale i.MX8MMQ rev1.0 at 0 MHz
78   -Reset cause: POR
79   -DRAM: 2 GiB
80   -MMC: FSL_SDHC: 0, FSL_SDHC: 1, FSL_SDHC: 2
81   -Loading Environment from MMC... OK
82   -In: serial
83   -Out: serial
84   -Err: serial
85   -Model: Toradex Verdin iMX8M Mini Quad 2GB Wi-Fi / BT IT V1.0A, Serial# 06535149
86   -Net: eth0: ethernet@30be0000
87   -Hit any key to stop autoboot: 0
88   -Verdin iMX8MM #
doc/board/toradex/index.rst
... ... @@ -7,4 +7,5 @@
7 7 :maxdepth: 2
8 8  
9 9 colibri_imx7
  10 + verdin-imx8mm
doc/board/toradex/verdin-imx8mm.rst
  1 +.. SPDX-License-Identifier: GPL-2.0+
  2 +
  3 +Verdin iMX8M Mini Module
  4 +========================
  5 +
  6 +Quick Start
  7 +-----------
  8 +
  9 +- Build the ARM trusted firmware binary
  10 +- Get the DDR firmware
  11 +- Build U-Boot
  12 +- Flash to eMMC
  13 +- Boot
  14 +
  15 +Get and Build the ARM Trusted Firmware (Trusted Firmware A)
  16 +-----------------------------------------------------------
  17 +
  18 +.. code-block:: bash
  19 +
  20 + $ echo "Downloading and building TF-A..."
  21 + $ git clone -b imx_4.14.98_2.3.0 \
  22 + https://source.codeaurora.org/external/imx/imx-atf
  23 + $ cd imx-atf
  24 +
  25 +Please edit ``plat/imx/imx8mm/include/platform_def.h`` so it contains proper
  26 +values for UART configuration and BL31 base address (correct values listed
  27 +below):
  28 +
  29 +.. code-block:: bash
  30 +
  31 + #define BL31_BASE 0x910000
  32 + #define IMX_BOOT_UART_BASE 0x30860000
  33 + #define DEBUG_CONSOLE 1
  34 +
  35 +Then build ATF (TF-A):
  36 +
  37 +.. code-block:: bash
  38 +
  39 + $ make PLAT=imx8mm bl31
  40 +
  41 +Get the DDR Firmware
  42 +--------------------
  43 +
  44 +.. code-block:: bash
  45 +
  46 + $ wget https://www.nxp.com/lgfiles/NMG/MAD/YOCTO/firmware-imx-8.4.1.bin
  47 + $ chmod +x firmware-imx-8.4.1.bin
  48 + $ ./firmware-imx-8.4.1.bin
  49 + $ cp firmware-imx-8.4.1/firmware/ddr/synopsys/lpddr4*.bin ./
  50 +
  51 +Build U-Boot
  52 +------------
  53 +.. code-block:: bash
  54 +
  55 + $ export CROSS_COMPILE=aarch64-linux-gnu-
  56 + $ make verdin-imx8mm_defconfig
  57 + $ make flash.bin
  58 +
  59 +Flash to eMMC
  60 +-------------
  61 +
  62 +.. code-block:: bash
  63 +
  64 + > tftpboot ${loadaddr} flash.bin
  65 + > setexpr blkcnt ${filesize} + 0x1ff && setexpr blkcnt ${blkcnt} / 0x200
  66 + > mmc dev 0 1 && mmc write ${loadaddr} 0x2 ${blkcnt}
  67 +
  68 +As a convenience, instead of the last two commands one may also use the update
  69 +U-Boot wrapper:
  70 +
  71 +.. code-block:: bash
  72 +
  73 + > run update_uboot
  74 +
  75 +Boot
  76 +----
  77 +
  78 +ATF, U-Boot proper and u-boot.dtb images are packed into FIT image,
  79 +which is loaded and parsed by SPL.
  80 +
  81 +Boot sequence is:
  82 +
  83 +* SPL ---> ATF (TF-A) ---> U-Boot proper
  84 +
  85 +Output:
  86 +
  87 +.. code-block:: bash
  88 +
  89 + U-Boot SPL 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
  90 + Normal Boot
  91 + Trying to boot from MMC1
  92 + NOTICE: Configuring TZASC380
  93 + NOTICE: RDC off
  94 + NOTICE: BL31: v2.0(release):rel_imx_4.14.98_2.3.0-0-g09c5cc994-dirty
  95 + NOTICE: BL31: Built : 01:11:41, Jan 25 2020
  96 + NOTICE: sip svc init
  97 +
  98 +
  99 + U-Boot 2020.01-00187-gd411d164e5 (Jan 26 2020 - 04:47:26 +0100)
  100 +
  101 + CPU: Freescale i.MX8MMQ rev1.0 at 0 MHz
  102 + Reset cause: POR
  103 + DRAM: 2 GiB
  104 + MMC: FSL_SDHC: 0, FSL_SDHC: 1, FSL_SDHC: 2
  105 + Loading Environment from MMC... OK
  106 + In: serial
  107 + Out: serial
  108 + Err: serial
  109 + Model: Toradex Verdin iMX8M Mini Quad 2GB Wi-Fi / BT IT V1.0A, Serial:
  110 + Net: eth0: ethernet@30be0000
  111 + Hit any key to stop autoboot: 0
  112 + Verdin iMX8MM #