D-Bus Interface to the Mode Control Entity. More...

Macros
MCE D-Bus Service
#define	MCE_SERVICE "com.nokia.mce"
	MCE D-Bus service name. More...

#define	MCE_REQUEST_IF "com.nokia.mce.request"
	MCE D-Bus Request interface. More...

#define	MCE_SIGNAL_IF "com.nokia.mce.signal"
	MCE D-Bus Signal interface. More...

#define	MCE_REQUEST_PATH "/com/nokia/mce/request"
	MCE D-Bus Request path. More...

#define	MCE_SIGNAL_PATH "/com/nokia/mce/signal"
	MCE D-Bus Signal path. More...

#define	MCE_ERROR_FATAL "com.nokia.mce.error.fatal"
	The MCE D-Bus error interface; currently not used. More...

#define	MCE_ERROR_INVALID_ARGS "org.freedesktop.DBus.Error.InvalidArgs"
	The D-Bus interface for invalid arguments; currently not used. More...

Radio State
#define	MCE_RADIO_STATES_GET "get_radio_states"
	Query radio states. More...

#define	MCE_RADIO_STATES_CHANGE_REQ "req_radio_states_change"
	Request radio states change. More...

#define	MCE_RADIO_STATES_SIG "radio_states_ind"
	Notify everyone that the radio states have changed. More...

Call State
#define	MCE_CALL_STATE_GET "get_call_state"
	Query the call state. More...

#define	MCE_CALL_STATE_CHANGE_REQ "req_call_state_change"
	Request call state change. More...

#define	MCE_CALL_STATE_SIG "sig_call_state_ind"
	Notify everyone that the call state has changed. More...

Display State
#define	MCE_DISPLAY_STATUS_GET "get_display_status"
	Query the display status. More...

#define	MCE_DISPLAY_ON_REQ "req_display_state_on"
	Unblank display. More...

#define	MCE_DISPLAY_DIM_REQ "req_display_state_dim"
	Dim display. More...

#define	MCE_DISPLAY_OFF_REQ "req_display_state_off"
	Blank display. More...

#define	MCE_DISPLAY_LPM_REQ "req_display_state_lpm"
	Set display to low power mode. More...

#define	MCE_DISPLAY_SIG "display_status_ind"
	Notify everyone that the display is on/dimmed/off. More...

Touchscreen And Keypad Lock State
#define	MCE_TKLOCK_MODE_GET "get_tklock_mode"
	Query the touchscreen/keypad lock mode. More...

#define	MCE_TKLOCK_MODE_CHANGE_REQ "req_tklock_mode_change"
	Request tklock mode change. More...

#define	MCE_TKLOCK_MODE_SIG "tklock_mode_ind"
	Signal that indicates that the touchscreen/keypad lock mode has changed. More...

Display Blank Prevention
#define	MCE_PREVENT_BLANK_REQ "req_display_blanking_pause"
	Prevent display from blanking. More...

#define	MCE_CANCEL_PREVENT_BLANK_REQ "req_display_cancel_blanking_pause"
	Cancel display blanking prevention. More...

#define	MCE_PREVENT_BLANK_GET "get_display_blanking_pause"
	Get current blank prevention status. More...

#define	MCE_PREVENT_BLANK_SIG "display_blanking_pause_ind"
	Notify everyone whether the display blanking is paused. More...

#define	MCE_PREVENT_BLANK_ALLOWED_GET "get_display_blanking_pause_allowed"
	Query whether MCE_PREVENT_BLANK_REQ request can be made. More...

#define	MCE_PREVENT_BLANK_ALLOWED_SIG "display_blanking_pause_allowed_ind"
	Notify change in whether MCE_PREVENT_BLANK_REQ request can be made. More...

Display Blanking Inhibit State
#define	MCE_BLANKING_INHIBIT_GET "get_display_blanking_inhibit"
	Get current blank inhibition status. More...

#define	MCE_BLANKING_INHIBIT_SIG "display_blanking_inhibit_ind"
	Notify everyone whether the display blanking is inhibited. More...

Display Blanking Policy State
#define	MCE_BLANKING_POLICY_GET "get_display_blanking_policy"
	Get current display blanking policy status. More...

#define	MCE_BLANKING_POLICY_SIG "display_blanking_policy_ind"
	Notify everyone when the display blanking policy changes. More...

Power Save Mode
#define	MCE_PSM_STATE_GET "get_psm_state"
	Query the automatic power saving mode. More...

#define	MCE_PSM_STATE_SIG "psm_state_ind"
	Notify everyone that the state of the automatic power saving mode changed. More...

Keypad Backlight Status
#define	MCE_KEY_BACKLIGHT_STATE_GET "get_key_backlight_state"
	Query key backlight state. More...

Device Inactivity
#define	MCE_INACTIVITY_STATUS_GET "get_inactivity_status"
	Query the inactivity status. More...

#define	MCE_INACTIVITY_SIG "system_inactivity_ind"
	Notify everyone that the system is active/inactive. More...

#define	MCE_ADD_ACTIVITY_CALLBACK_REQ "add_activity_callback"
	Add an activity notification callback;. More...

#define	MCE_REMOVE_ACTIVITY_CALLBACK_REQ "remove_activity_callback"
	Remove any activity notification callback belonging to the calling process. More...

CPU Keepalive
#define	MCE_CPU_KEEPALIVE_PERIOD_REQ "req_cpu_keepalive_period"
	Query the length of time late suspend can be blocked. More...

#define	MCE_CPU_KEEPALIVE_START_REQ "req_cpu_keepalive_start"
	Temporarily disable enter late suspend policy. More...

#define	MCE_CPU_KEEPALIVE_STOP_REQ "req_cpu_keepalive_stop"
	Allow normal enter late suspend policy again. More...

#define	MCE_CPU_KEEPALIVE_WAKEUP_REQ "req_cpu_keepalive_wakeup"
	Signal wakeup from suspend due to aligned timer triggering. More...

MCE Settings
#define	MCE_CONFIG_GET "get_config"
	Query configuration value. More...

#define	MCE_CONFIG_GET_ALL "get_config_all"
	Query all configuration values. More...

#define	MCE_CONFIG_SET "set_config"
	Set configuration value. More...

#define	MCE_CONFIG_RESET "reset_config"
	Reset configuration values to default. More...

#define	MCE_CONFIG_CHANGE_SIG "config_change_ind"
	Notify everyone that mce configuration value has changed. More...

Battery And Charging State
#define	MCE_USB_CABLE_STATE_GET "get_usb_cable_state"
	Query current USB cable state. More...

#define	MCE_USB_CABLE_STATE_SIG "usb_cable_state_ind"
	Signal that indicates that USB cable state has changed. More...

#define	MCE_CHARGER_STATE_GET "get_charger_state"
	Query current charger state. More...

#define	MCE_CHARGER_STATE_SIG "charger_state_ind"
	Signal that indicates that charger state has changed. More...

#define	MCE_BATTERY_STATUS_GET "get_battery_status"
	Query current battery status. More...

#define	MCE_BATTERY_STATUS_SIG "battery_status_ind"
	Signal that indicates that battery status has changed. More...

