tlp

#!/bin/sh
# tlp - adjust power settings
#
# Copyright (c) 2024 Thomas Koch <linrunner at gmx.net> and others.
# SPDX-License-Identifier: GPL-2.0-or-later

# --- Source libraries

for lib in /usr/local/share/tlp/tlp-func-base /usr/local/share/tlp/func.d/[0-9][0-9]*; do
    # shellcheck disable=SC1090
    . "$lib" || exit 70
done

# --- Constants

# --- Subroutines

apply_common_settings () { # apply settings common to all modes
                           # $1: 0=ac mode, 1=battery mode
    set_laptopmode "$1"
    set_dirty_parms "$1"
    set_platform_profile "$1"
    set_cpu_driver_opmode "$1"
    set_cpu_scaling_governor "$1"
    set_cpu_scaling_min_max_freq "$1"
    set_intel_cpu_perf_pct "$1"
    set_cpu_boost_all "$1"
    set_cpu_dyn_boost "$1"
    set_cpu_perf_policy "$1"
    set_nmi_watchdog
    set_mem_sleep "$1"
    set_ahci_port_runtime_pm "$1"
    set_runtime_pm "$1"
    set_ahci_disk_runtime_pm "$1"
    set_sata_link_power "$1"
    set_disk_apm_level "$1"
    set_disk_spindown_timeout "$1"
    set_disk_iosched
    set_pcie_aspm "$1"
    set_intel_gpu_min_max_boost_freq "$1"
    set_amdgpu_profile "$1"
    set_abm_level "$1"
    set_wifi_power_mode "$1"
    disable_wake_on_lan
    set_sound_power_mode "$1"

    return 0
}

apply_suspend_settings () { # apply settings before suspending

    set_ahci_port_runtime_pm "2"
    set_ahci_disk_runtime_pm "2"
    set_pcie_aspm "2"

    return 0
}

show_usage () {
    echo "Usage: tlp start|true|bat|false|ac|usb|bayoff|chargeonce|discharge|setcharge|fullcharge|recalibrate|diskid" 1>&2
}

parse_args () { # parse command-line arguments
    # $@:       arguments to parse
    # retval:   $_cmd:  command;
    #           $_cmd2: subcommand;
    #           $_carg1,
    #           $_carg2,
    #           $_carg3: command arguments

    # parsing control: 'nil' means that the element is still expected
    _cmd="nil"
    _cmd2="nil"
    _carg1="nil"
    _carg2="nil"
    _carg3="nil"

    # iterate arguments until exhausted or delimiter '--' reached
    while [ $# -gt 0 ]; do
        if [ "$1" = "--" ]; then
            break;

        elif [ "$_cmd" = "nil" ]; then
            # command
            case "$1" in
                ac|auto|bat|bayoff|false|diskid|resume|suspend|start|true|usb)
                    # commands without further arguments
                    _cmd="$1"
                    _cmd2=""
                    _carg1=""
                    _carg2=""
                    _carg3=""
                    ;;

                chargeonce|discharge|fullcharge|recalibrate)
                    # commands with one or no arguments
                    _cmd="$1"
                    _cmd2=""
                    _carg2=""
                    _carg3=""
                    ;;

                setcharge)
                    # command with up to three arguments
                    _cmd="$1"
                    _cmd2=""
                    ;;

                init)
                    # command with subcommand and no arguments
                    _cmd="$1"
                    _carg1=""
                    _carg2=""
                    _carg3=""
                    ;;

                stat)
                    # unsupported command
                    echo "Error: 'tlp stat' no longer supported, use 'tlp-stat' instead."  1>&2
                    do_exit 3
                    ;;

                noop)
                    # no operation
                    _cmd="$1"
                    _cmd2=""
                    ;;

                --version)
                    # no operation
                    _cmd="version"
                    _cmd2=""
                    ;;

                *)
                    # unknown command
                    echo "Error: unknown command \"$1\"."  1>&2
                    show_usage
                    do_exit 3
                    ;;
            esac

        elif [ "$_cmd2" = "nil" ]; then
            # subcommand
            case "$1" in
                start|stop|restart|force-reload)
                    _cmd2="$1"
                    ;;

                *) # unknown subcommand
                    echo "Usage: tlp init {start|stop|restart|force-reload}" >&2
                    do_exit 3
                    ;;
            esac

        elif [ "$_carg1" = "nil" ]; then
            # first command argument
            _carg1="$1"

        elif [ "$_carg2" = "nil" ]; then
            # second command argument
            _carg2="$1"

        elif [ "$_carg3" = "nil" ]; then
            # third command argument
            _carg3="$1"

        fi

        shift # next argument
    done # while arguments

    if  [ "$_cmd" = "nil" ]; then
        # no command parsed
        show_usage
        do_exit 3
    fi

    # clear missing arguments
    [ "$_carg1" = "nil" ] && _carg1=""
    [ "$_carg2" = "nil" ] && _carg2=""
    [ "$_carg3" = "nil" ] && _carg3=""

    return 0
}

# --- MAIN
parse_args "$@"

if [ "$_cmd" = "version" ]; then
    print_version
    exit 0
