MCE D-Bus Interface  1.10.x
dbus-names.h File Reference

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

Go to the source code of this file.

Macros

D-Bus Daemon
#define MCE_SERVICE   "com.nokia.mce"
 MCE D-Bus service. 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...
 
Generic D-Bus methods
#define MCE_RADIO_STATES_GET   "get_radio_states"
 Query radio states. More...
 
#define MCE_CALL_STATE_GET   "get_call_state"
 Query the call state. More...
 
#define MCE_TKLOCK_MODE_GET   "get_tklock_mode"
 Query the touchscreen/keypad lock mode. More...
 
#define MCE_DISPLAY_STATUS_GET   "get_display_status"
 Query the display status. More...
 
#define MCE_CABC_MODE_GET   "get_cabc_mode"
 Query CABC mode. More...
 
#define MCE_PSM_STATE_GET   "get_psm_state"
 Query the automatic power saving mode. More...
 
#define MCE_KEY_BACKLIGHT_STATE_GET   "get_key_backlight_state"
 Query key backlight state. More...
 
#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. More...
 
#define MCE_REMOVE_ACTIVITY_CALLBACK_REQ   "remove_activity_callback"
 Remove any activity notification callback belonging to the calling process. More...
 
#define MCE_INACTIVITY_STATUS_GET   "get_inactivity_status"
 Query the inactivity status. More...
 
#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_VERSION_GET   "get_version"
 Query the MCE version. More...
 
#define MCE_RADIO_STATES_CHANGE_REQ   "req_radio_states_change"
 Request radio states change. More...
 
#define MCE_CALL_STATE_CHANGE_REQ   "req_call_state_change"
 Request call state change Changes can only be made to/from the "none" state; all other transitions will be vetoed. 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_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_BLANKING_INHIBIT_GET   "get_display_blanking_inhibit"
 Get current blank inhibition status. More...
 
#define MCE_BLANKING_POLICY_GET   "get_display_blanking_policy"
 Get current display blanking policy status. More...
 
#define MCE_CABC_MODE_REQ   "req_cabc_mode"
 Request CABC mode change. More...
 
#define MCE_TKLOCK_MODE_CHANGE_REQ   "req_tklock_mode_change"
 Request tklock mode change. More...
 
#define MCE_TRIGGER_POWERKEY_EVENT_REQ   "req_trigger_powerkey_event"
 Request powerkey event triggering. More...
 
#define MCE_COLOR_PROFILE_CHANGE_REQ   "req_color_profile_change"
 Request color profile change. More...
 
#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...
 
#define MCE_CONFIG_GET   "get_config"
 Query configuration value. More...
 
#define MCE_CONFIG_SET   "set_config"
 Set configuration value. More...
 
#define MCE_CONFIG_RESET   "reset_config"
 Reset configuration values to default. More...
 
Generic D-Bus signals
#define MCE_TKLOCK_MODE_SIG   "tklock_mode_ind"
 Signal that indicates that the touchscreen/keypad lock mode has changed. More...
 
#define MCE_DISPLAY_SIG   "display_status_ind"
 Notify everyone that the display is on/dimmed/off. More...
 
#define MCE_PREVENT_BLANK_SIG   "display_blanking_pause_ind"
 Notify everyone whether the display blanking is paused. More...
 
#define MCE_BLANKING_INHIBIT_SIG   "display_blanking_inhibit_ind"
 Notify everyone whether the display blanking is inhibited. More...
 
#define MCE_BLANKING_POLICY_SIG   "display_blanking_policy_ind"
 Notify everyone when the display blanking policy changes. More...
 
#define MCE_PSM_STATE_SIG   "psm_state_ind"
 Notify everyone that the state of the automatic power saving mode changed. More...
 
#define MCE_INACTIVITY_SIG   "system_inactivity_ind"
 Notify everyone that the system is active/inactive. More...
 
#define MCE_COLOR_PROFILE_SIG   "color_profile_ind"
 Notify everyone that the color profile has changed. More...
 
#define MCE_RADIO_STATES_SIG   "radio_states_ind"
 Notify everyone that the radio states have changed. More...
 
#define MCE_CALL_STATE_SIG   "sig_call_state_ind"
 Notify everyone that the call state has changed. More...
 
#define MCE_CONFIG_CHANGE_SIG   "config_change_ind"
 Notify everyone that mce configuration value has changed. More...
 
LED interface D-Bus methods
#define MCE_ACTIVATE_LED_PATTERN   "req_led_pattern_activate"
 Activates a pre-defined LED pattern. More...
 
#define MCE_DEACTIVATE_LED_PATTERN   "req_led_pattern_deactivate"
 Deactivates 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"
 Enable LED; this does not affect the LED pattern stack Note: The GConf setting for LED flashing overrides this value If the pattern stack does not contain any active patterns, the LED logic will still remain in enabled mode, but will not display any patterns until a pattern is activated. More...
 
