# The GPLv2 License
#
#   Copyright (C) 2017  Peter Kenji Yamanaka
#
#   This program is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License along
#   with this program; if not, write to the Free Software Foundation, Inc.,
#   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


# NOTE
#
# Plans are currently directly sourced from the shell, meaning any and all
# shell script is valid in these files.
#
# pstate-frequency expects there to only be variable declarations in a plan file,
# but nothing is stopping pstate-frequency from sourcing a plan file which contains
# code and then executing said code. Make sure that none of your custom created
# plan file contain actual code in them or it will be executed.
#
# Because of the ability to execute arbitrary code, pstate-frequency only respects
# one location by default, which is handled by the root user on normal systems

# Plans should define the following
#
# EITHER
#
#   PLAN_AUTO_BAT [ plan name }
#     The identifier of the plan to run on battery
#
#   PLAN_AUTO_AC [ plan name }
#     The identifier of the plan to run on ac charger
#
# OR
#
#  PLAN_CPU_MAX [ number ]
#  PLAN_CPU_MIN [ number ]
#  PLAN_CPU_TURBO [ "on" | "off" ]
#  PLAN_CPU_PSTATE_GOVERNOR [ governor name ]
#  PLAN_CPU_CPUFREQ_GOVERNOR [ governor name ]
#
# If both are defined, the variables under PLAN_CPU take preference

PLAN_AUTO_AC=performance
PLAN_AUTO_BAT=powersave

PLAN_CPU_MAX=100
PLAN_CPU_MIN=0
PLAN_CPU_TURBO=off
PLAN_CPU_PSTATE_GOVERNOR=powersave
PLAN_CPU_CPUFREQ_GOVERNOR=ondemand
