powersavemode.c

/**
 * @file powersavemode.c
 * Power saving mode module -- this handles the power saving mode
 * for MCE
 * <p>
 * Copyright (c) 2010 - 2011 Nokia Corporation and/or its subsidiary(-ies).
 * Copyright (c) 2014 - 2020 Jolla Ltd.
 * Copyright (c) 2020 Open Mobile Platform LLC.
 * <p>
 * @author David Weinehall <david.weinehall@nokia.com>
 * @author Tapio Rantala <ext-tapio.rantala@nokia.com>
 * @author Santtu Lakkala <ext-santtu.1.lakkala@nokia.com>
 * @author Simo Piiroinen <simo.piiroinen@jollamobile.com>
 *
 * mce is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * mce 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with mce.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "powersavemode.h"

#include "../mce.h"
#include "../mce-log.h"
#include "../mce-setting.h"
#include "../mce-dbus.h"

#include <mce/dbus-names.h>
#include <mce/mode-names.h>

#include <gmodule.h>

/** Module name */
#define MODULE_NAME		"powersavemode"

/** Functionality provided by this module */
static const gchar *const provides[] = { MODULE_NAME, NULL };

/** Module information */
G_MODULE_EXPORT module_info_struct module_info = {
	/** Name of the module */
	.name = MODULE_NAME,
	/** Module provides */
	.provides = provides,
	/** Module priority */
	.priority = 250
};

/** Battery charge level: assume unknown == -1 */
static gint battery_level = MCE_BATTERY_LEVEL_UNKNOWN;

/** Charger state */
static charger_state_t charger_state = CHARGER_STATE_UNDEF;

/** Power saving mode enabled setting */
static gboolean power_saving_mode = MCE_DEFAULT_EM_ENABLE_PSM;
static guint    power_saving_mode_setting_id = 0;

/** Forced power saving mode setting */
static gboolean force_psm = MCE_DEFAULT_EM_FORCED_PSM;
static guint    force_psm_setting_id = 0;

/** Power saving mode threshold setting */
static gint  psm_threshold = MCE_DEFAULT_EM_PSM_THRESHOLD;
static guint psm_threshold_setting_id = 0;

/** Active power saving mode */
static bool active_power_saving_mode = false;

/** Device thermal state */
static thermal_state_t thermal_state = THERMAL_STATE_UNDEF;

/**
 * Send the PSM state
 *
 * @param method_call A DBusMessage to reply to;
 *                    pass NULL to send a signal instead
 * @return TRUE on success, FALSE on failure
 */
static gboolean send_psm_state(DBusMessage *const method_call)
{
	DBusMessage *msg = NULL;
	gboolean status = FALSE;

	mce_log(LL_DEBUG,
		"Sending PSM state: %s",
		active_power_saving_mode ? "TRUE" : "FALSE");

	/* If method_call is set, send a reply,
	 * otherwise, send a signal
	 */
	if (method_call != NULL) {
		msg = dbus_new_method_reply(method_call);
	} else {
		/* psm_state_ind */
		msg = dbus_new_signal(MCE_SIGNAL_PATH, MCE_SIGNAL_IF,
				      MCE_PSM_STATE_SIG);
	}

	dbus_bool_t arg = active_power_saving_mode;

	/* Append the power saving mode */
	if (dbus_message_append_args(msg,
				     DBUS_TYPE_BOOLEAN, &arg,
				     DBUS_TYPE_INVALID) == FALSE) {
		mce_log(LL_CRIT,
			"Failed to append %sargument to D-Bus message "
			"for %s.%s",
			method_call ? "reply " : "",
			method_call ? MCE_REQUEST_IF :
				      MCE_SIGNAL_IF,
			method_call ? MCE_PSM_STATE_GET :
				      MCE_PSM_STATE_SIG);
		dbus_message_unref(msg);
		goto EXIT;
	}

	/* Send the message */
	status = dbus_send_message(msg);

EXIT:
	return status;
}

/**
 * Update the power saving mode
 */