#define MCE_DISABLE_LED   "req_led_disable"
 Disable LED; this does not affect the LED pattern stack Note: Do NOT use this as a "master switch" for the LED framework, since some patterns should always be visible this interface is meant for testing and development only. More...
 

Detailed Description

D-Bus Interface to the Mode Control Entity.

This file is part of mce-dev

Copyright © 2004-2011 Nokia Corporation and/or its subsidiary(-ies).

Author
David Weinehall david.nosp@m..wei.nosp@m.nehal.nosp@m.l@no.nosp@m.kia.c.nosp@m.om

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

#define MCE_ACTIVATE_LED_PATTERN   "req_led_pattern_activate"

Activates a pre-defined LED pattern.

Non-existing patterns are ignored

See also: MCE_LED_PATTERN_ACTIVATED_SIG

mce::LEDControl

Since
v1.5.0
Parameters
patterngchar * with the pattern name (see /etc/mce/mce.ini for valid pattern names)
#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.

Since
1.10.106
Parameters
servicegchar * The method call service
pathgchar * The method call path
interfacegchar * The method call interface
namegchar * The name of the method to call
Returns
dbus_bool_t TRUE if registration was successful, FALSE if registration was a failure (too many registered clients)
#define MCE_BLANKING_INHIBIT_GET   "get_display_blanking_inhibit"

Get current blank inhibition status.

Since
1.51.0
Returns
gchar * with the blanking inhibit state (see mce/mode-names.h for valid blanking inhibit states)
#define MCE_BLANKING_INHIBIT_SIG   "display_blanking_inhibit_ind"

Notify everyone whether the display blanking is inhibited.

Since
v1.51.0
Returns
gchar * with the display baling inhibit state (see mce/mode-names.h for valid blanking inhibit states)
#define MCE_BLANKING_POLICY_GET   "get_display_blanking_policy"

Get current display blanking policy status.

Since
v1.55.0
Returns
gchar * with the blanking polic state (see mce/mode-names.h for valid blanking policy states)
#define MCE_BLANKING_POLICY_SIG   "display_blanking_policy_ind"

Notify everyone when the display blanking policy changes.

Since
v1.55.0
Returns
gchar * with the display blankiing policy state (see mce/mode-names.h for valid blanking policy states)
#define MCE_CABC_MODE_GET   "get_cabc_mode"

Query CABC mode.

Since
v1.10.0
Returns
gchar * with the CABC mode (see mce/mode-names.h for valid CABC modes)
#define MCE_CABC_MODE_REQ   "req_cabc_mode"

Request CABC mode change.

Since
v1.10.0
Parameters
modegchar * with the new CABC mode (see mce/mode-names.h for valid CABC modes)
Returns
gchar * with the updated CABC mode (see mce/mode-names.h for valid CABC modes)
#define MCE_CALL_STATE_CHANGE_REQ   "req_call_state_change"

Request call state change Changes can only be made to/from the "none" state; all other transitions will be vetoed.

This is to avoid race conditions between different services.

An exception is made when the tuple is active:emergency; such requests are always accepted

If the service that requests the transition emits a NameOwnerChanged, then the call state will revert back to "none", to ensure that crashing applications doesn't cause a forever busy call state

Since
v1.8.1 mce::CallStateControl
Parameters
call_stategchar * with the new call state (see mce/mode-names.h for valid call states)
call_typegchar * with the new call type (see mce/mode-names.h for valid call types)
Returns
dbus_bool_t TRUE if the new call state was accepted, FALSE if the new call state was vetoed
#define MCE_CALL_STATE_GET   "get_call_state"

Query the call state.

Since
v1.8.1
Returns
gchar * with the new call state (see mce/mode-names.h for valid call states)
gchar * with the new emergency state type (see mce/mode-names.h for valid emergency state types)
#define MCE_CALL_STATE_SIG   "sig_call_state_ind"

Notify everyone that the call state has changed.

Since
v1.8.1
Returns
gchar * with the new call state (see mce/mode-names.h for valid call states)
gchar * with the new emergency state type (see mce/mode-names.h for valid emergency state types)
#define MCE_CANCEL_PREVENT_BLANK_REQ   "req_display_cancel_blanking_pause"

Cancel display blanking prevention.

Since
v1.10.35
#define MCE_COLOR_PROFILE_CHANGE_REQ   "req_color_profile_change"

Request color profile change.

Since
v1.11.2 mce::ColorProfileControl
Parameters
modegchar * with the new color profile id (see MCE_COLOR_PROFILE_IDS_GET to learn how to get the valid color profile ids)
#define MCE_COLOR_PROFILE_GET   "get_color_profile"