#define	MCE_BATTERY_STATE_GET "get_battery_state"
	Query current battery state. More...

#define	MCE_BATTERY_STATE_SIG "battery_state_ind"
	Signal that indicates that battery state has changed. More...

#define	MCE_BATTERY_LEVEL_GET "get_battery_level"
	Query current battery level. More...

#define	MCE_BATTERY_LEVEL_SIG "battery_level_ind"
	Signal that indicates that battery level has changed. More...

#define	MCE_CHARGER_TYPE_GET "get_charger_type"
	Query current charger type. More...

#define	MCE_CHARGER_TYPE_SIG "charger_type_ind"
	Signal that indicates that charger type has changed. More...

LED Control
#define	MCE_ACTIVATE_LED_PATTERN "req_led_pattern_activate"
	Activate a pre-defined LED pattern. More...

#define	MCE_DEACTIVATE_LED_PATTERN "req_led_pattern_deactivate"
	Deactivate a pre-defined LED pattern. More...

#define	MCE_LED_PATTERN_ACTIVATED_SIG "led_pattern_activated_ind"
	Notify everyone that a led pattern has been activated. More...

#define	MCE_LED_PATTERN_DEACTIVATED_SIG "led_pattern_deactivated_ind"
	Notify everyone that a led pattern has been deactivated. More...

#define	MCE_ENABLE_LED "req_led_enable"
	Allow activation of normal led patterns. More...

#define	MCE_DISABLE_LED "req_led_disable"
	Deny actiovation of normal led patterns. More...

Input Event Handling Policy
#define	MCE_TOUCH_INPUT_POLICY_GET "get_touch_input_policy"
	Get current touch screen input policy. More...

#define	MCE_TOUCH_INPUT_POLICY_SIG "touch_input_policy_ind"
	Indication for change of touch screen input policy. More...

#define	MCE_VOLKEY_INPUT_POLICY_GET "get_keypad_input_policy"
	Get current volume key input policy. More...

#define	MCE_VOLKEY_INPUT_POLICY_SIG "keypad_input_policy_ind"
	Indication for change of volume key input policy. More...

Button Backlight Policy
#define	MCE_BUTTON_BACKLIGHT_GET "get_button_backlight"
	Get current button backlight state. More...

#define	MCE_BUTTON_BACKLIGHT_CHANGE_REQ "req_button_backlight_change"
	Request button backlight state change. More...

#define	MCE_BUTTON_BACKLIGHT_MODE_REQ "req_button_backlight_mode"
	Request button backlight mode change. More...

#define	MCE_BUTTON_BACKLIGHT_SIG "sig_button_backlight_ind"
	Indication for change of button backlight state. More...

Hardware Keyboard Availability
#define	MCE_HARDWARE_KEYBOARD_STATE_GET "keyboard_available_state_req"
	Query HW keyboard availability. More...

#define	MCE_HARDWARE_KEYBOARD_STATE_SIG "keyboard_available_state_ind"
	Notify changes in HW keyboard availability. More...

Hardware Mouse Availability
#define	MCE_HARDWARE_MOUSE_STATE_GET "mouse_available_state_req"
	Query HW mouse availability. More...

#define	MCE_HARDWARE_MOUSE_STATE_SIG "mouse_available_state_ind"
	Notify changes in HW mouse availability. More...

Sliding Keyboard State
#define	MCE_SLIDING_KEYBOARD_STATE_GET "keyboard_slide_state_req"
	Query current sliding keyboard state. More...

#define	MCE_SLIDING_KEYBOARD_STATE_SIG "keyboard_slide_state_ind"
	Notify sliding keyboard state changes. More...

Interaction Between MCE And UI Components
#define	MCE_FADER_OPACITY_SIG "fader_opacity_ind"
	Signal for controlling compositor side display dimming. More...

#define	MCE_ALARM_UI_FEEDBACK_SIG "alarm_ui_feedback_ind"
	Signal for notifying alarm ui about power key presses / device flip overs. More...

#define	MCE_CALL_UI_FEEDBACK_SIG "call_ui_feedback_ind"
	Signal for notifying call ui about power key presses / device flip overs. More...

#define	MCE_IGNORE_INCOMING_CALL_REQ "req_ignore_incoming_call"
	Inform mce that incoming call has been ignored by ui. More...

#define	MCE_POWER_BUTTON_TRIGGER "power_button_trigger"
	Signal for notifying systemui about power button etc related events. More...

#define	MCE_TKLOCK_CB_REQ "tklock_callback"
	Method for sending tklock feedback from systemui to mce. More...

Display Low Power Mode
#define	MCE_DISPLAY_STATE_LPM_OFF_REQ "req_display_state_lpm_off"
	Request transition to lpm-off display state. More...

#define	MCE_DISPLAY_STATE_LPM_ON_REQ "req_display_state_lpm_on"
	Request transition to lpm-on display state. More...

#define	MCE_LPM_UI_MODE_SIG "lpm_ui_mode_ind"
	Used for triggering UI transitions to/from LPM view. More...

System Memory Pressure
#define	MCE_MEMORY_LEVEL_GET "get_memory_level"
	Method for querying current system memory pressure level. More...

#define	MCE_MEMORY_LEVEL_SIG "sig_memory_level_ind"
	Signal for notifying system memory pressure level changes. More...

Time Limited Display Wakeups
#define	MCE_NOTIFICATION_BEGIN_REQ "notification_begin_req"
	Method for declaring start of exceptional display on state. More...

#define	MCE_NOTIFICATION_END_REQ "notification_end_req"
	Method for declaring end of exceptional display on state. More...

Content Adaptive Backlight Control Mode
#define	MCE_CABC_MODE_GET "get_cabc_mode"
	Query CABC mode. More...

#define	MCE_CABC_MODE_REQ "req_cabc_mode"
	Request CABC mode change. More...

Color Profile
#define	MCE_COLOR_PROFILE_GET "get_color_profile"
	Query the current color profile id. More...

#define	MCE_COLOR_PROFILE_IDS_GET "get_color_profile_ids"
	Query the list of the available color profile ids. More...

#define	MCE_COLOR_PROFILE_CHANGE_REQ "req_color_profile_change"
	Request color profile change. More...

#define	MCE_COLOR_PROFILE_SIG "color_profile_ind"
	Notify everyone that the color profile has changed. More...

Miscellaneous
#define	MCE_VERSION_GET "get_version"
	Query MCE version. More...

#define	MCE_TRIGGER_POWERKEY_EVENT_REQ "req_trigger_powerkey_event"
	Request powerkey event triggering. More...

#define	MCE_DISPLAY_STATS_GET "get_display_stats"
	Get amount of time spent in each display state. More...

#define	MCE_SUSPEND_STATS_GET "get_suspend_stats"
	Query current uptime and time spent in suspend. More...

#define	MCE_VERBOSITY_GET "get_verbosity"
	Query current logging verbosity. More...

#define	MCE_VERBOSITY_REQ "set_verbosity"
	Change current logging verbosity. More...

Detailed Description

D-Bus Interface to the Mode Control Entity.

This file is part of mce-dev

