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: Andy Gross <agross@kernel.org>,
Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
Bjorn Andersson <bjorn.andersson@linaro.org>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
David Airlie <airlied@linux.ie>,
Emil Velikov <emil.l.velikov@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-arm-msm@vger.kernel.org, linux-pwm@vger.kernel.org,
Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
Maxime Ripard <mripard@kernel.org>,
Michael Hennerich <michael.hennerich@analog.com>,
patches@opensource.cirrus.com,
Support Opensource <support.opensource@diasemi.com>,
Thierry Reding <thierry.reding@gmail.com>,
Thomas Zimmermann <tzimmermann@suse.de>,
Uwe Kleine-Konig <u.kleine-koenig@pengutronix.de>,
Peter Ujfalusi <peter.ujfalusi@ti.com>, Tomi Valkeinen <tomi.v>
Subject: [PATCH v5 07/19] backlight: document enums in backlight.h
Date: Sun, 19 Jul 2020 10:07:31 +0200 [thread overview]
Message-ID: <20200719080743.8560-8-sam@ravnborg.org> (raw)
In-Reply-To: <20200719080743.8560-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>
Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com>
Cc: Lee Jones <lee.jones@linaro.org>
Cc: Daniel Thompson <daniel.thompson@linaro.org>
Cc: Jingoo Han <jingoohan1@gmail.com>
---
include/linux/backlight.h | 72 +++++++++++++++++++++++++++++++++++++++
1 file changed, 72 insertions(+)
diff --git a/include/linux/backlight.h b/include/linux/backlight.h
index 7d6cb61e10f5..0f425b32e6be 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,
};
--
2.25.1
next prev parent reply other threads:[~2020-07-19 8:08 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-19 8:07 [PATCH v5 0/19] backlight: backlight updates Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 01/19] backlight: refactor fb_notifier_callback() Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 02/19] backlight: add backlight_is_blank() Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 03/19] backlight: improve backlight_ops documentation Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 04/19] backlight: improve backlight_properties documentation Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 05/19] backlight: improve backlight_device documentation Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 06/19] backlight: document inline functions in backlight.h Sam Ravnborg
2020-07-19 8:07 ` Sam Ravnborg [this message]
2020-07-19 8:07 ` [PATCH v5 08/19] backlight: remove the unused backlight_bl driver Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 09/19] backlight: drop extern from prototypes Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 10/19] backlight: add overview and update existing doc Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 11/19] backlight: wire up kernel-doc documentation Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 12/19] backlight: introduce backlight_get_brightness() Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 13/19] backlight: as3711_bl: simplify update_status Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 14/19] backlight: cr_bllcd: introduce gpio-backlight semantics Sam Ravnborg
2020-07-20 8:48 ` Daniel Thompson
2020-07-20 9:14 ` Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 15/19] backlight: gpio_backlight: simplify update_status() Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 16/19] backlight: jornada720_bl: introduce backlight_is_blank() Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 17/19] backlight: use backlight_get_brightness() Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 18/19] backlight: drop backlight_put() Sam Ravnborg
2020-07-19 8:07 ` [PATCH v5 19/19] backlight: make of_find_backlight static Sam Ravnborg
2020-07-20 9:36 ` [PATCH v5 0/19] backlight: backlight updates Lee Jones
2020-07-20 11: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=20200719080743.8560-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=maarten.lankhorst@linux.intel.com \
--cc=michael.hennerich@analog.com \
--cc=mripard@kernel.org \
--cc=patches@opensource.cirrus.com \
--cc=peter.ujfalusi@ti.com \
--cc=support.opensource@diasemi.com \
--cc=thierry.reding@gmail.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).