Query the current color profile id.

Since
v1.11.2
Returns
gchar * with the the current profile id
#define MCE_COLOR_PROFILE_IDS_GET   "get_color_profile_ids"

Query the list of the available color profile ids.

Since
v1.11.2
Returns
gchar ** with the nul-terminated array of the color profile ids
#define MCE_COLOR_PROFILE_SIG   "color_profile_ind"

Notify everyone that the color profile has changed.

Since
v1.11.2
Returns
gchar * with the color profile id
#define MCE_CONFIG_CHANGE_SIG   "config_change_ind"

Notify everyone that mce configuration value has changed.

Since
v1.14.1
Parameters
keyConfig value name as DBUS_TYPE_STRING
valConfig value as DBUS_TYPE_VARIANT
#define MCE_CONFIG_GET   "get_config"

Query configuration value.

Since
v1.12.15
Parameters
keyConfiguration value name as DBUS_TYPE_STRING
Returns
Configuration value as DBUS_TYPE_VARIANT, or error reply
#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
v1.42.0
Parameters
keyishSubstring of config value name as DBUS_TYPE_STRING
Returns
Number of changed settings as DBUS_TYPE_INT32; -1 on failure
#define MCE_CONFIG_SET   "set_config"

Set configuration value.

Since
v1.12.15
Parameters
keyConfiguration value name as DBUS_TYPE_STRING
valConfiguration value as DBUS_TYPE_VARIANT
Returns
Success as DBUS_TYPE_BOOLEAN, or error reply
#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.

Since
v1.12.8
v1.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
contextTracking id as DBUS_TYPE_STRING
Returns
period in seconds as DBUS_TYPE_INT32
#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.

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

Since
v1.12.8
Parameters
contextTracking id as DBUS_TYPE_STRING
Returns
success as DBUS_TYPE_BOOLEAN
#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.

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

Since
v1.12.8
Parameters
contextTracking id as DBUS_TYPE_STRING
Returns
success as DBUS_TYPE_BOOLEAN
#define MCE_CPU_KEEPALIVE_WAKEUP_REQ   "req_cpu_keepalive_wakeup"

Signal wakeup from suspend due to aligned timer triggering.

NOTE: This is reserved for use from dsme iphb module and is used to transfer ownership of rtc irq wakeup wakelock from dsme to mce.

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

Since
v1.12.8
Returns
success as DBUS_TYPE_BOOLEAN
#define MCE_DEACTIVATE_LED_PATTERN   "req_led_pattern_deactivate"

Deactivates a pre-defined LED pattern.

Non-existing patterns are ignored

See also: MCE_LED_PATTERN_DEACTIVATED_SIG

mce::LEDControl

Since
v1.5.0
Parameters
patterngchar * with the pattern name (see /etc/mce/mce.ini for valid pattern names)
#define MCE_DISABLE_LED   "req_led_disable"

Disable LED; this does not affect the LED pattern stack Note: Do NOT use this as a "master switch" for the LED framework, since some patterns should always be visible this interface is meant for testing and development only.

mce::LEDControl

Since
v1.5.0
#define MCE_DISPLAY_DIM_REQ   "req_display_state_dim"

Dim display.

Since
v1.6.20
#define MCE_DISPLAY_LPM_REQ   "req_display_state_lpm"

Set display to low power mode.

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.

Since
v1.33.0
#define MCE_DISPLAY_OFF_REQ   "req_display_state_off"

Blank display.

Since
v1.6.20
#define MCE_DISPLAY_ON_REQ   "req_display_state_on"

Unblank display.

Since
v0.5
#define MCE_DISPLAY_SIG   "display_status_ind"

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

Since
v1.5.21
Returns
gchar * with the display state (see mce/mode-names.h for valid display states)
#define MCE_DISPLAY_STATUS_GET   "get_display_status"

Query the display status.

Since
v1.5.21
Returns
gchar * with the display state (see mce/mode-names.h for valid display states)
#define MCE_ENABLE_LED   "req_led_enable"

Enable LED; this does not affect the LED pattern stack Note: The GConf setting for LED flashing overrides this value If the pattern stack does not contain any active patterns, the LED logic will still remain in enabled mode, but will not display any patterns until a pattern is activated.

Do NOT use this as a "master switch" for the LED framework, since some patterns should always be visible this interface is meant for testing and development only

mce::LEDControl

Since
v1.5.0
#define MCE_ERROR_FATAL   "com.nokia.mce.error.fatal"

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

Since
v0.3
#define MCE_ERROR_INVALID_ARGS   "org.freedesktop.DBus.Error.InvalidArgs"

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

Since
v0.3
#define MCE_INACTIVITY_SIG   "system_inactivity_ind"

Notify everyone that the system is active/inactive.