Author: David Weinehall david.nosp@m..wei.nosp@m.nehal.nosp@m.l@no.nosp@m.kia.c.nosp@m.om; Santtu Lakkala ext-s.nosp@m.antt.nosp@m.u.1.l.nosp@m.akka.nosp@m.la@no.nosp@m.kia..nosp@m.com; Victor Portnov Victo.nosp@m.r.Po.nosp@m.rtnov.nosp@m.@tel.nosp@m.eca.c.nosp@m.om; Simo Piiroinen simo..nosp@m.piir.nosp@m.oinen.nosp@m.@jol.nosp@m.lamob.nosp@m.ile..nosp@m.com; Kimmo Lindholm kimmo.nosp@m..lin.nosp@m.dholm.nosp@m.@eke.nosp@m..fi

These headers are free software; you can redistribute them and/or modify them under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation.

These headers are distributed in the hope that they 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 these headers. If not, see http://www.gnu.org/licenses/.

Macro Definition Documentation

◆ MCE_SERVICE

#define MCE_SERVICE "com.nokia.mce"

MCE D-Bus service name.

Since: mce 0.3

◆ MCE_REQUEST_IF

#define MCE_REQUEST_IF "com.nokia.mce.request"

MCE D-Bus Request interface.

Since: mce 0.3

◆ MCE_SIGNAL_IF

#define MCE_SIGNAL_IF "com.nokia.mce.signal"

MCE D-Bus Signal interface.

Since: mce 0.3

◆ MCE_REQUEST_PATH

#define MCE_REQUEST_PATH "/com/nokia/mce/request"

MCE D-Bus Request path.

Since: mce 0.3

◆ MCE_SIGNAL_PATH

#define MCE_SIGNAL_PATH "/com/nokia/mce/signal"

MCE D-Bus Signal path.

Since: mce 0.3

◆ MCE_ERROR_FATAL

#define MCE_ERROR_FATAL "com.nokia.mce.error.fatal"

The MCE D-Bus error interface; currently not used.

Since: mce 0.3

◆ MCE_ERROR_INVALID_ARGS

#define MCE_ERROR_INVALID_ARGS "org.freedesktop.DBus.Error.InvalidArgs"

The D-Bus interface for invalid arguments; currently not used.

Since: mce 0.3

◆ MCE_RADIO_STATES_GET

#define MCE_RADIO_STATES_GET "get_radio_states"

Query radio states.

Since: mce 1.10.60

Radio state bitmasks are constructed from:

Returns: uint32: bitmask of currently enabled radios

◆ MCE_RADIO_STATES_CHANGE_REQ

#define MCE_RADIO_STATES_CHANGE_REQ "req_radio_states_change"

Request radio states change.

Since: mce 1.10.60

Note: Aegis credential for Nokia N9: mce::DeviceModeControl

Radio state bitmasks are constructed from:

Changes the radio state bits set in the mask parameter to state given in the value parameter, i.e.

current = (current & ~mask) | (value & mask)

Parameters

value	uint32: bitmask of values to use
mask	uint32: bitmask of values to change

◆ MCE_RADIO_STATES_SIG

#define MCE_RADIO_STATES_SIG "radio_states_ind"

Notify everyone that the radio states have changed.

Since: mce 1.10.60

Radio state bitmasks are constructed from:

Parameters

current uint32: bitmask of currently active radios

◆ MCE_CALL_STATE_GET

#define MCE_CALL_STATE_GET "get_call_state"

Query the call state.

Since: mce 1.8.1

Returns

string: current call state, one of:

string: current call type, one of:

◆ MCE_CALL_STATE_CHANGE_REQ

#define MCE_CALL_STATE_CHANGE_REQ "req_call_state_change"

Request call state change.

Since: mce 1.8.1

MCE tracks call state separately:

from ofono modem and call properties
for each client using issuing call state requests

The overall call state will be "ringing" if at least one of the tracked entities declares ringing state.

The call type will be "emergency" it at least one of the tracked entities declares emergency call type.

If a client that has requested a call state change drops from system bus, it will be handled as if the client would have made a "none":"normal" request.

Note: Aegis credential for Nokia N9: mce::CallStateControl

Parameters

call_state	string: call state to request, one of: MCE_CALL_STATE_NONE MCE_CALL_STATE_RINGING MCE_CALL_STATE_ACTIVE MCE_CALL_STATE_SERVICE
call_type	string: call type to request, one of: MCE_NORMAL_CALL MCE_EMERGENCY_CALL

Returns: boolean: TRUE if the new call state was accepted, or FALSE if the new call state was vetoed

◆ MCE_CALL_STATE_SIG

#define MCE_CALL_STATE_SIG "sig_call_state_ind"

Notify everyone that the call state has changed.

Since: mce 1.8.1

Parameters

call_state	string: current call state, one of: MCE_CALL_STATE_NONE MCE_CALL_STATE_RINGING MCE_CALL_STATE_ACTIVE MCE_CALL_STATE_SERVICE
call_type	string: current call type, one of: MCE_NORMAL_CALL MCE_EMERGENCY_CALL

◆ MCE_DISPLAY_STATUS_GET

#define MCE_DISPLAY_STATUS_GET "get_display_status"

Query the display status.

Since: mce 1.5.21

Display state is one of:

Returns

string: current display state, one of:

◆ MCE_DISPLAY_ON_REQ

#define MCE_DISPLAY_ON_REQ "req_display_state_on"

Unblank display.

Since: mce 0.5

Note: Applications should never make explicit display on requests.

◆ MCE_DISPLAY_DIM_REQ

#define MCE_DISPLAY_DIM_REQ "req_display_state_dim"

Dim display.

Since: mce 1.6.20

Note: Applications should never make explicit display dim requests.

◆ MCE_DISPLAY_OFF_REQ

#define MCE_DISPLAY_OFF_REQ "req_display_state_off"

Blank display.

Since: mce 1.6.20

Note: Lockscreen is also activated when this call is made.

◆ MCE_DISPLAY_LPM_REQ

#define MCE_DISPLAY_LPM_REQ "req_display_state_lpm"

Set display to low power mode.

Since: mce 1.33.0

Blank screen via going through Display Low Power state.

If LPM feature is not enabled, blanks display immediately.

Low power mode is a display off sub state. From normal display state signaling point of view it behaves just as display off would. Depending on available hw support and configuration extra ipc relevant for home screen / system ui only might happen.

◆ MCE_DISPLAY_SIG

#define MCE_DISPLAY_SIG "display_status_ind"

Notify everyone that the display is on/dimmed/off.

Since: mce 1.5.21

Parameters

display_state

string: current display state, one of:

◆ MCE_TKLOCK_MODE_GET

#define MCE_TKLOCK_MODE_GET "get_tklock_mode"

Query the touchscreen/keypad lock mode.

Since: mce 1.4.0

Returns

string: current tklock state, one of:

◆ MCE_TKLOCK_MODE_CHANGE_REQ

#define MCE_TKLOCK_MODE_CHANGE_REQ "req_tklock_mode_change"

Request tklock mode change.

Since: mce 1.4.0

Note: Aegis credential for Nokia N9: mce::TKLockControl

Parameters

