Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 51f1f1cb authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Lee Jones
Browse files

mfd: sec-core: Update sec_pmic documentation



Update the documentation for sec_pmic state container structure to
reflect current code.

Signed-off-by: default avatarKrzysztof Kozlowski <k.kozlowski@samsung.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
parent e349c910
Loading
Loading
Loading
Loading
+17 −12
Original line number Diff line number Diff line
@@ -24,18 +24,23 @@ enum sec_device_type {
};

/**
 * struct sec_pmic_dev - s5m87xx master device for sub-drivers
 * @dev: master device of the chip (can be used to access platform data)
 * @pdata: pointer to private data used to pass platform data to child
 * @i2c: i2c client private data for regulator
 * @iolock: mutex for serializing io access
 * @irqlock: mutex for buslock
 * @irq_base: base IRQ number for sec-pmic, required for IRQs
 * @irq: generic IRQ number for s5m87xx
 * @ono: power onoff IRQ number for s5m87xx
 * @irq_masks_cur: currently active value
 * @irq_masks_cache: cached hardware value
 * @type: indicate which s5m87xx "variant" is used
 * struct sec_pmic_dev - s2m/s5m master device for sub-drivers
 * @dev:		Master device of the chip
 * @pdata:		Platform data populated with data from DTS
 *			or board files
 * @regmap_pmic:	Regmap associated with PMIC's I2C address
 * @i2c:		I2C client of the main driver
 * @device_type:	Type of device, matches enum sec_device_type
 * @irq_base:		Base IRQ number for device, required for IRQs
 * @irq:		Generic IRQ number for device
 * @irq_data:		Runtime data structure for IRQ controller
 * @ono:		Power onoff IRQ number for s5m87xx
 * @wakeup:		Whether or not this is a wakeup device
 * @wtsr_smpl:		Whether or not to enable in RTC driver the Watchdog
 *			Timer Software Reset (registers set to default value
 *			after PWRHOLD falling) and Sudden Momentary Power Loss
 *			(PMIC will enter power on sequence after short drop in
 *			VBATT voltage).
 */
struct sec_pmic_dev {
	struct device *dev;