Merge pull request #45 from TexasInstruments/create-wic

create-wic: Add a script to create SD Card image

README.md

@@ -78,20 +78,43 @@ The output will be generated at `build/`. The log file will be
 
 ## Flashing Image to SD Card
 
-To flash the image to the SD card, use the `create-sdcard.sh` script.
+If you just want to flash the built image to the SD card, use the
+`create-sdcard.sh` script.
 Syntax:
 
 ```bash
 sudo ./create-sdcard.sh <build>
 ```
 
-Continuing the example above, if you built `am62-bookworm-09.01.00.008`, type:
+Continuing the example above, if you've built `am62-bookworm-09.01.00.008`, type:
 
 ```bash
 sudo ./create-sdcard.sh am62-bookworm-09.01.00.008
 ```
 
 This command will flash `am62-bookworm-09.01.00.008` image to the SD card.
 
-Following the above, you should have a basic Debian system set up. 
+Following the above, you should have a basic Debian SD Card set up.
+
+## Creating SD Card Image
+
+To create a shareable SD card Image to flash with tools like balena-etcher, use
+`create-wic.sh` script.
+Syntax:
+
+```bash
+sudo ./create-wic.sh <build>
+```
+
+This command will generate a `tisdk-debian-bookworm-<machine>.wic.xz` image at
+`<ti-bdebstrap>/build/<build>/`
+
+Continuing the example above, if you've built `am62-bookworm-09.01.00.008`, type:
+
+```bash
+sudo ./create-wic.sh am62-bookworm-09.01.00.008
+```
+
+This command will generate a `tisdk-debian-bookworm-am62xx-evm.wic.xz` image at
+ `<ti-bdebstrap>/build/am62-bookworm-09.01.00.008/`
 

create-wic.sh

@@ -0,0 +1,168 @@
+#!/bin/bash
+#!/bin/bash
+# Authors:
+#    Sai Sree Kartheek Adivi <[email protected]>
+#    LT Thomas <[email protected]>
+#    Chase Maupin
+#    Franklin Cooper Jr.
+#
+# create-img.sh v0.1
+
+# This distribution contains contributions or derivatives under copyright
+# as follows:
+#
+# Copyright (c) 2024, Texas Instruments Incorporated
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# - Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# - Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+# - Neither the name of Texas Instruments nor the names of its
+#   contributors may be used to endorse or promote products derived
+#   from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# Force locale language to be set to English. This avoids issues when doing
+# text and string processing.
+export LANG=C
+
+# Determine the absolute path to the executable
+# EXE will have the PWD removed so we can concatenate with the PWD safely
+PWD=`pwd`
+EXE=`echo $0 | sed s=$PWD==`
+EXEPATH="$PWD"/"$EXE"
+clear
+
+export topdir=$(git rev-parse --show-toplevel)
+
+BUILD=$1
+BUILDPATH=${topdir}/build/
+
+cat << EOM
+
+################################################################################
+
+This script will create a flashable/bootable SD card image from the built
+binaries.
+
+The script must be run with root permissions and from the bin directory of
+the SDK
+
+Usage:
+ $ sudo ./create-wic.sh <build-id>
+
+################################################################################
+
+EOM
+
+AMIROOT=`whoami | awk {'print $1'}`
+if [ "$AMIROOT" != "root" ] ; then
+
+	echo "	**** Error *** must run script with sudo"
+	echo ""
+	exit
+fi
+
+source ${topdir}/scripts/common.sh
+
+validate_section "Build" ${BUILD} "${topdir}/builds.toml"
+machine=($(read_build_config ${BUILD} machine))
+bsp_version=($(read_build_config ${BUILD} bsp_version))
+distro_variant=($(read_build_config ${BUILD} distro_variant))
+
+if [[ $bsp_version == *"-rt"* ]]; then
+    IMAGE=tisdk-debian-bookworm-rt-${machine}.wic
+else
+    IMAGE=tisdk-debian-bookworm-${machine}.wic
+fi
+
+echo "Creating an empty image"
+dd if=/dev/zero of=${BUILDPATH}/${BUILD}/${IMAGE} count=6291456 status=progress
+sync ; sync
+
+cat << END | fdisk ${BUILDPATH}/${BUILD}/${IMAGE}
+o
+n
+p
+
+
++128M
+t
+c
+a
+n
+p
+
+
+
+w
+END
+
+echo "Mount the image"
+LOOPDEV=$(losetup -fP ${BUILDPATH}/${BUILD}/${IMAGE} --show)
+
+echo "Partitioning Boot"
+mkfs.fat -F32 -a -v -I -n "BOOT" ${LOOPDEV}p1
+
+echo "Partitioning RootFS"
+mkfs.ext3 -F -L "rootfs" ${LOOPDEV}p2
+
+echo "Mounting Boot Paritition"
+mkdir -p ${BUILDPATH}/${BUILD}/temp/ ; cd ${BUILDPATH}/${BUILD}/temp/
+mkdir img_boot
+mount ${LOOPDEV}p1 ./img_boot
+
+echo "Copy Boot Partition files"
+cd ./img_boot
+tar -xf ${BUILDPATH}/${BUILD}/tisdk-${distro_variant}-${machine}-boot.tar.xz
+mv tisdk-${distro_variant}-${machine}-boot/* ./
+rmdir tisdk-${distro_variant}-${machine}-boot
+
+echo "Sync and Unmount Boot Partition"
+cd ${BUILDPATH}/${BUILD}/temp/
+sync ; sync
+umount ./img_boot ; rmdir ./img_boot
+
+echo "Mounting RootFS Paritition"
+mkdir -p ${BUILDPATH}/${BUILD}/temp/ ; cd ${BUILDPATH}/${BUILD}/temp/
+mkdir img_rootfs
+mount ${LOOPDEV}p2 ./img_rootfs
+
+echo "Copy RootFS Partition files"
+cd ./img_rootfs
+tar -xf ${BUILDPATH}/${BUILD}/tisdk-${distro_variant}-${machine}-rootfs.tar.xz
+mv tisdk-${distro_variant}-${machine}-rootfs/* ./
+rmdir tisdk-${distro_variant}-${machine}-rootfs
+
+echo "Sync and Unmount RootFS Partition"
+cd ${BUILDPATH}/${BUILD}/temp/
+sync ; sync
+umount ./img_rootfs ; rmdir ./img_rootfs
+
+echo "Unmount the image"
+losetup -d ${LOOPDEV}
+
+echo "Compress the image"
+cd ${BUILDPATH}/${BUILD}/
+xz -T 0 ${IMAGE}
+
+echo "Cleanup"
+rm -rf ${BUILDPATH}/${BUILD}/temp
+
+echo "Done"