mode	string: requested tklock state, one of: MCE_TK_LOCKED MCE_TK_SILENT_LOCKED MCE_TK_LOCKED_DIM MCE_TK_LOCKED_DELAY MCE_TK_SILENT_LOCKED_DIM MCE_TK_UNLOCKED MCE_TK_SILENT_UNLOCKED

◆ MCE_TKLOCK_MODE_SIG

#define MCE_TKLOCK_MODE_SIG "tklock_mode_ind"

Signal that indicates that the touchscreen/keypad lock mode has changed.

Since: mce 1.4.0

Parameters

mode	string: current tklock state, one of: MCE_TK_LOCKED MCE_TK_SILENT_LOCKED MCE_TK_LOCKED_DIM MCE_TK_LOCKED_DELAY MCE_TK_SILENT_LOCKED_DIM MCE_TK_UNLOCKED MCE_TK_SILENT_UNLOCKED

◆ MCE_PREVENT_BLANK_REQ

#define MCE_PREVENT_BLANK_REQ "req_display_blanking_pause"

Prevent display from blanking.

Since: mce 0.5

Normal blanking timers are stopped for 60 seconds - under roughly the following conditions:

Display is already on and lockscreen is not active
Display is already on, lockscreen is active but compositor has notified that user interaction is expected and the blanking prevent request originates from the same process that owns the topmost window on screen.

The exact details are subject to change and clients showld track MCE_PREVENT_BLANK_ALLOWED_SIG signals to know when making blank prevention calls are allowed/ignored (and query the initial state with MCE_PREVENT_BLANK_ALLOWED_GET).

To keep display from blanking for longer periods, the client needs to re-issue this call every 60 seconds.

When application no longer wishes to keep display from blanking, it should make a MCE_CANCEL_PREVENT_BLANK_REQ method call.

Note: If client drops from the system bus, or misses the 60 second renew period, it is handled as if the client would have made a MCE_CANCEL_PREVENT_BLANK_REQ method call.; Previously mce waited exactly 60 seconds for renew calls which meant clients had to use shorter than 60 second renew periods to avoid hiccups. Since mce >= 1.93.0 the hard limit is 65 seconds and thus clients can schedule renewing to occur once / 60 seconds.

◆ MCE_CANCEL_PREVENT_BLANK_REQ

#define MCE_CANCEL_PREVENT_BLANK_REQ "req_display_cancel_blanking_pause"

Cancel display blanking prevention.

Since: mce 1.10.35

◆ MCE_PREVENT_BLANK_GET

#define MCE_PREVENT_BLANK_GET "get_display_blanking_pause"

Get current blank prevention status.

Since: mce 1.51.0

Returns

string: current blank prevention status, one of:

◆ MCE_PREVENT_BLANK_SIG

#define MCE_PREVENT_BLANK_SIG "display_blanking_pause_ind"

Notify everyone whether the display blanking is paused.

Since: mce 1.51.0

Parameters

status

string: current blank prevention status, one of:

◆ MCE_PREVENT_BLANK_ALLOWED_GET

#define MCE_PREVENT_BLANK_ALLOWED_GET "get_display_blanking_pause_allowed"

Query whether MCE_PREVENT_BLANK_REQ request can be made.

Since: 1.93.0

See MCE_PREVENT_BLANK_REQ for details.

Returns: boolean: true for allowed, false for not allowed

◆ MCE_PREVENT_BLANK_ALLOWED_SIG

#define MCE_PREVENT_BLANK_ALLOWED_SIG "display_blanking_pause_allowed_ind"

Notify change in whether MCE_PREVENT_BLANK_REQ request can be made.

Since: 1.93.0

See MCE_PREVENT_BLANK_REQ for details.

Parameters

boolean true for allowed, false for not allowed

◆ MCE_BLANKING_INHIBIT_GET

#define MCE_BLANKING_INHIBIT_GET "get_display_blanking_inhibit"

Get current blank inhibition status.

Since: mce 1.51.0

Returns

string: current blanking inhibit status, one of:

◆ MCE_BLANKING_INHIBIT_SIG

#define MCE_BLANKING_INHIBIT_SIG "display_blanking_inhibit_ind"

Notify everyone whether the display blanking is inhibited.

Since: mce 1.51.0

Parameters

status

string: current blanking inhibit status, one of:

◆ MCE_BLANKING_POLICY_GET

#define MCE_BLANKING_POLICY_GET "get_display_blanking_policy"

Get current display blanking policy status.

Since: mce 1.55.0

Returns

string: current blanking policy, one of:

◆ MCE_BLANKING_POLICY_SIG

#define MCE_BLANKING_POLICY_SIG "display_blanking_policy_ind"

Notify everyone when the display blanking policy changes.

Since: mce 1.55.0

Parameters

policy

string: current blanking policy, one of:

◆ MCE_PSM_STATE_GET

#define MCE_PSM_STATE_GET "get_psm_state"

Query the automatic power saving mode.

Since: mce 1.10.44

Returns: boolean: TRUE if automatic power saving mode is active, or FALSE if automatic power saving mode is inactive

◆ MCE_PSM_STATE_SIG

#define MCE_PSM_STATE_SIG "psm_state_ind"

Notify everyone that the state of the automatic power saving mode changed.

Since: mce 1.10.44

Parameters

active boolean: TRUE if automatic power saving mode is active, or FALSE if automatic power saving mode is inactive

◆ MCE_KEY_BACKLIGHT_STATE_GET

#define MCE_KEY_BACKLIGHT_STATE_GET "get_key_backlight_state"

Query key backlight state.

Since: mce 1.10.30

Returns: boolean: TRUE if the key backlight is on, or FALSE if the key backlight is off

◆ MCE_INACTIVITY_STATUS_GET

#define MCE_INACTIVITY_STATUS_GET "get_inactivity_status"

Query the inactivity status.

Since: mce 1.5.2

Returns: boolean: TRUE if the system is inactive, or FALSE if the system is active

◆ MCE_INACTIVITY_SIG

#define MCE_INACTIVITY_SIG "system_inactivity_ind"

Notify everyone that the system is active/inactive.

Since: mce 0.9.3

Parameters

active boolean: TRUE if the system is inactive, or FALSE if the system is active

◆ MCE_ADD_ACTIVITY_CALLBACK_REQ

#define MCE_ADD_ACTIVITY_CALLBACK_REQ "add_activity_callback"

Add an activity notification callback;.

Since: mce 1.10.106

The next user activity will trigger this callback.

Callbacks are one-shot – once the callback has been invoked, it will be unregistered.

Parameters

service	string: The method call service
path	string: The method call path
interface	string: The method call interface
name	string: The name of the method to call

Returns: boolean: TRUE if registration was successful, or FALSE if registration was a failure (too many registered clients)

◆ MCE_REMOVE_ACTIVITY_CALLBACK_REQ

#define MCE_REMOVE_ACTIVITY_CALLBACK_REQ "remove_activity_callback"

Remove any activity notification callback belonging to the calling process.

Since: mce 1.10.106

◆ MCE_CPU_KEEPALIVE_PERIOD_REQ

#define MCE_CPU_KEEPALIVE_PERIOD_REQ "req_cpu_keepalive_period"

Query the length of time late suspend can be blocked.

