Commit 72c356c2 authored by Luca Ceresoli's avatar Luca Ceresoli Committed by Lee Jones
Browse files

rtc: max77686: Convert comments to kernel-doc format 



Convert the comments documenting this struct to kernel-doc format for
standardization and readability.

Signed-off-by: default avatarLuca Ceresoli <luca@lucaceresoli.net>
Reviewed-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Acked-by: default avatarAlexandre Belloni <alexandre.belloni@bootlin.com>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
parent e783362e

drivers/rtc/rtc-max77686.c

+12 −9
Original line number Diff line number Diff line
@@ -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;

};