From: Sam Ravnborg <sam@ravnborg.org>
To: dri-devel@lists.freedesktop.org,
Jingoo Han <jingoohan1@gmail.com>,
Lee Jones <lee.jones@linaro.org>,
Daniel Thompson <daniel.thompson@linaro.org>,
Peter Ujfalusi <peter.ujfalusi@ti.com>,
Tomi Valkeinen <tomi.valkeinen@ti.com>
Cc: linux-pwm@vger.kernel.org,
Support Opensource <support.opensource@diasemi.com>,
Michael Hennerich <michael.hennerich@analog.com>,
Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
David Airlie <airlied@linux.ie>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
Jonathan Corbet <corbet@lwn.net>,
Douglas Anderson <dianders@chromium.org>,
Bjorn Andersson <bjorn.andersson@linaro.org>,
Jani Nikula <jani.nikula@intel.com>,
Andy Gross <agross@kernel.org>,
Thierry Reding <thierry.reding@gmail.com>,
Thomas Zimmermann <tzimmermann@suse.de>,
linux-arm-msm@vger.kernel.org,
Russell King <linux@armlinux.org.uk>,
Sam Ravnborg <sam@ravnborg.org>,
patches@opensource.cirrus.com,
Uwe Kleine-Konig <u.kleine-koenig@pengutronix.de>
Subject: [PATCH v2 05/16] backlight: improve backlight_properties documentation
Date: Sun, 17 May 2020 21:01:28 +0200 [thread overview]
Message-ID: <20200517190139.740249-6-sam@ravnborg.org> (raw)
In-Reply-To: <20200517190139.740249-1-sam@ravnborg.org>
Improve the documentation for backlight_properties and
adapt it to kernel-doc style.
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Cc: Lee Jones <lee.jones@linaro.org>
Cc: Daniel Thompson <daniel.thompson@linaro.org>
Cc: Jingoo Han <jingoohan1@gmail.com>
---
include/linux/backlight.h | 101 +++++++++++++++++++++++++++++++++-----
1 file changed, 90 insertions(+), 11 deletions(-)
diff --git a/include/linux/backlight.h b/include/linux/backlight.h
index 519dc61ce7e4..7f9cef299d6e 100644
--- a/include/linux/backlight.h
+++ b/include/linux/backlight.h
@@ -118,28 +118,107 @@ struct backlight_ops {
int (*check_fb)(struct backlight_device *bd, struct fb_info *info);
};
-/* This structure defines all the properties of a backlight */
+/**
+ * struct backlight_properties - backlight properties
+ *
+ * This structure defines all the properties of a backlight.
+ */
struct backlight_properties {
- /* Current User requested brightness (0 - max_brightness) */
+ /**
+ * @brightness:
+ *
+ * The current requested brightness by the user.
+ * The backlight core makes sure the range is (0 - max_brightness)
+ * when the brightness is set via the sysfs attribute:
+ * /sys/class/backlight/<backlight>/brightness.
+ *
+ * This value can be set in the backlight_properties passed
+ * to devm_backlight_device_register() to set a default brightness
+ * value.
+ */
int brightness;
- /* Maximal value for brightness (read-only) */
+
+ /**
+ * @max_brightness:
+ *
+ * The maximum brightness value.
+ *
+ * This value must be set in the backlight_properties passed
+ * to devm_backlight_device_register().
+ *
+ * This property must not be modified by a driver except
+ * before registering the backlight device as explained above.
+ */
int max_brightness;
- /* Current FB Power mode (0: full on, 1..3: power saving
- modes; 4: full off), see FB_BLANK_XXX */
+
+ /**
+ * @power:
+ *
+ * The current power mode. User space configure the power mode using
+ * the sysfs 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..3: power saving
+ * modes; 4: full off), see FB_BLANK_XXX.
+ *
+ * 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.
+ */
int power;
- /* FB Blanking active? (values as for power) */
- /* Due to be removed, please use (state & BL_CORE_FBBLANK) */
+
+ /**
+ * @fb_blank:
+ *
+ * When the FBIOBLANK ioctl is called fb_blank is set to the
+ * blank parameter and the update_status() operation is called.
+ *
+ * When the backlight device is enabled @fb_blank is set
+ * to FB_BLANK_UNBLANK. When the backlight device is disabled
+ * @fb_blank is set to FB_BLANK_POWERDOWN.
+ *
+ * This property must not be modified by a driver.
+ * The backlight driver shall never read this variable,
+ * as the necessary info is avaialble via the state.
+ *
+ * fb_blank is deprecated and will be removed.
+ */
int fb_blank;
- /* Backlight type */
+
+ /**
+ * @type:
+ *
+ * The type of backlight supported.
+ * The backlight type allows userspace to make appropriate
+ * policy desicions based on the backlight type.
+ *
+ * This value must be set in the backlight_properties
+ * passed to devm_backlight_device_register().
+ */
enum backlight_type type;
- /* Flags used to signal drivers of state changes */
+
+ /**
+ * @state:
+ *
+ * The state property is used to inform drivers of state changes
+ * when the update_status() operation is called.
+ * The state is a bitmask. BL_CORE_FBBLANK is set when the display
+ * is expected to be blank. BL_CORE_SUSPENDED is set when the
+ * driver is suspended.
+ *
+ * This property must not be modified by a driver.
+ */
unsigned int state;
- /* Type of the brightness scale (linear, non-linear, ...) */
- enum backlight_scale scale;
#define BL_CORE_SUSPENDED (1 << 0) /* backlight is suspended */
#define BL_CORE_FBBLANK (1 << 1) /* backlight is under an fb blank event */
+ /**
+ * @scale:
+ *
+ * The type of the brightness scale (linear, non-linear, ...)
+ */
+ enum backlight_scale scale;
};
struct backlight_device {
--
2.25.1
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
next prev parent reply other threads:[~2020-05-17 19:02 UTC|newest]
Thread overview: 50+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-17 19:01 [PATCH v2 0/16] backlight updates Sam Ravnborg
2020-05-17 19:01 ` [PATCH v2 01/16] video: amba-clcd: use devm_of_find_backlight Sam Ravnborg
2020-05-18 8:10 ` Linus Walleij
2020-05-18 10:16 ` Sam Ravnborg
2020-05-25 8:42 ` Linus Walleij
2020-05-25 11:01 ` Sam Ravnborg
2020-05-17 19:01 ` [PATCH v2 02/16] backlight: refactor fb_notifier_callback() Sam Ravnborg
2020-05-18 14:54 ` Daniel Thompson
2020-05-20 10:41 ` Emil Velikov
2020-05-17 19:01 ` [PATCH v2 03/16] backlight: add backlight_is_blank() Sam Ravnborg
2020-05-18 15:00 ` Daniel Thompson
2020-05-20 10:45 ` Emil Velikov
2020-05-28 13:39 ` Peter Ujfalusi
2020-05-17 19:01 ` [PATCH v2 04/16] backlight: improve backlight_ops documentation Sam Ravnborg
2020-05-18 15:02 ` Daniel Thompson
2020-05-17 19:01 ` Sam Ravnborg [this message]
2020-05-18 15:53 ` [PATCH v2 05/16] backlight: improve backlight_properties documentation Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 06/16] backlight: improve backlight_device documentation Sam Ravnborg
2020-05-18 16:03 ` Daniel Thompson
2020-05-18 17:03 ` Jani Nikula
2020-05-18 17:58 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 07/16] backlight: document inline functions in backlight.h Sam Ravnborg
2020-05-18 16:04 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 08/16] backlight: document enums " Sam Ravnborg
2020-05-18 16:15 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 09/16] backlight: remove the unused backlight_bl driver Sam Ravnborg
2020-05-18 16:17 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 10/16] backlight: drop extern from prototypes Sam Ravnborg
2020-05-18 16:22 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 11/16] backlight: add overview and update existing doc Sam Ravnborg
2020-05-18 16:44 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 12/16] backlight: wire up kernel-doc documentation Sam Ravnborg
2020-05-18 16:50 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 13/16] backlight: make of_find_backlight static Sam Ravnborg
2020-05-18 16:53 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 14/16] backlight: drop backlight_put() Sam Ravnborg
2020-05-18 16:53 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 15/16] backlight: make of_find_backlight_by_node() static Sam Ravnborg
2020-05-17 20:22 ` kbuild test robot
2020-05-17 20:53 ` kbuild test robot
2020-05-18 16:56 ` Daniel Thompson
2020-05-18 18:12 ` Sam Ravnborg
2020-05-18 19:56 ` Daniel Thompson
2020-05-17 19:01 ` [PATCH v2 16/16] backlight: use backlight_is_blank() in all backlight drivers Sam Ravnborg
2020-05-18 16:59 ` Daniel Thompson
2020-05-20 10:56 ` Emil Velikov
2020-05-20 15:11 ` Daniel Thompson
2020-05-28 13:39 ` Peter Ujfalusi
2020-05-28 13:43 ` Peter Ujfalusi
2020-05-20 11:01 ` [PATCH v2 0/16] backlight updates Emil Velikov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200517190139.740249-6-sam@ravnborg.org \
--to=sam@ravnborg.org \
--cc=agross@kernel.org \
--cc=airlied@linux.ie \
--cc=b.zolnierkie@samsung.com \
--cc=bjorn.andersson@linaro.org \
--cc=corbet@lwn.net \
--cc=daniel.thompson@linaro.org \
--cc=daniel.vetter@ffwll.ch \
--cc=dianders@chromium.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=jani.nikula@intel.com \
--cc=jingoohan1@gmail.com \
--cc=lee.jones@linaro.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-pwm@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=michael.hennerich@analog.com \
--cc=patches@opensource.cirrus.com \
--cc=peter.ujfalusi@ti.com \
--cc=support.opensource@diasemi.com \
--cc=thierry.reding@gmail.com \
--cc=tomi.valkeinen@ti.com \
--cc=tzimmermann@suse.de \
--cc=u.kleine-koenig@pengutronix.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).