Since: mce 1.12.8

The idea is: if some process needs to do non-interactive background processing, it can prevent the system from entering late suspend by

1) get timer period via MCE_CPU_KEEPALIVE_PERIOD_REQ call

2) call MCE_CPU_KEEPALIVE_START_REQ

3) repeat MCE_CPU_KEEPALIVE_START_REQ calls in interval that is shorter than the maximum obtained at (1)

4) call MCE_CPU_KEEPALIVE_STOP_REQ when finished

MCE keeps track of active clients and blocks late suspend until all clients have called MCE_CPU_KEEPALIVE_STOP_REQ, lost D-Bus connection (exit, crash, ...) or all timeouts have been missed.

Since: mce 1.23.7

An unique within process tracking id can be passed to all cpu keepalive related D-Bus method calls. This allows mce to keep track of multiple, possibly overlapping keepalive periods from one process.

Old code that does not pass the tracking id still works as long as the client process does not have multiple overlapping periods at once.

Parameters

context string: "unique enough" tracking id

Returns: int32: renew period in seconds

◆ MCE_CPU_KEEPALIVE_START_REQ

#define MCE_CPU_KEEPALIVE_START_REQ "req_cpu_keepalive_start"

Temporarily disable enter late suspend policy.

Since: mce 1.12.8

This method call must be repeated periodically to keep the system from entering late suspend.

The period length can be obtained via MCE_CPU_KEEPALIVE_PERIOD_REQ.

Note: The boolean reply message is optional and will be sent only if requested.

Parameters

context string: "unique enough" tracking id

Returns: boolean: TRUE on success, or FALSE in case of errors

◆ MCE_CPU_KEEPALIVE_STOP_REQ

#define MCE_CPU_KEEPALIVE_STOP_REQ "req_cpu_keepalive_stop"

Allow normal enter late suspend policy again.

Since: mce 1.12.8

If a process blocks late suspend via MCE_CPU_KEEPALIVE_START_REQ, it must call MCE_CPU_KEEPALIVE_STOP_REQ when background processing is finished to enable normal late suspend policy again.

Note: The boolean reply message is optional and will be sent only if requested.

Parameters

context string: "unique enough" tracking id

Returns: boolean: TRUE on success, or FALSE in case of errors

◆ MCE_CPU_KEEPALIVE_WAKEUP_REQ

#define MCE_CPU_KEEPALIVE_WAKEUP_REQ "req_cpu_keepalive_wakeup"

Signal wakeup from suspend due to aligned timer triggering.

Since: mce 1.12.8

Note: This is reserved for use from dsme iphb module and is used for transferring ownership of rtc irq wakeup wakelock from dsme to mce.; The boolean reply message is optional and will be sent only if requested.

Returns: boolean: TRUE on success, or FALSE in case of errors

◆ MCE_CONFIG_GET

#define MCE_CONFIG_GET "get_config"

Query configuration value.

Since: mce 1.12.15

Parameters

key	string: name of the setting value to query

Returns: variant: setting value, or error reply in case of errors

◆ MCE_CONFIG_GET_ALL

#define MCE_CONFIG_GET_ALL "get_config_all"

Query all configuration values.

Since: mce 1.83.0

Get array of (key,value) pairs for all runtime changeable settings that mce supports.

array [
   dict entry(
      string SETTING_KEY_NAME
      variant SETTING_KEY_VALUE
   )
   ...
]

Returns: array of dict entries from setting key names and value variants

◆ MCE_CONFIG_SET

#define MCE_CONFIG_SET "set_config"

Set configuration value.

Since: mce 1.12.15

Parameters

key	string: setting key name
val	variant: setting key value

Returns: boolean: success, or error reply in case of failure

◆ MCE_CONFIG_RESET

#define MCE_CONFIG_RESET "reset_config"

Reset configuration values to default.

All config settings with keyname that matches the given substring will be reset to configured defaults e.g. using "/" resets all settings while using "/display/" resets only display related values.

Since: mce 1.42.0

Parameters

key	string: setting key name / initial part of key name

Returns: int32: number of changed settings, or -1 on failure

◆ MCE_CONFIG_CHANGE_SIG

#define MCE_CONFIG_CHANGE_SIG "config_change_ind"

Notify everyone that mce configuration value has changed.

Since: mce 1.14.1

Parameters

key	string: setting key name
val	variant: setting key value

◆ MCE_USB_CABLE_STATE_GET

#define MCE_USB_CABLE_STATE_GET "get_usb_cable_state"

Query current USB cable state.

Since: mce 1.86.0

Returns

string: current cable state, one of:

◆ MCE_USB_CABLE_STATE_SIG

#define MCE_USB_CABLE_STATE_SIG "usb_cable_state_ind"

Signal that indicates that USB cable state has changed.

Since: mce 1.86.0

Parameters

cable_state

string: current cable state, one of:

◆ MCE_CHARGER_STATE_GET

#define MCE_CHARGER_STATE_GET "get_charger_state"

Query current charger state.

Since: mce 1.86.0

Returns

string: current charger state, one of:

◆ MCE_CHARGER_STATE_SIG

#define MCE_CHARGER_STATE_SIG "charger_state_ind"

Signal that indicates that charger state has changed.

Since: mce 1.86.0

Parameters

charger_state

string: current charger state, one of:

◆ MCE_BATTERY_STATUS_GET

#define MCE_BATTERY_STATUS_GET "get_battery_status"

Query current battery status.

Since: mce 1.86.0

Returns

string: current battery status, one of:

◆ MCE_BATTERY_STATUS_SIG

#define MCE_BATTERY_STATUS_SIG "battery_status_ind"

Signal that indicates that battery status has changed.

Since: mce 1.86.0

Parameters

battery_status

string: current battery status, one of:

◆ MCE_BATTERY_STATE_GET

#define MCE_BATTERY_STATE_GET "get_battery_state"

Query current battery state.

Since: mce 1.104.0

Returns

string: current battery state, one of:

◆ MCE_BATTERY_STATE_SIG

#define MCE_BATTERY_STATE_SIG "battery_state_ind"

Signal that indicates that battery state has changed.

Since: mce 1.104.0

Parameters

battery_state

string: current battery state, one of:

◆ MCE_BATTERY_LEVEL_GET

#define MCE_BATTERY_LEVEL_GET "get_battery_level"

Query current battery level.

Since: mce 1.86.0

Returns: int32: battery level percent, or MCE_BATTERY_LEVEL_UNKNOWN

◆ MCE_BATTERY_LEVEL_SIG

#define MCE_BATTERY_LEVEL_SIG "battery_level_ind"

Signal that indicates that battery level has changed.

Since: mce 1.86.0

Parameters

bettery_level int32: battery level percent, or MCE_BATTERY_LEVEL_UNKNOWN

◆ MCE_CHARGER_TYPE_GET

#define MCE_CHARGER_TYPE_GET "get_charger_type"

Query current charger type.

Since: mce 1.102.0

Returns

string: current charger type, one of:

◆ MCE_CHARGER_TYPE_SIG

#define MCE_CHARGER_TYPE_SIG "charger_type_ind"

Signal that indicates that charger type has changed.