fi

# read configuration: quit on error, trace allowed
read_config 1 0
parse_args4config "$@"

check_tlp_enabled 1 || do_exit 1
add_sbin2path

check_laptop_mode_tools

if [ -z "$_cmd2" ]; then
    echo_debug "run" "+++ $_cmd ($TLPVER) ++++++++++++++++++++++++++++++++++++++++"
else
    echo_debug "run" "+++ $_cmd $_cmd2 ($TLPVER) ++++++++++++++++++++++++++++++++++++++++"
fi

# shellcheck disable=SC2154
if [ -n "$_addpath" ]; then
    # shellcheck disable=SC2154
    echo_debug "path" "PATH=${_oldpath}[${_addpath}]"
else
    # shellcheck disable=SC2154
    echo_debug "path" "PATH=${_oldpath}"
fi
echo_debug "run" "SHELL=$(print_shell); umask=$(umask)"

# get current power state
get_power_mode "$_cmd"; pwrmode=$?
get_manual_mode

# determine new power state
case "$_cmd" in
    init|start)
        # discard manual mode
        clear_manual_mode
        ;;

    auto|resume)
        # if manual mode is set, use instead of current power state
        # shellcheck disable=SC2154
        case $_manual_mode in
            0|1) pwrmode="$_manual_mode" ;;
        esac
        ;;

    true|bat)
        pwrmode=1
        set_manual_mode 1
        ;;

    false|ac)
        pwrmode=0
        set_manual_mode 0
        ;;
esac

# shellcheck disable=SC2154
case "$_syspwr" in
    0) echo_debug "run" "power_source=ac" ;;
    1) echo_debug "run" "power_source=bat" ;;
    *) echo_debug "run" "power_source=unknown ($_syspwr)" ;;
esac

echo_debug "run" "manual_mode=$_manual_mode"

case "$pwrmode" in
    0) echo_debug "run" "power_mode=ac" ;;
    1) echo_debug "run" "power_mode=bat" ;;
    *) echo_debug "run" "power_mode=unknown ($pwrmode)" ;;
esac

# process command
exitcode=0

