All of lore.kernel.org
 help / color / mirror / Atom feed
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.valkeinen@ti.com>,
	Sam Ravnborg <sam@ravnborg.org>
Subject: [PATCH v4 06/20] backlight: document inline functions in backlight.h
Date: Fri,  3 Jul 2020 20:45:32 +0200	[thread overview]
Message-ID: <20200703184546.144664-7-sam@ravnborg.org> (raw)
In-Reply-To: <20200703184546.144664-1-sam@ravnborg.org>

Add documentation for the inline functions in backlight.h

v2:
 - Fix spelling (Daniel)

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 | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/include/linux/backlight.h b/include/linux/backlight.h
index 7654fe5f1589..7d6cb61e10f5 100644
--- a/include/linux/backlight.h
+++ b/include/linux/backlight.h
@@ -268,6 +268,10 @@ struct backlight_device {
 	int use_count;
 };
 
+/**
+ * backlight_update_status - force an update of the backlight device status
+ * @bd: the backlight device
+ */
 static inline int backlight_update_status(struct backlight_device *bd)
 {
 	int ret = -ENOENT;
@@ -361,6 +365,18 @@ extern int backlight_device_set_brightness(struct backlight_device *bd, unsigned
 
 #define to_backlight_device(obj) container_of(obj, struct backlight_device, dev)
 
+/**
+ * bl_get_data - access devdata
+ * @bl_dev: pointer to backlight device
+ *
+ * When a backlight device is registered the driver has the possibility
+ * to supply a void * devdata. bl_get_data() return a pointer to the
+ * devdata.
+ *
+ * RETURNS:
+ *
+ * pointer to devdata stored while registering the backlight device.
+ */
 static inline void * bl_get_data(struct backlight_device *bl_dev)
 {
 	return dev_get_drvdata(&bl_dev->dev);
-- 
2.25.1


WARNING: multiple messages have this Message-ID (diff)
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 v4 06/20] backlight: document inline functions in backlight.h
Date: Fri,  3 Jul 2020 20:45:32 +0200	[thread overview]
Message-ID: <20200703184546.144664-7-sam@ravnborg.org> (raw)
In-Reply-To: <20200703184546.144664-1-sam@ravnborg.org>

Add documentation for the inline functions in backlight.h

v2:
 - Fix spelling (Daniel)

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 | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/include/linux/backlight.h b/include/linux/backlight.h
index 7654fe5f1589..7d6cb61e10f5 100644
--- a/include/linux/backlight.h
+++ b/include/linux/backlight.h
@@ -268,6 +268,10 @@ struct backlight_device {
 	int use_count;
 };
 
+/**
+ * backlight_update_status - force an update of the backlight device status
+ * @bd: the backlight device
+ */
 static inline int backlight_update_status(struct backlight_device *bd)
 {
 	int ret = -ENOENT;
@@ -361,6 +365,18 @@ extern int backlight_device_set_brightness(struct backlight_device *bd, unsigned
 
 #define to_backlight_device(obj) container_of(obj, struct backlight_device, dev)
 
+/**
+ * bl_get_data - access devdata
+ * @bl_dev: pointer to backlight device
+ *
+ * When a backlight device is registered the driver has the possibility
+ * to supply a void * devdata. bl_get_data() return a pointer to the
+ * devdata.
+ *
+ * RETURNS:
+ *
+ * pointer to devdata stored while registering the backlight device.
+ */
 static inline void * bl_get_data(struct backlight_device *bl_dev)
 {
 	return dev_get_drvdata(&bl_dev->dev);
-- 
2.25.1

WARNING: multiple messages have this Message-ID (diff)
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 v4 06/20] backlight: document inline functions in backlight.h
Date: Fri,  3 Jul 2020 20:45:32 +0200	[thread overview]
Message-ID: <20200703184546.144664-7-sam@ravnborg.org> (raw)
In-Reply-To: <20200703184546.144664-1-sam@ravnborg.org>

Add documentation for the inline functions in backlight.h

v2:
 - Fix spelling (Daniel)

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 | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/include/linux/backlight.h b/include/linux/backlight.h
index 7654fe5f1589..7d6cb61e10f5 100644
--- a/include/linux/backlight.h
+++ b/include/linux/backlight.h
@@ -268,6 +268,10 @@ struct backlight_device {
 	int use_count;
 };
 
+/**
+ * backlight_update_status - force an update of the backlight device status
+ * @bd: the backlight device
+ */
 static inline int backlight_update_status(struct backlight_device *bd)
 {
 	int ret = -ENOENT;
@@ -361,6 +365,18 @@ extern int backlight_device_set_brightness(struct backlight_device *bd, unsigned
 
 #define to_backlight_device(obj) container_of(obj, struct backlight_device, dev)
 
+/**
+ * bl_get_data - access devdata
+ * @bl_dev: pointer to backlight device
+ *
+ * When a backlight device is registered the driver has the possibility
+ * to supply a void * devdata. bl_get_data() return a pointer to the
+ * devdata.
+ *
+ * RETURNS:
+ *
+ * pointer to devdata stored while registering the backlight device.
+ */
 static inline void * bl_get_data(struct backlight_device *bl_dev)
 {
 	return dev_get_drvdata(&bl_dev->dev);
-- 
2.25.1

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

  parent reply	other threads:[~2020-07-03 18:46 UTC|newest]

Thread overview: 117+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-03 18:45 [PATCH v4 0/20] backlight: backlight updates Sam Ravnborg
2020-07-03 18:45 ` Sam Ravnborg
2020-07-03 18:45 ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 01/20] backlight: refactor fb_notifier_callback() Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 02/20] backlight: add backlight_is_blank() Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-07  5:42   ` Daniel Vetter
2020-07-07  5:42     ` Daniel Vetter
2020-07-07  5:42     ` Daniel Vetter
2020-07-03 18:45 ` [PATCH v4 03/20] backlight: improve backlight_ops documentation Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 04/20] backlight: improve backlight_properties documentation Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 05/20] backlight: improve backlight_device documentation Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-08 10:23   ` Daniel Thompson
2020-07-08 10:23     ` Daniel Thompson
2020-07-08 10:23     ` Daniel Thompson
2020-07-16 14:39   ` Lee Jones
2020-07-16 14:39     ` Lee Jones
2020-07-16 14:39     ` Lee Jones
2020-07-16 15:00     ` Sam Ravnborg
2020-07-16 15:00       ` Sam Ravnborg
2020-07-16 15:00       ` Sam Ravnborg
2020-07-16 15:09       ` Lee Jones
2020-07-16 15:09         ` Lee Jones
2020-07-16 15:09         ` Lee Jones
2020-07-18  5:18   ` Jingoo Han
2020-07-18  5:18     ` Jingoo Han
2020-07-18  5:18     ` Jingoo Han
2020-07-18  6:00     ` Sam Ravnborg
2020-07-18  6:00       ` Sam Ravnborg
2020-07-18  6:00       ` Sam Ravnborg
2020-07-03 18:45 ` Sam Ravnborg [this message]
2020-07-03 18:45   ` [PATCH v4 06/20] backlight: document inline functions in backlight.h Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 07/20] backlight: document enums " Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 08/20] backlight: remove the unused backlight_bl driver Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 09/20] backlight: drop extern from prototypes Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 10/20] backlight: add overview and update existing doc Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 11/20] backlight: wire up kernel-doc documentation Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 12/20] backlight: introduce backlight_get_brightness() Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-08 10:27   ` Daniel Thompson
2020-07-08 10:27     ` Daniel Thompson
2020-07-08 10:27     ` Daniel Thompson
2020-07-03 18:45 ` [PATCH v4 13/20] backlight: as3711_bl: simplify update_status Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 14/20] backlight: cr_bllcd: introduce backlight_is_blank() Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-08 11:06   ` Daniel Thompson
2020-07-08 11:06     ` Daniel Thompson
2020-07-08 11:06     ` Daniel Thompson
2020-07-03 18:45 ` [PATCH v4 15/20] backlight: gpio_backlight: simplify update_status() Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-08 11:07   ` Daniel Thompson
2020-07-08 11:07     ` Daniel Thompson
2020-07-08 11:07     ` Daniel Thompson
2020-07-03 18:45 ` [PATCH v4 16/20] backlight: jornada720_bl: introduce backlight_is_blank() Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-08 11:12   ` Daniel Thompson
2020-07-08 11:12     ` Daniel Thompson
2020-07-08 11:12     ` Daniel Thompson
2020-07-03 18:45 ` [PATCH v4 17/20] backlight: use backligt_get_brightness() Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-07  5:48   ` Daniel Vetter
2020-07-07  5:48     ` Daniel Vetter
2020-07-07  5:48     ` Daniel Vetter
2020-07-07 19:59     ` Sam Ravnborg
2020-07-07 19:59       ` Sam Ravnborg
2020-07-07 19:59       ` Sam Ravnborg
2020-07-07 20:15       ` Daniel Vetter
2020-07-07 20:15         ` Daniel Vetter
2020-07-07 20:15         ` Daniel Vetter
2020-07-07 20:23         ` Sam Ravnborg
2020-07-07 20:23           ` Sam Ravnborg
2020-07-07 20:23           ` Sam Ravnborg
2020-07-08 11:14   ` Daniel Thompson
2020-07-08 11:14     ` Daniel Thompson
2020-07-08 11:14     ` Daniel Thompson
2020-07-03 18:45 ` [PATCH v4 18/20] backlight: drop backlight_put() Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45 ` [PATCH v4 19/20] backlight: make of_find_backlight static Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-08 11:17   ` Daniel Thompson
2020-07-08 11:17     ` Daniel Thompson
2020-07-08 11:17     ` Daniel Thompson
2020-07-03 18:45 ` [PATCH v4 20/20] backlight: make of_find_backlight_by_node() static Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-03 18:45   ` Sam Ravnborg
2020-07-07 21:46   ` kernel test robot
2020-07-07 21:46     ` kernel test robot
2020-07-07 21:46     ` kernel test robot

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=20200703184546.144664-7-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=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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.