Since: mce 1.102.0

Parameters

charger_type

string: current charger type, one of:

◆ MCE_ACTIVATE_LED_PATTERN

#define MCE_ACTIVATE_LED_PATTERN "req_led_pattern_activate"

Activate a pre-defined LED pattern.

Since: mce 1.5.0

Note: Aegis credential for Nokia N9: mce::LEDControl

Available patterns depends on mce configuration.

Non-existing patterns are ignored.

◆ MCE_DEACTIVATE_LED_PATTERN

#define MCE_DEACTIVATE_LED_PATTERN "req_led_pattern_deactivate"

Deactivate a pre-defined LED pattern.

Since: mce 1.5.0

Note: Aegis credential for Nokia N9: mce::LEDControl

Available patterns depends on mce configuration.

Non-existing patterns are ignored

See also: MCE_LED_PATTERN_DEACTIVATED_SIG

Parameters

pattern string: led pattern name

◆ MCE_LED_PATTERN_ACTIVATED_SIG

#define MCE_LED_PATTERN_ACTIVATED_SIG "led_pattern_activated_ind"

Notify everyone that a led pattern has been activated.

Since: mce 1.25.0

Parameters

activated_pattern string: led pattern name

◆ MCE_LED_PATTERN_DEACTIVATED_SIG

#define MCE_LED_PATTERN_DEACTIVATED_SIG "led_pattern_deactivated_ind"

Notify everyone that a led pattern has been deactivated.

Since: mce 1.25.0

Parameters

deactivated_pattern string: led pattern name

◆ MCE_ENABLE_LED

#define MCE_ENABLE_LED "req_led_enable"

Allow activation of normal led patterns.

Since: mce 1.5.0

Note: Aegis credential for Nokia N9: mce::LEDControl

The current led stack is re-evaluated and also normal led patterns are considered when choosing active pattern.

Note: Applications should never call this method. It is reserved for things like development time debugging and CSD test application (which needs to be sure patterns used by it do get priority over normal led patterns).

◆ MCE_DISABLE_LED

#define MCE_DISABLE_LED "req_led_disable"

Deny actiovation of normal led patterns.

Since: mce 1.5.0

Note: Aegis credential for Nokia N9: mce::LEDControl

The current led stack is re-evaluated and normal led patterns are ignored when choosing active pattern.

Note: Applications should never call this method. It is reserved for things like development time debugging and CSD test application (which needs to be sure patterns used by it do get priority over normal led patterns).

◆ MCE_TOUCH_INPUT_POLICY_GET

#define MCE_TOUCH_INPUT_POLICY_GET "get_touch_input_policy"

Get current touch screen input policy.

Since: mce 1.87.0

Returns

string: current touch input policy state, one of:

◆ MCE_TOUCH_INPUT_POLICY_SIG

#define MCE_TOUCH_INPUT_POLICY_SIG "touch_input_policy_ind"

Indication for change of touch screen input policy.

Since: mce 1.87.0

Parameters

input_state

string: current touch input input policy state, one of:

◆ MCE_VOLKEY_INPUT_POLICY_GET

#define MCE_VOLKEY_INPUT_POLICY_GET "get_keypad_input_policy"

Get current volume key input policy.

Since: mce 1.87.0

Returns

string: current volkey input policy state, one of:

◆ MCE_VOLKEY_INPUT_POLICY_SIG

#define MCE_VOLKEY_INPUT_POLICY_SIG "keypad_input_policy_ind"

Indication for change of volume key input policy.

Since: mce 1.87.0

Parameters

input_state

string: current volkey input input policy state, one of:

◆ MCE_BUTTON_BACKLIGHT_GET

#define MCE_BUTTON_BACKLIGHT_GET "get_button_backlight"

Get current button backlight state.

Since: mce 1.90.0

Returns true when button backlight is lit, false otherwise.

Returns: boolean: TRUE for backlight is on, FALSE for off

◆ MCE_BUTTON_BACKLIGHT_CHANGE_REQ

#define MCE_BUTTON_BACKLIGHT_CHANGE_REQ "req_button_backlight_change"

Request button backlight state change.

Since: mce 1.90.0

The button backlight is lit when policy permits is, at least one D-Bus client has requested it, and the required control file configuration has been provided.

Parameters

state boolean: TRUE for backlight on, FALSE for off

◆ MCE_BUTTON_BACKLIGHT_MODE_REQ

#define MCE_BUTTON_BACKLIGHT_MODE_REQ "req_button_backlight_mode"

Request button backlight mode change.

Since: mce 1.98.0

For use from the CSD application button backlight verification test.

Allows bypassing of the button backlight policy and explicitly turn the backlight on or off.

Parameters

mode	int32: MCE_BUTTON_BACKLIGHT_MODE_OFF, MCE_BUTTON_BACKLIGHT_MODE_ON, or MCE_BUTTON_BACKLIGHT_MODE_POLICY

◆ MCE_BUTTON_BACKLIGHT_SIG

#define MCE_BUTTON_BACKLIGHT_SIG "sig_button_backlight_ind"

Indication for change of button backlight state.

Since: mce 1.90.0

The state is true when button backlight is lit, false otherwise.

Parameters

state boolean: TRUE for backlight in on, FALSE for off

◆ MCE_HARDWARE_KEYBOARD_STATE_GET

#define MCE_HARDWARE_KEYBOARD_STATE_GET "keyboard_available_state_req"

Query HW keyboard availability.

Since: mce 1.39.0

Non-slidable keyboard present, or sliding keyboard present and opened

Used for example in evaluating whether virtual keyboard should be used or not.

Returns

string: availability state, one of:

◆ MCE_HARDWARE_KEYBOARD_STATE_SIG

#define MCE_HARDWARE_KEYBOARD_STATE_SIG "keyboard_available_state_ind"

Notify changes in HW keyboard availability.

Since: mce 1.39.0

Non-slidable keyboard present, or sliding keyboard present and opened

Returns

string: availability state, one of:

◆ MCE_HARDWARE_MOUSE_STATE_GET

#define MCE_HARDWARE_MOUSE_STATE_GET "mouse_available_state_req"

Query HW mouse availability.

Since: mce 1.109.0

Mouse present

Used for example in evaluating whether mouse pointer should be shown or not.

Returns

string: availability state, one of:

◆ MCE_HARDWARE_MOUSE_STATE_SIG

#define MCE_HARDWARE_MOUSE_STATE_SIG "mouse_available_state_ind"

Notify changes in HW mouse availability.

Since: mce 1.109.0

Mouse present

Returns

string: availability state, one of:

◆ MCE_SLIDING_KEYBOARD_STATE_GET

#define MCE_SLIDING_KEYBOARD_STATE_GET "keyboard_slide_state_req"

Query current sliding keyboard state.

Since: mce 1.39.0

Returns

string: keyboard state, one of:

◆ MCE_SLIDING_KEYBOARD_STATE_SIG

#define MCE_SLIDING_KEYBOARD_STATE_SIG "keyboard_slide_state_ind"

Notify sliding keyboard state changes.

Since: mce 1.39.0

Parameters

state

string: keyboard state, one of:

◆ MCE_FADER_OPACITY_SIG

