diff --git a/source/_static/boards/am62xx-sk-steps-2.png b/source/_static/boards/am62xx-sk-steps-2.png deleted file mode 100644 index 8f34a01bf..000000000 Binary files a/source/_static/boards/am62xx-sk-steps-2.png and /dev/null differ diff --git a/source/_static/boards/am64xx-sk-steps-2.png b/source/_static/boards/am64xx-sk-steps-2.png deleted file mode 100644 index 1d2299e57..000000000 Binary files a/source/_static/boards/am64xx-sk-steps-2.png and /dev/null differ diff --git a/source/_static/boards/apalis-imx6-steps-2.png b/source/_static/boards/apalis-imx6-steps-2.png deleted file mode 100644 index ff1729176..000000000 Binary files a/source/_static/boards/apalis-imx6-steps-2.png and /dev/null differ diff --git a/source/_static/boards/apalis-imx8-steps-2.png b/source/_static/boards/apalis-imx8-steps-2.png deleted file mode 100644 index a4648cd5f..000000000 Binary files a/source/_static/boards/apalis-imx8-steps-2.png and /dev/null differ diff --git a/source/_static/boards/generic-portena-steps-1.png b/source/_static/boards/generic-portena-steps-1.png deleted file mode 100644 index 8e9d39ee3..000000000 Binary files a/source/_static/boards/generic-portena-steps-1.png and /dev/null differ diff --git a/source/_static/boards/generic-steps-1.png b/source/_static/boards/generic-steps-1.png deleted file mode 100644 index 6dd37f07e..000000000 Binary files a/source/_static/boards/generic-steps-1.png and /dev/null differ diff --git a/source/_static/boards/generic-steps-2.png b/source/_static/boards/generic-steps-2.png deleted file mode 100644 index ca66ecca9..000000000 Binary files a/source/_static/boards/generic-steps-2.png and /dev/null differ diff --git a/source/_static/boards/imx6ul-steps-2.png b/source/_static/boards/imx6ul-steps-2.png deleted file mode 100644 index e455fe058..000000000 Binary files a/source/_static/boards/imx6ul-steps-2.png and /dev/null differ diff --git a/source/_static/boards/imx6ull-steps-2.png b/source/_static/boards/imx6ull-steps-2.png deleted file mode 100644 index bd310ede6..000000000 Binary files a/source/_static/boards/imx6ull-steps-2.png and /dev/null differ diff --git a/source/_static/boards/portena-steps-2.png b/source/_static/boards/portena-steps-2.png deleted file mode 100644 index a217d3074..000000000 Binary files a/source/_static/boards/portena-steps-2.png and /dev/null differ diff --git a/source/_static/boards/versal-steps-2.png b/source/_static/boards/versal-steps-2.png deleted file mode 100644 index e0da34c3f..000000000 Binary files a/source/_static/boards/versal-steps-2.png and /dev/null differ diff --git a/source/reference-manual/boards/am62xx-sk-prepare.rst b/source/reference-manual/boards/am62xx-sk-prepare.rst index ce2cf0d57..ccd731716 100644 --- a/source/reference-manual/boards/am62xx-sk-prepare.rst +++ b/source/reference-manual/boards/am62xx-sk-prepare.rst @@ -1,67 +1,49 @@ Building -------- -When building the Cortex R5 u-boot, it builds for all different variants: +When building the Cortex R5 U-Boot, all variants are built: -* ``hs-fs`` (High Security/Field Securable) also known as `SK-AM62B`_: This is a SoC/board state before a customer has blown the keys in the device. i.e. the state at which HS device leaves TI factory. In this state, the device protects the ROM code, TI keys and certain security peripherals. In this state, device do not force authentication for booting, however DMSC is locked. +* ``hs-fs`` (High Security/Field Securable), also known as `SK-AM62B`_: The SoC/board state before blowing the keys on the device, + i.e., the state at which the HS device leaves the TI factory. + The device protects the ROM code, TI keys, and certain security peripherals. + In this state, devices do not force authentication for booting, however DMSC is locked. -* ``hs`` (High Security/Security Enforced) also known as `SK-AM62B`_: This is a SoC/board state after a customer has successfully blown the keys and set “customer keys enable”. In HS-SE device all security features are enabled. All secrets within the device are fully protected and all of the security goals are fully enforced. The device also enforces secure booting. +* ``hs`` (High Security/Security Enforced), also known as `SK-AM62B`_: This is the SoC/board state after successfully blowing the keys and setting “customer keys enable”. + In HS-SE, all security features are enabled. + Secrets within the device are fully protected and all security goals are enforced. + The device enforces secure booting. -* ``gp`` (General Purpose) variant also known as `SK-AM62`_: This is a SoC/board state where there is no device protection and authentication is not enabled for booting the device. +* ``gp`` (General Purpose), also known as `SK-AM62`_: This is a SoC/board state with no device protection and authentication is not enabled for booting the device. -The default variant is the ``hs-fs``. To boot an image on the others variants without pre-flash files manipulations -on the target file-system we need to change the ``SYSFW_SUFFIX`` variable. -The following changes the default to ``gp`` so the image produced boots on that variant: +The default variant is ``hs-fs``. +To boot an image on other variants without pre-flash files manipulations on the target file-system, we need to change the ``SYSFW_SUFFIX`` variable. +The following changes the default to ``gp``, so that the image produced boots that variant: .. code-block:: shell echo 'SYSFW_SUFFIX:am62xx-evm-k3r5 = "gp"' >> meta-subscriber-overrides/conf/machine/include/lmp-factory-custom.inc -Preparation ------------ +.. include:: generic-prepare.rst -Ensure you replace the ```` placeholder below with the name of your -Factory. - -Download necessary files from ``https://app.foundries.io/factories//targets`` - -#. Click the latest Target with the :guilabel:`platform-devel` trigger. - - .. figure:: /_static/boards/generic-steps-1.png - :align: center - :width: 300 - -#. Expand the **run** in the :guilabel:`Runs` section (by clicking on the ``+`` sign) which corresponds - with the name of the board and **download the Factory image for that - machine.** - - | E.g: ``lmp-factory-image-am62xx-evm.wic.gz`` - - .. figure:: /_static/boards/am62xx-sk-steps-2.png - :align: center - :width: 600 -#. Extract the file ``lmp-factory-image-am62xx-evm.wic.gz``:: +#. Extract the file:: gunzip lmp-factory-image-am62xx-evm.wic.gz -#. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board ti-mfgtool-files and **download the tools for that - machine.** - - E.g: ``ti-mfgtool-files-am62xx-evm.tar.gz`` +#. Expand the **run** in the :guilabel:`Runs` section corresponding with the name of the board. + Download ``ti-mfgtool-files-am62xx-evm.tar.gz``. -#. Download and extract the file ``ti-mfgtool-files-am62xx-evm.tar.gz``:: +#. Extract the file:: tar -zxvf ti-mfgtool-files-am62xx-evm.tar.gz -#. Organize all the files like the tree below:: +#. Organize the files as in the tree below:: ├── lmp-factory-image-am62xx-evm.wic └── ti-mfgtool-files-am62xx-evm -    ├── flash.sh -    ├── tiboot3.bin -    ├── tispl.bin -    └── uboot.img + ├── flash.sh + ├── tiboot3.bin + ├── tispl.bin + └── uboot.img .. _SK-AM62B: https://www.ti.com/tool/SK-AM62B diff --git a/source/reference-manual/boards/am62xx-sk.rst b/source/reference-manual/boards/am62xx-sk.rst index 7e68ce9a0..66c5bb4fc 100644 --- a/source/reference-manual/boards/am62xx-sk.rst +++ b/source/reference-manual/boards/am62xx-sk.rst @@ -8,9 +8,9 @@ Texas Instruments AM62x SKEVM Hardware Preparation -------------------- -Set up the board for booting from USB DFU mode: +Set up the board for booting from MMC1-SDCard: -#. Ensure that the power is off (remove cable from J11) +#. Ensure that the power is off (remove cable from **J11**): .. figure:: /_static/boards/am62xx-sk-top.png :width: 600 @@ -18,50 +18,25 @@ Set up the board for booting from USB DFU mode: AM62xx-sk top view -2. Put the am62xx-sk into boot from USB DFU Mode, - changing boot switches to: ``00000000 11001010`` +#. Put the am62xx-sk into boot from SDCard Mode: + +.. figure:: /_static/boards/am62xx-sk-switches.png + :width: 300 + :align: center + + Switch settings + Flashing -------- -#. Power on the board and flash the board using ``flash.sh`` script from - ``ti-mfgtool-files-am62xx-evm`` directory, it copies the - ``lmp-factory-image-am62xx-evm.wic`` image. - The wic image contains the :term:`system image` that the device will boot. - -.. prompt:: bash host:~$, auto - - host:~$ sudo ./ti-mfgtool-files-am62xx-evm/flash.sh --wic lmp-factory-image-am62xx-evm.wic - Load U-Boot via DFU... - ------------------------------------------ - DFU BOOT TIBOOT3: TIFS and R5 - ------------------------------------------ - ------------------------------------------ - DFU BOOT TISPL: TFA/OPTEE/ and A53 SPL - ------------------------------------------ - ------------------------------------------ - DFU BOOT UBOOT: A53 UBOOT - ------------------------------------------ - ------------------------------------------ - Exposing eMMC via USB using UMS - ------------------------------------------ - Detected device: /dev/sda - Confirm flashing lmp-factory-image-am62xx-evm.wic to /dev/sda (y/N) >y - ------------------------------------------ - Flashing /dev/sda via UMS - ------------------------------------------ - 844103680 bytes (844 MB, 805 MiB) copied, 57 s, 14,8 MB/s - 814+1 records in - 814+1 records out - 854511616 bytes (855 MB, 815 MiB) copied, 57,7472 s, 14,8 MB/s - Flashing is finished - -2. Power off the board. - -Configure eMMC UDA Boot ------------------------ - -#. Put the am62xx-sk into boot from eMMC UDA mode, - changing boot switches to: ``00000000 11000010``. - -#. Power on a board. \ No newline at end of file +Flash ``lmp-factory-image-am62xx-evm.wic.gz`` to an SD Card. +This contains the bootable :term:`system image`. + +.. include:: generic-flashing.rst + +.. figure:: /_static/boards/am62xx-sk-bottom.png + :width: 600 + :align: center + + SDCard location diff --git a/source/reference-manual/boards/am64xx-sk-prepare.rst b/source/reference-manual/boards/am64xx-sk-prepare.rst index e75acfca3..406eb134d 100644 --- a/source/reference-manual/boards/am64xx-sk-prepare.rst +++ b/source/reference-manual/boards/am64xx-sk-prepare.rst @@ -1,46 +1,31 @@ Building -------- -When building the Cortex R5 u-boot, it builds for all different variants: +When building the Cortex R5 U-Boot, all variants are built: -* ``hs-fs`` (High Security/Field Securable) also known as `SK-AM64B`_: This is a SoC/board state before a customer has blown the keys in the device. i.e. the state at which HS device leaves TI factory. In this state, the device protects the ROM code, TI keys and certain security peripherals. In this state, device do not force authentication for booting, however DMSC is locked. +* ``hs-fs`` (High Security/Field Securable), also known as `SK-AM64B`_: This is a SoC/board state before a customer has blown the keys in the device, + i.e., the state at which the HS device leaves TI factory. + The device protects the ROM code, TI keys and certain security peripherals. + In this state, devices do not force authentication for booting, however DMSC is locked. -* ``hs`` (High Security/Security Enforced) also known as `SK-AM64B`_: This is a SoC/board state after a customer has successfully blown the keys and set “customer keys enable”. In HS-SE device all security features are enabled. All secrets within the device are fully protected and all of the security goals are fully enforced. The device also enforces secure booting. +* ``hs`` (High Security/Security Enforced), also known as `SK-AM64B`_: This is a SoC/board state after successfully blowning the keys and set “customer keys enable”. + In HS-SE device all security features are enabled. + All secrets within the device are fully protected and all of the security goals are fully enforced. + The device also enforces secure booting. -* ``gp`` (General Purpose) variant also known as `SK-AM64`_: This is a SoC/board state where there is no device protection and authentication is not enabled for booting the device. +* ``gp`` (General Purpose), also known as `SK-AM64`_: This is a SoC/board state with no device protection and authentication is not enabled for booting the device. -The default variant is the ``hs-fs``. To boot an image on the others variants without pre-flash files manipulations -on the target file-system we need to change the ``SYSFW_SUFFIX`` variable. -The following changes the default to ``gp`` so the image produced boots on that variant: +The default variant is ``hs-fs``. +To boot an image on other variants without pre-flash files manipulations on the target file-system, we need to change the ``SYSFW_SUFFIX`` variable. +The following changes the default to ``gp``, so that the image produced boots that variant: .. code-block:: shell echo 'SYSFW_SUFFIX:am64xx-evm-k3r5 = "gp"' >> meta-subscriber-overrides/conf/machine/include/lmp-factory-custom.inc -Preparation ------------ +.. include:: generic-prepare.rst -Ensure you replace the ```` placeholder below with the name of your -Factory. - -Download necessary files from ``https://app.foundries.io/factories//targets`` - -#. Click the latest Target with the :guilabel:`platform-devel` trigger. - - .. figure:: /_static/boards/generic-steps-1.png - :align: center - :width: 300 - -#. Expand the **run** in the :guilabel:`Runs` section (by clicking on the ``+`` sign) which corresponds - with the name of the board and **download the Factory image for that - machine.** - - | E.g: ``lmp-factory-image-am64xx-evm.wic.gz`` - - .. figure:: /_static/boards/am64xx-sk-steps-2.png - :align: center - :width: 600 -#. Extract the file ``lmp-factory-image-am64xx-evm.wic.gz``:: +#. Extract the file:: gunzip lmp-factory-image-am64xx-evm.wic.gz diff --git a/source/reference-manual/boards/am64xx-sk.rst b/source/reference-manual/boards/am64xx-sk.rst index 785c2794c..b027776fc 100644 --- a/source/reference-manual/boards/am64xx-sk.rst +++ b/source/reference-manual/boards/am64xx-sk.rst @@ -8,9 +8,9 @@ Texas Instruments AM64x SKEVM Hardware Preparation -------------------- -Set up the board for booting from MMC1 - SDCard: +Set up the board for booting from MMC1–SDCard: -#. Ensure that the power is off (remove cable from J8) +#. Ensure that the power is off (remove cable from **J8**): .. figure:: /_static/boards/am64xx-sk-top.png :width: 600 @@ -30,9 +30,8 @@ Set up the board for booting from MMC1 - SDCard: Flashing -------- -Now, flash the ``lmp-factory-image-am64xx-evm.wic.gz`` retrieved from the -previous section to an SD Card. This contains the :term:`system image` that the -device will boot. +Flash ``lmp-factory-image-am64xx-evm.wic.gz`` to an SD Card. +This contains the bootable :term:`system image`. .. include:: generic-flashing.rst diff --git a/source/reference-manual/boards/apalis-imx6-prepare.rst b/source/reference-manual/boards/apalis-imx6-prepare.rst index edb9acbf2..6f6cf2ac6 100644 --- a/source/reference-manual/boards/apalis-imx6-prepare.rst +++ b/source/reference-manual/boards/apalis-imx6-prepare.rst @@ -1,46 +1,38 @@ Preparation ----------- -Ensure you replace the ```` placeholder below with the name of your -Factory. +.. important:: + Ensure you replace the ```` placeholder below with the name of your Factory. -#. Download necessary files from ``https://app.foundries.io/factories//targets`` +#. Download necessary files from ``https://app.foundries.io/factories//targets``: - a. Click the latest :guilabel:`Target` with the ``platform-devel`` :guilabel:`Trigger`. + a. Click the latest Target with a ``platform`` trigger. - .. figure:: /_static/boards/generic-steps-1.png - :width: 769 - :align: center + b. Expand **run** in the :guilabel:`Runs` section corresponding with the name of the board. + **Download the Factory image for that machine.** - #. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board and **download the Factory image for that - machine.** + For example:: - | E.g: - | ``lmp-factory-image-.wic.gz`` - | ``u-boot-.itb`` - | ``sit-.bin`` - | ``SPL-`` - - .. figure:: /_static/boards/apalis-imx6-steps-2.png - :width: 769 - :align: center + lmp-factory-image-.wic.gz + u-boot-.itb + sit-.bin + SPL- #. Extract the file ``lmp-factory-image-apalis-imx6.wic.gz``:: gunzip lmp-factory-image-apalis-imx6.wic.gz -#. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board mfgtool-files and **download the tools for that - machine.** +#. Expand the **run** in the :guilabel:`Runs` section which corresponds with the board's mfgtool-files. + **Download the tools for that machine.** + - E.g: ``mfgtool-files-.tar.gz`` +#. Extract ``mfgtool-files-apalis-imx6.tar.gz``: -#. Download and extract the file ``mfgtool-files-apalis-imx6.tar.gz``:: + .. prompt:: - tar -zxvf mfgtool-files-apalis-imx6.tar.gz + tar -zxvf mfgtool-files-apalis-imx6.tar.gz -#. Organize all the files like the tree below:: +#. Organize the files as in the tree below:: ├── lmp-factory-image-.wic.gz ├── u-boot-.itb diff --git a/source/reference-manual/boards/apalis-imx6.rst b/source/reference-manual/boards/apalis-imx6.rst index cc40ca889..c7f00b143 100644 --- a/source/reference-manual/boards/apalis-imx6.rst +++ b/source/reference-manual/boards/apalis-imx6.rst @@ -12,8 +12,7 @@ Apalis iMX6 with the Ixora Carrier Board Flashing -------- -Once in serial downloader mode and connected to your PC, the evaluation board -should show up as a Freescale USB device. +Once in serial downloader mode and connected to your PC, the evaluation board should show up as a Freescale USB device. .. note:: Device names and IDs can slightly differ from the steps below. @@ -21,7 +20,6 @@ should show up as a Freescale USB device. .. include:: imx6-flashing.rst -To go back to run mode, disconnect the jumper from the recovery pads (JP4) and -reconnect the JP2 jumper. +To return to run mode, disconnect the jumper from the recovery pads (JP4) and reconnect the JP2 jumper. Power on the board to boot the new image. diff --git a/source/reference-manual/boards/apalis-imx8.rst b/source/reference-manual/boards/apalis-imx8.rst index 751e16300..3bbcb427e 100644 --- a/source/reference-manual/boards/apalis-imx8.rst +++ b/source/reference-manual/boards/apalis-imx8.rst @@ -10,14 +10,12 @@ Apalis iMX8 with the Ixora Carrier Board Flashing -------- -Once in serial downloader mode and connected to your PC, the evaluation board -should show up as a Freescale USB device. +Once in serial downloader mode and connected to your PC, the evaluation board should show up as a Freescale USB device. .. note:: Device names and IDs can slightly differ from the steps below. -.. include:: imx6-flashing.rst +.. include:: imx8-flashing.rst -To go back to run mode, disconnect the jumper from the recovery pads (JP4) and -reconnect the JP2 jumper. +To return to run mode, disconnect the jumper from the recovery pads (**JP4**) and reconnect the **JP2** jumper. Power on the board to boot the new image. diff --git a/source/reference-manual/boards/apalis-ixora-recovery.rst b/source/reference-manual/boards/apalis-ixora-recovery.rst index 213f26f8a..1c93fb720 100644 --- a/source/reference-manual/boards/apalis-ixora-recovery.rst +++ b/source/reference-manual/boards/apalis-ixora-recovery.rst @@ -3,38 +3,38 @@ Hardware Preparation Set up the board for updating using the manufacturing tools: -#. Ensure that the power is off (SW1) +#. Ensure that the power is off (**SW1**) #. Put the apalis-imx into Recovery Mode: - Remove the JP2 jumper from the board + a. Remove the **JP2** jumper from the board + + .. figure:: /_static/boards/apalis-imx-jp2.png + :width: 300 + :align: center - .. figure:: /_static/boards/apalis-imx-jp2.png - :width: 300 - :align: center + JP2 location - JP2 location + b. Connect the Micro-USB cable to the **X9** connector - Connect the Micro-USB cable to the X9 connector + .. figure:: /_static/boards/apalis-imx-usb.png + :width: 300 + :align: center - .. figure:: /_static/boards/apalis-imx-usb.png - :width: 300 - :align: center + USB location - USB location + c. Connect the two bottom pads of **JP4** as in the following images - Connect the two bottom pads of JP4 as in the following images + .. figure:: /_static/boards/apalis-imx-jp4.png + :width: 300 + :align: center - .. figure:: /_static/boards/apalis-imx-jp4.png - :width: 300 - :align: center + Recovery jumper location - Recovery jumper location + .. figure:: /_static/boards/apalis-imx-jp4-close.jpeg + :width: 300 + :align: center - .. figure:: /_static/boards/apalis-imx-jp4-close.jpeg - :width: 300 - :align: center + Recovery jumper setup - Recovery jumper setup - -#. Power on the board by pressing the SW1 button. \ No newline at end of file +#. Power on the board by pressing the **SW1** button. diff --git a/source/reference-manual/boards/beagleboneblack.rst b/source/reference-manual/boards/beagleboneblack.rst index 536df0d6f..782ce5e22 100644 --- a/source/reference-manual/boards/beagleboneblack.rst +++ b/source/reference-manual/boards/beagleboneblack.rst @@ -3,25 +3,24 @@ Beaglebone Black ================ -This tutorial covers both Beaglebone Black and Beaglebone Black Wireless. +.. note:: + This tutorial applies to both the Beaglebone Black and Beaglebone Black Wireless. .. include:: generic-prepare.rst Flashing -------- -Now, flash the ``lmp-factory-image-beaglebone-yocto.wic.gz`` retrieved from the -previous section to an SD Card. This contains the :term:`system image` that the -device will boot. +Flash your Factory image to an SD Card. +This contains the bootable :term:`system image`. -By default Beaglebone Black boots from internal eMMC. There are several ways to -avoid this: +By default, the Beaglebone Black boots from internal eMMC. +To avoid this, you can either: - * Press S2 button before powering on + * Press the **S2** button before powering on. + This causes the boot sequence to start from SPI0, followed by SD card. + If the board is not connected to any SPI boot source, the SD card should be used. - This causes boot sequence to start from SPI0 followed by SD card. If the - board is not connected to any SPI boot source SD card should be used - - * Erase eMMC or disable 'bootable' flag on eMMC boot partition + * Erase the eMMC, or disable the 'bootable' flag on the eMMC boot partition. .. include:: generic-flashing.rst diff --git a/source/reference-manual/boards/boards.rst b/source/reference-manual/boards/boards.rst index efb41326e..97eb0f457 100644 --- a/source/reference-manual/boards/boards.rst +++ b/source/reference-manual/boards/boards.rst @@ -3,7 +3,7 @@ Supported Boards ================ -Find below the instructions on how to flash the supported boards. +Select your board below to view flashing instructions. .. toctree:: :maxdepth: 1 diff --git a/source/reference-manual/boards/generic-flashing.rst b/source/reference-manual/boards/generic-flashing.rst index 27f49b967..e62cd4280 100644 --- a/source/reference-manual/boards/generic-flashing.rst +++ b/source/reference-manual/boards/generic-flashing.rst @@ -2,16 +2,15 @@ .. group-tab:: Linux - 1. Determine the disk you want to flash by finding the device with the - ``SIZE`` that matches your flash drive in the list below. Be sure to ignore - partitions (where ``TYPE`` is ``part``). Save the ``NAME`` for your flash drive to - be used in a later step as the disk path. e.g: ``/dev/mmcblk0``, ``/dev/sdb``:: + 1. Determine which disk to flash by finding the device with the ``SIZE`` that matches that of your flash drive. + Ignore partitions (indicated by ``part`` under ``TYPE``). + Note the ``NAME`` of the flash drive (e.g., ``/dev/mmcblk0``, ``/dev/sdb``), as it will be used for the disk path:: lsblk -po +MODEL .. highlight:: none - **Example Output**:: + :: $ lsblk -po +MODEL NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT MODEL @@ -32,17 +31,15 @@ .. group-tab:: macOS - 1. Determine the disk you want to flash by finding the device with the - ``SIZE`` that matches your flash drive in the list below. Be sure to ignore - partitions (lines without the * in the ``SIZE``). Save the ``IDENTIFIER`` for your - flash drive to be used in a later step as the disk path. e.g: - ``/dev/disk3``:: + 1. Determine which disk you want to flash by finding the device with the ``SIZE`` that matches that of your flash drive. + Ignore partitions (lines without ``*`` in the ``SIZE``). + Note the ``IDENTIFIER`` of the flash drive, (e.g., ``/dev/disk3``) as it will be used for the disk path:: - diskutil list + ``diskutil list``: .. highlight:: none - **Example Output**:: + :: $ diskutil list /dev/disk3 (internal, physical): @@ -62,17 +59,15 @@ .. group-tab:: Windows - Windows has no ``dd`` like tool built into the operating system to flash - your image to disk. In this case, we recommend you download and use either - **Win32 Disk Imager** or **Rufus**. + Windows has no built in tools for flashing the image to disk. + We recommend you download and use either **Win32 Disk Imager** or **Rufus**. .. note:: - Your system image is in a compressed wic.gz format. To follow these next - steps, you must extract it using a tool like 7zip_ which will leave you with a - .wic image file. + Your system image is in a compressed ``wic.gz`` format. + To follow these next steps, you must extract it using a tool like 7zip_ which will leave you with a ``.wic`` image file. - **Using Rufus** + **Using Rufus**: #. Download and run Rufus_. #. Select your disk. @@ -86,9 +81,10 @@ #. Select your ```` #. Select your disk via the :guilabel:`Device` dropdown. #. Click :guilabel:`Write` - #. Wait for the image to finish writing, and a **Write Successful** dialog will appear. + #. Wait for the image to finish writing. + A **Write Successful** dialog will appear. -1. Remove the flash drive from the host and insert/connect it into the board. +1. Remove the flash drive and connect it to the board. 2. Power on the board to boot the new image. diff --git a/source/reference-manual/boards/generic-prepare.rst b/source/reference-manual/boards/generic-prepare.rst index 179c1f629..ff012bf20 100644 --- a/source/reference-manual/boards/generic-prepare.rst +++ b/source/reference-manual/boards/generic-prepare.rst @@ -1,23 +1,13 @@ Preparation ----------- -Ensure you replace the ```` placeholder below with the name of your -Factory. +.. important:: + Ensure you replace ```` with the name of your Factory. -#. Download necessary files from ``https://app.foundries.io/factories//targets`` +#. Download the necessary files from ``https://app.foundries.io/factories//targets``: - a. Click the latest :guilabel:`Target` with the ``platform-devel`` :guilabel:`Trigger`. + a. Click the latest :guilabel:`Target` with the :guilabel:`platform` trigger. - .. figure:: /_static/boards/generic-steps-1.png - :width: 769 - :align: center + b. Expand the **run** in the :guilabel:`Runs` section which corresponds with the name of the board. + **Download the Factory image for that machine**, e.g., ``lmp-factory-image-.wic.gz`` or ``lmp-base-console-image-.wic.gz``. - #. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board and **download the Factory image for that - machine.** - - E.g: ``lmp-factory-image-.wic.gz`` - - .. figure:: /_static/boards/generic-steps-2.png - :width: 769 - :align: center diff --git a/source/reference-manual/boards/imx-common-board.inc b/source/reference-manual/boards/imx-common-board.inc index c901444b2..a9b4a1c87 100644 --- a/source/reference-manual/boards/imx-common-board.inc +++ b/source/reference-manual/boards/imx-common-board.inc @@ -3,34 +3,24 @@ Preparation |secure_boot_preparation_note| -Ensure you replace the ```` placeholder below with the name of your -Factory. +.. important:: + Ensure you replace ```` placeholder below with the name of your Factory. -#. Download necessary files from ``https://app.foundries.io/factories//targets`` +#. Download the necessary files from ``https://app.foundries.io/factories//targets``: - a. Click the latest :guilabel:`Target` with the ``platform-devel`` :guilabel:`Trigger`. + a. Click the latest Target with the :guilabel:`platform` trigger. - .. figure:: /_static/boards/generic-steps-1.png - :width: 769 - :align: center - - #. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board and **download the Factory image for that - machine.** - - | E.g: - | ``lmp-factory-image-.wic.gz`` - | ``u-boot-.itb`` - | ``imx-boot-`` - - .. note:: - The compressed image (``.wic.gz``) is used since LmP **v92**. Before it the scripts - require a compressed file image (``.wic``). - - .. figure:: /_static/boards/generic-steps-2.png - :width: 769 - :align: center + b. Expand the **run** in the :guilabel:`Runs` section which corresponds with the name of the board. + **Download the Factory image for that machine.** + For example:: + + lmp-factory-image-.wic.gz + u-boot-.itb + imx-boot- + .. note:: + The compressed image (``.wic.gz``) is used since LmP **v92**. + Before, the scripts required a compressed file image (``.wic``). #. Download and extract the file ``mfgtool-files-.tar.gz``: @@ -38,7 +28,7 @@ Factory. tar -zxvf mfgtool-files-|machine_name|.tar.gz -#. Organize all the files like the tree below: +#. Organize all the files, mirroring the tree below: |imx_file_list| @@ -51,18 +41,17 @@ Set up the board for updating using the manufacturing tools: Top view of |board_name| -#. **OPTIONAL**—Only required if you have problems or want to see the boot console output. +#. **OPTIONAL**. Only required if you have problems or want to see the boot console output. Connect the |imx_usb_type_debug| end of the USB cable into debug port |debug_port|. - Connect the other end of the cable to a PC acting as a host - terminal. |imx_n_consoles| UART connections will appear on the PC. - On a Linux host for example: + Connect the other end of the cable to a PC acting as a host terminal. + |imx_n_consoles| UART connections will appear on the PC. For example, on a Linux host: |imx_tty_list| Using a serial terminal program like `minicom `_, - connect to the port with |imx_tty_port| in the name (in this example |imx_tty_device|) - and apply the following configuration: + connect to the port with |imx_tty_port| in the name (in this example |imx_tty_device|). + Apply the following configuration: - Baud rate: 115200 - Data bits: 8 @@ -89,8 +78,7 @@ Top view of |board_name| Flashing -------- -Once in serial downloader mode and connected to your PC the evaluation board -should show up as an NXP® USB device. +Once in serial downloader mode and connected to your PC, the evaluation board should show up as an NXP® USB device. |secure_boot_pre_flash_note| @@ -102,10 +90,10 @@ should show up as an NXP® USB device. |imx_lsusb| - In this mode you will use the ``uuu`` tools to program the images to the eMMC. The USB - ID may differ if a different SoC is used. + In this mode you will use the ``uuu`` tools to program the images to the eMMC. + The ``USB ID`` may differ if a different SoC is used. - #. Run the command below to program the LmP to the EMMC: + #. To program the LmP to the EMMC run .. parsed-literal:: @@ -117,7 +105,7 @@ should show up as an NXP® USB device. 1:92 6/ 6 [Done ] FB: done - #. Turn off the power. + #. Turn off the power #. Put the board into run mode .. group-tab:: Windows diff --git a/source/reference-manual/boards/imx6-flashing.rst b/source/reference-manual/boards/imx6-flashing.rst index c5a20f2cb..0fdb3fe98 100644 --- a/source/reference-manual/boards/imx6-flashing.rst +++ b/source/reference-manual/boards/imx6-flashing.rst @@ -9,7 +9,7 @@ .. highlight:: none - In this mode you will use the ``uuu`` tools to program the images to the eMMC. + In this mode, you will use the ``uuu`` tools to program the images to the eMMC. #. Run the command below to program the LmP to the EMMC:: diff --git a/source/reference-manual/boards/imx6ul.rst b/source/reference-manual/boards/imx6ul.rst index df796a4f7..2bcc2fc44 100644 --- a/source/reference-manual/boards/imx6ul.rst +++ b/source/reference-manual/boards/imx6ul.rst @@ -59,15 +59,16 @@ i.MX 6UL Evaluation Kit └── uuu.exe .. |secure_boot_preparation_note| replace:: The instructions in this section - show the preparation before the flashing procedure. + show the preparation needed before the flashing procedure. -.. |secure_boot_pre_flash_note| replace:: Follow the instructios below. +.. |secure_boot_pre_flash_note| replace:: Follow the instructions below. -Pre-preparation + +Pre-Preparation --------------- -Before starting to work with |board_name| make sure to switch **SW601** to device -microSD by setting to OFF, OFF, ON, OFF (from 1-4 bit) +Before starting to work with |board_name|, +switch **SW601** to device microSD by setting to OFF, OFF, ON, OFF (from 1–4 bit) .. figure:: /_static/boards/imx6_sw601.png :width: 300 @@ -75,4 +76,4 @@ microSD by setting to OFF, OFF, ON, OFF (from 1-4 bit) **SW601** settings -.. include:: imx-common-board.inc \ No newline at end of file +.. include:: imx-common-board.inc diff --git a/source/reference-manual/boards/imx6ull.rst b/source/reference-manual/boards/imx6ull.rst index 70543f5e1..635fb6bfb 100644 --- a/source/reference-manual/boards/imx6ull.rst +++ b/source/reference-manual/boards/imx6ull.rst @@ -58,20 +58,19 @@ i.MX 6ULL Evaluation Kit └── uuu.exe .. |secure_boot_preparation_note| replace:: - The instructions in this section also applies to those boards with secure - boot enabled. There are references on how to perform common instructions - along with the flow. The :ref:`ref-security` Reference Manual details the - required background for secure boot. + The instructions in this section also applies to those boards with secure boot enabled. + There are references on how to perform common instructions along with the flow. + :ref:`ref-security` details the required background for secure boot. .. |secure_boot_pre_flash_note| replace:: For instructions on how to sign the required images before flashing them to the board with secure boot enabled, - follow the instructions from :ref:`ref-secure-machines`. + see:ref:`ref-secure-machines`. -Pre-preparation +Pre-Preparation --------------- -Before starting to work with |board_name| make sure to switch **SW601** to device -microSD by setting to OFF, OFF, ON, OFF (from 1-4 bit) +Before starting to work with |board_name|, +switch **SW601** to device microSD by setting to OFF, OFF, ON, OFF (from 1–4 bit) .. figure:: /_static/boards/imx6_sw601.png :width: 300 @@ -79,4 +78,4 @@ microSD by setting to OFF, OFF, ON, OFF (from 1-4 bit) **SW601** settings -.. include:: imx-common-board.inc \ No newline at end of file +.. include:: imx-common-board.inc diff --git a/source/reference-manual/boards/imx8-flashing.rst b/source/reference-manual/boards/imx8-flashing.rst index cd2eebd60..2dd9fb0da 100644 --- a/source/reference-manual/boards/imx8-flashing.rst +++ b/source/reference-manual/boards/imx8-flashing.rst @@ -9,10 +9,10 @@ .. highlight:: none - In this mode you will use the ``uuu`` tools to program the images to the eMMC. The USB - ID may differ if a different SoC is used. + In this mode, you will use the ``uuu`` tools to program the images to the eMMC. + The ``USB ID`` may differ if a different SoC is used. - #. Run the command below to program the LmP to the EMMC:: + #. To program the LmP to the EMMC, run:: $ sudo mfgtool-files-/uuu -pp 1 mfgtool-files-/full_image.uuu uuu (Universal Update Utility) for nxp imx chips -- libuuu_1.4.43-0-ga9c099a @@ -23,21 +23,21 @@ 1:31 3/ 3 [=================100%=================] SDPV: jump 2:31 8/ 8 [Done ] FB: done - #. Turn off the power. - #. Put the board into run mode + #. Turn off the power + #. Put the board into run mode. .. group-tab:: Windows #. Start the ``Device Manager`` #. Select ``View`` #. Select ``Devices by container`` - #. Verify a device like the following: + #. Verify a device as in the following: .. figure:: /_static/boards/windows_verify.png :width: 600 :align: center - #. Run the command below to program the LmP to the EMMC:: + #. To program the LmP to the EMMC, run:: C:\Users\Someone> mfgtool-files-\uuu.exe -pp 1 mfgtool-files-\full_image.uuu uuu (Universal Update Utility) for nxp imx chips -- libuuu_1.4.43-0-ga9c099a @@ -48,5 +48,5 @@ 1:31 3/ 3 [=================100%=================] SDPV: jump 2:31 8/ 8 [Done ] FB: done - #. Turn off the power. - #. Put the board into run mode + #. Turn off the power + #. Put the board into run mode. diff --git a/source/reference-manual/boards/imx8-prepare.rst b/source/reference-manual/boards/imx8-prepare.rst index 6cf8a0d44..289bd49c2 100644 --- a/source/reference-manual/boards/imx8-prepare.rst +++ b/source/reference-manual/boards/imx8-prepare.rst @@ -1,45 +1,35 @@ Preparation ----------- -Ensure you replace the ```` placeholder below with the name of your -Factory. +.. important:: + Ensure you replace the ```` placeholder below with the name of your Factory. #. Download necessary files from ``https://app.foundries.io/factories//targets`` - a. Click the latest :guilabel:`Target` with the ``platform-devel`` :guilabel:`Trigger`. + a. Click the latest Target with the :guilabel:`platform` trigger. - .. figure:: /_static/boards/generic-steps-1.png - :width: 769 - :align: center + b. Expand the **run** in the :guilabel:`Runs` section which corresponds with the name of the board. + **Download the Factory image for that machine.** + For example:: - #. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board and **download the Factory image for that - machine.** - - | E.g: - | ``lmp-factory-image-.wic.gz`` - | ``u-boot-.itb`` - | ``imx-boot-`` - - .. figure:: /_static/boards/apalis-imx8-steps-2.png - :width: 769 - :align: center + lmp-factory-image-.wic.gz + u-boot-.itb + imx-boot- #. Extract the file ``lmp-factory-image-.wic.gz``:: gunzip lmp-factory-image-.wic.gz -#. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board mfgtool-files and **download the tools for that - machine.** - - E.g: ``mfgtool-files-.tar.gz`` - -#. Download and extract the file ``mfgtool-files-.tar.gz``:: +#. Expand the **run** in the :guilabel:`Runs` section which corresponds with the name of the board. + Download the **mfgtools** for that machine, e.g., ``mfgtool-files-.tar.gz``. - tar -zxvf mfgtool-files-.tar.gz +#. Extract the file + + .. prompt:: auto + + tar -zxvf mfgtool-files-.tar.gz -#. Organize all the files like the tree below:: +#. Organize all the files, mirroring the tree below:: ├── lmp-factory-image-.wic.gz ├── u-boot-.itb diff --git a/source/reference-manual/boards/imx8mm.rst b/source/reference-manual/boards/imx8mm.rst index dc5a76658..d5d762150 100644 --- a/source/reference-manual/boards/imx8mm.rst +++ b/source/reference-manual/boards/imx8mm.rst @@ -59,13 +59,12 @@ i.MX 8M Mini Evaluation Kit └── uuu.exe .. |secure_boot_preparation_note| replace:: - The instructions in this section also apply to those boards with secure - boot enabled. There are references on how to perform common instructions - along with the flow. The :ref:`ref-security` Reference Manual details the - required background for secure boot. + The instructions in this section also apply to those boards with secure boot enabled. + There are references on how to perform common instructions along with the flow. + :ref:`ref-security` details the required background for secure boot. .. |secure_boot_pre_flash_note| replace:: For instructions on how to sign the required images before flashing them to the board with secure boot enabled, - follow the instructions from :ref:`ref-secure-machines`. + see :ref:`ref-secure-machines`. .. include:: imx-common-board.inc diff --git a/source/reference-manual/boards/imx8mn.rst b/source/reference-manual/boards/imx8mn.rst index bed2716e1..4d8d550e6 100644 --- a/source/reference-manual/boards/imx8mn.rst +++ b/source/reference-manual/boards/imx8mn.rst @@ -58,13 +58,13 @@ i.MX 8M Nano Evaluation Kit └── uuu.exe .. |secure_boot_preparation_note| replace:: - The instructions in this section also apply to those boards with secure - boot enabled. There are references on how to perform common instructions - along with the flow. The :ref:`ref-security` Reference Manual details the - required background for secure boot. + The instructions in this section also apply to those boards with secure boot enabled. + There are references on how to perform common instructions along with the flow. + The :ref:`ref-security` section details the required background for secure boot. -.. |secure_boot_pre_flash_note| replace:: For instructions on how to sign the - required images before flashing them to the board with secure boot enabled, - follow the instructions from :ref:`ref-secure-machines`. +.. |secure_boot_pre_flash_note| replace:: + For instructions on how to sign the + required images before flashing them to the board with secure boot enabled, + see :ref:`ref-secure-machines`. .. include:: imx-common-board.inc diff --git a/source/reference-manual/boards/imx8mp.rst b/source/reference-manual/boards/imx8mp.rst index 2b583c55a..e61c2616e 100644 --- a/source/reference-manual/boards/imx8mp.rst +++ b/source/reference-manual/boards/imx8mp.rst @@ -60,13 +60,12 @@ i.MX 8M Plus Evaluation Kit └── uuu.exe .. |secure_boot_preparation_note| replace:: - The instructions in this section also apply to those boards with secure - boot enabled. There are references on how to perform common instructions - along with the flow. The :ref:`ref-security` Reference Manual details the - required background for secure boot. + The instructions in this section also applies to those boards with secure boot enabled. + There are references on how to perform common instructions along with the flow. + :ref:`ref-security` details the required background for secure boot. .. |secure_boot_pre_flash_note| replace:: For instructions on how to sign the required images before flashing them to the board with secure boot enabled, - follow the instructions from :ref:`ref-secure-machines`. + see:ref:`ref-secure-machines` .. include:: imx-common-board.inc diff --git a/source/reference-manual/boards/imx8mq.rst b/source/reference-manual/boards/imx8mq.rst index c4c601a06..7e92f113c 100644 --- a/source/reference-manual/boards/imx8mq.rst +++ b/source/reference-manual/boards/imx8mq.rst @@ -57,13 +57,12 @@ i.MX 8M Quad Evaluation Kit └── uuu.exe .. |secure_boot_preparation_note| replace:: - The instructions in this section also apply to those boards with secure - boot enabled. There are references on how to perform common instructions - along with the flow. The :ref:`ref-security` Reference Manual details the - required background for secure boot. + The instructions in this section also applies to those boards with secure boot enabled. + There are references on how to perform common instructions along with the flow. + :ref:`ref-security` details the required background for secure boot. .. |secure_boot_pre_flash_note| replace:: For instructions on how to sign the required images before flashing them to the board with secure boot enabled, - follow the instructions from :ref:`ref-secure-machines`. + see:ref:`ref-secure-machines` -.. include:: imx-common-board.inc \ No newline at end of file +.. include:: imx-common-board.inc diff --git a/source/reference-manual/boards/imx8qm-mek.rst b/source/reference-manual/boards/imx8qm-mek.rst index 9be14cceb..c23001605 100644 --- a/source/reference-manual/boards/imx8qm-mek.rst +++ b/source/reference-manual/boards/imx8qm-mek.rst @@ -10,14 +10,13 @@ Hardware Preparation Set up the board for updating using the manufacturing tools: -#. Connect the micro-B end of the supplied USB cable into Debug UART port - J18. Connect the other end of the cable to a host computer. +#. Connect the micro-B end of the supplied USB cable into Debug UART port **J18**. + Connect the other end of the cable to a host computer. -#. Connect Type-C into USB Type-C port ``J17``. Connect the other end of - the cable to a host computer. +#. Connect Type-C into USB Type-C port **J17**. + Connect the other end of the cable to a host computer. -#. Use boot switch (``SW2``) to configure to boot from SDP - (``[D1-D6]: 000100``). +#. Use boot switch (**SW2**) to configure to boot from SDP (``[D1-D6]: 000100``). .. figure:: /_static/boards/imx8qm-mek-bootswitches.png :width: 300 @@ -25,17 +24,16 @@ Set up the board for updating using the manufacturing tools: Boot switches -#. Power the board by flipping the switch (``SW1``). +#. Power the board by flipping the switch (**SW1**). Flashing -------- -Once in serial downloader mode and connected to your PC, the evaluation board -should show up as a Freescale USB device. +Once in serial downloader mode and connected to your PC, the evaluation board should show up as a Freescale USB device. .. note:: Device names and IDs can slightly differ from the steps below. .. include:: imx6-flashing.rst -Configure the boot switch (``SW2``) to boot from eMMC (``[D1-D6]: 001000``). +Configure the boot switch (**SW2**) to boot from eMMC (``[D1-D6]: 001000``). Power on the board to boot the new image. diff --git a/source/reference-manual/boards/imx8ulpevk.rst b/source/reference-manual/boards/imx8ulpevk.rst index 5e0adfc0b..35efecbae 100644 --- a/source/reference-manual/boards/imx8ulpevk.rst +++ b/source/reference-manual/boards/imx8ulpevk.rst @@ -61,6 +61,6 @@ i.MX 8 ULP Evaluation Kit .. |secure_boot_preparation_note| replace:: The instructions in this section show the preparation before the flashing procedure. -.. |secure_boot_pre_flash_note| replace:: Follow the instructios below. +.. |secure_boot_pre_flash_note| replace:: Follow the instruction below. -.. include:: imx-common-board.inc \ No newline at end of file +.. include:: imx-common-board.inc diff --git a/source/reference-manual/boards/imx9-flashing.rst b/source/reference-manual/boards/imx9-flashing.rst index 8bc5bb0e1..da7857fc4 100644 --- a/source/reference-manual/boards/imx9-flashing.rst +++ b/source/reference-manual/boards/imx9-flashing.rst @@ -9,10 +9,10 @@ .. highlight:: none - In this mode you will use the ``uuu`` tools to program the images to the eMMC. The USB - ID may differ if a different SoC is used. + In this mode you will use the ``uuu`` tools to program the images to the eMMC. + The ``USB ID`` may differ if a different SoC is used. - #. Run the command below to program the LmP to the EMMC:: + #. To program the LmP to the EMMC, run:: $ sudo mfgtool-files-/uuu mfgtool-files-/full_image.uuu uuu (Universal Update Utility) for nxp imx chips -- libuuu_1.4.243-0-ged48c51 @@ -22,8 +22,8 @@ 1:92 6/ 6 [Done ] FB: done - #. Turn off the power. - #. Put the board into run mode + #. Turn off the power + #. Put the board into run mode. .. group-tab:: Windows @@ -36,7 +36,7 @@ :width: 600 :align: center - #. Run the command below to program the LmP to the EMMC:: + #. To program the LmP to the EMMC, run:: C:\Users\Someone> mfgtool-files-\uuu.exe mfgtool-files-\full_image.uuu uuu (Universal Update Utility) for nxp imx chips -- libuuu_1.4.243-0-ged48c51 @@ -46,5 +46,5 @@ 1:92 6/ 6 [Done ] FB: done - #. Turn off the power. - #. Put the board into run mode + #. Turn off the power + #. Put the board into run mode. diff --git a/source/reference-manual/boards/intel-corei7-external.rst b/source/reference-manual/boards/intel-corei7-external.rst index ee189f4d0..c39a32948 100644 --- a/source/reference-manual/boards/intel-corei7-external.rst +++ b/source/reference-manual/boards/intel-corei7-external.rst @@ -1,20 +1,20 @@ -Intel Core i7 CPU (and later) - Booting from External Flash +Intel Core i7 CPU (and later): Booting From External Flash =========================================================== -This section explains how to boot the :term:`system image` from an external flash like a USB stick or SD Card. +This section explains how to boot the :term:`system image` a USB stick or SD Card. .. include:: generic-prepare.rst Flashing -------- -Now, flash the ``lmp-factory-image-intel-corei7-64.wic.gz`` retrieved from the -previous section to a USB Stick/SD Card. This contains the :term:`system image` that the -device will boot. +Flash ``lmp-factory-image-intel-corei7-64.wic.gz`` to a USB stick/SD Card. +This contains the bootable :term:`system image`. .. include:: generic-flashing.rst -Most Intel devices will boot from USB automatically. If the device doesn't automatically boot from USB, -try holding ``F12`` when your device first boots. This will allow you to select the USB from a system-specific boot menu. +Most Intel devices will boot from USB automatically. +If the device does not, hold ``F12`` when the device boots. +This will allow you to select the USB from a system-specific boot menu. -If ``F12`` doesn't work for you, check your device documentation to find how to bring up the boot menu. \ No newline at end of file +If ``F12`` does not work for you, check your device's documentation for how to bring up the boot menu. diff --git a/source/reference-manual/boards/intel-corei7-installer.rst b/source/reference-manual/boards/intel-corei7-installer.rst index c0ffd2c09..e0102db64 100644 --- a/source/reference-manual/boards/intel-corei7-installer.rst +++ b/source/reference-manual/boards/intel-corei7-installer.rst @@ -1,34 +1,33 @@ .. _ref-rm_board_intel-corei7-64: -Intel Core i7 CPU (and later) - Installing into Internal Flash -============================================================== +Intel Core i7 CPU (and later): Installing to Internal Flash +=========================================================== -To install the :term:`system image` into an internal flash drive, you should enable -the :ref:`ref-linux-wic-installer`. - -With the WIC installer enabled, follow the instructions to flash the installer into a USB stick/SD Card. +To install the :term:`system image` onto an internal flash drive, enable the :ref:`ref-linux-wic-installer`. +Next, follow these instructions to flash the installer onto a USB stick/SD Card. .. include:: generic-prepare.rst Flashing -------- -Now, flash the ``lmp-factory-image-intel-corei7-64.wic.gz`` retrieved from the -previous section to a USB Stick/SD Card. This contains the :term:`system image` installer. +Flash ``lmp-factory-image-intel-corei7-64.wic.gz`` onto a USB Stick/SD Card. +This contains the :term:`system image` installer. .. include:: generic-flashing.rst -Most Intel devices will boot from USB automatically. If the device doesn't automatically boot from USB, -try holding ``F12`` when your device first boots. This will allow you to select the device from a system-specific boot menu. +Most Intel devices will boot from USB automatically. +If the device does not, hold **F12** when the device boots. +This will allow you to select the USB from a system-specific boot menu. -If ``F12`` doesn't work for you, check your device documentation to find how to bring up the boot menu. +If **F12** does not work for you, check your device's documentation for how to bring up the boot menu. -Booting installer ------------------ +Booting the Installer +--------------------- .. warning:: - The following steps will delete all your programs, documents, photos, music, and any other files on the selected device. + The following steps will delete anything already on the selected device. After boot, wait until the message: @@ -40,15 +39,8 @@ After boot, wait until the message: Type the name of the device you want to install the :term:`system image`. In the example above, the device used was ``sda``. -Right after select the device, the prompt will ask if you want to proceed: - -.. prompt:: - - Proceed anyway? (y,N) - -Type ``y`` if you want to continue the installation. - -When the installation completes, the following message will be displayed: +After selecting the device, you will be asked if you want to proceed. +Type `y` to continue the installation. .. prompt:: diff --git a/source/reference-manual/boards/jetson-agx-orin-devkit.rst b/source/reference-manual/boards/jetson-agx-orin-devkit.rst index 1bfc38dc9..581e49bec 100644 --- a/source/reference-manual/boards/jetson-agx-orin-devkit.rst +++ b/source/reference-manual/boards/jetson-agx-orin-devkit.rst @@ -3,34 +3,28 @@ Jetson AGX Orin Developer Kit ============================= -This page shows how to flash a Jetson AGX Orin Developer Kit with LmP artifacts. +This page covers flashing a Jetson AGX Orin Developer Kit with LmP artifacts. Preparation ----------- -1. On your factory, click on the latest ``platform-devel`` build: +1. In your Factory, click on the latest ``platform`` build. - .. figure:: /_static/boards/generic-steps-1.png - :width: 769 - :align: center - -2. Expand the run for ``jetson-agx-orin-devkit`` and look for the **lmp-factory-image-jetson-agx-orin-devkit.tegraflash.tar.gz** -artifact: +2. Expand the run for ``jetson-agx-orin-devkit``. + Find ``lmp-factory-image-jetson-agx-orin-devkit.tegraflash.tar.gz`` and download the file. - .. figure:: /_static/boards/jetson-agx-orin-devkit_artifacts.png +3. Unzip the file: -3. Unzip the downloaded file: - - .. prompt:: bash host:~$, auto + .. prompt:: bash host:~$, auto - host:~$ tar -xvf lmp-factory-image-jetson-agx-orin-devkit.tegraflash.tar.gz + host:~$ tar -xvf lmp-factory-image-jetson-agx-orin-devkit.tegraflash.tar.gz -The script used for flashing is **doflash.sh**. +The script used for flashing is ``doflash.sh``. Hardware Preparation -------------------- -Set up the board to boot into recovery mode: +Set the board to boot into recovery mode: .. figure:: /_static/boards/jetson-agx-orin-devkit.png :width: 600 @@ -38,18 +32,20 @@ Set up the board to boot into recovery mode: jetson-agx-orin-devkit -1. Connect the USB cable in the base board Type-C connector (10) to the host machine. +1. Connect the USB cable in the base board Type-C connector (**10**) to the host machine. -2. Press and hold down the Force Recovery button, then either press the Reset button (if already powered) or press the Power button, releasing both buttons in the end. +2. While holding down the force recovery button, either press the Reset button (if already powered), or the Power button. + Release both buttons. - To check if the board is in recovery mode ``lsusb`` can be used to check if a device from vendor ``0955`` (NVIDIA) is available:: + To check if the board is in recovery mode, ``lsusb`` can be used. + Check if a device from vendor ``0955`` (NVIDIA) is available:: host:~$ lsusb | grep 0955 Bus 001 Device 014: ID 0955:7023 NVIDIA Corp. APX - This device is only available when the board successfully booted in recovery mode. + This device is only available when the board successfully boots in recovery mode. -3. **OPTIONAL:** For UART output connect a USB cable in the base board USB Micro B connector (9) to the host machine. +3. **OPTIONAL**: For UART output, connect a USB cable from the base board's USB Micro B connector (**9**), to the host machine. Flashing -------- diff --git a/source/reference-manual/boards/jetson-agx-xavier-devkit.rst b/source/reference-manual/boards/jetson-agx-xavier-devkit.rst index aca2444cf..eb0955811 100644 --- a/source/reference-manual/boards/jetson-agx-xavier-devkit.rst +++ b/source/reference-manual/boards/jetson-agx-xavier-devkit.rst @@ -3,34 +3,28 @@ Jetson AGX Xavier Developer Kit =============================== -This page shows how to flash a Jetson AGX Xavier Developer Kit with LmP artifacts. +This page covers flashing a Jetson AGX Xavier Developer Kit with LmP artifacts. Preparation ----------- -1. On your factory, click on the latest ``platform-devel`` build: +1. In your Factory, click on the latest ``platform`` build. - .. figure:: /_static/boards/generic-steps-1.png - :width: 769 - :align: center - -2. Expand the run for ``jetson-agx-xavier-devkit`` and look for the **lmp-factory-image-jetson-agx-xavier-devkit.tegraflash.tar.gz** -artifact: - - .. figure:: /_static/boards/jetson-agx-xavier-devkit_artifacts.png +2. Expand the run for ``jetson-agx-xavier-devkit``. + Find and download ``lmp-factory-image-jetson-agx-xavier-devkit.tegraflash.tar.gz``. 3. Unzip the downloaded file: - .. prompt:: bash host:~$, auto + .. prompt:: bash host:~$, auto - host:~$ tar -xvf lmp-factory-image-jetson-agx-xavier-devkit.tegraflash.tar.gz + host:~$ tar -xvf lmp-factory-image-jetson-agx-xavier-devkit.tegraflash.tar.gz -The script used for flashing is **doflash.sh**. +The script used for flashing is ``doflash.sh``. Hardware Preparation -------------------- -Set up the board to boot into recovery mode: +Set the board to boot into recovery mode: .. figure:: /_static/boards/jetson-agx-xavier-devkit.png :width: 600 @@ -38,28 +32,31 @@ Set up the board to boot into recovery mode: jetson-agx-xavier-devkit -1. Connect the USB cable in the base board Type-C connector (J512) to the host machine. +1. Connect the USB cable in the base board Type-C connector (**J512**) to the host machine. -2. Press and hold down the Force Recovery button, then either press the Reset button (if already powered) or press the Power button, releasing both buttons in the end. +2. While holding down the force recovery button, either press the Reset button (if already powered), or the Power button, + Releasing both buttons. - To check if the board is in recovery mode ``lsusb`` can be used to check if a device from vendor ``0955`` (NVIDIA) is available:: + To check if the board is in recovery mode, ``lsusb`` can be used. + Check if a device from vendor ``0955`` (NVIDIA) is available:: host:~$ lsusb | grep 0955 Bus 001 Device 013: ID 0955:7019 NVIDIA Corp. APX - This device is only available when the board successfully booted in recovery mode. + This device is only available when the board successfully boots in recovery mode. -3. **OPTIONAL:** For UART output connect a USB cable in the base board USB Micro B connector (J501) to the host machine. +3. **OPTIONAL**: For UART output, connect a USB cable in the base board USB Micro B connector (**J501**) to the host machine. Flashing -------- 1. With the board powered in recovery mode, flash the board: + + .. prompt:: bash host:~$, auto + + host:~$ sudo ./doflash.sh - .. prompt:: bash host:~$, auto - - host:~$ sudo ./doflash.sh - - This can take a few minutes to complete. The process can be watched from the host console or UART output. + This can take a few minutes to complete. + The process can be watched from the host console or UART output. 2. Once the flashing procedure finishes, reset the board to boot the installed LmP image. diff --git a/source/reference-manual/boards/kv260.rst b/source/reference-manual/boards/kv260.rst index 8c12f4722..505ff0753 100644 --- a/source/reference-manual/boards/kv260.rst +++ b/source/reference-manual/boards/kv260.rst @@ -12,7 +12,7 @@ Hardware Preparation #. Ensure that the power code is disconnected. -#. Connect the Micro-USB cable to the ``J4`` connector for serial console +#. Connect the Micro-USB cable to the **J4** connector for serial console output. @@ -36,12 +36,10 @@ The SoM Starter Kits use a two stage boot process: - The secondary boot device is an SD card containing the Linux kernel and system root. -The Xilinx Starter Kit carrier card hardware design sets and factory-locks -the MPSoC boot mode to QSPI32. The SoM boots up to U-Boot using the QSPI -contents and U-Boot then does a hand-off to the secondary boot device. -To replace the boot image on QSPI device with LmP boot images, they have to be -manually flashed to QSPI using pre-installed U-Boot bootloader shell, which -will be automatically booted on the first boot: +The Xilinx Starter Kit carrier card hardware design sets and factory-locks the MPSoC boot mode to QSPI32. +The SoM boots to U-Boot using the QSPI contents, and U-Boot then does a hand-off to the secondary boot device. +To replace the boot image on a QSPI device with LmP boot images, manually flash to QSPI using the pre-installed U-Boot bootloader shell. +The shell is automatically booted on first boot: :: > sf probe; setenv bootseq 1; mmc dev ${bootseq}; @@ -56,7 +54,7 @@ will be automatically booted on the first boot: > sf erase 0x2220000 0x20000 > reset -After reboot, LmP U-Boot serial output is shown: +After rebooting, the LmP U-Boot serial output is shown: :: @@ -80,16 +78,13 @@ After reboot, LmP U-Boot serial output is shown: Recovery -------- -If boot images are eventually corrupted, Kria KV260 Vision AI Starter Kit -provides a Image Recovery application. The Image Recovery application is a -baremetal application that uses a web-browser-user interface. It is -invoked when the FW-update (``FWUEN``) button is pressed at power-on, -or automatically, when both image A and image B becomes un-bootable. -It can be used to directly update the A/B images and persistent register -states. +If boot images become corrupted, the Kria KV260 Vision AI Starter Kit provides an Image Recovery application. +The Image Recovery is a baremetal application that uses a web-browser user interface. +It can be invoked when the FW-update (**FWUEN**) button is pressed at power-on. +This can happen automatically, when both A and B images becomes un-bootable. +It can be used to directly update the A/B images, and persistent register states. -Read the `Boot Firmware Image Recovery`_ page for more details on this -application. +Read the `Boot Firmware Image Recovery`_ page for more details on this application. .. |Image of Kria board| image:: kria_kv260.png .. _Boot Firmware Image Recovery: https://xilinx.github.io/kria-apps-docs/bootfw/build/html/docs/bootfw_image_recovery.html diff --git a/source/reference-manual/boards/portenta-x8-prepare.rst b/source/reference-manual/boards/portenta-x8-prepare.rst index af86a0b9e..9ef020549 100644 --- a/source/reference-manual/boards/portenta-x8-prepare.rst +++ b/source/reference-manual/boards/portenta-x8-prepare.rst @@ -1,46 +1,36 @@ Preparation ----------- -Ensure you replace the ```` placeholder below with the name of your -Factory. +.. important:: -#. Download necessary files from ``https://app.foundries.io/factories//targets`` + Ensure you replace ```` With the name of your Factory. - a. Click the latest :guilabel:`Target` with the ``platform-devel`` :guilabel:`Trigger`. +#. Download the necessary files from ``https://app.foundries.io/factories//targets`` - .. figure:: /_static/boards/generic-portena-steps-1.png - :width: 769 - :align: center + a. Click the latest Target with the ``platform`` Trigger. - #. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board and **download the Factory image for that - machine.** + b. Expand the :guilabel:`Runs` section which corresponds with the board. + **Download the Factory image for that machine**:: - | E.g: - | ``lmp-partner-arduino-image-.wic.gz`` - | ``u-boot-.itb`` - | ``sit-.bin`` - | ``imx-boot-`` - - .. figure:: /_static/boards/portena-steps-2.png - :width: 769 - :align: center - -#. Extract the file ``lmp-partner-arduino-image-.wic.gz``:: + lmp-partner-arduino-image-.wic.gz + u-boot-.itb + sit-.bin + imx-boot- +#. Extract ``lmp-partner-arduino-image-.wic.gz``: + + .. prompt:: + gunzip lmp-partner-arduino-image-.wic.gz -#. Expand the **run** in the :guilabel:`Runs` section which corresponds - with the name of the board mfgtool-files and **download the tools for that - machine.** - - E.g: ``mfgtool-files-.tar.gz`` +#. Expand the :guilabel:`Runs` section which corresponds with the board. + **Download the corresponding mfgtool files**, e.g., ``mfgtool-files-.tar.gz``. -#. Download and extract the file ``mfgtool-files-.tar.gz``:: +#. Extract the files:: tar -zxvf mfgtool-files-.tar.gz -#. Organize all the files like the tree below:: +#. Organize the files, mirroring the tree below:: ├── lmp-partner-arduino-image-.wic ├── u-boot-.itb diff --git a/source/reference-manual/boards/portenta-x8.rst b/source/reference-manual/boards/portenta-x8.rst index b3dccc228..650af76e7 100644 --- a/source/reference-manual/boards/portenta-x8.rst +++ b/source/reference-manual/boards/portenta-x8.rst @@ -18,7 +18,7 @@ Set up the board for updating using the manufacturing tools: portenta-x8 -#. **OPTIONAL** —Only required if you have problems and/or want to see the boot console output. +#. **OPTIONAL**: Only required if you have problems and/or want to see the boot console output. .. figure:: /_static/boards/portenta-x8-uart.png :width: 600 @@ -26,7 +26,7 @@ Set up the board for updating using the manufacturing tools: UART 2 Pins -#. You may need to solder a six pin header to the UART2 pad. +#. You may need to solder a six pin header to the **UART2** pad. #. Connect a TTL USB to UART 3v3 adapter to the corresponding UART 2 pins on the breakout board. @@ -50,26 +50,26 @@ Set up the board for updating using the manufacturing tools: - Parity: None - Flow control: None - A helpful reminder, if your not receiving console output to swap the TX and RX pins. Most TTL - USB to UART adaptors do not provide the cross over function. + .. tip:: + If you are not receiving console output to swap the TX and RX pins. Most TTL + USB to UART adaptors do not provide the cross over function. -#. Ensure that the power is off (no power input connected) +#. Ensure that the power is off—no power input connected. -#. Put the Portenta-x8 into programing mode: +#. Put the Portenta x8 into programming mode: - Switch BT_SEL to ON and - Switch BOOT ON as shown below. + Switch **BT_SEL** to **ON** and switch **BOOT** to **ON** as shown below. .. figure:: /_static/boards/portenta-x8-boot.png :width: 600 :align: center - BT_SEL and BOOT programing settings + BT_SEL and BOOT programming settings #. Connect your computer to the Portenta X8 board via either USB-C® to USB-A or USB-C® to USB-C®. - This connection will power your board ON. It is best to use 5V supply with at least 2A via - a USB-C® connector. Negotiating power supplies do not always work and frequent reboots - can be detected. + This connection will power your board ON. It is best to use 5V supply with at least 2A via + a USB-C® connector. Negotiating power supplies do not always work and frequent reboots + can be detected. Flashing -------- @@ -80,4 +80,4 @@ Once in serial downloader mode and connected to your PC the evaluation board sho .. include:: imx8-flashing.rst -To put the Portenta X8 into run mode, switch BT_SEL and BOOT to OFF. +To put the Portenta X8 into run mode, switch **BT_SEL** and **BOOT** to **OFF**. diff --git a/source/reference-manual/boards/raspberrypi.rst b/source/reference-manual/boards/raspberrypi.rst index fd6298f87..d37bd00ea 100644 --- a/source/reference-manual/boards/raspberrypi.rst +++ b/source/reference-manual/boards/raspberrypi.rst @@ -1,6 +1,6 @@ .. _ref-rm_board_rasbperrypi: -Raspberry Pi 3/4 +Raspberry Pi 4 ================ .. include:: generic-prepare.rst @@ -8,8 +8,7 @@ Raspberry Pi 3/4 Flashing -------- -Now, flash the ``lmp-factory-image-raspberrypi4-64.wic.gz`` or -``lmp-factory-image-raspberrypi3-64.wic.gz`` retrieved from the previous section -to an SD Card. This contains the :term:`system image` that the device will boot. +Flash your Factory image to an SD Card. +This contains the bootable :term:`system image`. .. include:: generic-flashing.rst diff --git a/source/reference-manual/boards/se050_imx6ull.rst b/source/reference-manual/boards/se050_imx6ull.rst index 0d9450995..47986d380 100644 --- a/source/reference-manual/boards/se050_imx6ull.rst +++ b/source/reference-manual/boards/se050_imx6ull.rst @@ -1,19 +1,16 @@ -i.MX 6ULL Evaluation Kit with SE050ARD -======================================== +i.MX 6ULL Evaluation kit With SE050ARD +======================================= -This document will walk a developer through the steps of installing a -FoundriesFactory image with the SE050 hardware enabled onto the NXP -``imx6ullevk`` that is connected to the NXP OM-SE050ARD development platform. +This page walks through installing a FoundriesFactory® image with SE050 hardware enabled onto the NXP® ``imx6ullevk``, +connected to the NXP OM-SE050ARD development platform. .. note:: - An image created in the factory with the SE050 enabled will not boot on - boards without the SE050 properly attached. + An image created in a Factory with SE050 enabled will not boot on boards without the SE050 properly attached. Attaching the SE050 ------------------- -Using four male to male jumper wires (Arduino Compatible Pin size) -connect the two boards as follows: +Using four male to male jumper wires (Arduino Compatible Pin size), connect the two boards as shown: .. figure:: /_static/boards/imx6ullevk.png :width: 400 @@ -42,10 +39,9 @@ Connect the signals as follows: +----------+--------------+-------------+ .. note:: - The ``J1704`` and ``J1705`` headers are located in the center of the - imx6ullevk board (Arduino headers). + The ``J1704`` and ``J1705`` headers are located in the center of the imx6ullevk board (Arduino headers). -Be sure that the jumpers on the SE050 evaluation board are set as follows: +Be sure that the jumpers on the SE050 evaluation board are set as shown: .. figure:: /_static/boards/se050ard_jumpers.png :width: 400 @@ -53,7 +49,7 @@ Be sure that the jumpers on the SE050 evaluation board are set as follows: SE050 Jumper Settings -Lastly the connected boards should look like this: +The connected boards should look like this: .. figure:: /_static/boards/se050ard_imx6ull.jpg :width: 400 @@ -64,9 +60,8 @@ Lastly the connected boards should look like this: Installing the FoundriesFactory Image ------------------------------------- -Download the images that have the SE050 enabled from the factory following -the instructions in :ref:`ref-rm_board_imx6ullevk`. +Download the images that have the SE050 enabled from the Factory. +Follow the instructions in :ref:`ref-rm_board_imx6ullevk`. .. note:: - A reference on the needed changes to enable the SE050 middleware can be - found in :ref:`ref-security_se05x_enablement`. + A reference on the needed changes to enable the SE050 middleware can be found in :ref:`ref-security_se05x_enablement`. diff --git a/source/reference-manual/boards/se050_imx8mm.rst b/source/reference-manual/boards/se050_imx8mm.rst index 852d5a677..96927b2ee 100644 --- a/source/reference-manual/boards/se050_imx8mm.rst +++ b/source/reference-manual/boards/se050_imx8mm.rst @@ -1,20 +1,16 @@ i.MX 8M Mini/Nano Evaluation Kit with SE050ARD ============================================== -This document will walk a developer through the steps of installing a -FoundriesFactory image with the SE050 hardware enabled onto the NXP -``imx8mm-lpddr4-evk`` or ``imx8mn-ddr4-evk`` that is connected to the NXP -OM-SE050ARD development platform. +This page walks through installing a SE050 hardware enabled FoundriesFactory® image onto an NXP® ``imx8mm-lpddr4-evk`` or ``imx8mn-ddr4-evk``, +connected to the NXP OM-SE050ARD development platform. .. note:: - An image created in the factory with the SE050 enabled will not boot on - boards without the SE050 properly attached. + An image created in a Factory with the SE050 enabled will not boot on boards without the SE050 properly attached. Attaching the SE050 ------------------- -Using four male to male jumper wires (Arduino Compatible Pin size) -connect the two boards as follows: +Using four male to male jumper wires (Arduino Compatible Pin size), connect the two boards as shown: .. figure:: /_static/boards/imx8mmevk_J1004.png :width: 400 @@ -48,7 +44,7 @@ Connect the signals as follows: | GND | J1004 pin 7 | J2 pin 7 | +----------+--------------+-------------+ -Alternatively use J22 on OM-SE050ARD and connect as follows +Alternatively, use J22 on OM-SE050ARD: +---------+-------------+-------------+ | Signal | 8MMINI-BB | OM-SE050ARD | @@ -62,8 +58,7 @@ Alternatively use J22 on OM-SE050ARD and connect as follows | GND | J1004 pin 7 | J22 pin 3 | +---------+-------------+-------------+ -Be sure that the jumpers on the SE050 evaluation board are -set as follows: +Be sure that the jumpers on the SE050 evaluation board are set as shown: .. figure:: /_static/boards/se050ard_jumpers.png :width: 400 @@ -71,7 +66,7 @@ set as follows: SE050 Jumper Settings -Lastly the connected boards should look like this: +The connected boards should look like this: .. figure:: /_static/boards/se050ard_imx8mm.png :width: 400 @@ -82,10 +77,9 @@ Lastly the connected boards should look like this: Installing the FoundriesFactory Image ------------------------------------- -Download the images that have the SE050 enabled from the factory following -the instructions in :ref:`ref-rm_board_imx8mmevk` or -:ref:`ref-rm_board_imx8mn-ddr4-evk` depending on the hardware used. +Download the images that have the SE050 enabled from the Factory. +Follow the instructions in :ref:`ref-rm_board_imx8mmevk` or :ref:`ref-rm_board_imx8mn-ddr4-evk` +—depending on the hardware used. .. note:: - A reference on the needed changes to enable the SE050 middleware can be - found in :ref:`ref-security_se05x_enablement`. + A reference on the needed changes to enable the SE050 middleware can be found in :ref:`ref-security_se05x_enablement`. diff --git a/source/reference-manual/boards/se050_imx8mp.rst b/source/reference-manual/boards/se050_imx8mp.rst index 8d1282755..ea0f1c4dd 100644 --- a/source/reference-manual/boards/se050_imx8mp.rst +++ b/source/reference-manual/boards/se050_imx8mp.rst @@ -1,20 +1,16 @@ -i.MX 8M Plus Evaluation Kit with SE050ARD +i.MX 8M Plus Evaluation Kit With SE050ARD ========================================= -This document walks a developer through the steps of installing a -FoundriesFactory image with the SE050 hardware enabled onto the NXP -``imx8mp-lpddr4-evk`` that is connected to the NXP OM-SE050ARD development -platform. +This document walks through the steps of installing a FoundriesFactory® image with SE050 hardware enabled onto the NXP® ``imx8mp-lpddr4-evk``, +connected to the NXP OM-SE050ARD development platform. .. note:: - An image created in the factory with the SE050 enabled does not boot on - boards without the SE050 properly attached. + An image created in a Factory with SE050 enabled does not boot on boards without the SE050 properly attached. Attaching the SE050 ------------------- -Using four male to male jumper wires (Arduino Compatible Pin size) -connect the two boards as follows: +Using four male to male jumper wires (Arduino Compatible Pin size) connect the two boards as shown: .. figure:: /_static/boards/imx8mp-lpddr4-evk_J22.png :width: 400 @@ -48,8 +44,7 @@ Connect the signals as follows: | GND | J22 pin 7 | J2 pin 7 | +----------+----------------------+-------------+ -Be sure that the jumpers on the SE050 evaluation board are -set as follows: +Be sure that the jumpers on the SE050 evaluation board are set as shown: .. figure:: /_static/boards/se050ard_jumpers.png :width: 400 @@ -57,7 +52,7 @@ set as follows: SE050 Jumper Settings -Lastly, the connected boards should look like this: +The connected boards should look like this: .. figure:: /_static/boards/se050ard_imx8mp.jpg :width: 400 @@ -68,9 +63,8 @@ Lastly, the connected boards should look like this: Installing the FoundriesFactory Image ------------------------------------- -Download the images that have the SE050 enabled from the factory following -the instructions in :ref:`ref-rm_board_imx8mp-lpddr4-evk`. +Download the images that have the SE050 enabled from the Factory. +Follow the instructions in :ref:`ref-rm_board_imx8mp-lpddr4-evk`. .. note:: - A reference on the needed changes to enable the SE050 middleware can be - found in :ref:`ref-security_se05x_enablement`. + A reference on the needed changes to enable the SE050 middleware can be found in :ref:`ref-security_se05x_enablement`. diff --git a/source/reference-manual/boards/se050_imx8mq.rst b/source/reference-manual/boards/se050_imx8mq.rst index 1d2d8eb12..35aeacb79 100644 --- a/source/reference-manual/boards/se050_imx8mq.rst +++ b/source/reference-manual/boards/se050_imx8mq.rst @@ -1,19 +1,16 @@ i.MX 8M Quad Evaluation Kit with SE050ARD ========================================= -This document will walk a developer through the steps of installing a -FoundriesFactory image with the SE050 hardware enabled onto the NXP -``imx8mqevk`` that is connected to the NXP OM-SE050ARD development platform. +This page walks through walk installing a FoundriesFactory® image with SE050 hardware enabled onto the NXP® ``imx8mqevk``, +connected to the NXP OM-SE050ARD development platform. .. note:: - An image created in the factory with the SE050 enabled will not boot on - boards without the SE050 properly attached. + An image created in the Factory with SE050 enabled will not boot on boards without the SE050 properly attached. Attaching the SE050 ------------------- -Using four male to male jumper wires (Arduino Compatible Pin size) -connect the two boards as follows: +Using four male to male jumper wires (Arduino Compatible Pin size) connect the two boards as shown: .. figure:: /_static/boards/imx8mqevk_J801.png :width: 400 @@ -47,8 +44,7 @@ Connect the signals as follows: | GND | J801 pin 2 | J2 pin 7 | +----------+-------------+-------------+ -Be sure that the jumpers on the SE050 evaluation board are -set as follows: +Be sure that the jumpers on the SE050 evaluation board are set as shown: .. figure:: /_static/boards/se050ard_jumpers.png :width: 400 @@ -56,7 +52,7 @@ set as follows: SE050 Jumper Settings -Lastly the connected boards should look like this: +The connected boards should look like this: .. figure:: /_static/boards/se050ard_imx8mq.png :width: 400 @@ -67,9 +63,8 @@ Lastly the connected boards should look like this: Installing the FoundriesFactory Image ------------------------------------- -Download the images that have the SE050 enabled from the factory following -the instructions in :ref:`ref-rm_board_imx8mqevk`. +Download the images that have the SE050 enabled from the Factory. +Following the instructions in :ref:`ref-rm_board_imx8mqevk`. .. note:: - A reference on the needed changes to enable the SE050 middleware can be - found in :ref:`ref-security_se05x_enablement`. + A reference on the needed changes to enable the SE050 middleware can be found in :ref:`ref-security_se05x_enablement`. diff --git a/source/reference-manual/boards/secure-boot-note.rst b/source/reference-manual/boards/secure-boot-note.rst index 853cce6e4..cf13a3802 100644 --- a/source/reference-manual/boards/secure-boot-note.rst +++ b/source/reference-manual/boards/secure-boot-note.rst @@ -1,7 +1,5 @@ .. note:: - The instructions in this section also applies to those boards with secure - boot enabled. There are references on how to perform common instructions - along with the flow. + The instructions in this section also applies to those boards with secure boot enabled. + There are references on how to perform common instructions along with the flow. - The :ref:`ref-security` Reference Manual details the required background - for secure boot. \ No newline at end of file + :ref:`ref-secure-boot` details the required background for secure boot. diff --git a/source/reference-manual/boards/secure-boot-pre-flash-note.rst b/source/reference-manual/boards/secure-boot-pre-flash-note.rst index 62129fd29..9ae06779d 100644 --- a/source/reference-manual/boards/secure-boot-pre-flash-note.rst +++ b/source/reference-manual/boards/secure-boot-pre-flash-note.rst @@ -1,5 +1,4 @@ .. note:: - For instructions on how to sign the required images before flashing them - to the board with secure boot enabled, follow the instructions from - :ref:`ref-secure-machines`. \ No newline at end of file + For instructions on how to sign the required images before flashing them to the board with secure boot enabled, + follow the instructions from :ref:`ref-secure-machines`. diff --git a/source/reference-manual/boards/stm32mp15-disco.rst b/source/reference-manual/boards/stm32mp15-disco.rst index 098a37dd3..2cd199041 100644 --- a/source/reference-manual/boards/stm32mp15-disco.rst +++ b/source/reference-manual/boards/stm32mp15-disco.rst @@ -6,39 +6,39 @@ STM32MP157 Discovery Kit FoundriesFactory CI Build ------------------------- -Including STM OpenEmbedded layer requires accepting EULA. When building locally -it is enough to accept EULA using interactive prompt. When building in CI this -isn't possible. To enable EULA acceptance in the CI job, ``EULA_stm32mp15disco`` -variable needs to be set in the ``factory-config.yml``:: - - ... - lmp: - params: - ... - EULA_stm32mp15disco: "1" - ... - -``factory-config.yml`` can be found in ci-scripts.git repository that is -created for each factory. +.. important:: + Including the STM™ OpenEmbedded layer requires accepting the EULA. + When building locally, it is enough to accept the EULA from an interactive prompt. + When building in CI, this is not possible. + To enable EULA acceptance in the CI job, the variable ``EULA_stm32mp15disco`` needs to be set in the ``factory-config.yml`` + :: + + ... + lmp: + params: + ... + EULA_stm32mp15disco: "1" + ... + + ``factory-config.yml`` can be found in the ``ci-scripts.git`` repo for your Factory. .. include:: generic-prepare.rst Flashing -------- -Now, flash the ``lmp-factory-image-stm32mp15-disco.wic.gz`` retrieved from the -previous section to an SD Card. This contains the :term:`system image` that the -device will boot. +Flash ``lmp-factory-image-stm32mp15-disco.wic.gz`` to an SD Card. +This contains the bootable :term:`system image`. .. include:: generic-flashing.rst -Boot mode +Boot Mode --------- -STM32MP157C-DK2 board has a dip switch that controls boot mode. Dip switch -covers BOOT0 and BOOT2 signals. They both have to be turned ON for the board -to boot from SD card. +The STM32MP157C-DK2 has a dip switch that controls boot mode. +The dip switch covers ``BOOT0`` and ``BOOT2`` signals. +Turn both ``ON`` for the board to boot from SD card. .. figure:: /_static/boards/stm32mp1_boot_mode.png :width: 660 diff --git a/source/reference-manual/boards/stm32mp15-eval.rst b/source/reference-manual/boards/stm32mp15-eval.rst index 3909c2284..2fdb19232 100644 --- a/source/reference-manual/boards/stm32mp15-eval.rst +++ b/source/reference-manual/boards/stm32mp15-eval.rst @@ -3,111 +3,99 @@ STM32MP15 EV1 Evaluation Board ============================== -This page shows how to flash an STM32MP15 EV1 board with LmP artifacts. +This page covers flashing an STM32MP15 EV1 board with LmP artifacts. -Getting Required Software -------------------------- +Getting the Required Software +----------------------------- **STM32CubeProgrammer** is used to flash the STM32MP15 EV1 board. -This section shows how to properly download and setup this tool on a Linux -machine. Please skip to the next section if **STM32CubeProgrammer** is -already installed on your machine. +This section shows how to download and set it up. +Skip to the next section if you already have **STM32CubeProgrammer** installed. .. tabs:: .. group-tab:: Linux - 1. Download the `STM32CubeProgrammer`_ software for Linux. + 1. Download the `STM32CubeProgrammer`_ software for Linux®. - 2. Unzip it to a known location: + 2. Unzip it to a known location: - .. prompt:: bash host:~$, auto + .. prompt:: bash host:~$, auto + + host:~$ mkdir + host:~$ unzip en.stm32cubeprg-lin_v*.zip -d - host:~$ mkdir - host:~$ unzip en.stm32cubeprg-lin_v*.zip -d + 3. Run the installer and follow the instructions on screen: - 3. Run the installer and follow the instructions on screen: + .. prompt:: bash host:~$, auto - .. prompt:: bash host:~$, auto + host:~$ ./SetupSTM32CubeProgrammer*.linux - host:~$ ./SetupSTM32CubeProgrammer*.linux + 4. Export the ``STM32CubeProgrammer_path`` to the system path: - 4. Export the ``STM32CubeProgrammer_path`` to the system path: + .. prompt:: bash host:~$, auto - .. prompt:: bash host:~$, auto + host:~$ export PATH=/bin:$PATH - host:~$ export PATH=/bin:$PATH + 5. To allow **STM32CubeProgrammer** to access the USB port through low-level commands, proceed as follows: - 5. To allow **STM32CubeProgrammer** to access the USB port through low-level commands, proceed as follows: + .. prompt:: bash host:~$, auto - .. prompt:: bash host:~$, auto - - host:~$ cd /Drivers/rules - host:~$ sudo cp *.* /etc/udev/rules.d/ + host:~$ cd /Drivers/rules + host:~$ sudo cp *.* /etc/udev/rules.d/ .. group-tab:: Windows - 1. Download the `STM32CubeProgrammer`_ software for Windows. + 1. Download the `STM32CubeProgrammer`_ software for Windows. - 2. Unzip it to a known location. + 2. Unzip it to a known location. - 3. Execute the Windows installer and follow the instructions on screen. + 3. Execute the Windows installer and follow the instructions on screen. - 4. Run ``STM32 Bootloader.bat`` to install the required DFU drivers and activate the STM32 device in USB DFU mode. + 4. Run ``STM32 Bootloader.bat`` to install the required DFU drivers and activate the STM32 device in USB DFU mode. - For more information, check the `STM32CubeProgrammer Installation page`_. +For more information, check the `STM32CubeProgrammer Installation page`_. Preparation ----------- -1. On your factory, click on the latest ``platform-devel`` build: - - .. figure:: /_static/boards/generic-steps-1.png - :width: 769 - :align: center - -2. Expand the run for ``stm32mp15-eval`` and look for the **flashlayouts-stm32mp15-eval.tar.gz** -artifact under the ``other`` folder: - - .. figure:: /_static/boards/stm32mp15-eval_artifacts.png +1. In your Factory, click on the latest ``platform`` build. -3. Unzip the downloaded file: +2. Expand the run for ``stm32mp15-eval``, and under the ``other`` folder, find and download ``flashlayouts-stm32mp15-eval.tar.gz``. -.. prompt:: bash host:~$, auto +3. Unzip the file: :: - host:~$ tar -xvf flashlayouts-stm32mp15-eval.tar.gz + tar -xvf flashlayouts-stm32mp15-eval.tar.gz -The file used for flashing is **FlashLayout_stm32mp1-optee.tsv**. +The file used for flashing is ``FlashLayout_stm32mp1-optee.tsv`` Hardware Preparation -------------------- 1. Connect the USB OTG cable in the base board to the host machine. -2. Set the boot switches in the CPU board to Serial Download Mode, ``0000``: +2. Set the boot switches in the CPU board to Serial Download Mode, **0000**: - .. figure:: /_static/boards/stm32-ev1_sdp.jpg - :width: 350 - :align: center + .. figure:: /_static/boards/stm32-ev1_sdp.jpg + :width: 350 + :align: center - stm32mp15-ev1 SDP mode + stm32mp15-ev1 SDP mode -3. **OPTIONAL:** For UART output in the USB connector in the CPU board, remove -``JP1`` jumper and move ``JP4`` and ``JP5`` to the 2-3 position, as pictures -below: +3. **OPTIONAL**: For UART output in the USB connector on the CPU board, remove **JP1** jumper and move **JP4** and **JP5** to the 2–3 position: .. figure:: /_static/boards/stm32-ev1_jp1.jpg - :width: 50% - :align: center + :width: 50% + :align: center - stm32mp15-ev1 JP1 + stm32mp15-ev1 JP1 .. figure:: /_static/boards/stm32-ev1_jp4-jp5.jpg - :width: 350 - :align: center + :width: 350 + :align: center - stm32mp15-ev1 JP4 and JP5 + stm32mp15-ev1 JP4 and JP5 Flashing -------- @@ -142,8 +130,7 @@ Index`` from the previous step if needed: This can take a few minutes to complete. The process can be watched from the host console, UART output, or board display. -3. Once the flashing procedure finishes, change the boot switches to eMMC boot, -``0100``: +3. Once the flashing procedure finishes, change the boot switches to eMMC boot, **0100**: .. figure:: /_static/boards/stm32-ev1_boot.jpg :width: 350 diff --git a/source/reference-manual/boards/uz3eg-iocc.rst b/source/reference-manual/boards/uz3eg-iocc.rst index 679592fd7..2359046d8 100644 --- a/source/reference-manual/boards/uz3eg-iocc.rst +++ b/source/reference-manual/boards/uz3eg-iocc.rst @@ -8,22 +8,21 @@ Avnet UltraZed SOM with UltraZed-EG IO Carrier Card Hardware Preparation -------------------- -#. Ensure that the power switch is off (``SW8`` switch is off). +#. Ensure that the power switch is off (**SW8** switch is off). #. Install UltraZed SOM on UltraZed-EG carrier. -#. Connect the Micro-USB cable to the ``J11`` (``DUAL USB UART`` label) - connector. +#. Connect the Micro-USB cable to the **J11** (**DUAL USB UART** label) connector. -#. Connect power cord. +#. Connect the power cord. -#. Set boot switch, which is located on SOM, to ``[1:4]`` to - ``OFF,ON,OFF,ON``, so it boots from SD by default. +#. Set the boot switch located on the SOM at **[1:4]** to **OFF,ON,OFF,ON**. + This will cause it to boot from the SD by default. -Flashing and boot +Flashing and Boot ----------------- -.. note:: Device names and IDs can slightly differ from the steps below. +.. note:: Device names and IDs can differ slightly from the steps below. .. include:: generic-flashing.rst diff --git a/source/reference-manual/boards/versal-prepare.rst b/source/reference-manual/boards/versal-prepare.rst index bcf6ec0d3..21c8ba004 100644 --- a/source/reference-manual/boards/versal-prepare.rst +++ b/source/reference-manual/boards/versal-prepare.rst @@ -1,26 +1,18 @@ Preparation ----------- -.. attention:: - Replace the ```` placeholder below with the name of your Factory. +.. important:: + Replace ```` with the name of your Factory. #. Download the necessary files from ``https://app.foundries.io/factories//targets``: - a. Click the latest :guilabel:`Target` with the ``platform-devel`` :guilabel:`Trigger`. + a. Click the latest :guilabel:`Target` with the ``platform`` trigger. - .. figure:: /_static/boards/generic-steps-1.png - :width: 769 - :align: center - - #. Expand the :guilabel:`Runs` section corresponding with the name of the board and **download the Factory image**. - For reference on how to boot using the JTAG port, download ``boot.bin`` from the **other** folder: - - | ``lmp-factory-image-.wic.gz`` - | ``boot.bin`` - - .. figure:: /_static/boards/versal-steps-2.png - :width: 769 - :align: center + b. Expand the :guilabel:`Runs` section corresponding with the board. + **Download the Factory image.** For example, ``lmp-factory-image-.wic.gz``. + + .. note:: + For reference on how to boot using the JTAG port, download ``boot.bin`` from the **other** folder. #. Extract the file ``lmp-factory-image-.wic.gz``:: @@ -42,7 +34,4 @@ Preparation :width: 400 :align: center -#. Power up the board. - - - +#. Power up the board. diff --git a/source/reference-manual/boards/versal.rst b/source/reference-manual/boards/versal.rst index 6d9b32004..376091257 100644 --- a/source/reference-manual/boards/versal.rst +++ b/source/reference-manual/boards/versal.rst @@ -8,7 +8,7 @@ Versal AI Core Series VCK190 Evaluation Kit Hardware Preparation: Console/JTAG ---------------------------------------- -Set up the board for accessing the console or using the JTAG interface +Set up the board for accessing the console or using the JTAG interface: .. figure:: /_static/boards/vck190.png :width: 800 @@ -16,9 +16,9 @@ Set up the board for accessing the console or using the JTAG interface #. Using a USB Type-C cable, connect the board to the PC host. -#. Four UART connections will appear on the PC: one of them is a JTAG interface, and another one is a console. +#. Four UART connections will appear on the PC: including a JTAG interface and a console. - On a Linux host for example you will see:: + On a Linux® host, for example, you will see:: usb 1-14.4.4.3: new high-speed USB device number 117 using xhci_hcd usb 1-14.4.4.3: New USB device found, idVendor=0403, idProduct=6011, bcdDevice= 8.00 @@ -39,7 +39,7 @@ Set up the board for accessing the console or using the JTAG interface usb 1-14.4.4.3: Detected FT4232H usb 1-14.4.4.3: FTDI USB Serial Device converter now attached to ttyUSB7 - Inspection of these new devices will show:: + Inspection of these new devices will show:: $ ls -la /dev/serial/by-id/ total 0 @@ -53,9 +53,10 @@ Console Hardware Configuration #. Power off the board. -#. Using a serial terminal program like minicom, connect to the port - with ``usb-Xilinx_VCK190_532143136405-if01-port0`` in the name - (in this example ttyUSB5) and apply the following configuration:: +#. Using a serial terminal program like minicom, + connect to the port with ``usb-Xilinx_VCK190_532143136405-if01-port0`` in the name. + In this example that would be ``ttyUSB5``. + Apply the following configuration:: - Baud rate: 115200 - Data bits: 8 diff --git a/source/reference-manual/boards/x86.rst b/source/reference-manual/boards/x86.rst index e858cc43c..01cab536c 100644 --- a/source/reference-manual/boards/x86.rst +++ b/source/reference-manual/boards/x86.rst @@ -3,7 +3,7 @@ x86 === -The instructions for boards based on x86 cores. +Instructions for boards based on x86 cores. .. seealso:: Instructions on how to boot a :ref:`generic x86-64 image with QEMU `