View source for 1-4-1-1-2-1-10

<!-- Set release according to "release" parameter in URL and use MORTY_BETA_DART-6UL as default
--> {{#vardefine:RELEASE_PARAM|{{#urlget:release}}}} <!--
--> {{#lst:Yocto_Platform_Customization|{{#var:RELEASE_PARAM|RELEASE_MORTY_BETA_DART-6UL}}}} <!--
--> {{PageHeader|Installing Yocto to the SOM's internal storage}} {{DocImage|category1={{#var:HARDWARE_NAME}}|category2=Yocto}} __toc__
= Introduction =
All SOMs can either boot from an SD card or from their internal storage.<br>
<br>
The SOM's internal storage:<br>
{{#ifeq: {{#var:HARDWARE_NAME}} | VAR-SOM-MX6 |
* '''VAR-SOM-MX6 and VAR-SOM-SOLO/DUAL''' SOMs use the on-SOM NAND flash to boot.<br>
The file system can reside either on the NAND flash or the eMMC.<br>
When the file system resides on the NAND flash, a UBIFS file system is used.<br>
When the file system resides on the eMMC, an ext4 file system is used.<br>
Regardless of the file system type and location, U-Boot will always boot from the NAND flash.<br>
By default, the kernel image and device tree blob are also written to the NAND flash (again, regardless of the file system type and location).
* '''VAR-DART-MX6''' has only an on-SOM eMMC which can be used to boot from and to hold the filesystem.
|
{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
The Variscite {{#var:HARDWARE_NAME}} comes with eMMC, which holds U-Boot, the kernel image and the ext4 root file system.<br>
|
The Variscite {{#var:HARDWARE_NAME}} has either an on-SOM NAND flash or eMMC, and either of them can be used to boot from and to hold the file system.<br>
For NAND flash we use a UBI file system and for eMMC we use ext4.
}}
}}

{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
|
= NAND flash structure =
{{#ifeq: {{#var:MACHINE_NAME}} | var-som-mx6 |* '''VAR-SOM-MX6 and VAR-SOM-SOLO/DUAL'''
These are the defined MTD partitions on the NAND flash:<br>
0x000000000000-0x000000200000 : "spl"<br>
0x000000200000-0x000000400000 : "bootloader"<br>
0x000000400000-0x000000c00000 : "kernel"'''<br>
0x000000c00000-End &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : "rootfs"
|
0x000000000000-0x000000200000 : "spl"<br>
0x000000200000-0x000000400000 : "u-boot"<br>
0x000000400000-0x000000600000 : "u-boot_env"<br>
0x000000600000-0x000000e00000 : "kernel"<br>
0x000000e00000-End &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : "rootfs"<br>}}
}}

= eMMC structure =
{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
0-8 MiB &nbsp;&nbsp;&nbsp;&nbsp; : Non-partitioned space, saved for U-Boot.<br>
8 MiB-End: "rootfs" - An ext4 partition containing the root file system (including Linux image and the device tree blobs under /boot).
|
{{#ifeq: {{#var:MACHINE_NAME}} | var-som-mx6 |* '''VAR-SOM-MX6 and VAR-SOM-SOLO/DUAL'''
0 MiB-End: "rootfs" - An ext4 partition containing the root file system (including the kernel modules).
* '''VAR-DART-MX6'''|}}
0-4 MiB &nbsp;&nbsp;&nbsp;&nbsp; : Non-partitioned space, saved for U-Boot.<br>
4-12 MiB &nbsp;&nbsp; : {{#var:EMMC_FAT_PARTITION_NAME}} - A FAT16 partition containing the Linux image and the device tree blob/s.<br>
12 MiB-End: "rootfs" - An ext4 partition containing the root file system (including the kernel modules).}}

{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
|
= Yocto Built binaries for NAND flash / eMMC =

The resulting images are located at tmp/deploy/images/{{#var:MACHINE_NAME}}.<br>
{{#lst:Yocto_Build_Release|YOCTO_BUILD_RESULTS}}
{{#lst:Yocto_Platform_Customization|{{#var:YOCTO_BUILD_RESULTS_SECTION}}}}
}}

= Installing the Yocto binaries =
If you followed the [[Yocto_Build_Release#Create an extended SD card |Create an extended SD card]] steps, the [[#Images locations|Yocto binaries]] and the [[#Flashing scripts|flashing scripts]] will be included in your SD card. <br>
The flashing scripts are easy-to-use example scripts for flashing images into NAND flash / eMMC.<br>
There is also a section below describing how to [[#Manual step-by-step flashing to NAND flash / eMMC|flash the images manually]].

== Images locations ==
Following is the directory structure on your SD card, which elaborates the files' location that the below installation scripts are expecting:
{{#lst:Yocto_Platform_Customization|{{#var:SD_TREE_SECTION}}}}

{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
=== Prepare the images for flashing to eMMC  ===
|
=== Prepare the images for NAND flash / eMMC flashing ===
}}
Plug the bootable SD card into your host machine and mount the rootfs partition - here we assume it is mounted on /media/rootfs.<br>
Copy all the mentioned yocto-built binaries to the SD card:
<br>
* <span style="color:red">Note:</span> If you followed the [[Yocto_Build_Release#Create an extended SD card |Create an extended SD card]] steps, the [[#Flashing scripts|flashing scripts]] and all relevant binaries are already included in your SD card, and the below commands are redundant!<br>

Setup:
 $ export YOCTO_IMGS_PATH={{#var:BUILD_FOLDER}}/{{#var:BUILD_FOLDER_X11}}/tmp/deploy/images/{{#var:MACHINE_NAME}}
 $ export P2_MOUNT_DIR=/media/rootfs/
 $ sudo mkdir -p ${P2_MOUNT_DIR}/opt/images/Yocto/

{{#ifeq: {{#var:SOC_SERIES}} | imx8 ||
Linux:
 $ sudo cp ${YOCTO_IMGS_PATH}/{{#var:KERNEL_IMAGE}} ${P2_MOUNT_DIR}/opt/images/Yocto/

Device Tree:
 $ for f in ${YOCTO_IMGS_PATH}/*.dtb; do if <nowiki>[[ -L $f ]] && [[</nowiki> $f != *{{#var:MACHINE_NAME}}.dtb <nowiki>]]</nowiki>; then sudo cp $f ${P2_MOUNT_DIR}/opt/images/Yocto/; fi done
 $ sudo rename 's/{{#var:KERNEL_IMAGE}}-imx/imx/' ${P2_MOUNT_DIR}/opt/images/Yocto/*.dtb


{{#ifeq: {{#var:SOC_SERIES}} | imx8 ||
NAND images:
 {{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A ||SPL:
 $ sudo cp ${YOCTO_IMGS_PATH}/{{#var:SPL_NAND_IMAGE_NAME}} ${P2_MOUNT_DIR}/opt/images/Yocto/
 }}
 
 U-Boot:
 $ sudo cp ${YOCTO_IMGS_PATH}/{{#var:U-BOOT_NAND_IMAGE_NAME}} ${P2_MOUNT_DIR}/opt/images/Yocto/
 
 File System:
 $ sudo cp ${YOCTO_IMGS_PATH}/fsl-image-gui-{{#var:MACHINE_NAME}}.ubi ${P2_MOUNT_DIR}/opt/images/Yocto/rootfs.ubi
}}
eMMC images:
{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|*'''VAR-SOM-MX6 and VAR-SOM-SOLO/DUAL'''
 File System:
 $ sudo cp ${YOCTO_IMGS_PATH}/fsl-image-gui-{{#var:MACHINE_NAME}}.tar.gz ${P2_MOUNT_DIR}/opt/images/Yocto/rootfs.tar.gz
|}} <!--

-->{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|*'''DART-MX6'''|}}
 {{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A ||SPL:
 $ sudo cp ${YOCTO_IMGS_PATH}/{{#var:SPL_SD_IMAGE_NAME}} ${P2_MOUNT_DIR}/opt/images/Yocto/
|}}

{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
 <br>
 U-Boot: 
 $ sudo cp ${YOCTO_IMGS_PATH}/imx-boot-{{#var:MACHINE_NAME}}-sd.bin ${P2_MOUNT_DIR}/opt/images/Yocto/{{#var:U-BOOT_SD_IMAGE_NAME}}
 
 File System:
 $ sudo cp ${YOCTO_IMGS_PATH}/fsl-image-gui-{{#var:MACHINE_NAME}}.tar.gz ${P2_MOUNT_DIR}/opt/images/Yocto/rootfs.tar.gz
|
 <br>
 U-Boot: 
 $ sudo cp ${YOCTO_IMGS_PATH}/{{#var:U-BOOT_SD_IMAGE_NAME}} ${P2_MOUNT_DIR}/opt/images/Yocto/
 
 File System:
 $ sudo cp ${YOCTO_IMGS_PATH}/fsl-image-gui-{{#var:MACHINE_NAME}}.tar.gz ${P2_MOUNT_DIR}/opt/images/Yocto/rootfs.tar.gz
}}

== Flashing scripts ==
The flashing scripts are located on the SD card at /usr/bin/:

 {{#ifeq: {{#var:SOC_SERIES}} | imx8 |
 install_yocto.sh	- Flash Yocto into eMMC (Run and follow usage instructions)
|
 install_yocto.sh	- Flash Yocto into NAND flash or eMMC (Run and follow usage instructions)
}}
 {{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
 (install_yocto_emmc.sh	- This script is being called by install_yocto.sh when choosing to install the rootfs to eMMC - it should not be called directly!)
 |}}

{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
|
== Manual step-by-step flashing to NAND flash ==

Use the prepared SD card to boot the board and run the following:
<br>
<pre>
$ cd /opt/images/Yocto
</pre>

{{#ifeq: {{#var:SPL_NAND_IMAGE_NAME}} | N/A |Flash U-Boot:| Flash SPL & U-Boot:}}

 $ flash_erase /dev/mtd0 0 0
 {{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
 $ kobs-ng init -x {{#var:SPL_NAND_IMAGE_NAME}} --search_exponent=1 -v
 $ flash_erase /dev/mtd1 0 0
 $ nandwrite -p /dev/mtd1 {{#var:U-BOOT_NAND_IMAGE_NAME}}
 |
 {{#ifeq: {{#var:HARDWARE_NAME}}|DART-6UL|
 $ kobs-ng init -x {{#var:SPL_NAND_IMAGE_NAME}} --search_exponent=1 -v
 $ flash_erase /dev/mtd1 0 0
 $ nandwrite -p /dev/mtd1 {{#var:U-BOOT_NAND_IMAGE_NAME}}
 $ flash_erase /dev/mtd2 0 0
 |}}
 {{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX7|
{{#ifeq: {{#var:SPL_NAND_IMAGE_NAME}} | N/A |
 $ kobs-ng init -x {{#var:U-BOOT_NAND_IMAGE_NAME}} --search_exponent=1 -v
|
 $ kobs-ng init -x {{#var:SPL_NAND_IMAGE_NAME}} --search_exponent=1 -v
 $ flash_erase /dev/mtd1 0 0
 $ nandwrite -p /dev/mtd1 {{#var:U-BOOT_NAND_IMAGE_NAME}}
}}
 $ flash_erase /dev/mtd2 0 0
 |}}
}}

Flash the Linux Kernel image & Device Tree:<br>
You need to use the right .dtb file for you hardware setup. See the [[#Yocto Built binaries for NAND flash / eMMC | table]] above for a complete description.

 {{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
 $ flash_erase /dev/mtd2 0 0
 $ nandwrite -p /dev/mtd2 {{#var:KERNEL_IMAGE}}
 $ nandwrite -p /dev/mtd1 -s 0x1e0000 <DEVICE_TREE_FILE>
 |
 $ flash_erase /dev/mtd3 0 0
 $ nandwrite -p /dev/mtd3 {{#var:KERNEL_IMAGE}}
 $ nandwrite -p /dev/mtd3 -s 0x7e0000 <DEVICE_TREE_FILE>
 }}

Flash the (UBI) File System to NAND flash:

 {{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
 $ ubiformat /dev/mtd3 -f rootfs.ubi
 |
 $ ubiformat /dev/mtd4 -f rootfs.ubi
 }}
}}

== Manual step-by-step flashing to eMMC ==

Flashing the eMMC requires several steps including partitioning, file system formatting and image extraction.<br>
We recommend to use our provided scripts to perform this task.<br><br>
Use the prepared SD card to boot the board and run the following:
{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
 * '''DART-MX6'''
 $ export node=/dev/mmcblk2
 $ cd /opt/images/Yocto
* '''VAR-SOM-MX6 and VAR-SOM-SOLO/DUAL'''
}}
 $ export node=/dev/{{#var:EMMC_ROOTFS_DEV}} 
 $ cd /opt/images/Yocto

Make sure the eMMC is not mounted:
 $ umount ${node}p*

{{#ifeq: {{#var:SOC_SERIES}} | imx8 |
Delete current data on eMMC:
 $ for((i=1; i<=16; i++)); do [ -e ${node}p${i} ] && dd if=/dev/zero of=${node}p${i} bs=1M count=1 conv=fsync; done
 $ dd if=/dev/zero of=${node} bs=1M count=8 conv=fsync

Create a partition table:
 $ (echo n; echo p; echo 1; echo 16384; echo; echo p; echo w) <nowiki>|</nowiki> fdisk -u $node
 $ sync

Format the partitions:
 $ mkfs.ext4 ${node}p1 -L rootfs
 $ sync

Flash U-Boot:
 $ dd if={{#var:U-BOOT_SD_IMAGE_NAME}} of=${node} bs=1K seek={{#var:U-BOOT_OFFSET}} conv=fsync

Extract the rootfs archive:
 $ mkdir /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}
 $ mount ${node}{{#var:EMMC_ROOTFS_PARTITION_NUM}} /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}
 $ tar xvpf rootfs.tar.gz -C /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}
 {{#ifeq: {{#var:HARDWARE_NAME}} | DART-MX8M |$ (cd /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}/boot; ln -fs {{#var:DEFAULT_DTB_EMMC}} {{#var:DEFAULT_DTB}})|}}
 $ sync
 $ umount /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}
|
Delete current data on eMMC:
 $ dd if=/dev/zero of=${node}p1 bs=1024 count=1024
 $ dd if=/dev/zero of=${node}p2 bs=1024 count=1024
 $ dd if=/dev/zero of=${node}p3 bs=1024 count=1024
 $ dd if=/dev/zero of=${node}p4 bs=1024 count=1024
 $ dd if=/dev/zero of=${node}p5 bs=1024 count=1024
 $ dd if=/dev/zero of=${node}p6 bs=1024 count=1024
 $ dd if=/dev/zero of=${node}p7 bs=1024 count=1024
 $ sync
 $ (echo d; echo 1; echo d; echo 2; echo d; echo 3; echo d; echo w) <nowiki>|</nowiki> fdisk ${node}
 $ sync
 $ dd if=/dev/zero of=${node} bs=1M count=4
 $ sync

Create a partition table:
{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
* '''VAR-SOM-MX6 and  VAR-SOM-SOLO/DUAL'''
 $ (echo n; echo p; echo 1; echo; echo; echo p; echo w) <nowiki>|</nowiki> fdisk -u ${node}
 $ sync
* '''DART-MX6'''
 }}
 $(echo n; echo p; echo 1; echo 8192; echo 24575; echo t; echo c; \
   echo n; echo p; echo 2; echo 24576; echo; \
   echo p; echo w) <nowiki>|</nowiki> fdisk -u ${node}
 $ sync

Format the partitions:
{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
* '''VAR-SOM-MX6 and  VAR-SOM-SOLO/DUAL'''
 $ mkfs.ext4 ${node}p1 -L rootfs
* '''DART-MX6'''
}}
 $ mkfs.vfat ${node}p1 -n {{#var:EMMC_FAT_PARTITION_NAME}}
 $ mkfs.ext4 ${node}p2 -L rootfs

{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX7|
{{#ifeq: {{#var:SPL_SD_IMAGE_NAME}} | N/A |
Flash U-Boot to eMMC:
 $ dd if={{#var:U-BOOT_SD_IMAGE_NAME}} of=${node} bs=1K seek=1; sync
|
Flash SPL and U-Boot to eMMC:
 $ dd if={{#var:SPL_SD_IMAGE_NAME}} of=${node} bs=1K seek=1; sync
 $ dd if={{#var:U-BOOT_SD_IMAGE_NAME}} of=${node} bs=1K seek=69; sync
}}
}}
{{#ifeq: {{#var:HARDWARE_NAME}}|DART-6UL|
Flash SPL and U-Boot to eMMC:
 $ dd if={{#var:SPL_SD_IMAGE_NAME}} of=${node} bs=1K seek=1; sync
 $ dd if={{#var:U-BOOT_SD_IMAGE_NAME}} of=${node} bs=1K seek=69; sync
}}
{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
Flash SPL and U-Boot to eMMC:
* '''DART-MX6 only'''
 $ dd if={{#var:SPL_SD_IMAGE_NAME}} of=${node} bs=1K seek=1; sync
 $ dd if={{#var:U-BOOT_SD_IMAGE_NAME}} of=${node} bs=1K seek=69; sync
}}

Copy the Linux kernel image and the device tree blobs to the BOOT partition:
{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
* '''DART-MX6 only'''
}}
 $ mkdir /run/media/{{#var:EMMC_ROOTFS_DEV}}p1
 $ mount -t vfat ${node}p1	/run/media/{{#var:EMMC_ROOTFS_DEV}}p1/
 $ cp *emmc*.dtb			/run/media/{{#var:EMMC_ROOTFS_DEV}}p1/
 $ cp {{#var:KERNEL_IMAGE}}			/run/media/{{#var:EMMC_ROOTFS_DEV}}p1/
 $ sync
 $ umount /run/media/{{#var:EMMC_ROOTFS_DEV}}p1
 
Extract the rootfs archive:
 $ mkdir /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}
 $ mount ${node}{{#var:EMMC_ROOTFS_PARTITION_NUM}} /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}
 $ tar xvpf rootfs.tar.gz -C /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}
 $ sync
 $ umount /run/media/{{#var:EMMC_ROOTFS_DEV}}{{#var:EMMC_ROOTFS_PARTITION_NUM}}
}}

{{#ifeq: {{#var:HARDWARE_NAME}}|VAR-SOM-MX6|
Set the U-Boot env. variable "rootfs_device" to "emmc" by one of the following two methods:
* '''VAR-SOM-MX6 and  VAR-SOM-SOLO/DUAL only'''
 $ fw_setenv rootfs_device emmc
 (A "Warning: Bad CRC, using default environment" message is expected, since this is the first write of the U-Boot environment to the NAND flash)
 
 or:
 Reboot and stop at the U-Boot command line, and enter the following:
 => setenv rootfs_device emmc
 => saveenv
|}}

= Summary =
We described the results of a Yocto build, how to copy it to a bootable SD card and how to flash it to NAND and eMMC.<br>
With our extended SD card and our recovery SD card we provide an installation script located at /usr/bin/install_yocto.sh. It is much safer to use it instead of flashing the system manually.<br>