#define MCE_FADER_OPACITY_SIG "fader_opacity_ind"

Signal for controlling compositor side display dimming.

Since: mce 1.34.0

In situations where there is not enough dynamic range available to make the difference between "on" and "dimmed" display states clear to user, mce sends this signal to instruct compositor to complement the display backlight brightness based dimming by blending the whole visible ui with an all black rectangle.

The amount of requested dimming depends on hw specific configuration and backlight brightness level in use.

The requested fade animation duration is derived from what mce would use for backlight brightness fade anination and depends on mce side configuration.

It is expected that compositor can and will cap both the amount of dimming and transition length to some span that makes sense from compositor point of view.

Parameters

dimming	int32: dimming percent 0 for normal, undimmed ui ... 100 completely blacked out ui
duration	int32: fade animation duration [ms]

◆ MCE_ALARM_UI_FEEDBACK_SIG

#define MCE_ALARM_UI_FEEDBACK_SIG "alarm_ui_feedback_ind"

Signal for notifying alarm ui about power key presses / device flip overs.

Since: mce 1.26.0

Used for silencing alarm via power key press / device flip over.

Parameters

event

string: event name, such as:

◆ MCE_CALL_UI_FEEDBACK_SIG

#define MCE_CALL_UI_FEEDBACK_SIG "call_ui_feedback_ind"

Signal for notifying call ui about power key presses / device flip overs.

Since: mce 1.26.0

Used for silencing incoming call via power key press / device flip over

Parameters

event

string: event name, such as:

◆ MCE_IGNORE_INCOMING_CALL_REQ

#define MCE_IGNORE_INCOMING_CALL_REQ "req_ignore_incoming_call"

Inform mce that incoming call has been ignored by ui.

Since: mce 1.19.0

When there is an incoming call, mce reserves the power key for alarm ui and silencing the ringing tone.

This method can be used by the call ui to inform mce that the call has been ignored and power key can again be used for display power control even though there still are calls in ringing state.

◆ MCE_POWER_BUTTON_TRIGGER

#define MCE_POWER_BUTTON_TRIGGER "power_button_trigger"

Signal for notifying systemui about power button etc related events.

Since: mce 1.37.0

Parameters

event

string: partly configurable and varies, but includes:

MCE_FEEDBACK_EVENT_HOMEKEY wake up to fingerprint detection, or toggle between home and app view
MCE_FEEDBACK_EVENT_UNLOCK switch ui to device unlock view

◆ MCE_TKLOCK_CB_REQ

#define MCE_TKLOCK_CB_REQ "tklock_callback"

Method for sending tklock feedback from systemui to mce.

Since: mce 1.10.88 (legacy)

Deprecated:: Must not be used in application code and should be removed altogether both from mce and lipstick.

Parameters

status

int32: tklock feedback, one of:

◆ MCE_DISPLAY_STATE_LPM_OFF_REQ

#define MCE_DISPLAY_STATE_LPM_OFF_REQ "req_display_state_lpm_off"

Request transition to lpm-off display state.

Since: mce 1.82.3

Note: This method is not available in normal mce builds and it is meant strictly for debugging transitions to/from lpm display states only.

◆ MCE_DISPLAY_STATE_LPM_ON_REQ

#define MCE_DISPLAY_STATE_LPM_ON_REQ "req_display_state_lpm_on"

Request transition to lpm-on display state.

Since: mce 1.82.3

Note: This method is not available in normal mce builds and it is meant strictly for debugging transitions to/from lpm display states only.

◆ MCE_LPM_UI_MODE_SIG

#define MCE_LPM_UI_MODE_SIG "lpm_ui_mode_ind"

Used for triggering UI transitions to/from LPM view.

Since: mce 1.30.0

The "Display Low Power Mode" is substate applicable when display is logically in off state and lockscreen is active.

The intent is that display gets powered up and lockscreen ui with less decorations and suitable for low brightness display is shown.

Normal applications should not have any reason to follow these signals.

Parameters

state

string, one of:

◆ MCE_MEMORY_LEVEL_GET

#define MCE_MEMORY_LEVEL_GET "get_memory_level"

Method for querying current system memory pressure level.

Since: mce 1.35.0

Returns

level string, one of:

◆ MCE_MEMORY_LEVEL_SIG

#define MCE_MEMORY_LEVEL_SIG "sig_memory_level_ind"

Signal for notifying system memory pressure level changes.

Since: mce 1.35.0

Parameters

level

string, one of:

◆ MCE_NOTIFICATION_BEGIN_REQ

#define MCE_NOTIFICATION_BEGIN_REQ "notification_begin_req"

Method for declaring start of exceptional display on state.

Since: mce 1.29.0

Parameters

name	string: unique-enough identifier
duration	int32: notification duration [ms]
extend	int32: extend due to user activity time [ms]

◆ MCE_NOTIFICATION_END_REQ

#define MCE_NOTIFICATION_END_REQ "notification_end_req"

Method for declaring end of exceptional display on state.

Since: mce 1.29.0

Parameters

name	string: unique-enough identifier
linger	int32: remain in display on time [ms]

◆ MCE_CABC_MODE_GET

#define MCE_CABC_MODE_GET "get_cabc_mode"

Query CABC mode.

Since: mce 1.10.0

Returns

string: current cabc mode, one of:

◆ MCE_CABC_MODE_REQ

#define MCE_CABC_MODE_REQ "req_cabc_mode"

Request CABC mode change.

Since: mce 1.10.0

Note: Content Adaptive Backlight Control has been supported only in maemo/meego phones made by Nokia.

A non-functional skeleton interface is available unless suitable hw and driver support exists along with relevant configuration.

Parameters

mode	string: requested cabc mode, one of: MCE_CABC_MODE_OFF MCE_CABC_MODE_UI MCE_CABC_MODE_STILL_IMAGE MCE_CABC_MODE_MOVING_IMAGE

Returns

string: updated cabc mode, one of:

◆ MCE_COLOR_PROFILE_GET

#define MCE_COLOR_PROFILE_GET "get_color_profile"

Query the current color profile id.

Since: mce 1.11.2

Returns: string: the current profile id

◆ MCE_COLOR_PROFILE_IDS_GET

#define MCE_COLOR_PROFILE_IDS_GET "get_color_profile_ids"

Query the list of the available color profile ids.

Since: mce 1.11.2

Apart from built-in "hardcoded" the available color profiles depends on mce configuration.

Returns: array of strings: supported color profile ids

◆ MCE_COLOR_PROFILE_CHANGE_REQ

#define MCE_COLOR_PROFILE_CHANGE_REQ "req_color_profile_change"

Request color profile change.

Since: mce 1.11.2

Note: Currently the color profiles are not supported and a skeleton API is available solely for backwards compatibility.; Aegis credential for Nokia N9: mce::ColorProfileControl

Parameters

mode	string: requested color profile id

◆ MCE_COLOR_PROFILE_SIG

#define MCE_COLOR_PROFILE_SIG "color_profile_ind"

Notify everyone that the color profile has changed.

Since: mce 1.11.2

Note: Color profiles have been supported only in maemo/meego phones made by Nokia.

