diff options
author | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2008-11-08 00:57:33 +0100 |
---|---|---|
committer | Samuel Ortiz <samuel@sortiz.org> | 2009-01-04 12:17:37 +0100 |
commit | 858e674466427b1236eb5ef9568999a7df286b1e (patch) | |
tree | 24ca231b73d6919b3b70f0f6a9b39b650d71e1fb /drivers/mfd/wm8350-core.c | |
parent | 2c5212279a89224512e421fa9f8bd0fabbab77d8 (diff) | |
download | linux-858e674466427b1236eb5ef9568999a7df286b1e.tar.bz2 |
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: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Samuel Ortiz <sameo@openedhand.com>
Diffstat (limited to 'drivers/mfd/wm8350-core.c')
-rw-r--r-- | drivers/mfd/wm8350-core.c | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/drivers/mfd/wm8350-core.c b/drivers/mfd/wm8350-core.c index 0d47fb9e4b3b..d63a530c4fe8 100644 --- a/drivers/mfd/wm8350-core.c +++ b/drivers/mfd/wm8350-core.c @@ -299,6 +299,13 @@ int wm8350_block_write(struct wm8350 *wm8350, int start_reg, int regs, } 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) { u16 key = WM8350_LOCK_KEY; @@ -314,6 +321,15 @@ int wm8350_reg_lock(struct wm8350 *wm8350) } 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) { u16 key = WM8350_UNLOCK_KEY; |