backlight: Add BACKLIGHT_POWER_ constants for power states

Duplicate FB_BLANK_ constants as BACKLIGHT_POWER__ constants in the
backlight header file. Allows backlight drivers to avoid including
the fbdev header file and removes a compile-time dependency between
the two subsystems.

The new BACKLIGHT_POWER_ constants have the same values as their
FB_BLANK_ counterparts. Hence UAPI and internal semantics do not
change. The backlight drivers can be converted one by one. Each
instance of FB_BLANK_UNBLANK becomes BACKLIGHT_POWER_ON, each of
FB_BLANK_POWERDOWN becomes BACKLIGHT_POWER_OFF, and FB_BLANK_NORMAL
becomes BACKLIGHT_POWER_REDUCED.

Backlight code or drivers do not use FB_BLANK_VSYNC_SUSPEND and
FB_BLANK_HSYNC_SUSPEND, so no new constants for these are being
added.

The semantics of FB_BLANK_NORMAL appear inconsistent. In fbdev,
NORMAL means display off with sync enabled. In backlight code,
this translates to turn the backlight off, but some drivers
interpret it as backlight on. So we keep the current code as is,
but mark BACKLIGHT_POWER_REDUCED as deprecated. Drivers should be
fixed and the constant removed. This affects ams369fg06 and a few
DRM panel drivers.

v2:
- rename BL_CORE_ power constants to BACKLIGHT_POWER_ (Sam)
- fix documentation

Signed-off-by: Thomas Zimmermann <tzimmermann@suse.de>
Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org>
Link: https://lore.kernel.org/r/20240624152033.25016-2-tzimmermann@suse.de
Signed-off-by: Lee Jones <lee@kernel.org>

diff --git a/Documentation/ABI/stable/sysfs-class-backlight b/Documentation/ABI/stable/sysfs-class-backlight
index 023fb52645f8bdcd02c22c3faf0f803609a9a2dd..6102d6bebdf9ad6ba9672bd62f9ae63954cad6c6 100644 (file)
--- a/Documentation/ABI/stable/sysfs-class-backlight
+++ b/Documentation/ABI/stable/sysfs-class-backlight
@@ -3,10 +3,11 @@ Date:         April 2005
 KernelVersion: 2.6.12
 Contact:       Richard Purdie <rpurdie@rpsys.net>
 Description:
-               Control BACKLIGHT power, values are FB_BLANK_* from fb.h
+               Control BACKLIGHT power, values are compatible with
+               FB_BLANK_* from fb.h
 
-                - FB_BLANK_UNBLANK (0)   : power on.
-                - FB_BLANK_POWERDOWN (4) : power off
+                - 0 (FB_BLANK_UNBLANK)   : power on.
+                - 4 (FB_BLANK_POWERDOWN) : power off
 Users:         HAL
 
 What:          /sys/class/backlight/<backlight>/brightness

diff --git a/include/linux/backlight.h b/include/linux/backlight.h
index 19a1c0e22629da13d8f9f241ad2bdc9fb6d58f6a..ea9c1bc8148ee057e9153413350d24ba1f234d56 100644 (file)
--- a/include/linux/backlight.h
+++ b/include/linux/backlight.h
@@ -209,15 +209,19 @@ struct backlight_properties {
         * attribute: /sys/class/backlight/<backlight>/bl_power
         * When the power property is updated update_status() is called.
         *
-        * The possible values are: (0: full on, 1 to 3: power saving
-        * modes; 4: full off), see FB_BLANK_XXX.
+        * The possible values are: (0: full on, 4: full off), see
+        * BACKLIGHT_POWER constants.
         *
-        * When the backlight device is enabled @power is set
-        * to FB_BLANK_UNBLANK. When the backlight device is disabled
-        * @power is set to FB_BLANK_POWERDOWN.
+        * When the backlight device is enabled, @power is set to
+        * BACKLIGHT_POWER_ON. When the backlight device is disabled,
+        * @power is set to BACKLIGHT_POWER_OFF.
         */
        int power;
 
+#define BACKLIGHT_POWER_ON             (0)
+#define BACKLIGHT_POWER_OFF            (4)
+#define BACKLIGHT_POWER_REDUCED                (1) // deprecated; don't use in new code
+
        /**
         * @type: The type of backlight supported.
         *
@@ -346,7 +350,7 @@ static inline int backlight_enable(struct backlight_device *bd)
        if (!bd)
                return 0;
 
-       bd->props.power = FB_BLANK_UNBLANK;
+       bd->props.power = BACKLIGHT_POWER_ON;
        bd->props.state &= ~BL_CORE_FBBLANK;
 
        return backlight_update_status(bd);
@@ -361,7 +365,7 @@ static inline int backlight_disable(struct backlight_device *bd)
        if (!bd)
                return 0;
 
-       bd->props.power = FB_BLANK_POWERDOWN;
+       bd->props.power = BACKLIGHT_POWER_OFF;
        bd->props.state |= BL_CORE_FBBLANK;
 
        return backlight_update_status(bd);
@@ -380,7 +384,7 @@ static inline int backlight_disable(struct backlight_device *bd)
  */
 static inline bool backlight_is_blank(const struct backlight_device *bd)
 {
-       return bd->props.power != FB_BLANK_UNBLANK ||
+       return bd->props.power != BACKLIGHT_POWER_ON ||
               bd->props.state & (BL_CORE_SUSPENDED | BL_CORE_FBBLANK);
 }