static void update_power_saving_mode(void)
{
	bool activate = false;

	if( thermal_state == THERMAL_STATE_OVERHEATED ) {
		/* If device overheats, PSM is triggered regardless
		 * of other settings and states. */
		activate = true;
	}
	else if ( battery_level <= MCE_BATTERY_LEVEL_UNKNOWN ) {
		/* Ignore triggers based on charger and battery
		 * info until battery level becomes known. */
	}
	else if( charger_state == CHARGER_STATE_ON ) {
		/* If charger is connected, PSM should be deactivated. */
	}
	else if( force_psm ) {
		/* Forced PSM is triggered when no charger is connected. */
		if( charger_state == CHARGER_STATE_UNDEF )
			mce_log(LL_DEBUG, "charger state unknown; "
				"not activating forced-psm");
		else
			activate = true;
	}
	else if( power_saving_mode && battery_level <= psm_threshold ) {
		/* Normally PSM is triggered when the feature is enabled and
		 * battery level is not over the threshold. */
		if( charger_state == CHARGER_STATE_UNDEF )
			mce_log(LL_DEBUG, "charger state unknown; "
				"not activating psm");
		else
			activate = true;
	}

	if( active_power_saving_mode != activate ) {
		active_power_saving_mode = activate;
		mce_log(LL_DEBUG, "power_saving_mode: %s",
			active_power_saving_mode ? "activated" : "deactivated");
		datapipe_exec_full(&power_saving_mode_active_pipe,
				   GINT_TO_POINTER(active_power_saving_mode));
		send_psm_state(NULL);
	}
}

/**
 * Datapipe trigger for the battery charge level
 *
 * @param data A pointer representation of the battery charge level in percent
 */
static void battery_level_trigger(gconstpointer const data)
{
	gint prev = battery_level;
	battery_level = GPOINTER_TO_INT(data);

	if( prev == battery_level )
		goto EXIT;

	mce_log(LL_DEBUG, "battery_level: %d -> %d", prev, battery_level);

	update_power_saving_mode();

EXIT:
	return;
}

/**
 * Datapipe trigger for the charger state
 *
 * @param data A pointer representation of the charger state
 */
static void charger_state_trigger(gconstpointer const data)
{
	charger_state_t prev = charger_state;
	charger_state = GPOINTER_TO_INT(data);

	if( prev == charger_state )
		goto EXIT;

	mce_log(LL_DEBUG, "charger_state: %s -> %s",
		charger_state_repr(prev),
		charger_state_repr(charger_state));

	/* Disable forced-psm on charger connect - but ignore
	 * undef -> on transitions that are expected to happen
	 * on mce startup. */
	if( force_psm &&
	    prev == CHARGER_STATE_OFF &&
	    charger_state == CHARGER_STATE_ON ) {
		mce_log(LL_DEBUG, "autodisable forced-power-save-mode");
		/* Change cached value before changing the setting
		 * value to avoid repeated state evaluation. */
		force_psm = false;
		mce_setting_set_bool(MCE_SETTING_EM_FORCED_PSM, false);
	}

	update_power_saving_mode();

EXIT:
	return;
}

/**
 * Datapipe trigger for the thermal state
 *
 * @param data THERMAL_STATE_OK if the device temperature is normal,
 *             THERMAL_STATE_OVERHEATED if the device is overheated
 */
static void thermal_state_trigger(gconstpointer const data)
{
	thermal_state_t prev = thermal_state;
	thermal_state = GPOINTER_TO_INT(data);

	if( prev == thermal_state )
		goto EXIT;

	mce_log(LL_DEBUG, "thermal_state: %s -> %s",
		thermal_state_repr(prev),
		thermal_state_repr(thermal_state));

	update_power_saving_mode();

EXIT:
	return;
}

/**
 * GConf callback for power saving related settings
 *
 * @param gcc Unused
 * @param id Connection ID from gconf_client_notify_add()
 * @param entry The modified GConf entry
 * @param data Unused
 */
static void psm_setting_cb(GConfClient *const gcc, const guint id,
			   GConfEntry *const entry, gpointer const data)
{
	const GConfValue *gcv = gconf_entry_get_value(entry);

	(void)gcc;
	(void)data;

	/* Key is unset */
	if (gcv == NULL) {
		mce_log(LL_DEBUG,
			"GConf Key `%s' has been unset",
			gconf_entry_get_key(entry));
		goto EXIT;
	}

	if (id == power_saving_mode_setting_id) {
		gboolean prev = power_saving_mode;
		power_saving_mode = gconf_value_get_bool(gcv);
		if( prev != power_saving_mode )
			update_power_saving_mode();
	} else if (id == force_psm_setting_id) {
		gboolean prev = force_psm;
		force_psm = gconf_value_get_bool(gcv);
		if( prev != force_psm )
			update_power_saving_mode();
	} else if (id == psm_threshold_setting_id) {
		gint prev = psm_threshold;
		psm_threshold = gconf_value_get_int(gcv);
		if( prev != psm_threshold )
			update_power_saving_mode();
	} else {
		mce_log(LL_WARN,
			"Spurious GConf value received; confused!");
	}

EXIT:
	return;
}

/**
 * D-Bus callback for the get PSM mode method call
 *
 * @param msg The D-Bus message
 * @return TRUE on success, FALSE on failure
 */
