mfd: wm8350-core: Supply description wm8350_reg_{un}lock args

Kerneldoc syntax is used, but not complete.  Descriptions required.

Prevents warnings like:

 drivers/mfd/wm8350-core.c:136: warning: Function parameter or member 'wm8350' not described in 'wm8350_reg_lock'
 drivers/mfd/wm8350-core.c:165: warning: Function parameter or member 'wm8350' not described in 'wm8350_reg_unlock'

Cc: patches@opensource.cirrus.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
This commit is contained in:
Lee Jones 2020-06-23 15:44:48 +01:00
parent 38ea9f4731
commit afb718a870

View File

@ -131,6 +131,8 @@ EXPORT_SYMBOL_GPL(wm8350_block_write);
* The WM8350 has a hardware lock which can be used to prevent writes to * The WM8350 has a hardware lock which can be used to prevent writes to
* some registers (generally those which can cause particularly serious * some registers (generally those which can cause particularly serious
* problems if misused). This function enables that lock. * problems if misused). This function enables that lock.
*
* @wm8350: pointer to local driver data structure
*/ */
int wm8350_reg_lock(struct wm8350 *wm8350) int wm8350_reg_lock(struct wm8350 *wm8350)
{ {
@ -160,6 +162,8 @@ EXPORT_SYMBOL_GPL(wm8350_reg_lock);
* problems if misused). This function disables that lock so updates * problems if misused). This function disables that lock so updates
* can be performed. For maximum safety this should be done only when * can be performed. For maximum safety this should be done only when
* required. * required.
*
* @wm8350: pointer to local driver data structure
*/ */
int wm8350_reg_unlock(struct wm8350 *wm8350) int wm8350_reg_unlock(struct wm8350 *wm8350)
{ {