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

Commit 858e6744 authored by Mark Brown's avatar Mark Brown Committed by Samuel Ortiz
Browse files

mfd: Add some documentation for WM8350 register lock



Hopefully this will make the purpose of these functions a bit clearer,
it's not immediately obvious that the lock is a hardware feature.

Signed-off-by: default avatarMark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: default avatarSamuel Ortiz <sameo@openedhand.com>
parent 2c521227
Loading
Loading
Loading
Loading
+16 −0
Original line number Original line Diff line number Diff line
@@ -299,6 +299,13 @@ int wm8350_block_write(struct wm8350 *wm8350, int start_reg, int regs,
}
}
EXPORT_SYMBOL_GPL(wm8350_block_write);
EXPORT_SYMBOL_GPL(wm8350_block_write);


/**
 * wm8350_reg_lock()
 *
 * The WM8350 has a hardware lock which can be used to prevent writes to
 * some registers (generally those which can cause particularly serious
 * problems if misused).  This function enables that lock.
 */
int wm8350_reg_lock(struct wm8350 *wm8350)
int wm8350_reg_lock(struct wm8350 *wm8350)
{
{
	u16 key = WM8350_LOCK_KEY;
	u16 key = WM8350_LOCK_KEY;
@@ -314,6 +321,15 @@ int wm8350_reg_lock(struct wm8350 *wm8350)
}
}
EXPORT_SYMBOL_GPL(wm8350_reg_lock);
EXPORT_SYMBOL_GPL(wm8350_reg_lock);


/**
 * wm8350_reg_unlock()
 *
 * The WM8350 has a hardware lock which can be used to prevent writes to
 * some registers (generally those which can cause particularly serious
 * problems if misused).  This function disables that lock so updates
 * can be performed.  For maximum safety this should be done only when
 * required.
 */
int wm8350_reg_unlock(struct wm8350 *wm8350)
int wm8350_reg_unlock(struct wm8350 *wm8350)
{
{
	u16 key = WM8350_UNLOCK_KEY;
	u16 key = WM8350_UNLOCK_KEY;