static gboolean psm_state_get_dbus_cb(DBusMessage *const msg)
{
	gboolean status = FALSE;

	mce_log(LL_DEVEL, "Received PSM state get request from %s",
	       mce_dbus_get_message_sender_ident(msg));

	/* Try to send a reply that contains the current PSM state */
	if (send_psm_state(msg) == FALSE)
		goto EXIT;

	status = TRUE;

EXIT:
	return status;
}

/** Array of dbus message handlers */
static mce_dbus_handler_t psm_dbus_handlers[] =
{
	/* signals - outbound (for Introspect purposes only) */
	{
		.interface = MCE_SIGNAL_IF,
		.name      = MCE_PSM_STATE_SIG,
		.type      = DBUS_MESSAGE_TYPE_SIGNAL,
		.args      =
			"    <arg name=\"psm_active\" type=\"b\"/>\n"
	},
	/* method calls */
	{
		.interface = MCE_REQUEST_IF,
		.name      = MCE_PSM_STATE_GET,
		.type      = DBUS_MESSAGE_TYPE_METHOD_CALL,
		.callback  = psm_state_get_dbus_cb,
		.args      =
			"    <arg direction=\"out\" name=\"power_saving_mode_active\" type=\"b\"/>\n"
	},
	/* sentinel */
	{
		.interface = 0
	}
};

/** Add dbus handlers
 */
static void mce_psm_init_dbus(void)
{
	mce_dbus_handler_register_array(psm_dbus_handlers);
}

/** Remove dbus handlers
 */
static void mce_psm_quit_dbus(void)
{
	mce_dbus_handler_unregister_array(psm_dbus_handlers);
}

/** Array of datapipe handlers */
static datapipe_handler_t mce_psm_datapipe_handlers[] =
{
	// output triggers
	{
		.datapipe  = &battery_level_pipe,
		.output_cb = battery_level_trigger,
	},
	{
		.datapipe  = &charger_state_pipe,
		.output_cb = charger_state_trigger,
	},
	{
		.datapipe  = &thermal_state_pipe,
		.output_cb = thermal_state_trigger,
	},
	// sentinel
	{
		.datapipe  = 0,
	}
};

static datapipe_bindings_t mce_psm_datapipe_bindings =
{
	.module   = "mce_psm",
	.handlers = mce_psm_datapipe_handlers,
};

/** Append triggers/filters to datapipes
 */
static void mce_psm_datapipe_init(void)
{
	mce_datapipe_init_bindings(&mce_psm_datapipe_bindings);
}

/** Remove triggers/filters from datapipes
 */
static void mce_psm_datapipe_quit(void)
{
	mce_datapipe_quit_bindings(&mce_psm_datapipe_bindings);
}

/**
 * Init function for the power saving mode module
 *
 * @todo XXX status needs to be set on error!
 *
 * @param module Unused
 * @return NULL on success, a string with an error message on failure
 */
G_MODULE_EXPORT const gchar *g_module_check_init(GModule *module);
const gchar *g_module_check_init(GModule *module)
{
	(void)module;

	/* Append triggers/filters to datapipes */
	mce_psm_datapipe_init();

	/* Power saving mode setting */
	mce_setting_track_bool(MCE_SETTING_EM_ENABLE_PSM,
			       &power_saving_mode,
			       MCE_DEFAULT_EM_ENABLE_PSM,
			       psm_setting_cb,
			       &power_saving_mode_setting_id);

	/* Forced power saving mode setting */
	mce_setting_track_bool(MCE_SETTING_EM_FORCED_PSM,
			       &force_psm,
			       MCE_DEFAULT_EM_FORCED_PSM,
			       psm_setting_cb,
			       &force_psm_setting_id);

	/* Power saving mode threshold */
	mce_setting_track_int(MCE_SETTING_EM_PSM_THRESHOLD,
			      &psm_threshold,
			      MCE_DEFAULT_EM_PSM_THRESHOLD,
			      psm_setting_cb,
			      &psm_threshold_setting_id);

	/* Add dbus handlers */
	mce_psm_init_dbus();

	/* Explicitly evaluate initial state */
	update_power_saving_mode();
	return NULL;
}

/**
 * Exit function for the power saving mode module
 *
 * @todo D-Bus unregistration
 *
 * @param module Unused
 */
G_MODULE_EXPORT void g_module_unload(GModule *module);
void g_module_unload(GModule *module)
{
	(void)module;

	/* Stop tracking setting changes */
	mce_setting_notifier_remove(power_saving_mode_setting_id),
		power_saving_mode_setting_id = 0;

	mce_setting_notifier_remove(force_psm_setting_id),
		force_psm_setting_id = 0;

	mce_setting_notifier_remove(psm_threshold_setting_id),
		psm_threshold_setting_id = 0;

	/* Remove dbus handlers */
	mce_psm_quit_dbus();

	/* Remove triggers/filters from datapipes */
	mce_psm_datapipe_quit();

	return;
}