On Wed, Feb 12, 2020 at 11:14 PM Igor Opaniuk <[email protected]> wrote: > > From: Igor Opaniuk <[email protected]> > > - add initial index for toradex boards reST documentation > - add initial colibri_imx7.rst doc file which provides all needed > information for obtaining a workable image ready for flashing > for both eMMC/NAND versions of Colibri iMX7. > > Reviewed-by: Bin Meng <[email protected]> > Signed-off-by: Igor Opaniuk <[email protected]> > --- > > doc/board/index.rst | 1 + > doc/board/toradex/colibri_imx7.rst | 127 +++++++++++++++++++++++++++++ > doc/board/toradex/index.rst | 9 ++ > 3 files changed, 137 insertions(+) > create mode 100644 doc/board/toradex/colibri_imx7.rst > create mode 100644 doc/board/toradex/index.rst > > diff --git a/doc/board/index.rst b/doc/board/index.rst > index 00e72f57cd..f2f5907b8c 100644 > --- a/doc/board/index.rst > +++ b/doc/board/index.rst > @@ -15,4 +15,5 @@ Board-specific doc > intel/index > renesas/index > sifive/index > + toradex/index > xilinx/index > diff --git a/doc/board/toradex/colibri_imx7.rst > b/doc/board/toradex/colibri_imx7.rst > new file mode 100644 > index 0000000000..0c7ae082d0 > --- /dev/null > +++ b/doc/board/toradex/colibri_imx7.rst > @@ -0,0 +1,127 @@ > +.. SPDX-License-Identifier: GPL-2.0+ > + > +Colibri iMX7 > +============ > + > +Quick Start > +----------- > + > +- Build U-Boot > +- NAND IMX image adjustments before flashing > +- Flashing manually U-Boot to eMMC > +- Flashing manually U-Boot to NAND > +- Using ``update_uboot`` script > + > +Build U-Boot > +------------ > + > +.. code-block:: bash > + > + $ export CROSS_COMPILE=arm-linux-gnueabi- > + $ export ARCH=arm > + $ make colibri_imx7_emmc_defconfig # For NAND: colibri_imx7_defconfig > + $ make > + > +After build succeeds, you will obtain final ``u-boot-dtb.imx`` IMX specific > +image, ready for flashing (but check next section for additional > +adjustments). > + > +Final IMX program image includes (section ``6.6.7`` from `IMX7DRM > +<https://www.nxp.com/webapp/Download?colCode=IMX7DRM>`_): > + > +* **Image vector table** (IVT) for BootROM > +* **Boot data** -indicates the program image location, program image size > + in bytes, and the plugin flag. > +* **Device configuration data** > +* **User image**: U-Boot image (``u-boot-dtb.bin``) > + > + > +IMX image adjustments prior to flashing > +--------------------------------------------
nits: title underline length should match the title > + > +1. U-Boot for both Colibri iMX7 NAND and eMMC versions > +is built with HABv4 support (`AN4581.pdf > +<https://www.nxp.com/docs/en/application-note/AN4581.pdf>`_) > +enabled by default, which requires to generate a proper > +Command Sequence File (CSF) by srktool from NXP (not included in the > +U-Boot tree, check additional details in introduction_habv4.txt) > +and concatenate it to the final ``u-boot-dtb.imx``. > + > +2. In case if you don't want to generate a proper ``CSF`` (for any reason), > +you still need to pad the IMX image so i has the same size as specified in > +in **Boot Data** section of IMX image. > +To obtain this value, run: > + Will fix the nits when applying. Tested the doc build, no warnings Tested-by: Bin Meng <[email protected]>
