#!/bin/bash

################################################################################
# Copyright 2026 ModalAI Inc.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
#    this list of conditions and the following disclaimer.
#
# 2. 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.
#
# 3. Neither the name of the copyright holder nor the names of its contributors
#    may be used to endorse or promote products derived from this software
#    without specific prior written permission.
#
# 4. The Software is licensed to be used solely in conjunction with devices
#    provided by ModalAI Inc.
#
# 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.
################################################################################


# This is the new hardware variant method based on a kernel module introduced in
# system image 1.7.4 as part of an effort to use the same rootfs across all
# hardware platforms.

FILE="/sys/module/voxl_platform_mod/parameters/variant"
SHOW_DESCRIPTION=false

print_usage () {

    echo ""
    echo "This tool displays the kernel variant currently running."
    echo ""
    echo "Typical usage to print variant id:"
    echo "    voxl-variant"
    echo ""
    echo "To print a human-readable description of this variant:"
    echo "    voxl-variant -d"
    echo "    voxl-variant --description"
    echo ""
    echo "To print this help message:"
    echo "    voxl-variant -h"
    echo "    voxl-variant --help"
    echo ""
}

case $1 in
    "")
        ;;
    "h"|"-h"|"help"|"--help")
        print_usage
        exit 0
        ;;
    "d"|"-d"|"--description"|"description")
        SHOW_DESCRIPTION=true
        ;;
    *)
        echo "invalid option $arg"
        print_usage
        exit 1
esac


# If on an old system image assume we are running the old default kernel
if ! [ -f "$FILE" ]; then
    if $SHOW_DESCRIPTION; then
        echo "default"
    else
        echo "0"
    fi
    exit 0
fi

# simple mode, no need to print description
if ! $SHOW_DESCRIPTION; then
    cat $FILE
    exit 0
fi


# now we need to figure out description based on variant.
# TODO this might need to query /sys/module/voxl_platform_mod/parameters/machine
# in the future as we add more variants

variant=$(cat "$FILE")
if [[ $variant == 0 ]]; then
    echo "default"
    exit 0
elif [[ $variant == 1 ]]; then
    echo "no combo mode J6/J8"
    exit 0
elif [[ $variant == 2 ]]; then
    echo "QSM8250"
    exit 0
fi


echo "ERROR unknown variant type: $variant"
exit 1

