Upload tools/cmm-os-mem-config.sh

sdk/tools/cmm-os-mem-config.sh

@@ -0,0 +1,404 @@
+#!/bin/sh
+# Extend the AX650 OS MEM and CMM memory layout.
+# Changes to U-Boot bootargs take effect only after a reboot.
+
+set -u
+
+MIN_OS_MEM_MIB=512
+BACKUP_FILE=/root/cmm-os-mem-config.bootargs.bak
+AUTO_LOAD_SCRIPT=/soc/scripts/auto_load_all_drv.sh
+AUTO_LOAD_BACKUP_FILE=/root/cmm-os-mem-config.auto_load_all_drv.sh.bak
+FW_ENV_CONFIG_FILE=/etc/fw_env.config
+FW_ENV_CONFIG_BACKUP_FILE=/root/cmm-os-mem-config.fw_env.config.bak
+FW_ENV_CONFIG_LINE='/dev/mmcblk0p3 0x0000 0x20000 0x100'
+LINUX_PHYS_BASE_MIB=4096
+EXPANDED_TOTAL_MIB=8192
+LEGACY_REPORTED_TOTAL_MIB=6144
+MODE=
+TARGET_MIB=
+TOTAL_OVERRIDE_MIB=
+ASSUME_YES=0
+INIT_FW_ENV=0
+ALLOW_FW_ENV_INIT=0
+EXPANDED_LAYOUT_DETECTED=0
+
+die() {
+    printf 'Error: %s\n' "$*" >&2
+    exit 1
+}
+
+usage() {
+    cat <<'EOF'
+Usage:
+  cmm-os-mem-config.sh                     Extend memory interactively
+  cmm-os-mem-config.sh --show               Show the current split
+  cmm-os-mem-config.sh --os-mem MiB [opts]  Set OS MEM
+  cmm-os-mem-config.sh --cmm MiB [opts]     Set CMM
+  cmm-os-mem-config.sh --init-fw-env        Initialize fw_env.config for this board
+
+Options:
+  --total-mem MiB  Specify total physical memory when auto-detection fails
+  --init-fw-env    Create or replace /etc/fw_env.config with the board default
+  --yes            Skip confirmations; valid only with a write or init option
+  -h, --help       Show this help text
+
+Examples:
+  cmm-os-mem-config.sh --show
+  cmm-os-mem-config.sh --init-fw-env
+  cmm-os-mem-config.sh --cmm 4096
+  cmm-os-mem-config.sh --os-mem 6144 --yes
+  cmm-os-mem-config.sh --cmm 4096 --total-mem 8192
+
+OS MEM maps to the mem= bootargs value.
+CMM maps to the ax_cmm.ko cmmpool value in /soc/scripts/auto_load_all_drv.sh.
+After a successful write, run reboot manually. This script never reboots automatically.
+EOF
+}
+
+is_nonnegative_integer() {
+    case "$1" in
+        ''|*[!0-9]*) return 1 ;;
+        *) return 0 ;;
+    esac
+}
+
+read_bootargs() {
+    command -v fw_printenv >/dev/null 2>&1 || die 'fw_printenv was not found, please install libubootenv-tool'
+    if ! BOOTARGS=$(fw_printenv -n bootargs 2>&1); then
+        FW_PRINTENV_ERROR=$BOOTARGS
+        if [ "$INIT_FW_ENV" -eq 1 ] || [ "$ALLOW_FW_ENV_INIT" -eq 1 ]; then
+            init_fw_env_config
+            BOOTARGS=$(fw_printenv -n bootargs 2>/dev/null) || die 'Failed to read U-Boot bootargs after initializing /etc/fw_env.config.'
+        else
+            explain_bootargs_read_failure "$FW_PRINTENV_ERROR"
+            exit 1
+        fi
+    fi
+    CURRENT_OS_MIB=$(printf '%s\n' "$BOOTARGS" | sed -n 's/.*mem=\([0-9][0-9]*\)M.*/\1/p')
+    is_nonnegative_integer "$CURRENT_OS_MIB" || die 'No valid mem=<MiB>M parameter was found in bootargs.'
+}
+
+explain_bootargs_read_failure() {
+    printf 'Error: Failed to read U-Boot bootargs.\n' >&2
+    if [ -n "$1" ]; then
+        printf 'fw_printenv output: %s\n' "$1" >&2
+    fi
+    if [ ! -s "$FW_ENV_CONFIG_FILE" ]; then
+        printf '%s is missing or empty.\n' "$FW_ENV_CONFIG_FILE" >&2
+    elif grep -Fqx "$FW_ENV_CONFIG_LINE" "$FW_ENV_CONFIG_FILE"; then
+        printf '%s already contains the expected board default, but fw_printenv still failed.\n' "$FW_ENV_CONFIG_FILE" >&2
+    else
+        printf '%s exists but does not contain the expected board default.\n' "$FW_ENV_CONFIG_FILE" >&2
+    fi
+    printf 'This board usually needs:\n  %s\n' "$FW_ENV_CONFIG_LINE" >&2
+    printf 'Run this script with --init-fw-env to create it, or update %s manually.\n' "$FW_ENV_CONFIG_FILE" >&2
+}
+
+confirm_fw_env_init() {
+    if [ "$ASSUME_YES" -eq 1 ]; then
+        return
+    fi
+
+    [ -t 0 ] || die 'Cannot initialize /etc/fw_env.config without a terminal. Re-run with --init-fw-env --yes.'
+    printf 'Initialize %s with "%s"? [y/N] ' "$FW_ENV_CONFIG_FILE" "$FW_ENV_CONFIG_LINE"
+    read -r ANSWER || exit 1
+    case "$ANSWER" in
+        y|Y|yes|YES) ;;
+        *) printf 'Cancelled. No configuration was changed.\n'; exit 0 ;;
+    esac
+}
+
+init_fw_env_config() {
+    [ -b /dev/mmcblk0p3 ] || die 'Expected block device /dev/mmcblk0p3 was not found.'
+
+    if [ -s "$FW_ENV_CONFIG_FILE" ] && grep -Fqx "$FW_ENV_CONFIG_LINE" "$FW_ENV_CONFIG_FILE"; then
+        printf '%s already contains the board default.\n' "$FW_ENV_CONFIG_FILE"
+        return
+    fi
+
+    if [ -e "$FW_ENV_CONFIG_FILE" ]; then
+        printf '%s exists and will be backed up to %s before replacement.\n' "$FW_ENV_CONFIG_FILE" "$FW_ENV_CONFIG_BACKUP_FILE"
+    fi
+    confirm_fw_env_init
+
+    umask 077
+    if [ -e "$FW_ENV_CONFIG_FILE" ]; then
+        cp -p "$FW_ENV_CONFIG_FILE" "$FW_ENV_CONFIG_BACKUP_FILE" || die "Cannot back up ${FW_ENV_CONFIG_FILE}."
+    fi
+    printf '%s\n' "$FW_ENV_CONFIG_LINE" > "${FW_ENV_CONFIG_FILE}.tmp" || die "Cannot create ${FW_ENV_CONFIG_FILE}.tmp."
+    chmod 0644 "${FW_ENV_CONFIG_FILE}.tmp" || die "Cannot chmod ${FW_ENV_CONFIG_FILE}.tmp."
+    mv "${FW_ENV_CONFIG_FILE}.tmp" "$FW_ENV_CONFIG_FILE" || die "Cannot save ${FW_ENV_CONFIG_FILE}."
+    sync
+
+    printf 'Initialized %s.\n' "$FW_ENV_CONFIG_FILE"
+}
+
+read_current_cmm() {
+    CURRENT_CMM_MIB=
+    CURRENT_AUTO_LOAD_CMM_BASE=
+    CURRENT_AUTO_LOAD_CMM_MIB=
+
+    if [ -r "$AUTO_LOAD_SCRIPT" ]; then
+        CURRENT_AUTO_LOAD_CMM_BASE=$(sed -n 's/.*cmmpool=anonymous,0,\(0x[0-9A-Fa-f][0-9A-Fa-f]*\),[0-9][0-9]*M.*/\1/p' "$AUTO_LOAD_SCRIPT" | sed -n '1p')
+        CURRENT_AUTO_LOAD_CMM_MIB=$(sed -n 's/.*cmmpool=anonymous,0,0x[0-9A-Fa-f][0-9A-Fa-f]*,\([0-9][0-9]*\)M.*/\1/p' "$AUTO_LOAD_SCRIPT" | sed -n '1p')
+    fi
+
+    if is_nonnegative_integer "$CURRENT_AUTO_LOAD_CMM_MIB"; then
+        CURRENT_CMM_MIB=$CURRENT_AUTO_LOAD_CMM_MIB
+    elif [ -r /proc/ax_proc/mem_cmm_info ]; then
+        CURRENT_CMM_MIB=$(sed -n 's/.*Size=[0-9][0-9]*KB(\([0-9][0-9]*\)MB).*/\1/p' /proc/ax_proc/mem_cmm_info | awk '{sum += $1} END {if (NR > 0) print sum}')
+    fi
+}
+
+cmm_base_for_os_mib() {
+    printf '0x%X\n' $(((LINUX_PHYS_BASE_MIB + $1) * 1024 * 1024))
+}
+
+detect_expanded_memory_layout() {
+    EXPANDED_LAYOUT_DETECTED=0
+    if is_nonnegative_integer "$CURRENT_CMM_MIB"; then
+        CURRENT_REPORTED_TOTAL_MIB=$((CURRENT_OS_MIB + CURRENT_CMM_MIB))
+        if [ "$CURRENT_REPORTED_TOTAL_MIB" -eq "$LEGACY_REPORTED_TOTAL_MIB" ]; then
+            EXPANDED_LAYOUT_DETECTED=1
+        fi
+    fi
+}
+
+determine_total_memory() {
+    if [ "$EXPANDED_LAYOUT_DETECTED" -eq 1 ]; then
+        if [ -n "$TOTAL_OVERRIDE_MIB" ] && [ "$TOTAL_OVERRIDE_MIB" -ne "$EXPANDED_TOTAL_MIB" ]; then
+            die "This memory layout requires --total-mem ${EXPANDED_TOTAL_MIB} or omitted."
+        fi
+        TOTAL_MIB=$EXPANDED_TOTAL_MIB
+        return
+    fi
+
+    if [ -n "$TOTAL_OVERRIDE_MIB" ]; then
+        TOTAL_MIB=$TOTAL_OVERRIDE_MIB
+        return
+    fi
+
+    if is_nonnegative_integer "$CURRENT_CMM_MIB"; then
+        TOTAL_MIB=$((CURRENT_OS_MIB + CURRENT_CMM_MIB))
+        return
+    fi
+
+    die 'Unable to detect total physical memory. Add --total-mem MiB, for example --total-mem 8192.'
+}
+
+show_status() {
+    printf 'Current OS MEM: %s MiB\n' "$CURRENT_OS_MIB"
+    if is_nonnegative_integer "$CURRENT_CMM_MIB"; then
+        printf 'Current CMM: %s MiB\n' "$CURRENT_CMM_MIB"
+    else
+        printf 'Current CMM: unavailable from /proc/ax_proc/mem_cmm_info\n'
+    fi
+    if [ -n "$CURRENT_AUTO_LOAD_CMM_BASE" ]; then
+        printf 'Current CMM base in auto_load script: %s\n' "$CURRENT_AUTO_LOAD_CMM_BASE"
+    fi
+    if [ -n "${TOTAL_MIB:-}" ]; then
+        printf 'Total physical memory: %s MiB\n' "$TOTAL_MIB"
+    fi
+}
+
+confirm_write() {
+    if [ "$ASSUME_YES" -eq 1 ]; then
+        return
+    fi
+
+    printf 'Set OS MEM=%s MiB and CMM=%s MiB; changes apply after reboot. Continue? [y/N] ' "$NEW_OS_MIB" "$NEW_CMM_MIB"
+    read -r ANSWER || exit 1
+    case "$ANSWER" in
+        y|Y|yes|YES) ;;
+        *) printf 'Cancelled. No configuration was changed.\n'; exit 0 ;;
+    esac
+}
+
+confirm_total_memory() {
+    if [ "$ASSUME_YES" -eq 1 ]; then
+        return
+    fi
+
+    if [ "$EXPANDED_LAYOUT_DETECTED" -eq 1 ]; then
+        return
+    fi
+
+    printf 'Detected total physical memory: %s MiB. Continue with this value? [y/N] ' "$TOTAL_MIB"
+    read -r ANSWER || exit 1
+    case "$ANSWER" in
+        y|Y|yes|YES) ;;
+        *) printf 'Cancelled. No configuration was changed.\n'; exit 0 ;;
+    esac
+}
+
+check_write_targets() {
+    command -v fw_setenv >/dev/null 2>&1 || die 'fw_setenv was not found.'
+    [ -r "$AUTO_LOAD_SCRIPT" ] || die "${AUTO_LOAD_SCRIPT} was not found or is not readable."
+    [ -w "$AUTO_LOAD_SCRIPT" ] || die "${AUTO_LOAD_SCRIPT} is not writable."
+    AUTO_LOAD_CMM_FOUND=$(sed -n 's/.*cmmpool=anonymous,0,0x[0-9A-Fa-f][0-9A-Fa-f]*,[0-9][0-9]*M.*/yes/p' "$AUTO_LOAD_SCRIPT" | sed -n '1p')
+    [ -n "$AUTO_LOAD_CMM_FOUND" ] || die "No ax_cmm.ko cmmpool parameter was found in ${AUTO_LOAD_SCRIPT}."
+}
+
+prepare_auto_load_config() {
+    [ -r "$AUTO_LOAD_SCRIPT" ] || die "${AUTO_LOAD_SCRIPT} was not found or is not readable."
+    [ -w "$AUTO_LOAD_SCRIPT" ] || die "${AUTO_LOAD_SCRIPT} is not writable."
+
+    AUTO_LOAD_TMP_FILE="${AUTO_LOAD_SCRIPT}.tmp"
+    sed "s/cmmpool=anonymous,0,0x[0-9A-Fa-f][0-9A-Fa-f]*,[0-9][0-9]*M/cmmpool=anonymous,0,${NEW_CMM_BASE},${NEW_CMM_MIB}M/" "$AUTO_LOAD_SCRIPT" > "$AUTO_LOAD_TMP_FILE" || die "Cannot create ${AUTO_LOAD_TMP_FILE}."
+    if cmp -s "$AUTO_LOAD_SCRIPT" "$AUTO_LOAD_TMP_FILE"; then
+        die "No ax_cmm.ko cmmpool parameter was found in ${AUTO_LOAD_SCRIPT}."
+    fi
+    chmod 0755 "$AUTO_LOAD_TMP_FILE" || die "Cannot chmod ${AUTO_LOAD_TMP_FILE}."
+}
+
+write_config() {
+    NEW_BOOTARGS=$(printf '%s\n' "$BOOTARGS" | sed "s/mem=[0-9][0-9]*M/mem=${NEW_OS_MIB}M/")
+    [ "$NEW_BOOTARGS" != "$BOOTARGS" ] || die 'Failed to replace the mem= parameter in bootargs.'
+    NEW_CMM_BASE=$(cmm_base_for_os_mib "$NEW_OS_MIB")
+    prepare_auto_load_config
+
+    umask 077
+    printf '%s\n' "$BOOTARGS" > "${BACKUP_FILE}.tmp" || die "Cannot create ${BACKUP_FILE}."
+    mv "${BACKUP_FILE}.tmp" "$BACKUP_FILE" || die "Cannot save ${BACKUP_FILE}."
+    cp -p "$AUTO_LOAD_SCRIPT" "$AUTO_LOAD_BACKUP_FILE" || die "Cannot back up ${AUTO_LOAD_SCRIPT}."
+    fw_setenv bootargs "$NEW_BOOTARGS" || die 'Failed to write U-Boot bootargs.'
+    mv "$AUTO_LOAD_TMP_FILE" "$AUTO_LOAD_SCRIPT" || die "Cannot save ${AUTO_LOAD_SCRIPT}."
+    sync
+
+    printf 'Configuration was written to the U-Boot environment and auto_load script.\n'
+    printf 'OS MEM: %s MiB; CMM: %s MiB; CMM base: %s.\n' "$NEW_OS_MIB" "$NEW_CMM_MIB" "$NEW_CMM_BASE"
+    printf 'Original bootargs backup: %s\n' "$BACKUP_FILE"
+    printf 'Original auto_load script backup: %s\n' "$AUTO_LOAD_BACKUP_FILE"
+    printf 'Run reboot to apply the new memory split.\n'
+}
+
+parse_args() {
+    while [ "$#" -gt 0 ]; do
+        case "$1" in
+            --show)
+                [ -z "$MODE" ] || die '--show cannot be combined with a set option.'
+                MODE=show
+                ;;
+            --os-mem)
+                [ "$#" -ge 2 ] || die '--os-mem requires a MiB value.'
+                [ -z "$MODE" ] || die 'Choose either --os-mem or --cmm, not both.'
+                MODE=os
+                TARGET_MIB=$2
+                shift
+                ;;
+            --cmm)
+                [ "$#" -ge 2 ] || die '--cmm requires a MiB value.'
+                [ -z "$MODE" ] || die 'Choose either --os-mem or --cmm, not both.'
+                MODE=cmm
+                TARGET_MIB=$2
+                shift
+                ;;
+            --total-mem)
+                [ "$#" -ge 2 ] || die '--total-mem requires a MiB value.'
+                TOTAL_OVERRIDE_MIB=$2
+                shift
+                ;;
+            --init-fw-env)
+                INIT_FW_ENV=1
+                ;;
+            --yes)
+                ASSUME_YES=1
+                ;;
+            -h|--help)
+                usage
+                exit 0
+                ;;
+            *)
+                die "Unknown option: $1"
+                ;;
+        esac
+        shift
+    done
+}
+
+choose_interactively() {
+    [ -t 0 ] || die 'Use --os-mem or --cmm in a non-interactive environment.'
+    show_status
+    printf '\nSelect the value to change:\n  1) OS MEM\n  2) CMM\n  q) Quit\n> '
+    read -r CHOICE || exit 1
+    case "$CHOICE" in
+        1)
+            MODE=os
+            printf 'Enter OS MEM in MiB: '
+            read -r TARGET_MIB || exit 1
+            ;;
+        2)
+            MODE=cmm
+            printf 'Enter CMM in MiB: '
+            read -r TARGET_MIB || exit 1
+            ;;
+        q|Q)
+            exit 0
+            ;;
+        *)
+            die 'Invalid selection.'
+            ;;
+    esac
+}
+
+main() {
+    parse_args "$@"
+    if [ "$ASSUME_YES" -eq 1 ] && [ "$MODE" != os ] && [ "$MODE" != cmm ] && [ "$INIT_FW_ENV" -ne 1 ]; then
+        die '--yes is valid only with --os-mem, --cmm, or --init-fw-env.'
+    fi
+    is_nonnegative_integer "$TOTAL_OVERRIDE_MIB" || [ -z "$TOTAL_OVERRIDE_MIB" ] || die '--total-mem must be an integer MiB value.'
+    if [ -z "$MODE" ] && [ "$INIT_FW_ENV" -eq 1 ]; then
+        MODE=init
+    fi
+    if [ -z "$MODE" ] && [ -t 0 ]; then
+        ALLOW_FW_ENV_INIT=1
+    fi
+
+    [ "$(id -u)" -eq 0 ] || die 'Run this script as root.'
+    read_bootargs
+
+    if [ "$MODE" = init ]; then
+        printf 'U-Boot bootargs can be read successfully. No memory split was changed.\n'
+        exit 0
+    fi
+
+    read_current_cmm
+    detect_expanded_memory_layout
+    determine_total_memory
+
+    if [ "$MODE" = show ]; then
+        show_status
+        exit 0
+    fi
+
+    if [ -z "$MODE" ]; then
+        choose_interactively
+    fi
+
+    is_nonnegative_integer "$TARGET_MIB" || die 'The memory size must be an integer MiB value.'
+    case "$MODE" in
+        os)
+            NEW_OS_MIB=$TARGET_MIB
+            NEW_CMM_MIB=$((TOTAL_MIB - NEW_OS_MIB))
+            ;;
+        cmm)
+            NEW_CMM_MIB=$TARGET_MIB
+            NEW_OS_MIB=$((TOTAL_MIB - NEW_CMM_MIB))
+            ;;
+        *)
+            die 'Internal mode error.'
+            ;;
+    esac
+
+    [ "$TOTAL_MIB" -gt "$MIN_OS_MEM_MIB" ] || die "Total memory must exceed ${MIN_OS_MEM_MIB} MiB."
+    [ "$NEW_OS_MIB" -ge "$MIN_OS_MEM_MIB" ] || die "OS MEM must be at least ${MIN_OS_MEM_MIB} MiB."
+    [ "$NEW_CMM_MIB" -ge 1 ] || die 'CMM must retain at least 1 MiB.'
+    [ "$NEW_OS_MIB" -lt "$TOTAL_MIB" ] || die 'OS MEM must be smaller than total physical memory.'
+
+    check_write_targets
+    confirm_total_memory
+    confirm_write
+    write_config
+}
+
+main "$@"