From: Luca Ceresoli <luca@lucaceresoli.net>
To: linux-kernel@vger.kernel.org
Cc: Luca Ceresoli <luca@lucaceresoli.net>,
Lee Jones <lee.jones@linaro.org>,
Rob Herring <robh+dt@kernel.org>,
Alessandro Zummo <a.zummo@towertech.it>,
Alexandre Belloni <alexandre.belloni@bootlin.com>,
Chanwoo Choi <cw00.choi@samsung.com>,
Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>,
Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
Wim Van Sebroeck <wim@linux-watchdog.org>,
Guenter Roeck <linux@roeck-us.net>,
devicetree@vger.kernel.org, linux-rtc@vger.kernel.org,
linux-watchdog@vger.kernel.org,
Chiwoong Byun <woong.byun@samsung.com>,
Laxman Dewangan <ldewangan@nvidia.com>
Subject: [PATCH 2/8] rtc: max77686: convert comments to kernel-doc format
Date: Mon, 11 Oct 2021 17:56:09 +0200 [thread overview]
Message-ID: <20211011155615.257529-3-luca@lucaceresoli.net> (raw)
In-Reply-To: <20211011155615.257529-1-luca@lucaceresoli.net>
Convert the comments documenting this struct to kernel-doc format for
standardization and readability.
Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
---
drivers/rtc/rtc-max77686.c | 21 ++++++++++++---------
1 file changed, 12 insertions(+), 9 deletions(-)
diff --git a/drivers/rtc/rtc-max77686.c b/drivers/rtc/rtc-max77686.c
index eae7cb9faf1e..bac52cdea97d 100644
--- a/drivers/rtc/rtc-max77686.c
+++ b/drivers/rtc/rtc-max77686.c
@@ -61,24 +61,27 @@ enum {
RTC_NR_TIME
};
+/**
+ * struct max77686_rtc_driver_data - model-specific configuration
+ * @delay: Minimum usecs needed for a RTC update
+ * @mask: Mask used to read RTC registers value
+ * @map: Registers offset to I2C addresses map
+ * @alarm_enable_reg: Has a separate alarm enable register?
+ * @rtc_i2c_addr: I2C address for RTC block
+ * @rtc_irq_from_platform: RTC interrupt via platform resource
+ * @alarm_pending_status_reg: Pending alarm status register
+ * @rtc_irq_chip: RTC IRQ CHIP for regmap
+ * @regmap_config: regmap configuration for the chip
+ */
struct max77686_rtc_driver_data {
- /* Minimum usecs needed for a RTC update */
unsigned long delay;
- /* Mask used to read RTC registers value */
u8 mask;
- /* Registers offset to I2C addresses map */
const unsigned int *map;
- /* Has a separate alarm enable register? */
bool alarm_enable_reg;
- /* I2C address for RTC block */
int rtc_i2c_addr;
- /* RTC interrupt via platform resource */
bool rtc_irq_from_platform;
- /* Pending alarm status register */
int alarm_pending_status_reg;
- /* RTC IRQ CHIP for regmap */
const struct regmap_irq_chip *rtc_irq_chip;
- /* regmap configuration for the chip */
const struct regmap_config *regmap_config;
};
--
2.25.1
next prev parent reply other threads:[~2021-10-11 15:56 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-11 15:56 [PATCH 0/8] Add MAX77714 PMIC minimal driver (RTC and watchdog only) Luca Ceresoli
2021-10-11 15:56 ` [PATCH 1/8] mfd: max77686: Correct tab-based alignment of register addresses Luca Ceresoli
2021-10-12 8:00 ` Krzysztof Kozlowski
2021-10-11 15:56 ` Luca Ceresoli [this message]
2021-10-12 8:00 ` [PATCH 2/8] rtc: max77686: convert comments to kernel-doc format Krzysztof Kozlowski
2021-10-15 17:29 ` Alexandre Belloni
2021-10-11 15:56 ` [PATCH 3/8] rtc: max77686: rename day-of-month defines Luca Ceresoli
2021-10-12 2:23 ` kernel test robot
2021-10-12 2:58 ` kernel test robot
2021-10-12 8:13 ` Krzysztof Kozlowski
2021-10-11 15:56 ` [PATCH 4/8] rtc: max77686: remove useless variable Luca Ceresoli
2021-10-12 8:01 ` Krzysztof Kozlowski
2021-10-15 17:33 ` Alexandre Belloni
2021-10-15 20:59 ` Luca Ceresoli
2021-10-11 15:56 ` [PATCH 5/8] dt-bindings: mfd: add Maxim MAX77714 PMIC Luca Ceresoli
2021-10-12 8:02 ` Krzysztof Kozlowski
2021-10-13 21:28 ` Luca Ceresoli
2021-10-14 7:38 ` Krzysztof Kozlowski
2021-10-11 15:56 ` [PATCH 6/8] mfd: max77714: Add driver for " Luca Ceresoli
2021-10-11 17:15 ` Guenter Roeck
2021-10-12 7:11 ` kernel test robot
2021-10-12 8:09 ` Krzysztof Kozlowski
2021-10-13 21:49 ` Luca Ceresoli
2021-10-14 7:44 ` Krzysztof Kozlowski
2021-10-12 8:32 ` Krzysztof Kozlowski
2021-10-13 21:39 ` Luca Ceresoli
2021-10-14 7:40 ` Krzysztof Kozlowski
2021-10-14 8:25 ` Luca Ceresoli
2021-10-11 15:56 ` [PATCH 7/8] watchdog: max77714: add driver for the watchdog in the " Luca Ceresoli
2021-10-11 17:17 ` Guenter Roeck
2021-10-15 16:43 ` Luca Ceresoli
2021-10-12 1:18 ` Randy Dunlap
2021-10-15 16:42 ` Luca Ceresoli
2021-10-15 17:07 ` Randy Dunlap
2021-10-11 20:25 ` [PATCH 8/8] rtc: max77686: add MAX77714 support Luca Ceresoli
2021-10-11 16:12 ` Luca Ceresoli
2021-10-12 8:20 ` Krzysztof Kozlowski
2021-10-15 16:46 ` Luca Ceresoli
2021-10-12 8:29 ` Krzysztof Kozlowski
2021-10-15 17:36 ` Alexandre Belloni
2021-10-12 7:59 ` [PATCH 0/8] Add MAX77714 PMIC minimal driver (RTC and watchdog only) Krzysztof Kozlowski
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=20211011155615.257529-3-luca@lucaceresoli.net \
--to=luca@lucaceresoli.net \
--cc=a.zummo@towertech.it \
--cc=alexandre.belloni@bootlin.com \
--cc=b.zolnierkie@samsung.com \
--cc=cw00.choi@samsung.com \
--cc=devicetree@vger.kernel.org \
--cc=krzysztof.kozlowski@canonical.com \
--cc=ldewangan@nvidia.com \
--cc=lee.jones@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rtc@vger.kernel.org \
--cc=linux-watchdog@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=robh+dt@kernel.org \
--cc=wim@linux-watchdog.org \
--cc=woong.byun@samsung.com \
/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).