Difference between revisions of "Template:How to create a bootable SD card"

From DAVE Developer's Wiki
Jump to: navigation, search
Line 3: Line 3:
 
!colspan="4" style="width:100%; text-align:left"; border-bottom:solid 2px #ededed"|History
 
!colspan="4" style="width:100%; text-align:left"; border-bottom:solid 2px #ededed"|History
 
|-  
 
|-  
−
!style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#73B2C7; padding:5px; color:white"|Version
 
 
!style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#73B2C7; padding:5px; color:white"|Issue Date
 
!style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#73B2C7; padding:5px; color:white"|Issue Date
 
!style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#73B2C7; padding:5px; color:white"|Notes
 
!style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#73B2C7; padding:5px; color:white"|Notes
 
|-
 
|-
−
|style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#edf8fb; padding:5px; color:#000000"|X.Y.Z
+
|style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#edf8fb; padding:5px; color:#000000"|{{oldid|xxxx|Year/Month/Day}}
−
|style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#edf8fb; padding:5px; color:#000000"|Month Year
 
 
|style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#edf8fb; padding:5px; color:#000000"|TBD
 
|style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#edf8fb; padding:5px; color:#000000"|TBD
 
|-
 
|-
 
|-
 
|-
−
|style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#edf8fb; padding:5px; color:#000000"|[TBD_link X.Y.Z]
+
!style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#ededed; padding:5px; color:#000000"|Year/Month/Day
−
|style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#edf8fb; padding:5px; color:#000000"|Month Year
+
!style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#ededed; padding:5px; color:#000000"|TBD
−
|style="border-left:solid 2px #73B2C7; border-right:solid 2px #73B2C7;border-top:solid 2px #73B2C7; border-bottom:solid 2px #73B2C7; background-color:#edf8fb; padding:5px; color:#000000"|TBD
 
 
|-
 
|-
 
|}
 
|}
Line 23: Line 20:
 
==How to create a bootable SD card==
 
==How to create a bootable SD card==
  
