lkml.org 
[lkml]   [2021]   [Oct]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 2/8] rtc: max77686: convert comments to kernel-doc format
On 11/10/2021 17:56:09+0200, Luca Ceresoli wrote:
> Convert the comments documenting this struct to kernel-doc format for
> standardization and readability.
>
> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com>

> ---
> 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
>

--
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

\
 
 \ /
  Last update: 2021-10-15 19:32    [W:0.269 / U:0.240 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site