Deprecated:: Only a skeleton functionality is provided for backwards compatibility.

Parameters

mode	string: current color profile id

◆ MCE_VERSION_GET

#define MCE_VERSION_GET "get_version"

Query MCE version.

Since: mce 1.1.6

Returns: string: MCE version

◆ MCE_TRIGGER_POWERKEY_EVENT_REQ

#define MCE_TRIGGER_POWERKEY_EVENT_REQ "req_trigger_powerkey_event"

Request powerkey event triggering.

Since: mce 1.5.3 (implemented); mce 1.10.54 (argument changed from boolean to uint32)

Note: Aegis credential for Nokia N9: mce::DeviceModeControl; Intended for use from automated qa testing only.

Parameters

type	uint32: power key event to trigger, one of: MCE_POWERKEY_EVENT_SHORT_PRESS MCE_POWERKEY_EVENT_LONG_PRESS MCE_POWERKEY_EVENT_DOUBLE_PRESS

◆ MCE_DISPLAY_STATS_GET

#define MCE_DISPLAY_STATS_GET "get_display_stats"

Get amount of time spent in each display state.

Since: mce 1.74.0

Used for: Debugging power drain issues, QA reporting, etc.

After MCE process starts up, it keeps track of the number of times various display states have been entered and total time spent in each state. Time before mce startup gets accounted to "undefined" display state.

The data returned is - in dbus terms - array of dictionary entries having display state name as a key and total time and entry count as value.

array [
   dict entry(
      string DISPLAY_STATE_NAME
      struct {
         int64 MS_SPENT_IN_THE_STATE
         int64 ENTRY_COUNT_TO_THE_STATE
      }
   )
   ...
]

Returns: array of entries as described above

◆ MCE_SUSPEND_STATS_GET

#define MCE_SUSPEND_STATS_GET "get_suspend_stats"

Query current uptime and time spent in suspend.

Since: mce 1.65.0

Used for: Automated suspend testing, QA reporting, etc.

Basically:

uptime is taken from CLOCK_BOOTTIME
suspend time is taken from CLOCK_MONOTONIC - CLOCK_BOOTTIME

Returns: int64: uptime_ms; int64: suspend_ms

◆ MCE_VERBOSITY_GET

#define MCE_VERBOSITY_GET "get_verbosity"

Query current logging verbosity.

Since: mce 1.71.0

Returns

int32: syslog compatible verbosity level:

0 == LOG_EMERG
...
7 == LOG_DEBUG

◆ MCE_VERBOSITY_REQ

#define MCE_VERBOSITY_REQ "set_verbosity"

Change current logging verbosity.

Since: mce 1.71.0

Parameters

verbosity

int32: syslog compatible verbosity level:

0 == LOG_EMERG
...
7 == LOG_DEBUG

Macros

Detailed Description

Macro Definition Documentation

◆ MCE_SERVICE

◆ MCE_REQUEST_IF

◆ MCE_SIGNAL_IF

◆ MCE_REQUEST_PATH

◆ MCE_SIGNAL_PATH

◆ MCE_ERROR_FATAL

◆ MCE_ERROR_INVALID_ARGS

◆ MCE_RADIO_STATES_GET

◆ MCE_RADIO_STATES_CHANGE_REQ

◆ MCE_RADIO_STATES_SIG

◆ MCE_CALL_STATE_GET

◆ MCE_CALL_STATE_CHANGE_REQ

◆ MCE_CALL_STATE_SIG

◆ MCE_DISPLAY_STATUS_GET

◆ MCE_DISPLAY_ON_REQ

◆ MCE_DISPLAY_DIM_REQ

◆ MCE_DISPLAY_OFF_REQ

◆ MCE_DISPLAY_LPM_REQ

◆ MCE_DISPLAY_SIG

◆ MCE_TKLOCK_MODE_GET

◆ MCE_TKLOCK_MODE_CHANGE_REQ

◆ MCE_TKLOCK_MODE_SIG

◆ MCE_PREVENT_BLANK_REQ

◆ MCE_CANCEL_PREVENT_BLANK_REQ

◆ MCE_PREVENT_BLANK_GET

◆ MCE_PREVENT_BLANK_SIG

◆ MCE_PREVENT_BLANK_ALLOWED_GET

◆ MCE_PREVENT_BLANK_ALLOWED_SIG

◆ MCE_BLANKING_INHIBIT_GET

◆ MCE_BLANKING_INHIBIT_SIG

◆ MCE_BLANKING_POLICY_GET

◆ MCE_BLANKING_POLICY_SIG

◆ MCE_PSM_STATE_GET

◆ MCE_PSM_STATE_SIG

◆ MCE_KEY_BACKLIGHT_STATE_GET

◆ MCE_INACTIVITY_STATUS_GET

◆ MCE_INACTIVITY_SIG

◆ MCE_ADD_ACTIVITY_CALLBACK_REQ

◆ MCE_REMOVE_ACTIVITY_CALLBACK_REQ

◆ MCE_CPU_KEEPALIVE_PERIOD_REQ

◆ MCE_CPU_KEEPALIVE_START_REQ

◆ MCE_CPU_KEEPALIVE_STOP_REQ

◆ MCE_CPU_KEEPALIVE_WAKEUP_REQ

◆ MCE_CONFIG_GET

◆ MCE_CONFIG_GET_ALL

◆ MCE_CONFIG_SET

◆ MCE_CONFIG_RESET

◆ MCE_CONFIG_CHANGE_SIG

◆ MCE_USB_CABLE_STATE_GET

◆ MCE_USB_CABLE_STATE_SIG

◆ MCE_CHARGER_STATE_GET

◆ MCE_CHARGER_STATE_SIG

◆ MCE_BATTERY_STATUS_GET

◆ MCE_BATTERY_STATUS_SIG

◆ MCE_BATTERY_STATE_GET

◆ MCE_BATTERY_STATE_SIG

◆ MCE_BATTERY_LEVEL_GET

◆ MCE_BATTERY_LEVEL_SIG

◆ MCE_CHARGER_TYPE_GET

◆ MCE_CHARGER_TYPE_SIG

◆ MCE_ACTIVATE_LED_PATTERN

◆ MCE_DEACTIVATE_LED_PATTERN

◆ MCE_LED_PATTERN_ACTIVATED_SIG

◆ MCE_LED_PATTERN_DEACTIVATED_SIG

◆ MCE_ENABLE_LED

◆ MCE_DISABLE_LED

◆ MCE_TOUCH_INPUT_POLICY_GET

◆ MCE_TOUCH_INPUT_POLICY_SIG

◆ MCE_VOLKEY_INPUT_POLICY_GET

◆ MCE_VOLKEY_INPUT_POLICY_SIG

◆ MCE_BUTTON_BACKLIGHT_GET

◆ MCE_BUTTON_BACKLIGHT_CHANGE_REQ

◆ MCE_BUTTON_BACKLIGHT_MODE_REQ

◆ MCE_BUTTON_BACKLIGHT_SIG

◆ MCE_HARDWARE_KEYBOARD_STATE_GET

◆ MCE_HARDWARE_KEYBOARD_STATE_SIG

◆ MCE_HARDWARE_MOUSE_STATE_GET