| Message ID | 20211011155615.257529-3-luca@lucaceresoli.net (mailing list archive) |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | Add MAX77714 PMIC minimal driver (RTC and watchdog only) | expand |
On 11/10/2021 17:56, 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> > --- > 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 > }; > Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com> Best regards, Krzysztof
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 >
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; };
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(-)