|
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 | |
D-Bus Daemon | |
| #define | MCE_SERVICE "com.nokia.mce" |
| MCE D-Bus service. | |
| #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. | |
Generic D-Bus methods | |
| #define | MCE_RADIO_STATES_GET "get_radio_states" |
| Query radio states. | |
| #define | MCE_CALL_STATE_GET "get_call_state" |
| Query the call state. | |
| #define | MCE_TKLOCK_MODE_GET "get_tklock_mode" |
| Query the touchscreen/keypad lock mode. | |
| #define | MCE_DISPLAY_STATUS_GET "get_display_status" |
| Query the display status. | |
| #define | MCE_CABC_MODE_GET "get_cabc_mode" |
| Query CABC mode. | |
| #define | MCE_PSM_STATE_GET "get_psm_state" |
| Query the automatic power saving mode. | |
| #define | MCE_KEY_BACKLIGHT_STATE_GET "get_key_backlight_state" |
| Query key backlight state. | |
| #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. | |
| #define | MCE_REMOVE_ACTIVITY_CALLBACK_REQ "remove_activity_callback" |
| Remove any activity notification callback belonging to the calling process. | |
| #define | MCE_INACTIVITY_STATUS_GET "get_inactivity_status" |
| Query the inactivity status. | |
| #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_VERSION_GET "get_version" |
| Query the MCE version. | |
| #define | MCE_RADIO_STATES_CHANGE_REQ "req_radio_states_change" |
| Request radio states change. | |
| #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. | |
| #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_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_BLANKING_INHIBIT_GET "get_display_blanking_inhibit" |
| Get current blank inhibition status. | |
| #define | MCE_BLANKING_POLICY_GET "get_display_blanking_policy" |
| Get current display blanking policy status. | |
| #define | MCE_CABC_MODE_REQ "req_cabc_mode" |
| Request CABC mode change. | |
| #define | MCE_TKLOCK_MODE_CHANGE_REQ "req_tklock_mode_change" |
| Request tklock mode change. | |
| #define | MCE_TRIGGER_POWERKEY_EVENT_REQ "req_trigger_powerkey_event" |
| Request powerkey event triggering. | |
| #define | MCE_COLOR_PROFILE_CHANGE_REQ "req_color_profile_change" |
| Request color profile change. | |
| #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. | |
| #define | MCE_CONFIG_GET "get_config" |
| Query configuration value. | |
| #define | MCE_CONFIG_SET "set_config" |
| Set configuration value. | |
| #define | MCE_CONFIG_RESET "reset_config" |
| Reset configuration values to default. | |
Generic D-Bus signals | |
| #define | MCE_TKLOCK_MODE_SIG "tklock_mode_ind" |
| Signal that indicates that the touchscreen/keypad lock mode has changed. | |
| #define | MCE_DISPLAY_SIG "display_status_ind" |
| Notify everyone that the display is on/dimmed/off. | |
| #define | MCE_PREVENT_BLANK_SIG "display_blanking_pause_ind" |
| Notify everyone whether the display blanking is paused. | |
| #define | MCE_BLANKING_INHIBIT_SIG "display_blanking_inhibit_ind" |
| Notify everyone whether the display blanking is inhibited. | |
| #define | MCE_BLANKING_POLICY_SIG "display_blanking_policy_ind" |
| Notify everyone when the display blanking policy changes. | |
| #define | MCE_PSM_STATE_SIG "psm_state_ind" |
| Notify everyone that the state of the automatic power saving mode changed. | |
| #define | MCE_INACTIVITY_SIG "system_inactivity_ind" |
| Notify everyone that the system is active/inactive. | |
| #define | MCE_COLOR_PROFILE_SIG "color_profile_ind" |
| Notify everyone that the color profile has changed. | |
| #define | MCE_RADIO_STATES_SIG "radio_states_ind" |
| Notify everyone that the radio states have changed. | |
| #define | MCE_CALL_STATE_SIG "sig_call_state_ind" |
| Notify everyone that the call state has changed. | |
| #define | MCE_CONFIG_CHANGE_SIG "config_change_ind" |
| Notify everyone that mce configuration value has changed. | |
LED interface D-Bus methods | |
| #define | MCE_ACTIVATE_LED_PATTERN "req_led_pattern_activate" |
| Activates a pre-defined LED pattern. | |
| #define | MCE_DEACTIVATE_LED_PATTERN "req_led_pattern_deactivate" |
| Deactivates 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" |
| 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. | |
| #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. | |
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).
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_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
@credential mce::LEDControl
| pattern | gchar * 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.
| service | gchar * The method call service |
| path | gchar * The method call path |
| interface | gchar * The method call interface |
| name | gchar * The name of the method to call |
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.
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.
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.
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.
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.
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.
| mode | gchar * with the new CABC mode (see mce/mode-names.h for valid CABC modes) |
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
| call_state | gchar * with the new call state (see mce/mode-names.h for valid call states) |
| call_type | gchar * with the new call type (see mce/mode-names.h for valid call types) |
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.
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.
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.
| #define MCE_COLOR_PROFILE_CHANGE_REQ "req_color_profile_change" |
Request color profile change.
| mode | gchar * 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.
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.
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.
gchar * with the color profile id | #define MCE_CONFIG_CHANGE_SIG "config_change_ind" |
Notify everyone that mce configuration value has changed.
| key | Config value name as DBUS_TYPE_STRING |
| val | Config value as DBUS_TYPE_VARIANT |
| #define MCE_CONFIG_GET "get_config" |
Query configuration value.
| key | Configuration value name as DBUS_TYPE_STRING |
| #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.
| keyish | Substring of config value name as DBUS_TYPE_STRING |
| #define MCE_CONFIG_SET "set_config" |
Set configuration value.
| key | Configuration value name as DBUS_TYPE_STRING |
| val | Configuration value as DBUS_TYPE_VARIANT |
| #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 | Tracking id as DBUS_TYPE_STRING |
| #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.
| context | Tracking id as DBUS_TYPE_STRING |
| #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.
| context | Tracking id as DBUS_TYPE_STRING |
| #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.
| #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
@credential mce::LEDControl
| pattern | gchar * 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.
@credential mce::LEDControl
| #define MCE_DISPLAY_DIM_REQ "req_display_state_dim" |
Dim display.
| #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.
| #define MCE_DISPLAY_OFF_REQ "req_display_state_off" |
Blank display.
| #define MCE_DISPLAY_ON_REQ "req_display_state_on" |
Unblank display.
| #define MCE_DISPLAY_SIG "display_status_ind" |
Notify everyone that the display is on/dimmed/off.
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.
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
@credential mce::LEDControl
| #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_INACTIVITY_SIG "system_inactivity_ind" |
Notify everyone that the system is active/inactive.
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.
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.
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.
gchar * led pattern name | #define MCE_LED_PATTERN_DEACTIVATED_SIG "led_pattern_deactivated_ind" |
Notify everyone that a led pattern has been deactivated.
gchar * led pattern name | #define MCE_PREVENT_BLANK_GET "get_display_blanking_pause" |
Get current blank prevention status.
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.
| #define MCE_PREVENT_BLANK_SIG "display_blanking_pause_ind" |
Notify everyone whether the display blanking is paused.
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.
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.
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.
c dbus_uint32_t New radio states or:ed together (see mce/mode-names.h for defines for the radio states)
c dbus_uint32_t Mask for radio states or:ed together (see mce/mode-names.h for defines for the radio states)
| #define MCE_RADIO_STATES_GET "get_radio_states" |
Query radio states.
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.
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.
| #define MCE_REQUEST_IF "com.nokia.mce.request" |
MCE D-Bus Request interface.
| #define MCE_REQUEST_PATH "/com/nokia/mce/request" |
MCE D-Bus Request path.
| #define MCE_SERVICE "com.nokia.mce" |
MCE D-Bus service.
| #define MCE_SIGNAL_IF "com.nokia.mce.signal" |
MCE D-Bus Signal interface.
| #define MCE_SIGNAL_PATH "/com/nokia/mce/signal" |
MCE D-Bus Signal path.
| #define MCE_TKLOCK_MODE_CHANGE_REQ "req_tklock_mode_change" |
Request tklock mode change.
| mode | gchar * 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.
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.
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.
@credential mce::DeviceModeControl
| type | dbus_bool_t with the type of powerkey event to trigger; FALSE == short powerkey press, TRUE == long powerkey press |
| type | dbus_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.
gchar * with the MCE version 1.9.8