Since
v0.9.3
Returns
dbus_bool_t TRUE if the system is inactive, FALSE if the system is active
#define MCE_INACTIVITY_STATUS_GET   "get_inactivity_status"

Query the inactivity status.

Since
v1.5.2
Returns
dbus_bool_t TRUE if the system is inactive, FALSE if the system is active
#define MCE_KEY_BACKLIGHT_STATE_GET   "get_key_backlight_state"

Query key backlight state.

Since
v1.10.30
Returns
dbus_bool_t TRUE if the key backlight is on, FALSE if the key backlight is off
#define MCE_LED_PATTERN_ACTIVATED_SIG   "led_pattern_activated_ind"

Notify everyone that a led pattern has been activated.

Since
v1.25.0
Returns
gchar * led pattern name
#define MCE_LED_PATTERN_DEACTIVATED_SIG   "led_pattern_deactivated_ind"

Notify everyone that a led pattern has been deactivated.

Since
v1.25.0
Returns
gchar * led pattern name
#define MCE_PREVENT_BLANK_GET   "get_display_blanking_pause"

Get current blank prevention status.

Since
1.51.0
Returns
gchar * with the blanking pause state (see mce/mode-names.h for valid blanking pause states)
#define MCE_PREVENT_BLANK_REQ   "req_display_blanking_pause"

Prevent display from blanking.

Since
v0.5
#define MCE_PREVENT_BLANK_SIG   "display_blanking_pause_ind"

Notify everyone whether the display blanking is paused.

Since
v1.51.0
Returns
gchar * with the blanking pause state (see mce/mode-names.h for valid blanking pause states)
#define MCE_PSM_STATE_GET   "get_psm_state"

Query the automatic power saving mode.

Since
v1.10.44
Returns
dbus_bool_t TRUE if automatic power saving mode is active, FALSE if automatic power saving mode is inactive
#define MCE_PSM_STATE_SIG   "psm_state_ind"

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

Since
v1.10.44
Returns
dbus_bool_t TRUE if automatic power saving mode is active, FALSE if automatic power saving mode is inactive
#define MCE_RADIO_STATES_CHANGE_REQ   "req_radio_states_change"

Request radio states change.

Since
v1.10.60 mce::DeviceModeControl
Parameters
#define MCE_RADIO_STATES_GET   "get_radio_states"

Query radio states.

Since
v1.10.60
Returns
dbus_uint32_t Radio states or:ed together (see mce/mode-names.h for defines for the radio states)
#define MCE_RADIO_STATES_SIG   "radio_states_ind"

Notify everyone that the radio states have changed.

Since
v1.10.60
Returns
dbus_uint32_t Radio states or:ed together (see mce/mode-names.h for defines for the radio states)
#define MCE_REMOVE_ACTIVITY_CALLBACK_REQ   "remove_activity_callback"

Remove any activity notification callback belonging to the calling process.

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

MCE D-Bus Request interface.

Since
v0.3
#define MCE_REQUEST_PATH   "/com/nokia/mce/request"

MCE D-Bus Request path.

Since
v0.3
#define MCE_SERVICE   "com.nokia.mce"

MCE D-Bus service.

Since
v0.3
#define MCE_SIGNAL_IF   "com.nokia.mce.signal"

MCE D-Bus Signal interface.

Since
v0.3
#define MCE_SIGNAL_PATH   "/com/nokia/mce/signal"

MCE D-Bus Signal path.

Since
v0.3
#define MCE_TKLOCK_MODE_CHANGE_REQ   "req_tklock_mode_change"

Request tklock mode change.

Since
v1.4.0 mce::TKLockControl
Parameters
modegchar * with the new touchscreen/keypad lock mode (see mce/mode-names.h for valid lock modes)
#define MCE_TKLOCK_MODE_GET   "get_tklock_mode"

Query the touchscreen/keypad lock mode.

Since
v1.4.0
Returns
gchar * with the touchscreen/keypad lock mode (see mce/mode-names.h for valid lock modes)
#define MCE_TKLOCK_MODE_SIG   "tklock_mode_ind"

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

Since
v1.4.0
Returns
gchar * with the new touchscreen/keypad lock mode (see mce/mode-names.h for valid lock modes)
#define MCE_TRIGGER_POWERKEY_EVENT_REQ   "req_trigger_powerkey_event"

Request powerkey event triggering.

mce::DeviceModeControl

Since
v1.5.3
Parameters
typedbus_bool_t with the type of powerkey event to trigger; FALSE == short powerkey press, TRUE == long powerkey press
Since
v1.10.54
Parameters
typedbus_uint32_t with the type of powerkey event to trigger (see mce/mode-names.h for valid events)
#define MCE_VERSION_GET   "get_version"

Query the MCE version.

Since
v1.1.6
Returns
gchar * with the MCE version