All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Marek Behún" <kabel@kernel.org>
To: Lee Jones <lee@kernel.org>
Cc: "Pavel Machek" <pavel@ucw.cz>,
	linux-leds@vger.kernel.org, "Arnd Bergmann" <arnd@arndb.de>,
	soc@kernel.org, "Gregory CLEMENT" <gregory.clement@bootlin.com>,
	arm@kernel.org, "Andy Shevchenko" <andy@kernel.org>,
	"Hans de Goede" <hdegoede@redhat.com>,
	"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
	"Andrew Lunn" <andrew@lunn.ch>,
	"Sebastian Hesselbarth" <sebastian.hesselbarth@gmail.com>,
	"Rob Herring" <robh+dt@kernel.org>,
	"Krzysztof Kozlowski" <krzk+dt@kernel.org>,
	"Conor Dooley" <conor+dt@kernel.org>,
	devicetree@vger.kernel.org, "Marek Behún" <kabel@kernel.org>
Subject: [PATCH leds v5 06/12] leds: turris-omnia: Document driver private structures
Date: Mon,  4 Nov 2024 15:19:18 +0100	[thread overview]
Message-ID: <20241104141924.18816-7-kabel@kernel.org> (raw)
In-Reply-To: <20241104141924.18816-1-kabel@kernel.org>

Add documentation for driver private structures, `struct omnia_leds` and
`struct omnia_led`.

Signed-off-by: Marek Behún <kabel@kernel.org>
---
 drivers/leds/leds-turris-omnia.c | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/drivers/leds/leds-turris-omnia.c b/drivers/leds/leds-turris-omnia.c
index 50fef4389c93..7d2ed0c6500a 100644
--- a/drivers/leds/leds-turris-omnia.c
+++ b/drivers/leds/leds-turris-omnia.c
@@ -19,6 +19,15 @@
 /* MCU controller I2C address 0x2a, needed for detecting MCU features */
 #define OMNIA_MCU_I2C_ADDR	0x2a
 
+/**
+ * struct omnia_led - per-LED part of driver private data structure
+ * @mc_cdev:		multi-color LED class device
+ * @subled_info:	per-channel information
+ * @cached_channels:	cached values of per-channel brightness that was sent to the MCU
+ * @on:			whether the LED was set on
+ * @hwtrig:		whether the LED blinking was offloaded to the MCU
+ * @reg:		LED identifier to the MCU
+ */
 struct omnia_led {
 	struct led_classdev_mc mc_cdev;
 	struct mc_subled subled_info[OMNIA_LED_NUM_CHANNELS];
@@ -29,6 +38,13 @@ struct omnia_led {
 
 #define to_omnia_led(l)		container_of(l, struct omnia_led, mc_cdev)
 
+/**
+ * struct omnia_leds - driver private data structure
+ * @client:			I2C client device
+ * @lock:			mutex to protect
+ * @has_gamma_correction:	whether the MCU firmware supports gamma correction
+ * @leds:			flexible array of per-LED data
+ */
 struct omnia_leds {
 	struct i2c_client *client;
 	struct mutex lock;
-- 
2.45.2


  parent reply	other threads:[~2024-11-04 14:19 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-04 14:19 [PATCH leds v5 00/12] Turris Omnia LED driver changes Marek Behún
2024-11-04 14:19 ` [PATCH leds v5 01/12] turris-omnia-mcu-interface.h: Move command execution function to global header Marek Behún
2024-11-06 10:28   ` Lee Jones
2024-11-06 10:53     ` Gregory CLEMENT
2024-11-06 11:01       ` Lee Jones
2024-11-06 11:02         ` Lee Jones
2024-11-04 14:19 ` [PATCH leds v5 02/12] leds: turris-omnia: Use command execution functions from the MCU driver Marek Behún
2024-11-04 14:51   ` Andy Shevchenko
2024-11-05  9:07     ` Marek Behún
2024-11-05 14:49       ` Andy Shevchenko
2024-11-04 14:19 ` [PATCH leds v5 03/12] turris-omnia-mcu-interface.h: Add LED commands related definitions to global header Marek Behún
2024-11-04 14:19 ` [PATCH leds v5 04/12] leds: turris-omnia: Use global header for MCU command definitions Marek Behún
2024-11-04 14:19 ` [PATCH leds v5 05/12] dt-bindings: leds: cznic,turris-omnia-leds: Allow interrupts property Marek Behún
2024-11-04 14:19 ` Marek Behún [this message]
2024-11-04 14:19 ` [PATCH leds v5 07/12] leds: turris-omnia: Notify sysfs on MCU global LEDs brightness change Marek Behún
2024-11-05  3:25   ` kernel test robot
2024-11-06 10:29     ` Lee Jones
2024-11-08 12:40       ` Marek Behún
2024-11-06 10:37   ` Lee Jones
2024-11-04 14:19 ` [PATCH leds v5 08/12] platform: cznic: turris-omnia-mcu: Inform about missing LED panel brightness change interrupt feature Marek Behún
2024-11-04 14:19 ` [PATCH leds v5 09/12] leds: turris-omnia: Inform about missing LED gamma correction feature in the MCU driver Marek Behún
2024-11-04 14:19 ` [PATCH leds v5 10/12] leds: turris-omnia: Use dev_err_probe() where appropriate Marek Behún
2024-11-04 14:19 ` [PATCH leds v5 11/12] leds: turris-omnia: Use uppercase first letter in all comments Marek Behún
2024-11-04 14:19 ` [PATCH leds v5 12/12] ARM: dts: turris-omnia: Add global LED brightness change interrupt Marek Behún
2024-11-04 16:02   ` Gregory CLEMENT
2024-12-04  6:48     ` Klaus Kudielka
2024-12-05 12:38       ` Marek Behún
2024-12-05 12:42         ` Marek Behún
2024-12-06  9:04           ` Klaus Kudielka
2024-12-06 13:15             ` Marek Behún
2024-12-15 11:39           ` Klaus Kudielka
2024-12-15 21:26             ` Marek Behún
2024-12-16 17:46               ` Klaus Kudielka

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=20241104141924.18816-7-kabel@kernel.org \
    --to=kabel@kernel.org \
    --cc=andrew@lunn.ch \
    --cc=andy@kernel.org \
    --cc=arm@kernel.org \
    --cc=arnd@arndb.de \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=gregory.clement@bootlin.com \
    --cc=hdegoede@redhat.com \
    --cc=ilpo.jarvinen@linux.intel.com \
    --cc=krzk+dt@kernel.org \
    --cc=lee@kernel.org \
    --cc=linux-leds@vger.kernel.org \
    --cc=pavel@ucw.cz \
    --cc=robh+dt@kernel.org \
    --cc=sebastian.hesselbarth@gmail.com \
    --cc=soc@kernel.org \
    /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.