case "$_cmd" in
    init) # system initialization/shutdown: sysv, upstart, systemd, ...
        check_root
        # try to obtain lock (with timeout)
        locked=0
        if lock_tlp; then
            locked=1
        else
            echo "Failed to get lock, continuing anyway." 1>&2
        fi

        # do init business ...
        # shellcheck disable=SC2034
        _bgtask=1
        case "$_cmd2" in
            start)
                # apply power save settings
                compare_and_save_power_state "$pwrmode"
                echo -n "Applying power save settings..."
                apply_common_settings "$pwrmode"
                poweroff_drivebay "$pwrmode" 0
                [ "$X_TLP_USB_MODE" = "1" ] && set_usb_suspend 0 auto
                echo "done."

                # apply battery settings
                echo -n "Setting battery charge thresholds..."
                init_batteries_thresholds
                echo "done."

                # apply radio states
                set_radio_device_states start
                ;;

            restart|force-reload)
                # apply power save settings
                compare_and_save_power_state "$pwrmode"
                echo -n "Applying power save settings..."
                apply_common_settings "$pwrmode"
                poweroff_drivebay "$pwrmode" 0
                [ "$X_TLP_USB_MODE" = "1" ] && set_usb_suspend 0 auto
                echo "done."

                # apply battery settings
                echo -n "Setting battery charge thresholds..."
                init_batteries_thresholds
                echo "done."
                ;;

            stop)
                # remove usb startup flag
                [ -f "$USB_DONE" ] && rm "$USB_DONE"

                # clear saved power state
                clear_saved_power_state

                if [ "$X_TLP_SHUTDOWN_ACMODE" = "1" ]; then
                    # workaround (optional): apply ac settings
                    echo -n "Applying power save settings..."
                    apply_common_settings 0
                    poweroff_drivebay "$pwrmode" 0
                    echo "done."
                fi

                # apply radio states
                set_radio_device_states stop
                ;;

            *)
                echo "Usage: tlp init {start|stop|restart|force-reload}" >&2
                do_exit 3
                ;;
        esac

        save_runconf
        # unlock if necessary
        [ $locked -eq 0 ] || unlock_tlp
        ;;

    auto) # set mode depending on state (called by udev rule)
          # -- but only if not previously run for the same power state
          # rationale: filter out duplicate power_supply udev events
        check_root
        # shellcheck disable=SC2034
        _bgtask=1
        check_services_activation_status
        if lock_tlp_nb; then
            if compare_and_save_power_state "$pwrmode"; then
                apply_common_settings "$pwrmode"
                poweroff_drivebay "$pwrmode" 0
                set_radio_device_states "$pwrmode"
                if [ "$RESTORE_THRESHOLDS_ON_BAT" = "1" ] \
                    && [ "$pwrmode" = "1" ]; then
                    init_batteries_thresholds
                fi
                save_runconf
            fi
            unlock_tlp
        fi
        ;;

    start) # set mode depending on state (interactive mode)
        check_services_activation_status
        check_root
        if lock_tlp; then
            compare_and_save_power_state "$pwrmode"
            apply_common_settings "$pwrmode"
            poweroff_drivebay "$pwrmode" 0
            set_usb_suspend 0 auto
            init_batteries_thresholds
            set_radio_device_states "$pwrmode"
            save_runconf
            unlock_tlp

            echo_started_mode "$pwrmode"
        else
            echo_tlp_locked
        fi
        ;;

    true|bat) # set battery power mode
        check_services_activation_status
        check_root
        if lock_tlp; then
            compare_and_save_power_state 1
            apply_common_settings 1
            poweroff_drivebay "$pwrmode" 0
            [ "$X_TLP_USB_MODE" = "1" ] && set_usb_suspend 0 auto
            set_radio_device_states 1
            save_runconf
            unlock_tlp

            echo_started_mode 1
        else
            echo_tlp_locked
        fi
        ;;

    false|ac) # set ac power mode
        check_services_activation_status
        check_root
        if lock_tlp; then
            compare_and_save_power_state 0
            apply_common_settings 0
            poweroff_drivebay "$pwrmode" 0
            [ "$X_TLP_USB_MODE" = "1" ] && set_usb_suspend 0 auto
            set_radio_device_states 0
            save_runconf
            unlock_tlp

            echo_started_mode 0
        else
            echo_tlp_locked
        fi
        ;;

    suspend) # handle suspend/hibernate
        check_root
        save_device_states "bluetooth wwan"
        suspend_drivebay "$pwrmode"

        case "$X_TLP_SUSPEND_ACMODE" in
            1) # workaround (optional): apply ac settings
                if lock_tlp; then
                    apply_common_settings 0
                    save_runconf
                    unlock_tlp
                fi
                ;;

            0) # workaround disabled: do nothing
                ;;

            *) # workaround (default): apply selected settings to avoid freezes on wakeup
                if lock_tlp; then
                    apply_suspend_settings
                    save_runconf
                    unlock_tlp
                fi
                ;;
        esac
        ;;

    resume) # handle resume
        check_root
        if lock_tlp; then
            restore_device_states

            compare_and_save_power_state "$pwrmode"
            apply_common_settings "$pwrmode"
            resume_drivebay "$pwrmode"
            init_batteries_thresholds "asus huawei lg lg-legacy"
            save_runconf
            unlock_tlp
        fi
        ;;

    usb) # Enable usb autosuspend
        check_root
        set_usb_suspend 1 auto
        ;;

    bayoff) # power off drive bay
        check_root
        poweroff_drivebay "$pwrmode" 1
        ;;

    setcharge) # set charge thresholds (temporarily)
        check_root
        # quoting args will break $# in setcharge_battery()
        # shellcheck disable=SC2086
        setcharge_battery $_carg1 $_carg2 $_carg3
        exitcode=$?
        ;;

    fullcharge) # charge battery to 100% (temporarily)
        if check_ac_power fullcharge; then
            check_root
            # quoting args will break $# in setcharge_battery()
            # shellcheck disable=SC2086
            setcharge_battery DEF DEF $_carg1
            exitcode=$?
            if [ $exitcode -eq 0 ]; then
                echo "Charging starts now, keep AC connected."
            fi
        else
            exitcode=2
        fi
        ;;

    chargeonce) # charge battery to stop threshold once
        if check_ac_power chargeonce; then
            check_root
            # quoting args will break $# in chargeonce_battery()
            # shellcheck disable=SC2086
            chargeonce_battery $_carg1
            exitcode=$?
            if [ $exitcode -eq 0 ]; then
                echo "Charging starts now, keep AC connected."
            fi
        else
            exitcode=2
        fi
        ;;

    discharge) # discharge battery completely (to recalibrate)
        if check_ac_power discharge; then
            check_root
            if lock_tlp_nb tlp_discharge; then
                # quoting args will break $# in discharge_battery()
                # shellcheck disable=SC2086
                discharge_battery $_carg1
                exitcode=$?
            else
                echo_discharge_locked
            fi
        else
            exitcode=2
        fi
        ;;

    recalibrate) # recalibrate battery, i.e. discharge and charge to 100%
        if check_ac_power recalibrate; then
            check_root
            if lock_tlp_nb tlp_discharge; then
                if setcharge_battery DEF DEF "$_carg1" "/discharge/recalibrate"; then
                    sleep 1
                    # quoting args will break $# in discharge_battery()
                    # shellcheck disable=SC2086
                    discharge_battery $_carg1
                    exitcode=$?
                    if [ $exitcode -eq 0 ]; then
                        echo "Charging starts now, for a complete recalibration"
                        echo "keep AC connected until the battery is fully charged."
                    else
                        echo "Battery recalibration aborted."
                    fi
                fi
            else
                echo_discharge_locked
            fi
        else
            exitcode=2
        fi
        ;;

    diskid) # show disk id's
        show_disk_ids
        ;;

    noop) # Debug: no operation
        check_root
        select_batdrv
        batdrv_select_battery "DEF"
        save_runconf
        echo "Debug: no operation performed."
        ;;
esac

do_exit $exitcode