−
{{ImportantMessage|text=The procedure described here was tested with a physical machine. In case of a virtual machine such as the [[Managed_Virtual_Machine_(MVM)|MVM]], it might not work properly. Also, it is worth remembering that USB controller of the MVM is disabled by default. See also [[MVM_FAQs#Q:_How_to_use_the_USB_devices_connected_to_the_host_machine.3F|this section]].}}
+
This article shows how to (re)create the bootable SD card, from the binary images produced by the DESK-MX-L Yocto build, using a standard SD image flasher like [https://etcher.balena.io/ balenaEtcher]
  
 +
The process is relatively straightforward: it consists of writing the WIC file of interest generated by Yocto onto the SD card.
 +
The following instruction explains how to use ''balenaEtcher'' on a Windows host. The procedure is similar when working with a Linux host.
 +
* download the desired binary image to flash (<code>*.wic</code> or <code>*.wic.bz2</code>) from the [https://mirror.dave.eu/desk-mx-l/ mirror binary server] selecting the proper [[DESK-MXxx-L | DESK-MXxx-L]] release
 +
**among the binaries made available in the [[mirror:desk-mp1-l/| mirror]] there are several <code>*.wic.bz2</code> files for the available releases. In particular, there is the <code>dave-image-devel-desk-mxXXXX.wic.bz2</code> (for {{{nome-som}}}) file. This image is the one used to program the microSD card delivered along with the evaluation kit.
 +
* connect the microSD card to the PC Host
 +
* open balenaEtcher tool
 +
* once the tool is open:
 +
** select the binary to flash by clicking on <code>Flash from file</code>
 +
** select the microSD to flash by clicking on <code>Select target</code>
 +
** flash the uSD by clicking o <code>Flash</code>
  
−
This article shows how to create a bootable microSD for the [[DESK-{{{kit-code}}}-L/General/Release_Notes_(DESK-{{{kit-code}}}-L)|DESK-{{{kit-code}}}-L Release Notes] kit by using a simple bash script. <br>
+
{| class="wikitable" style="text-align: center"
−
'''Note:''' Starting from this release the support for the SPL has been introduced in Uboot. Previous versions of this script will no longer produce a fully functional and bootable microSD card. <br>
+
|[[File:DESK-MP1-L-1.0.0 balenaEtcher unpack.png|center|thumb|200x200px|Unpacking]]
−
+
|[[File:DESK-MP1-L-1.0.0 balenaEtcher flash.png|center|thumb|200x200px|Flashing]]
−
The procedure has been tested on a Linux PC running Ubuntu LTS (>=''TBD'') distribution with
+
|[[File:DESK-MP1-L-1.0.0 balenaEtcher valid.png|center|thumb|200x200px|Validating]]
−
*a 16 GB microSD card [1]
+
|}
−
*the binary files delivered along with the [[Axel_Embedded_Linux_Kit_(XELK)#Downloadable_binary_images|DESK{{{kit-code}}}-L ''1.x.x'']].
 
−
The resulting card is partitioned as depicted [[Axel_Embedded_Linux_Kit_(XELK)#XELK_microSD_Layout|here]].
 
−
 
 
−
The script - named <code>mksd.sh</code> - can be realized with the following code:
 
−
<pre>
 
−
#!/bin/bash
 
−
 
 
−
if [[ -z $1 || -z $2 || -z $3 || -z $4 || -z $5 ]]
 
−
then
 
−
echo "$0 Usage:"
 
−
echo " $0 <device> <u-boot.img> <SPL> <binaries directory> <rootfs tar.bz2>"
 
−
echo " Example: $0 /dev/sdc u-boot.img SPL binaries/ rootfs.tar.bz2"
 
−
exit
 
−
fi
 
−
 
 
−
if [ "$(whoami)" != "root" ]
 
−
then
 
−
echo "you must be root to run this script!"
 
−
exit
 
−
fi
 
−
 
 
−
if ! [[ -b $1 ]]
 
−
then
 
−
echo "$1 is not a valid block device!"
 
−
exit
 
−
fi
 
−
 
 
−
if ! [[ -e $2 ]]
 
−
then
 
−
echo "Incorrect u-boot.img location!"
 
−
exit
 
−
fi
 
−
 
 
−
if ! [[ -e $3 ]]
 
−
then
 
−
echo "Incorrect SPL location!"
 
−
exit
 
−
fi
 
−
 
 
−
if ! [[ -d $4 ]]
 
−
then
 
−
echo "Incorrect Binaries location!"
 
−
exit
 
−
fi
 
−
 
 
−
if ! [[ -f $5 ]]
 
−
then
 
−
echo "Incorrect rootfs location!"
 
−
exit
 
−
fi
 
−
 
 
−
DRIVE=$1
 
−
if [[ "$DRIVE" == *"mmcblk"* ]]
 
−
then
 
−
echo "You're using a mmc device, I need to fix partition names"
 
−
PART="p"
 
−
else
 
−
PART=""
 
−
fi
 
−
UBOOT=$2
 
−
SPL=$3
 
−
BINARIES=$4
 
−
RFS=$5
 
−
 
 
−
echo "All data on "$DRIVE" now will be destroyed! Continue? [y/n]"
 
−
read ans
 
−
if ! [ $ans == 'y' ]
 
−
then
 
−
exit
 
−
fi
 
−
 
 
−
echo "[Partitioning $1...]"
 
−
 
 
−
dd if=/dev/zero of=$DRIVE bs=1024 count=1024
 
−
 
 
−
SIZE=`fdisk -l $DRIVE | grep Disk | awk '{print $5}'`
 
−
 
 
−
echo DISK SIZE - $SIZE bytes
 
−
 
 
−
CYLINDERS=`echo $SIZE/255/63/512 | bc`
 
−
 
 
−
# check if we're running an old (e.g. 2.20.x) or new (e.g. 2.24.x) sfdisk
 
−
sfdisk --help | grep -- -H
 
−
 
 
−
if [ "$?" -eq "0" ]
 
−
then
 
−
{
 
−
echo 40,1380,0x0c,*
 
−
echo 1420,,83,-
 
−
} | sfdisk -D -H 255 -S 63 -C $CYLINDERS $DRIVE
 
−
else
 
−
{
 
−
    echo 16M,8176M,0x0c,*
 
−
    echo 8192M,,83,-
 
−
} | sfdisk $DRIVE
 
−
fi
 
−
 
 
−
partprobe
 
−
 
 
−
 
 
−
echo "[Making filesystems...]"
 
−
mkfs.vfat -F 32 -n BOOT "$DRIVE$PART"1 #> /dev/null
 
−
mkfs.ext3 -F -L ROOTFS "$DRIVE$PART"2 #> /dev/null
 
−
 
 
−
echo "[Copying files...]"
 
−
 
 
−
binaries_dir=${BINARIES%/}
 
−
mount "$DRIVE$PART"1 /mnt
 
−
cp -av --no-preserve=ownership $binaries_dir/* /mnt/
 
−
umount "$DRIVE$PART"1
 
−
 
 
−
echo "[Extracting rfs (this may take a while...)]"
 
−
mount "$DRIVE$PART"2 /mnt
 
−
tar jxf $RFS -C /mnt > /dev/null
 
−
chmod 755 /mnt
 
−
umount "$DRIVE$PART"2
 
−
 
 
−
echo "[Programming SPL]"
 
−
dd if=$SPL of=$DRIVE bs=512 seek=2 conv=fsync
 
−
 
 
−
echo "[Programming u-boot.img]"
 
−
dd if=$UBOOT of=$DRIVE bs=1k seek=69 conv=fsync
 
−
 
 
−
echo "[Done]"
 
−
</pre>
 
−
 
 
−
Here is an example that shows how to use this script. Let's assume that the binary files were downloaded in the <code>desk</code> subdirectory of the working directory. Before invoking the script, the following files has to be renamed in order to make them compatible with the default U-Boot environment variables:
 
−
* bootscript: <code>boot.scr</code>
 
−
* Linux kernel: <code>uImage</code>
 
−
* Device tree blob: <code>''carrier''.dtb</code>.
 
−
 
 
−
This is the list of the binary files that will be used by the script:
 
−
<pre>
 
−
dvdk@vagrant:~/desk-{{{kit}}}$ ls -la
 
−
...
 
−
TBD directory listing
 
−
...
 
−
</pre>
 
−
You can now run the script, by passing the following parameters:
 
−
*Device file of the microSD card (<code>/dev/sdc</code> in the example)
 
−
*U-Boot image
 
−
*SPL
 
−
*Path of the directory containing the bootscript file, the Linux kernel image, and the device tree blob files
 
−
*Archive of the target's root file system (compressed as <code>.tar.bz2</code> file).
 
−
<pre>
 
−
dvdk@vagrant:~/desk-{{{kit}}}$ ./mksd.sh /dev/sd<x> <u-boot.img> <SPL> <binaries_dir>/ <rfs_filename>
 
−
...
 
−
...
 
−
TBD
 
−
...
 
−
...
 
−
</pre>
 
−
 
 
−
 
 
−
[1] In case you have a different size, you'll need to change the <code>sfdisk</code> parameters accordingly.
 
−
 
 
−
===bootscr ===
 
−
 
 
−
Once you got the new binaries compiled from your modified sources, they have to be installed on first SD partition preserving the original file names used into <i>boot.scr</i> u-boot bootscript.
 
−
 
 
−
Here below there is an example on how to create a <code>boot.scr</code> file from the '''bootscript.txt''' for booting from SD card:
 
−
 
 
−
''TBD: bootscript.txt dump''
 
−
 
 
−
<pre>
 
−
echo 'bootscript generated with command "mkimage -A ARM -T script -C none -n AXEL-Lite-DESK-SBCX -d bootscript.txt boot.scr"'
 
−
 
 
−
setenv desk_release 'desk-mx6-l-1.0.0'
 
−
 
 
−
if test 0x${cb_configid#} = 0x00000012;
 
−
then
 
−
if test ${cpu} = 6DL; then
 
−
setenv fdtfile ${desk_release}_imx6dl-sbcx-cb0012.dtb
 
−
else
 
−
setenv fdtfile ${desk_release}_imx6q-sbcx-cb0012.dtb
 
−
fi
 
−
elif test 0x${cb_configid#} = 0x00000013;
 
−
then
 
−
if test ${cpu} = 6DL; then
 
−
setenv fdtfile ${desk_release}_imx6dl-sbcx-cb0013.dtb
 
−
else
 
−
setenv fdtfile ${desk_release}_imx6q-sbcx-cb0013.dtb
 
−
fi
 
−
elif test 0x${cb_configid#} = 0xffffffff;
 
−
then
 
−
if test ${cpu} = 6DL; then
 
−
setenv fdtfile ${desk_release}_imx6dl-desk-l-2.0.0.dtb
 
−
else
 
−
setenv fdtfile ${desk_release}_imx6q-desk-l-2.0.0.dtb
 
−
fi
 
−
else
 
−
    echo Invalid CB! Autoreset ...
 
−
    sleep 30
 
−
reset
 
−
fi
 
−
 
 
−
setenv bootfile ${desk_release}_uImage
 
−
 
 
−
setenv mmc_loadk 'fatload mmc ${mmcdev}:1 ${loadaddr} ${bootfile}'
 
−
setenv mmc_loadfdt 'fatload mmc ${mmcdev}:1 ${fdtaddr} ${fdtfile}'
 
−
 
 
−
echo Booting AxelLite-DESK-SBCX via mmcboot with ${fdtfile} as device tree
 
  
−
run mmcboot
+
=== SD card structure ===
 +
The created SD card has the following structure:
 +
* raw sectors for the bootloader storage: tipically this is a 8MB raw part where storing the bootloader binaries (like <code>imxXXX_flash.bin</code>) for the bootrom startup
 +
* <code>FAT32</code> first partition: this will be mapped to the <code>/dev/mmcblkXp1</code> device in Linux
 +
** usually this partition contains the Linux kernel binary and the device tree blob
 +
** the splash screen image is stored in this partition too for a splash image showing during U-Boot startup
 +
* <code>ext4</code> second partition: this will be mapped to the <code>/dev/mmcblkXp2</code> device in Linux
 +
** this partition contains the Linux ''root file system''
  
−
echo mmcboot FAILURE
+
=== Creating the SD card from binary artifacts ===
−
</pre>
 
  
−
and compile it using:
+
Even if the overall binary artifacts have been created by the Yocto build, it is highly discouraged to manually create the SD card starting from them.
  
−
<pre>
+
The Yocto build take care about the overall binary consistance (like kernel modules and so on) avoiding to mistmatch different version.
−
mkimage -A ARM -T script -C none -n AXEL-Lite-DESK-SBCX -d bootscript.txt boot.scr
 
−
</pre>
 
  
−
Then copy the ''boot.scr'' into the <code><binaries_dir></code> directories used by the script to create the SD card.
+
Moreover, the SD card is intended to be used during the development process and not for the production phase (where other deployment specifications and details have to be taken into account).
  
−
----
+
<section end=Body/>
  
 
[[Category:{{{nome-som}}}]]
 
[[Category:{{{nome-som}}}]]

Revision as of 09:04, 17 January 2024

History
Issue Date Notes

Year/Month/Day

TBD
Year/Month/Day TBD



How to create a bootable SD card[edit source]

This article shows how to (re)create the bootable SD card, from the binary images produced by the DESK-MX-L Yocto build, using a standard SD image flasher like balenaEtcher

The process is relatively straightforward: it consists of writing the WIC file of interest generated by Yocto onto the SD card. The following instruction explains how to use balenaEtcher on a Windows host. The procedure is similar when working with a Linux host.

  • download the desired binary image to flash (*.wic or *.wic.bz2) from the mirror binary server selecting the proper DESK-MXxx-L release
    • among the binaries made available in the mirror there are several *.wic.bz2 files for the available releases. In particular, there is the dave-image-devel-desk-mxXXXX.wic.bz2 (for {{{nome-som}}}) file. This image is the one used to program the microSD card delivered along with the evaluation kit.
  • connect the microSD card to the PC Host
  • open balenaEtcher tool
  • once the tool is open:
    • select the binary to flash by clicking on Flash from file
    • select the microSD to flash by clicking on Select target
    • flash the uSD by clicking o Flash
Unpacking
Flashing
Validating

SD card structure[edit source]

The created SD card has the following structure:

  • raw sectors for the bootloader storage: tipically this is a 8MB raw part where storing the bootloader binaries (like imxXXX_flash.bin) for the bootrom startup
  • FAT32 first partition: this will be mapped to the /dev/mmcblkXp1 device in Linux
    • usually this partition contains the Linux kernel binary and the device tree blob
    • the splash screen image is stored in this partition too for a splash image showing during U-Boot startup
  • ext4 second partition: this will be mapped to the /dev/mmcblkXp2 device in Linux
    • this partition contains the Linux root file system

Creating the SD card from binary artifacts[edit source]

Even if the overall binary artifacts have been created by the Yocto build, it is highly discouraged to manually create the SD card starting from them.

The Yocto build take care about the overall binary consistance (like kernel modules and so on) avoiding to mistmatch different version.

Moreover, the SD card is intended to be used during the development process and not for the production phase (where other deployment specifications and details have to be taken into account).


[[Category:{{{nome-som}}}]]

Retrieved from "https://wiki.dave.eu/index.php?title=Template:How_to_create_a_bootable_SD_card&oldid=19829"