MCE D-Bus Interface 1.10.x
|
D-Bus Interface to the Mode Control Entity. More...
Go to the source code of this file.
Macros | |
MCE D-Bus Service | |
#define | MCE_SERVICE "com.nokia.mce" |
MCE D-Bus service name. | |
#define | MCE_REQUEST_IF "com.nokia.mce.request" |
MCE D-Bus Request interface. | |
#define | MCE_SIGNAL_IF "com.nokia.mce.signal" |
MCE D-Bus Signal interface. | |
#define | MCE_REQUEST_PATH "/com/nokia/mce/request" |
MCE D-Bus Request path. | |
#define | MCE_SIGNAL_PATH "/com/nokia/mce/signal" |
MCE D-Bus Signal path. | |
#define | MCE_ERROR_FATAL "com.nokia.mce.error.fatal" |
The MCE D-Bus error interface; currently not used. | |
#define | MCE_ERROR_INVALID_ARGS "org.freedesktop.DBus.Error.InvalidArgs" |
The D-Bus interface for invalid arguments; currently not used. | |
Radio State | |
#define | MCE_RADIO_STATES_GET "get_radio_states" |
Query radio states. | |
#define | MCE_RADIO_STATES_CHANGE_REQ "req_radio_states_change" |
Request radio states change. | |
#define | MCE_RADIO_STATES_SIG "radio_states_ind" |
Notify everyone that the radio states have changed. | |
Call State | |
#define | MCE_CALL_STATE_GET "get_call_state" |
Query the call state. | |
#define | MCE_CALL_STATE_CHANGE_REQ "req_call_state_change" |
Request call state change. | |
#define | MCE_CALL_STATE_SIG "sig_call_state_ind" |
Notify everyone that the call state has changed. | |
Display State | |
#define | MCE_DISPLAY_STATUS_GET "get_display_status" |
Query the display status. | |
#define | MCE_DISPLAY_ON_REQ "req_display_state_on" |
Unblank display. | |
#define | MCE_DISPLAY_DIM_REQ "req_display_state_dim" |
Dim display. | |
#define | MCE_DISPLAY_OFF_REQ "req_display_state_off" |
Blank display. | |
#define | MCE_DISPLAY_LPM_REQ "req_display_state_lpm" |
Set display to low power mode. | |
#define | MCE_DISPLAY_SIG "display_status_ind" |
Notify everyone that the display is on/dimmed/off. | |
Touchscreen And Keypad Lock State | |
#define | MCE_TKLOCK_MODE_GET "get_tklock_mode" |
Query the touchscreen/keypad lock mode. | |
#define | MCE_TKLOCK_MODE_CHANGE_REQ "req_tklock_mode_change" |
Request tklock mode change. | |
#define | MCE_TKLOCK_MODE_SIG "tklock_mode_ind" |
Signal that indicates that the touchscreen/keypad lock mode has changed. | |
Display Blank Prevention | |
#define | MCE_PREVENT_BLANK_REQ "req_display_blanking_pause" |
Prevent display from blanking. | |
#define | MCE_CANCEL_PREVENT_BLANK_REQ "req_display_cancel_blanking_pause" |
Cancel display blanking prevention. | |
#define | MCE_PREVENT_BLANK_GET "get_display_blanking_pause" |
Get current blank prevention status. | |
#define | MCE_PREVENT_BLANK_SIG "display_blanking_pause_ind" |
Notify everyone whether the display blanking is paused. | |
#define | MCE_PREVENT_BLANK_ALLOWED_GET "get_display_blanking_pause_allowed" |
Query whether MCE_PREVENT_BLANK_REQ request can be made. | |
#define | MCE_PREVENT_BLANK_ALLOWED_SIG "display_blanking_pause_allowed_ind" |
Notify change in whether MCE_PREVENT_BLANK_REQ request can be made. | |
Display Blanking Inhibit State | |
#define | MCE_BLANKING_INHIBIT_GET "get_display_blanking_inhibit" |
Get current blank inhibition status. | |
#define | MCE_BLANKING_INHIBIT_SIG "display_blanking_inhibit_ind" |
Notify everyone whether the display blanking is inhibited. | |
Display Blanking Policy State | |
#define | MCE_BLANKING_POLICY_GET "get_display_blanking_policy" |
Get current display blanking policy status. | |
#define | MCE_BLANKING_POLICY_SIG "display_blanking_policy_ind" |
Notify everyone when the display blanking policy changes. | |
Power Save Mode | |
#define | MCE_PSM_STATE_GET "get_psm_state" |
Query the automatic power saving mode. | |
#define | MCE_PSM_STATE_SIG "psm_state_ind" |
Notify everyone that the state of the automatic power saving mode changed. | |
Keypad Backlight Status | |
#define | MCE_KEY_BACKLIGHT_STATE_GET "get_key_backlight_state" |
Query key backlight state. | |
Device Inactivity | |
#define | MCE_INACTIVITY_STATUS_GET "get_inactivity_status" |
Query the inactivity status. | |
#define | MCE_INACTIVITY_SIG "system_inactivity_ind" |
Notify everyone that the system is active/inactive. | |
#define | MCE_ADD_ACTIVITY_CALLBACK_REQ "add_activity_callback" |
Add an activity notification callback;. | |
#define | MCE_REMOVE_ACTIVITY_CALLBACK_REQ "remove_activity_callback" |
Remove any activity notification callback belonging to the calling process. | |
CPU Keepalive | |
#define | MCE_CPU_KEEPALIVE_PERIOD_REQ "req_cpu_keepalive_period" |
Query the length of time late suspend can be blocked. | |
#define | MCE_CPU_KEEPALIVE_START_REQ "req_cpu_keepalive_start" |
Temporarily disable enter late suspend policy. | |
#define | MCE_CPU_KEEPALIVE_STOP_REQ "req_cpu_keepalive_stop" |
Allow normal enter late suspend policy again. | |
#define | MCE_CPU_KEEPALIVE_WAKEUP_REQ "req_cpu_keepalive_wakeup" |
Signal wakeup from suspend due to aligned timer triggering. | |
MCE Settings | |
#define | MCE_CONFIG_GET "get_config" |
Query configuration value. | |
#define | MCE_CONFIG_GET_ALL "get_config_all" |
Query all configuration values. | |
#define | MCE_CONFIG_SET "set_config" |
Set configuration value. | |
#define | MCE_CONFIG_RESET "reset_config" |
Reset configuration values to default. | |
#define | MCE_CONFIG_CHANGE_SIG "config_change_ind" |
Notify everyone that mce configuration value has changed. | |
Battery And Charging State | |
#define | MCE_USB_CABLE_STATE_GET "get_usb_cable_state" |
Query current USB cable state. | |
#define | MCE_USB_CABLE_STATE_SIG "usb_cable_state_ind" |
Signal that indicates that USB cable state has changed. | |
#define | MCE_CHARGER_STATE_GET "get_charger_state" |
Query current charger state. | |
#define | MCE_CHARGER_STATE_SIG "charger_state_ind" |
Signal that indicates that charger state has changed. | |
#define | MCE_BATTERY_STATUS_GET "get_battery_status" |
Query current battery status. | |
#define | MCE_BATTERY_STATUS_SIG "battery_status_ind" |
Signal that indicates that battery status has changed. | |
#define | MCE_BATTERY_STATE_GET "get_battery_state" |
Query current battery state. | |
#define | MCE_BATTERY_STATE_SIG "battery_state_ind" |
Signal that indicates that battery state has changed. | |
#define | MCE_BATTERY_LEVEL_GET "get_battery_level" |
Query current battery level. | |
#define | MCE_BATTERY_LEVEL_SIG "battery_level_ind" |
Signal that indicates that battery level has changed. | |
#define | MCE_CHARGER_TYPE_GET "get_charger_type" |
Query current charger type. | |
#define | MCE_CHARGER_TYPE_SIG "charger_type_ind" |
Signal that indicates that charger type has changed. | |
#define | MCE_CHARGING_STATE_GET "get_charging_state" |
Query current charging hysteresis state. | |
#define | MCE_CHARGING_STATE_SIG "charging_state_ind" |
Signal that indicates that charging hysteresis state has changed. | |
#define | MCE_FORCED_CHARGING_GET "get_forced_charging" |
Query charge-once-to-full policy override state. | |
#define | MCE_FORCED_CHARGING_REQ "req_forced_charging" |
Request charge-once-to-full policy override state change. | |
#define | MCE_FORCED_CHARGING_SIG "forced_charging_ind" |
Signal that indicates that charge-once-to-full policy override state has changed. | |
#define | MCE_CHARGING_SUSPENDABLE_GET "get_charging_suspendable" |
Query whether charging can be suspended on this device. | |
LED Control | |
#define | MCE_ACTIVATE_LED_PATTERN "req_led_pattern_activate" |
Activate a pre-defined LED pattern. | |
#define | MCE_DEACTIVATE_LED_PATTERN "req_led_pattern_deactivate" |
Deactivate a pre-defined LED pattern. | |
#define | MCE_LED_PATTERN_ACTIVATED_SIG "led_pattern_activated_ind" |
Notify everyone that a led pattern has been activated. | |
#define | MCE_LED_PATTERN_DEACTIVATED_SIG "led_pattern_deactivated_ind" |
Notify everyone that a led pattern has been deactivated. | |
#define | MCE_ENABLE_LED "req_led_enable" |
Allow activation of normal led patterns. | |
#define | MCE_DISABLE_LED "req_led_disable" |
Deny actiovation of normal led patterns. | |
Input Event Handling Policy | |
#define | MCE_TOUCH_INPUT_POLICY_GET "get_touch_input_policy" |
Get current touch screen input policy. | |
#define | MCE_TOUCH_INPUT_POLICY_SIG "touch_input_policy_ind" |
Indication for change of touch screen input policy. | |
#define | MCE_VOLKEY_INPUT_POLICY_GET "get_keypad_input_policy" |
Get current volume key input policy. | |
#define | MCE_VOLKEY_INPUT_POLICY_SIG "keypad_input_policy_ind" |
Indication for change of volume key input policy. | |
Button Backlight Policy | |
#define | MCE_BUTTON_BACKLIGHT_GET "get_button_backlight" |
Get current button backlight state. | |
#define | MCE_BUTTON_BACKLIGHT_CHANGE_REQ "req_button_backlight_change" |
Request button backlight state change. | |
#define | MCE_BUTTON_BACKLIGHT_MODE_REQ "req_button_backlight_mode" |
Request button backlight mode change. | |
#define | MCE_BUTTON_BACKLIGHT_SIG "sig_button_backlight_ind" |
Indication for change of button backlight state. | |
Hardware Keyboard Availability | |
#define | MCE_HARDWARE_KEYBOARD_STATE_GET "keyboard_available_state_req" |
Query HW keyboard availability. | |
#define | MCE_HARDWARE_KEYBOARD_STATE_SIG "keyboard_available_state_ind" |
Notify changes in HW keyboard availability. | |
Hardware Mouse Availability | |
#define | MCE_HARDWARE_MOUSE_STATE_GET "mouse_available_state_req" |
Query HW mouse availability. | |
#define | MCE_HARDWARE_MOUSE_STATE_SIG "mouse_available_state_ind" |
Notify changes in HW mouse availability. | |
Sliding Keyboard State | |
#define | MCE_SLIDING_KEYBOARD_STATE_GET "keyboard_slide_state_req" |
Query current sliding keyboard state. | |
#define | MCE_SLIDING_KEYBOARD_STATE_SIG "keyboard_slide_state_ind" |
Notify sliding keyboard state changes. | |
Interaction Between MCE And UI Components | |
#define | MCE_FADER_OPACITY_SIG "fader_opacity_ind" |
Signal for controlling compositor side display dimming. | |
#define | MCE_ALARM_UI_FEEDBACK_SIG "alarm_ui_feedback_ind" |
Signal for notifying alarm ui about power key presses / device flip overs. | |
#define | MCE_CALL_UI_FEEDBACK_SIG "call_ui_feedback_ind" |
Signal for notifying call ui about power key presses / device flip overs. | |
#define | MCE_IGNORE_INCOMING_CALL_REQ "req_ignore_incoming_call" |
Inform mce that incoming call has been ignored by ui. | |
#define | MCE_POWER_BUTTON_TRIGGER "power_button_trigger" |
Signal for notifying systemui about power button etc related events. | |
#define | MCE_TKLOCK_CB_REQ "tklock_callback" |
Method for sending tklock feedback from systemui to mce. | |
Display Low Power Mode | |
#define | MCE_DISPLAY_STATE_LPM_OFF_REQ "req_display_state_lpm_off" |
Request transition to lpm-off display state. | |
#define | MCE_DISPLAY_STATE_LPM_ON_REQ "req_display_state_lpm_on" |
Request transition to lpm-on display state. | |
#define | MCE_LPM_UI_MODE_SIG "lpm_ui_mode_ind" |
Used for triggering UI transitions to/from LPM view. | |
System Memory Pressure | |
#define | MCE_MEMORY_LEVEL_GET "get_memory_level" |
Method for querying current system memory pressure level. | |
#define | MCE_MEMORY_LEVEL_SIG "sig_memory_level_ind" |
Signal for notifying system memory pressure level changes. | |
Time Limited Display Wakeups | |
#define | MCE_NOTIFICATION_BEGIN_REQ "notification_begin_req" |
Method for declaring start of exceptional display on state. | |
#define | MCE_NOTIFICATION_END_REQ "notification_end_req" |
Method for declaring end of exceptional display on state. | |
Content Adaptive Backlight Control Mode | |
#define | MCE_CABC_MODE_GET "get_cabc_mode" |
Query CABC mode. | |
#define | MCE_CABC_MODE_REQ "req_cabc_mode" |
Request CABC mode change. | |
Color Profile | |
#define | MCE_COLOR_PROFILE_GET "get_color_profile" |
Query the current color profile id. | |
#define | MCE_COLOR_PROFILE_IDS_GET "get_color_profile_ids" |
Query the list of the available color profile ids. | |
#define | MCE_COLOR_PROFILE_CHANGE_REQ "req_color_profile_change" |
Request color profile change. | |
#define | MCE_COLOR_PROFILE_SIG "color_profile_ind" |
Notify everyone that the color profile has changed. | |
Miscellaneous | |
#define | MCE_VERSION_GET "get_version" |
Query MCE version. | |
#define | MCE_TRIGGER_POWERKEY_EVENT_REQ "req_trigger_powerkey_event" |
Request powerkey event triggering. | |
#define | MCE_DISPLAY_STATS_GET "get_display_stats" |
Get amount of time spent in each display state. | |
#define | MCE_SUSPEND_STATS_GET "get_suspend_stats" |
Query current uptime and time spent in suspend. | |
#define | MCE_VERBOSITY_GET "get_verbosity" |
Query current logging verbosity. | |
#define | MCE_VERBOSITY_REQ "set_verbosity" |
Change current logging verbosity. | |
D-Bus Interface to the Mode Control Entity.
This file is part of mce-dev
Copyright (c) 2004 - 2011 Nokia Corporation and/or its subsidiary(-ies). Copyright (c) 2013 - 2022 Jolla Ltd. Copyright (c) 2019 Open Mobile Platform LLC.
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/.
#define MCE_SERVICE "com.nokia.mce" |
MCE D-Bus service name.
#define MCE_REQUEST_IF "com.nokia.mce.request" |
MCE D-Bus Request interface.
#define MCE_SIGNAL_IF "com.nokia.mce.signal" |
MCE D-Bus Signal interface.
#define MCE_REQUEST_PATH "/com/nokia/mce/request" |
MCE D-Bus Request path.
#define MCE_SIGNAL_PATH "/com/nokia/mce/signal" |
MCE D-Bus Signal path.
#define MCE_ERROR_FATAL "com.nokia.mce.error.fatal" |
The MCE D-Bus error interface; currently not used.
#define MCE_ERROR_INVALID_ARGS "org.freedesktop.DBus.Error.InvalidArgs" |
The D-Bus interface for invalid arguments; currently not used.
#define MCE_RADIO_STATES_GET "get_radio_states" |
Query radio states.
Radio state bitmasks are constructed from:
#define MCE_RADIO_STATES_CHANGE_REQ "req_radio_states_change" |
Request radio states change.
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)
value | uint32: bitmask of values to use |
mask | uint32: bitmask of values to change |
#define MCE_RADIO_STATES_SIG "radio_states_ind" |
Notify everyone that the radio states have changed.
Radio state bitmasks are constructed from:
current | uint32: bitmask of currently active radios |
#define MCE_CALL_STATE_GET "get_call_state" |
Query the call state.
#define MCE_CALL_STATE_CHANGE_REQ "req_call_state_change" |
Request call state change.
MCE tracks call state separately:
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.
call_state | string: call state to request, one of: |
call_type | string: call type to request, one of: |
#define MCE_CALL_STATE_SIG "sig_call_state_ind" |
Notify everyone that the call state has changed.
call_state | string: current call state, one of: |
call_type | string: current call type, one of: |
#define MCE_DISPLAY_STATUS_GET "get_display_status" |
Query the display status.
Display state is one of:
#define MCE_DISPLAY_ON_REQ "req_display_state_on" |
Unblank display.
#define MCE_DISPLAY_DIM_REQ "req_display_state_dim" |
Dim display.
#define MCE_DISPLAY_OFF_REQ "req_display_state_off" |
Blank display.
#define MCE_DISPLAY_LPM_REQ "req_display_state_lpm" |
Set display to low power mode.
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.
#define MCE_DISPLAY_SIG "display_status_ind" |
Notify everyone that the display is on/dimmed/off.
display_state | string: current display state, one of: |
#define MCE_TKLOCK_MODE_GET "get_tklock_mode" |
Query the touchscreen/keypad lock mode.
#define MCE_TKLOCK_MODE_CHANGE_REQ "req_tklock_mode_change" |
Request tklock mode change.
mode | string: requested tklock state, one of: |
#define MCE_TKLOCK_MODE_SIG "tklock_mode_ind" |
Signal that indicates that the touchscreen/keypad lock mode has changed.
mode | string: current tklock state, one of: |
#define MCE_PREVENT_BLANK_REQ "req_display_blanking_pause" |
Prevent display from blanking.
Normal blanking timers are stopped for 60 seconds - under roughly the following conditions:
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.
#define MCE_CANCEL_PREVENT_BLANK_REQ "req_display_cancel_blanking_pause" |
Cancel display blanking prevention.
#define MCE_PREVENT_BLANK_GET "get_display_blanking_pause" |
Get current blank prevention status.
#define MCE_PREVENT_BLANK_SIG "display_blanking_pause_ind" |
Notify everyone whether the display blanking is paused.
status | string: current blank prevention status, one of: |
#define MCE_PREVENT_BLANK_ALLOWED_GET "get_display_blanking_pause_allowed" |
Query whether MCE_PREVENT_BLANK_REQ request can be made.
See MCE_PREVENT_BLANK_REQ for details.
#define MCE_PREVENT_BLANK_ALLOWED_SIG "display_blanking_pause_allowed_ind" |
Notify change in whether MCE_PREVENT_BLANK_REQ request can be made.
See MCE_PREVENT_BLANK_REQ for details.
boolean | true for allowed, false for not allowed |
#define MCE_BLANKING_INHIBIT_GET "get_display_blanking_inhibit" |
Get current blank inhibition status.
#define MCE_BLANKING_INHIBIT_SIG "display_blanking_inhibit_ind" |
Notify everyone whether the display blanking is inhibited.
status | string: current blanking inhibit status, one of: |
#define MCE_BLANKING_POLICY_GET "get_display_blanking_policy" |
Get current display blanking policy status.
#define MCE_BLANKING_POLICY_SIG "display_blanking_policy_ind" |
Notify everyone when the display blanking policy changes.
policy | string: current blanking policy, one of: |
#define MCE_PSM_STATE_GET "get_psm_state" |
Query the automatic power saving mode.
#define MCE_PSM_STATE_SIG "psm_state_ind" |
Notify everyone that the state of the automatic power saving mode changed.
active | boolean: TRUE if automatic power saving mode is active, or FALSE if automatic power saving mode is inactive |
#define MCE_KEY_BACKLIGHT_STATE_GET "get_key_backlight_state" |
Query key backlight state.
#define MCE_INACTIVITY_STATUS_GET "get_inactivity_status" |
Query the inactivity status.
#define MCE_INACTIVITY_SIG "system_inactivity_ind" |
Notify everyone that the system is active/inactive.
active | boolean: TRUE if the system is inactive, or FALSE if the system is active |
#define MCE_ADD_ACTIVITY_CALLBACK_REQ "add_activity_callback" |
Add an activity notification callback;.
The next user activity will trigger this callback.
Callbacks are one-shot – once the callback has been invoked, it will be unregistered.
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 |
#define MCE_REMOVE_ACTIVITY_CALLBACK_REQ "remove_activity_callback" |
Remove any activity notification callback belonging to the calling process.
#define MCE_CPU_KEEPALIVE_PERIOD_REQ "req_cpu_keepalive_period" |
Query the length of time late suspend can be blocked.
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.
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.
context | string: "unique enough" tracking id |
#define MCE_CPU_KEEPALIVE_START_REQ "req_cpu_keepalive_start" |
Temporarily disable enter late suspend policy.
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.
context | string: "unique enough" tracking id |
#define MCE_CPU_KEEPALIVE_STOP_REQ "req_cpu_keepalive_stop" |
Allow normal enter late suspend policy again.
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.
context | string: "unique enough" tracking id |
#define MCE_CPU_KEEPALIVE_WAKEUP_REQ "req_cpu_keepalive_wakeup" |
Signal wakeup from suspend due to aligned timer triggering.
#define MCE_CONFIG_GET "get_config" |
Query configuration value.
key | string: name of the setting value to query |
#define MCE_CONFIG_GET_ALL "get_config_all" |
Query all configuration values.
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 ) ... ]
#define MCE_CONFIG_SET "set_config" |
Set configuration value.
key | string: setting key name |
val | variant: setting key value |
#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.
key | string: setting key name / initial part of key name |
#define MCE_CONFIG_CHANGE_SIG "config_change_ind" |
Notify everyone that mce configuration value has changed.
key | string: setting key name |
val | variant: setting key value |
#define MCE_USB_CABLE_STATE_GET "get_usb_cable_state" |
Query current USB cable state.
#define MCE_USB_CABLE_STATE_SIG "usb_cable_state_ind" |
Signal that indicates that USB cable state has changed.
cable_state | string: current cable state, one of: |
#define MCE_CHARGER_STATE_GET "get_charger_state" |
Query current charger state.
#define MCE_CHARGER_STATE_SIG "charger_state_ind" |
Signal that indicates that charger state has changed.
charger_state | string: current charger state, one of: |
#define MCE_BATTERY_STATUS_GET "get_battery_status" |
Query current battery status.
#define MCE_BATTERY_STATUS_SIG "battery_status_ind" |
Signal that indicates that battery status has changed.
battery_status | string: current battery status, one of: |
#define MCE_BATTERY_STATE_GET "get_battery_state" |
Query current battery state.
#define MCE_BATTERY_STATE_SIG "battery_state_ind" |
Signal that indicates that battery state has changed.
battery_state | string: current battery state, one of: |
#define MCE_BATTERY_LEVEL_GET "get_battery_level" |
Query current battery level.
#define MCE_BATTERY_LEVEL_SIG "battery_level_ind" |
Signal that indicates that battery level has changed.
bettery_level | int32: battery level percent, or MCE_BATTERY_LEVEL_UNKNOWN |
#define MCE_CHARGER_TYPE_GET "get_charger_type" |
Query current charger type.
#define MCE_CHARGER_TYPE_SIG "charger_type_ind" |
Signal that indicates that charger type has changed.
charger_type | string: current charger type, one of: |
#define MCE_CHARGING_STATE_GET "get_charging_state" |
Query current charging hysteresis state.
#define MCE_CHARGING_STATE_SIG "charging_state_ind" |
Signal that indicates that charging hysteresis state has changed.
Charging hysteresis policy decision.
string | charging hysteresis policy state, one of: |
#define MCE_FORCED_CHARGING_GET "get_forced_charging" |
Query charge-once-to-full policy override state.
#define MCE_FORCED_CHARGING_REQ "req_forced_charging" |
Request charge-once-to-full policy override state change.
value | string: override state, one of: |
#define MCE_FORCED_CHARGING_SIG "forced_charging_ind" |
Signal that indicates that charge-once-to-full policy override state has changed.
Charge-once-to-full policy override decision.
string | charge-once-to-full policy state, one of: |
#define MCE_CHARGING_SUSPENDABLE_GET "get_charging_suspendable" |
Query whether charging can be suspended on this device.
#define MCE_ACTIVATE_LED_PATTERN "req_led_pattern_activate" |
Activate a pre-defined LED pattern.
Available patterns depends on mce configuration.
Non-existing patterns are ignored.
See also: MCE_LED_PATTERN_ACTIVATED_SIG
pattern | string: led pattern name |
#define MCE_DEACTIVATE_LED_PATTERN "req_led_pattern_deactivate" |
Deactivate a pre-defined LED pattern.
Available patterns depends on mce configuration.
Non-existing patterns are ignored
See also: MCE_LED_PATTERN_DEACTIVATED_SIG
pattern | string: led pattern name |
#define MCE_LED_PATTERN_ACTIVATED_SIG "led_pattern_activated_ind" |
Notify everyone that a led pattern has been activated.
activated_pattern | string: led pattern name |
#define MCE_LED_PATTERN_DEACTIVATED_SIG "led_pattern_deactivated_ind" |
Notify everyone that a led pattern has been deactivated.
deactivated_pattern | string: led pattern name |
#define MCE_ENABLE_LED "req_led_enable" |
Allow activation of normal led patterns.
The current led stack is re-evaluated and also normal led patterns are considered when choosing active pattern.
#define MCE_DISABLE_LED "req_led_disable" |
Deny actiovation of normal led patterns.
The current led stack is re-evaluated and normal led patterns are ignored when choosing active pattern.
#define MCE_TOUCH_INPUT_POLICY_GET "get_touch_input_policy" |
Get current touch screen input policy.
#define MCE_TOUCH_INPUT_POLICY_SIG "touch_input_policy_ind" |
Indication for change of touch screen input policy.
input_state | string: current touch input input policy state, one of: |
#define MCE_VOLKEY_INPUT_POLICY_GET "get_keypad_input_policy" |
Get current volume key input policy.
#define MCE_VOLKEY_INPUT_POLICY_SIG "keypad_input_policy_ind" |
Indication for change of volume key input policy.
input_state | string: current volkey input input policy state, one of: |
#define MCE_BUTTON_BACKLIGHT_GET "get_button_backlight" |
Get current button backlight state.
Returns true when button backlight is lit, false otherwise.
#define MCE_BUTTON_BACKLIGHT_CHANGE_REQ "req_button_backlight_change" |
Request button backlight state change.
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.
state | boolean: TRUE for backlight on, FALSE for off |
#define MCE_BUTTON_BACKLIGHT_MODE_REQ "req_button_backlight_mode" |
Request button backlight mode change.
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.
mode | int32: MCE_BUTTON_BACKLIGHT_MODE_OFF, MCE_BUTTON_BACKLIGHT_MODE_ON, or MCE_BUTTON_BACKLIGHT_MODE_POLICY |
#define MCE_BUTTON_BACKLIGHT_SIG "sig_button_backlight_ind" |
Indication for change of button backlight state.
The state is true when button backlight is lit, false otherwise.
state | boolean: TRUE for backlight in on, FALSE for off |
#define MCE_HARDWARE_KEYBOARD_STATE_GET "keyboard_available_state_req" |
Query HW keyboard availability.
Non-slidable keyboard present, or sliding keyboard present and opened
Used for example in evaluating whether virtual keyboard should be used or not.
#define MCE_HARDWARE_KEYBOARD_STATE_SIG "keyboard_available_state_ind" |
Notify changes in HW keyboard availability.
Non-slidable keyboard present, or sliding keyboard present and opened
#define MCE_HARDWARE_MOUSE_STATE_GET "mouse_available_state_req" |
Query HW mouse availability.
Mouse present
Used for example in evaluating whether mouse pointer should be shown or not.
#define MCE_HARDWARE_MOUSE_STATE_SIG "mouse_available_state_ind" |
Notify changes in HW mouse availability.
Mouse present
#define MCE_SLIDING_KEYBOARD_STATE_GET "keyboard_slide_state_req" |
Query current sliding keyboard state.
#define MCE_SLIDING_KEYBOARD_STATE_SIG "keyboard_slide_state_ind" |
Notify sliding keyboard state changes.
state | string: keyboard state, one of: |
#define MCE_FADER_OPACITY_SIG "fader_opacity_ind" |
Signal for controlling compositor side display dimming.
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.
dimming | int32: dimming percent
|
duration | int32: fade animation duration [ms] |
#define MCE_ALARM_UI_FEEDBACK_SIG "alarm_ui_feedback_ind" |
Signal for notifying alarm ui about power key presses / device flip overs.
Used for silencing alarm via power key press / device flip over.
event | string: event name, such as: |
#define MCE_CALL_UI_FEEDBACK_SIG "call_ui_feedback_ind" |
Signal for notifying call ui about power key presses / device flip overs.
Used for silencing incoming call via power key press / device flip over
event | string: event name, such as: |
#define MCE_IGNORE_INCOMING_CALL_REQ "req_ignore_incoming_call" |
Inform mce that incoming call has been ignored by ui.
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.
#define MCE_POWER_BUTTON_TRIGGER "power_button_trigger" |
Signal for notifying systemui about power button etc related events.
event | string: partly configurable and varies, but includes:
|
#define MCE_TKLOCK_CB_REQ "tklock_callback" |
Method for sending tklock feedback from systemui to mce.
status | int32: tklock feedback, one of: |
#define MCE_DISPLAY_STATE_LPM_OFF_REQ "req_display_state_lpm_off" |
Request transition to lpm-off display state.
#define MCE_DISPLAY_STATE_LPM_ON_REQ "req_display_state_lpm_on" |
Request transition to lpm-on display state.
#define MCE_LPM_UI_MODE_SIG "lpm_ui_mode_ind" |
Used for triggering UI transitions to/from LPM view.
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.
state | string, one of: |
#define MCE_MEMORY_LEVEL_GET "get_memory_level" |
Method for querying current system memory pressure level.
#define MCE_MEMORY_LEVEL_SIG "sig_memory_level_ind" |
Signal for notifying system memory pressure level changes.
level | string, one of: |
#define MCE_NOTIFICATION_BEGIN_REQ "notification_begin_req" |
Method for declaring start of exceptional display on state.
name | string: unique-enough identifier |
duration | int32: notification duration [ms] |
extend | int32: extend due to user activity time [ms] |
#define MCE_NOTIFICATION_END_REQ "notification_end_req" |
Method for declaring end of exceptional display on state.
name | string: unique-enough identifier |
linger | int32: remain in display on time [ms] |
#define MCE_CABC_MODE_GET "get_cabc_mode" |
Query CABC mode.
#define MCE_CABC_MODE_REQ "req_cabc_mode" |
Request CABC mode change.
A non-functional skeleton interface is available unless suitable hw and driver support exists along with relevant configuration.
mode | string: requested cabc mode, one of: |
#define MCE_COLOR_PROFILE_GET "get_color_profile" |
Query the current color profile id.
#define MCE_COLOR_PROFILE_IDS_GET "get_color_profile_ids" |
Query the list of the available color profile ids.
Apart from built-in "hardcoded" the available color profiles depends on mce configuration.
#define MCE_COLOR_PROFILE_CHANGE_REQ "req_color_profile_change" |
Request color profile change.
mode | string: requested color profile id |
#define MCE_COLOR_PROFILE_SIG "color_profile_ind" |
Notify everyone that the color profile has changed.
mode | string: current color profile id |
#define MCE_VERSION_GET "get_version" |
Query MCE version.
#define MCE_TRIGGER_POWERKEY_EVENT_REQ "req_trigger_powerkey_event" |
Request powerkey event triggering.
type | uint32: power key event to trigger, one of: |
#define MCE_DISPLAY_STATS_GET "get_display_stats" |
Get amount of time spent in each display state.
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 } ) ... ]
#define MCE_SUSPEND_STATS_GET "get_suspend_stats" |
Query current uptime and time spent in suspend.
Used for: Automated suspend testing, QA reporting, etc.
Basically:
#define MCE_VERBOSITY_GET "get_verbosity" |
Query current logging verbosity.
#define MCE_VERBOSITY_REQ "set_verbosity" |
Change current logging verbosity.
verbosity | int32: syslog compatible verbosity level:
|