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>
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>,
Tomi Valkeinen <tomi.valkeinen@ti.com>,
Jonathan Corbet <corbet@lwn.net>,
Emil Velikov <emil.l.velikov@gmail.com>,
Bjorn Andersson <bjorn.andersson@linaro.org>,
Peter Ujfalusi <peter.ujfalusi@ti.com>,
Andy Gross <agross@kernel.org>,
Thierry Reding <thierry.reding@gmail.com>,
Thomas Zimmermann <tzimmermann@suse.de>,
linux-arm-msm@vger.kernel.org,
Uwe Kleine-Konig <u.kleine-koenig@pengutronix.de>,
Sam Ravnborg <sam@ravnborg.org>,
patches@opensource.cirrus.com
Subject: [PATCH v3 07/13] backlight: document enums in backlight.h
Date: Mon, 1 Jun 2020 08:52:01 +0200 [thread overview]
Message-ID: <20200601065207.492614-8-sam@ravnborg.org> (raw)
In-Reply-To: <20200601065207.492614-1-sam@ravnborg.org>
Add kernel-doc documentation for the backlight enums
v2:
- Add intro to each enum member (Daniel)
Except backlight type as line lenght was too long.
The generated HTML is the same.
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Reviewed-by: Daniel Thompson <daniel.thompson@linaro.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 | 74 ++++++++++++++++++++++++++++++++++++++-
1 file changed, 73 insertions(+), 1 deletion(-)
diff --git a/include/linux/backlight.h b/include/linux/backlight.h
index f99ca19cc3ec..c1c7b1666a9b 100644
--- a/include/linux/backlight.h
+++ b/include/linux/backlight.h
@@ -14,26 +14,98 @@
#include <linux/mutex.h>
#include <linux/notifier.h>
+/**
+ * enum backlight_update_reason - what method was used to update backlight
+ *
+ * A driver indicates the method (reason) used for updating the backlight
+ * when calling backlight_force_update().
+ */
enum backlight_update_reason {
+ /**
+ * @BACKLIGHT_UPDATE_HOTKEY: The backlight was updated using a hot-key.
+ */
BACKLIGHT_UPDATE_HOTKEY,
+
+ /**
+ * @BACKLIGHT_UPDATE_SYSFS: The backlight was updated using sysfs.
+ */
BACKLIGHT_UPDATE_SYSFS,
};
+/**
+ * enum backlight_type - the type of backlight control
+ *
+ * The type of interface used to control the backlight.
+ */
enum backlight_type {
+ /**
+ * @BACKLIGHT_RAW:
+ *
+ * The backlight is controlled using hardware registers.
+ */
BACKLIGHT_RAW = 1,
+
+ /**
+ * @BACKLIGHT_PLATFORM:
+ *
+ * The backlight is controlled using a platform-specific interface.
+ */
BACKLIGHT_PLATFORM,
+
+ /**
+ * @BACKLIGHT_FIRMWARE:
+ *
+ * The backlight is controlled using a standard firmware interface.
+ */
BACKLIGHT_FIRMWARE,
+
+ /**
+ * @BACKLIGHT_TYPE_MAX: Number of entries.
+ */
BACKLIGHT_TYPE_MAX,
};
+/**
+ * enum backlight_notification - the type of notification
+ *
+ * The notifications that is used for notification sent to the receiver
+ * that registered notifications using backlight_register_notifier().
+ */
enum backlight_notification {
+ /**
+ * @BACKLIGHT_REGISTERED: The backlight device is registered.
+ */
BACKLIGHT_REGISTERED,
+
+ /**
+ * @BACKLIGHT_UNREGISTERED: The backlight revice is unregistered.
+ */
BACKLIGHT_UNREGISTERED,
};
+/** enum backlight_scale - the type of scale used for brightness values
+ *
+ * The type of scale used for brightness values.
+ */
enum backlight_scale {
+ /**
+ * @BACKLIGHT_SCALE_UNKNOWN: The scale is unknown.
+ */
BACKLIGHT_SCALE_UNKNOWN = 0,
+
+ /**
+ * @BACKLIGHT_SCALE_LINEAR: The scale is linear.
+ *
+ * The linear scale will increase brightness the same for each step.
+ */
BACKLIGHT_SCALE_LINEAR,
+
+ /**
+ * @BACKLIGHT_SCALE_NON_LINEAR: The scale is not linear.
+ *
+ * This is often used when the brightness values tries to adjust to
+ * the relative perception of the eye demanding a non-linear scale.
+ */
BACKLIGHT_SCALE_NON_LINEAR,
};
@@ -149,7 +221,7 @@ struct backlight_properties {
/**
* @fb_blank: The power state from the FBIOBLANK ioclt.
*
- * When the FBIOBLANK ioctl is called fb_blank is set to the
+ * 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
--
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-06-01 6:52 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-01 6:51 [PATCH v3 0/16] backlight updates Sam Ravnborg
2020-06-01 6:51 ` [PATCH v3 01/13] backlight: refactor fb_notifier_callback() Sam Ravnborg
2020-06-01 6:51 ` [PATCH v3 02/13] backlight: add backlight_is_blank() Sam Ravnborg
2020-06-01 12:27 ` Peter Ujfalusi
2020-06-01 6:51 ` [PATCH v3 03/13] backlight: improve backlight_ops documentation Sam Ravnborg
2020-06-01 6:51 ` [PATCH v3 04/13] backlight: improve backlight_properties documentation Sam Ravnborg
2020-06-01 10:10 ` Daniel Thompson
2020-06-01 6:51 ` [PATCH v3 05/13] backlight: improve backlight_device documentation Sam Ravnborg
2020-06-01 10:23 ` Daniel Thompson
2020-06-01 6:52 ` [PATCH v3 06/13] backlight: document inline functions in backlight.h Sam Ravnborg
2020-06-01 6:52 ` Sam Ravnborg [this message]
2020-06-01 6:52 ` [PATCH v3 08/13] backlight: remove the unused backlight_bl driver Sam Ravnborg
2020-06-01 6:52 ` [PATCH v3 09/13] backlight: drop extern from prototypes Sam Ravnborg
2020-06-01 6:52 ` [PATCH v3 10/13] backlight: add overview and update existing doc Sam Ravnborg
2020-06-01 10:34 ` Daniel Thompson
2020-06-01 6:52 ` [PATCH v3 11/13] backlight: wire up kernel-doc documentation Sam Ravnborg
2020-06-01 6:52 ` [PATCH v3 12/13] backlight: as3711_bl: introduce backlight_is_blank() Sam Ravnborg
2020-06-01 10:35 ` Daniel Thompson
2020-06-01 6:52 ` [PATCH v3 13/13] backlight: use backlight_is_blank() in all backlight drivers Sam Ravnborg
2020-06-01 12:28 ` Peter Ujfalusi
2020-06-01 12:39 ` Sam Ravnborg
2020-06-02 14:04 ` [PATCH v3 0/16] backlight updates Emil Velikov
2020-07-02 8:01 ` Sam Ravnborg
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=20200601065207.492614-8-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=dri-devel@lists.freedesktop.org \
--cc=emil.l.velikov@gmail.com \
--cc=jingoohan1@gmail.com \
--cc=lee.jones@linaro.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-pwm@vger.kernel.org \
--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).