/** * @file display.h * Headers for the display module *

* @author David Weinehall * @author Tapio Rantala * @author Santtu Lakkala * @author Simo Piiroinen * * mce is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License * version 2.1 as published by the Free Software Foundation. * * mce is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with mce. If not, see . */ #ifndef DISPLAY_H_ # define DISPLAY_H_ /* ========================================================================= * * Constants * ========================================================================= */ /** Name of the display backlight configuration group */ # define MCE_CONF_DISPLAY_GROUP "Display" /** List of backlight control directories to try */ # define MCE_CONF_BACKLIGHT_DIRECTORY "BrightnessDirectory" /** List of backlight control files to try */ # define MCE_CONF_BACKLIGHT_PATH "BrightnessPath" /** List of max backlight control files to try */ # define MCE_CONF_MAX_BACKLIGHT_PATH "MaxBrightnessPath" /** Default timeout for the high brightness mode; in seconds */ # define DEFAULT_HBM_TIMEOUT 1800 /* 30 min */ /** Path to the SysFS entry for the CABC controls */ # define DISPLAY_BACKLIGHT_PATH "/sys/class/backlight" /** CABC brightness file */ # define DISPLAY_CABC_BRIGHTNESS_FILE "/brightness" /** CABC maximum brightness file */ # define DISPLAY_CABC_MAX_BRIGHTNESS_FILE "/max_brightness" /** CABC mode file */ # define DISPLAY_CABC_MODE_FILE "/cabc_mode" /** CABC available modes file */ # define DISPLAY_CABC_AVAILABLE_MODES_FILE "/cabc_available_modes" /** Generic name for the display in newer hardware */ # define DISPLAY_DISPLAY0 "/display0" /** The name of the directory for the Sony acx565akm display */ # define DISPLAY_ACX565AKM "/acx565akm" /** The name of the directory for the EID l4f00311 display */ # define DISPLAY_L4F00311 "/l4f00311" /** The name of the directory for the Taal display */ # define DISPLAY_TAAL "/taal" /** The name of the directory for the Himalaya display */ # define DISPLAY_HIMALAYA "/himalaya" /** The name of the directory for ACPI controlled displays */ # define DISPLAY_ACPI_VIDEO0 "/acpi_video0" /** Display device path */ # define DISPLAY_DEVICE_PATH "/device" /** Path to hardware dimming support */ # define DISPLAY_HW_DIMMING_FILE "/dimming" /** Low Power Mode file */ # define DISPLAY_LPM_FILE "/lpm" /** High Brightness Mode file */ # define DISPLAY_HBM_FILE "/hbm" /** CABC name for CABC disabled */ # define CABC_MODE_OFF "off" /** CABC name for UI mode */ # define CABC_MODE_UI "ui" /** CABC name for still image mode */ # define CABC_MODE_STILL_IMAGE "still-image" /** CABC name for moving image mode */ # define CABC_MODE_MOVING_IMAGE "moving-image" /** Default CABC mode */ # define DEFAULT_CABC_MODE CABC_MODE_UI /** Default CABC mode (power save mode active) */ # define DEFAULT_PSM_CABC_MODE CABC_MODE_MOVING_IMAGE /** Path to the SysFS entry for the generic display interface */ # define DISPLAY_GENERIC_PATH "/sys/class/graphics/fb0/device/panel" /** Generic brightness file */ # define DISPLAY_GENERIC_BRIGHTNESS_FILE "/backlight_level" /** Generic maximum brightness file */ # define DISPLAY_GENERIC_MAX_BRIGHTNESS_FILE "/backlight_max" /** Minimum blanking delay after bootup, in seconds */ # define AFTERBOOT_BLANKING_TIMEOUT 30 /** * Blank prevent timeout, in seconds; * Don't alter this, since this is part of the defined behaviour * for blanking inhibit that applications rely on */ # define BLANK_PREVENT_TIMEOUT 60 /** Blank prevent timeout slack, in seconds * * To allow clients to use exactly BLANK_PREVENT_TIMEOUT long * renew period, make mce wait for renew requests a bit longer * than that before automatically terminating blaning pause. */ # define BLANK_PREVENT_SLACK 5 /** * Default maximum brightness; * used if the maximum brightness cannot be read from SysFS */ # define DEFAULT_MAXIMUM_DISPLAY_BRIGHTNESS 127 /* ========================================================================= * * Settings * ========================================================================= */ /** Prefix for display setting keys */ # define MCE_SETTING_DISPLAY_PATH "/system/osso/dsm/display" /* ------------------------------------------------------------------------- * * Ambient light sensor related settings * ------------------------------------------------------------------------- */ /** Whether MCE is allowed to use ambient light sensor */ # define MCE_SETTING_DISPLAY_ALS_ENABLED MCE_SETTING_DISPLAY_PATH "/als_enabled" # define MCE_DEFAULT_DISPLAY_ALS_ENABLED true /** Whether ALS is used for automatic display brightness tuning */ # define MCE_SETTING_DISPLAY_ALS_AUTOBRIGHTNESS MCE_SETTING_DISPLAY_PATH "/als_autobrightness" # define MCE_DEFAULT_DISPLAY_ALS_AUTOBRIGHTNESS true /** What kind of filtering is used for ALS data */ # define MCE_SETTING_DISPLAY_ALS_INPUT_FILTER MCE_SETTING_DISPLAY_PATH "/als_input_filter" # define MCE_DEFAULT_DISPLAY_ALS_INPUT_FILTER "median" /** How long sample window is used for ALS filtering [ms] */ # define MCE_SETTING_DISPLAY_ALS_SAMPLE_TIME MCE_SETTING_DISPLAY_PATH "/als_sample_time" # define MCE_DEFAULT_DISPLAY_ALS_SAMPLE_TIME 125 # define ALS_SAMPLE_TIME_MIN 50 # define ALS_SAMPLE_TIME_MAX 1000 /* ------------------------------------------------------------------------- * * Orientation sensor related settings * ------------------------------------------------------------------------- */ /** Whether MCE is allowed to use orientation sensor */ # define MCE_SETTING_ORIENTATION_SENSOR_ENABLED MCE_SETTING_DISPLAY_PATH "/orientation_sensor_enabled" # define MCE_DEFAULT_ORIENTATION_SENSOR_ENABLED true /** Whether device flip over gesture detection should be enabled */ # define MCE_SETTING_FLIPOVER_GESTURE_ENABLED MCE_SETTING_DISPLAY_PATH "/flipover_gesture_enabled" # define MCE_DEFAULT_FLIPOVER_GESTURE_ENABLED true /** Whether orientation changes constitute user activity */ # define MCE_SETTING_ORIENTATION_CHANGE_IS_ACTIVITY MCE_SETTING_DISPLAY_PATH "/orientation_change_is_activity" # define MCE_DEFAULT_ORIENTATION_CHANGE_IS_ACTIVITY true /* ------------------------------------------------------------------------- * * Color profile related settings * ------------------------------------------------------------------------- */ /** Current color profile name * * Note: This is meaningful only to Nokia N900 / N9 devices. */ # define MCE_SETTING_DISPLAY_COLOR_PROFILE MCE_SETTING_DISPLAY_PATH "/color_profile" /* ------------------------------------------------------------------------- * * Display brightness level related settings * * NOTE: The following defines the legacy mce brightness scale. It is * carved in stone for the sake of backwards compatibility. On * startup mce will migrate existing, possibly modified by user * brightness settings to 1-100 range - Which is then used for * actual brightness control. * ------------------------------------------------------------------------- */ /** Available display brightness steps * * Should be considered just a hint for the settings ui. */ # define MCE_SETTING_DISPLAY_BRIGHTNESS_LEVEL_COUNT MCE_SETTING_DISPLAY_PATH "/max_display_brightness_levels" # define MCE_DEFAULT_DISPLAY_BRIGHTNESS_LEVEL_COUNT 5 // defines legacy [1,5] range /** Size of display brightness level step * * Should be considered just a hint for the settings ui. */ # define MCE_SETTING_DISPLAY_BRIGHTNESS_LEVEL_SIZE MCE_SETTING_DISPLAY_PATH "/display_brightness_level_step" # define MCE_DEFAULT_DISPLAY_BRIGHTNESS_LEVEL_SIZE 1 /** Display brightness [1-100] * * When autobrightness is disabled, is used as percentage of maximum * brightness allowed by the display hw, i.e. roughly * * display_brightness = maximum_brightness * brightness_setting / 100 * * When autobrightness is enabled, is used to select ambient light * to brightness responce curve, i.e. something like * * display_brightness = filter_brightness(brightness_setting, als_lux) * * Note: Originally only 5 brightness levels were used. Installation * defaults must still be defined using the [1,5] range. MCE * will migrate old-style values to [1,100] range on startup. */ # define MCE_SETTING_DISPLAY_BRIGHTNESS MCE_SETTING_DISPLAY_PATH "/display_brightness" # define MCE_DEFAULT_DISPLAY_BRIGHTNESS 3 // uses legacy [1,5] range = 60% /** Default brightness fade duration [ms] * * Used for all display state changes that do not have * a separate duration speficied, for example DIM->ON */ # define MCE_SETTING_BRIGHTNESS_FADE_DEFAULT_MS MCE_SETTING_DISPLAY_PATH "/brightness_fade_default_ms" # define MCE_DEFAULT_BRIGHTNESS_FADE_DEFAULT_MS 150 /** Dimming brightness fade duration [ms] * * Used when changing display state changes to DIM * (except from OFF states, which use unblank duration). */ # define MCE_SETTING_BRIGHTNESS_FADE_DIMMING_MS MCE_SETTING_DISPLAY_PATH "/brightness_fade_dimming_ms" # define MCE_DEFAULT_BRIGHTNESS_FADE_DIMMING_MS 1000 /** ALS brightness fade duration [ms] * * Used when brightness changes due to ambient light * sensor input and/or display brightness setting changes. */ # define MCE_SETTING_BRIGHTNESS_FADE_ALS_MS MCE_SETTING_DISPLAY_PATH "/brightness_fade_als_ms" # define MCE_DEFAULT_BRIGHTNESS_FADE_ALS_MS 1000 /** Blanking brightness fade duration [ms] * * Used when making transition to display OFF states. */ # define MCE_SETTING_BRIGHTNESS_FADE_BLANK_MS MCE_SETTING_DISPLAY_PATH "/brightness_fade_blank_ms" # define MCE_DEFAULT_BRIGHTNESS_FADE_BLANK_MS 100 /** Unblanking brightness fade duration [ms] * * Used when making transition from display OFF states. */ # define MCE_SETTING_BRIGHTNESS_FADE_UNBLANK_MS MCE_SETTING_DISPLAY_PATH "/brightness_fade_unblank_ms" # define MCE_DEFAULT_BRIGHTNESS_FADE_UNBLANK_MS 90 /* ------------------------------------------------------------------------- * * Display dimming related settings * ------------------------------------------------------------------------- */ /** List of 5 possible dim timeouts [s] * * Hint for settings UI. Also used for adaptive dimming within mce. */ # define MCE_SETTING_DISPLAY_DIM_TIMEOUT_LIST MCE_SETTING_DISPLAY_PATH "/possible_display_dim_timeouts" # define MCE_DEFAULT_DISPLAY_DIM_TIMEOUT_LIST 15,30,60,120,600 /** Display dimming delay [s] */ # define MCE_SETTING_DISPLAY_DIM_TIMEOUT MCE_SETTING_DISPLAY_PATH "/display_dim_timeout" # define MCE_DEFAULT_DISPLAY_DIM_TIMEOUT 30 /** Display dimming delay when slidable hw keyboard is open [s] * * Zero value: Follow MCE_SETTING_DISPLAY_DIM_TIMEOUT setting */ # define MCE_SETTING_DISPLAY_DIM_WITH_KEYBOARD_TIMEOUT MCE_SETTING_DISPLAY_PATH "/display_dim_timeout_with_keyboard" # define MCE_DEFAULT_DISPLAY_DIM_WITH_KEYBOARD_TIMEOUT 0 /** Whether adaptive dimming dealy is enabled * * Adaptive dimming = When display is dimmed and then turned back on due to * user activity, the dimming delay is made progressively longer by choosing * the next bigger delay from MCE_SETTING_DISPLAY_DIM_TIMEOUT_LIST. */ # define MCE_SETTING_DISPLAY_ADAPTIVE_DIMMING MCE_SETTING_DISPLAY_PATH "/use_adaptive_display_dimming" # define MCE_DEFAULT_DISPLAY_ADAPTIVE_DIMMING true /** How long adaptive dimming is active after dimming display [ms] * * The display might stay dimmed for long periods of time (due to * for example stay-dim-with-charger inhibit mode). In these cases * it would make little send to increase dimming delay. */ # define MCE_SETTING_DISPLAY_ADAPTIVE_DIM_THRESHOLD MCE_SETTING_DISPLAY_PATH "/adaptive_display_dim_threshold" # define MCE_DEFAULT_DISPLAY_ADAPTIVE_DIM_THRESHOLD 10000 /** Maximum brightness in dimmed state [% of hw maximum] * * The display brightness used in dimmed state is the minimum * of the values calculated based on * MCE_SETTING_DISPLAY_DIM_STATIC_BRIGHTNESS * and * MCE_DEFAULT_DISPLAY_DIM_DYNAMIC_BRIGHTNESS */ # define MCE_SETTING_DISPLAY_DIM_STATIC_BRIGHTNESS MCE_SETTING_DISPLAY_PATH "/display_dim_static" # define MCE_DEFAULT_DISPLAY_DIM_STATIC_BRIGHTNESS 3 /** Dynamic brightness in dimmed state [% of current on level] */ # define MCE_SETTING_DISPLAY_DIM_DYNAMIC_BRIGHTNESS MCE_SETTING_DISPLAY_PATH "/display_dim_dynamic" # define MCE_DEFAULT_DISPLAY_DIM_DYNAMIC_BRIGHTNESS 50 /* High compositor dimming threshold setting [% of hw maximum] * * If delta between display on and display dim backlight levels * is smaller than this value, additional darkening of the screen * is done by invoking also compositor side fade-to-black animation. */ # define MCE_SETTING_DISPLAY_DIM_COMPOSITOR_HI MCE_SETTING_DISPLAY_PATH "/display_dim_compositor_hi" # define MCE_DEFAULT_DISPLAY_DIM_COMPOSITOR_HI 10 /** Low compositor dimming threshold setting [% of hw maximum] * * If delta between display on and display dim backlight levels * is smaller than this value, but still larger than value from * MCE_SETTING_DISPLAY_DIM_COMPOSITOR_HI, limited opacity compositor * side fade-to-black animation is used in addition to backlight * level fade. * * If the value is smaller than MCE_SETTING_DISPLAY_DIM_COMPOSITOR_HI, * no opacity interpolation is done i.e. compositor fading uses on/off * control at high threshold point. */ # define MCE_SETTING_DISPLAY_DIM_COMPOSITOR_LO MCE_SETTING_DISPLAY_PATH "/display_dim_compositor_lo" # define MCE_DEFAULT_DISPLAY_DIM_COMPOSITOR_LO 0 /* ------------------------------------------------------------------------- * * Display blanking related settings * ------------------------------------------------------------------------- */ /** List of 3 possible display blanking delays [s] * * Hint for settings UI. Not used by MCE itself. */ # define MCE_SETTING_DISPLAY_BLANK_TIMEOUT_LIST MCE_SETTING_DISPLAY_PATH "/possible_display_blank_timeouts" # define MCE_DEFAULT_DISPLAY_BLANK_TIMEOUT_LIST 3,10,15 /** Display blanking delay from dimmed state [s] */ # define MCE_SETTING_DISPLAY_BLANK_TIMEOUT MCE_SETTING_DISPLAY_PATH "/display_blank_timeout" # define MCE_DEFAULT_DISPLAY_BLANK_TIMEOUT 3 /** Display blanking delay from lockscreen [s] */ # define MCE_SETTING_DISPLAY_BLANK_FROM_LOCKSCREEN_TIMEOUT MCE_SETTING_DISPLAY_PATH "/display_blank_from_locksreen_timeout" # define MCE_DEFAULT_DISPLAY_BLANK_FROM_LOCKSCREEN_TIMEOUT 10 /** Display blanking delay from lpm-on state [s] */ # define MCE_SETTING_DISPLAY_BLANK_FROM_LPM_ON_TIMEOUT MCE_SETTING_DISPLAY_PATH "/display_blank_from_lpm_on_timeout" # define MCE_DEFAULT_DISPLAY_BLANK_FROM_LPM_ON_TIMEOUT 5 /** Display blanking delay from lpm-off state [s] * * Note: The lpm-off state is almost identical to off state, the differences * include: suspend is blocked and uncovering of the proximity sensor * will cause transition back to lpm-on state. */ # define MCE_SETTING_DISPLAY_BLANK_FROM_LPM_OFF_TIMEOUT MCE_SETTING_DISPLAY_PATH "/display_blank_from_lpm_off_timeout" # define MCE_DEFAULT_DISPLAY_BLANK_FROM_LPM_OFF_TIMEOUT 5 /** Whether display blanking is forbidden * * When enabled, mce will not turn display off for any reason. * * This is of very limited usefulness except during initial porting efforts * to new hw platforms where display power controls might not be fully * functional yet. */ # define MCE_SETTING_DISPLAY_NEVER_BLANK MCE_SETTING_DISPLAY_PATH "/display_never_blank" # define MCE_DEFAULT_DISPLAY_NEVER_BLANK 0 /** Inhibit type */ typedef enum { /** Inhibit value invalid */ INHIBIT_INVALID = -1, /** No inhibit */ INHIBIT_OFF = 0, /** Inhibit blanking; always keep on if charger connected */ INHIBIT_STAY_ON_WITH_CHARGER = 1, /** Inhibit blanking; always keep on or dimmed if charger connected */ INHIBIT_STAY_DIM_WITH_CHARGER = 2, /** Inhibit blanking; always keep on */ INHIBIT_STAY_ON = 3, /** Inhibit blanking; always keep on or dimmed */ INHIBIT_STAY_DIM = 4, } inhibit_t; /** Inhibit timer based display dimming/blanking [mode] * * Can be used to disable timer based display dimming and blanking * logic without modifying the timeout values. */ # define MCE_SETTING_BLANKING_INHIBIT_MODE MCE_SETTING_DISPLAY_PATH "/inhibit_blank_mode" # define MCE_DEFAULT_BLANKING_INHIBIT_MODE 0 // = INHIBIT_OFF /** Kbd slide inhibit type */ typedef enum { /** Kbd slide state does not affect display blanking */ KBD_SLIDE_INHIBIT_OFF = 0, /** Keep display on while kbd slide is open */ KBD_SLIDE_INHIBIT_STAY_ON_WHEN_OPEN = 1, /** Allow dimming but not blanking while kbd slide is open */ KBD_SLIDE_INHIBIT_STAY_DIM_WHEN_OPEN = 2, } kbd_slide_inhibit_t; /** Inhibit display dimming/blanking when hw keyboard is open [mode] * * Can be used to disable timer based display dimming and blanking * logic without modifying the timeout values when sliding hw keyboard * is available and in open position */ # define MCE_SETTING_KBD_SLIDE_INHIBIT MCE_SETTING_DISPLAY_PATH "/kbd_slide_inhibit_blank_mode" # define MCE_DEFAULT_KBD_SLIDE_INHIBIT 0 // = KBD_SLIDE_INHIBIT_OFF /** Values for MCE_SETTING_DISPLAY_OFF_OVERRIDE setting */ typedef enum { /** Display off request turns display off and activates lockscreen */ DISPLAY_OFF_OVERRIDE_DISABLED = 0, /** Display off request puts display to lpm state */ DISPLAY_OFF_OVERRIDE_USE_LPM = 1 << 0, /** Display off request just turns display off * * Note: This is mutually exclusive with other override modifiers * as they require or imply lockscreen activation. */ DISPLAY_OFF_OVERRIDE_ONLY_BLANK = 1 << 1, /** Apply device lock */ DISPLAY_OFF_OVERRIDE_DEVLOCK = 1 << 2, } display_off_blanking_mode_t; /** How display off requests via D-Bus should be interpreted * * Can be used to tweak swipe + lock so that it enters * lpm state instead of turning display fully off. */ # define MCE_SETTING_DISPLAY_OFF_OVERRIDE MCE_SETTING_DISPLAY_PATH "/display_off_override" # define MCE_DEFAULT_DISPLAY_OFF_OVERRIDE 4 // = DISPLAY_OFF_OVERRIDE_DEVLOCK /** Display blanking pause modes */ typedef enum { /** Ignore blanking pause requests */ BLANKING_PAUSE_MODE_DISABLED = 0, /** Blanking pause keeps display on */ BLANKING_PAUSE_MODE_KEEP_ON = 1, /** Display can be dimmed during Blanking pause */ BLANKING_PAUSE_MODE_ALLOW_DIM = 2, } blanking_pause_mode_t; /** Finetune display state control behavior during blanking pause * * Normally display is kept powered on when there is application * with active blanking pause session. * * This setting allows display to dimmed or even turned off even * if there is some application requesting it to stay on. */ # define MCE_SETTING_DISPLAY_BLANKING_PAUSE_MODE MCE_SETTING_DISPLAY_PATH "/blanking_pause_mode" # define MCE_DEFAULT_DISPLAY_BLANKING_PAUSE_MODE 1 // = BLANKING_PAUSE_MODE_KEEP_ON /* ------------------------------------------------------------------------- * * Low Power Mode related settings * ------------------------------------------------------------------------- */ /** Whether display low power mode activation is enabled * * Originally this feature was implemented for Nokia N9 phone which had an * oled display that supported an actual low power mode. * * Currently it is implemented as a generic "fake lpm" that has the display * powered on normally, but uses lower than normal brightness and a timer * to blank the screen after a while. */ # define MCE_SETTING_USE_LOW_POWER_MODE MCE_SETTING_DISPLAY_PATH "/use_low_power_mode" # define MCE_DEFAULT_USE_LOW_POWER_MODE false /* ------------------------------------------------------------------------- * * Power Management related settings * ------------------------------------------------------------------------- */ /** Automatic suspend policy modes */ enum { /** Always stay in on-mode */ SUSPEND_POLICY_DISABLED = 0, /** Normal transitions between on, early suspend, and late suspend */ SUSPEND_POLICY_ENABLED = 1, /** Allow on and early suspend, but never enter late suspend */ SUSPEND_POLICY_EARLY_ONLY = 2, /** Disable suspend when charger is connected * * Note: Applies only when device is running normally in the USER * mode, i.e. not in ACT_DEAD etc special modes. */ SUSPEND_POLICY_DISABLE_ON_CHARGER = 3, }; /** Whether the device is allowed to automatically suspend [mode] * * Normally MCE allows the device to fully suspend shortly after the * display is turned off. * * This setting can be used to disable suspending altogether or allow * only early suspend when periphreals can be powered off, but (one) cpu * is kept online. */ # define MCE_SETTING_USE_AUTOSUSPEND MCE_SETTING_DISPLAY_PATH "/autosuspend_policy" # define MCE_DEFAULT_USE_AUTOSUSPEND 1 // = SUSPEND_POLICY_ENABLED, /** CPU scaling covernor policy states */ enum { GOVERNOR_UNSET = 0, GOVERNOR_DEFAULT = 1, GOVERNOR_INTERACTIVE = 2, }; /** Select cpu scaling governor to use when device is in user mode * * When suitable governor setting configuration is present on the device, * mce will use the "fastest" one during bootup, shutdowns etc and the * one selected via setting when the device is in user mode. * * Note: This is more or less vestigial feature and is not used normally. */ # define MCE_SETTING_CPU_SCALING_GOVERNOR MCE_SETTING_DISPLAY_PATH "/cpu_scaling_governor" # define MCE_DEFAULT_CPU_SCALING_GOVERNOR 0 // = GOVERNOR_UNSET /* ------------------------------------------------------------------------- * * Development/Debug settings * ------------------------------------------------------------------------- */ /** How long to wait for lipstick before killing it [s] * * Normally when lipstick does not respond to display power up/down * D-Bus ipc in timely manner, mce starts to blink red/green panic * led. * * To ease debugging of the causes of lipstick freezes, devel builds of * mce will additionally kill lipstick with a signal that should cause a * core dump to be produced. */ # define MCE_SETTING_LIPSTICK_CORE_DELAY MCE_SETTING_DISPLAY_PATH "/lipstick_core_dump_delay" # define MCE_DEFAULT_LIPSTICK_CORE_DELAY 30 #endif /* DISPLAY_H_ */