Commit 8b236565 authored by Mika Westerberg's avatar Mika Westerberg Committed by Andy Shevchenko
Browse files

platform/x86: intel_scu_ipc: Reformat kernel-doc comments of exported functions 



Format kernel-doc comments of the exported functions to follow the
typical format that does not have tab indentation. Also capitalize
parameter descriptions and add a missing period.

No functional changes intended.

Signed-off-by: default avatarMika Westerberg <mika.westerberg@linux.intel.com>
Reviewed-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
parent 49078988

drivers/platform/x86/intel_scu_ipc.c

+55 −57
Original line number Diff line number Diff line
@@ -223,10 +223,10 @@ static int pwr_reg_rdwr(u16 *addr, u8 *data, u32 count, u32 op, u32 id) 


/**

 * intel_scu_ipc_ioread8		-	read a word via the SCU

 *	@addr: register on SCU

 *	@data: return pointer for read byte

 * @addr: Register on SCU

 * @data: Return pointer for read byte

 *

 *	Read a single register. Returns 0 on success or an error code. All

 * Read a single register. Returns %0 on success or an error code. All

 * locking between SCU accesses is handled for the caller.

 *

 * This function may sleep.
@@ -239,10 +239,10 @@ EXPORT_SYMBOL(intel_scu_ipc_ioread8); 


/**

 * intel_scu_ipc_iowrite8		-	write a byte via the SCU

 *	@addr: register on SCU

 *	@data: byte to write

 * @addr: Register on SCU

 * @data: Byte to write

 *

 *	Write a single register. Returns 0 on success or an error code. All

 * Write a single register. Returns %0 on success or an error code. All

 * locking between SCU accesses is handled for the caller.

 *

 * This function may sleep.
@@ -255,12 +255,12 @@ EXPORT_SYMBOL(intel_scu_ipc_iowrite8); 


/**

 * intel_scu_ipc_readvv		-	read a set of registers

 *	@addr: register list

 *	@data: bytes to return

 *	@len: length of array

 * @addr: Register list

 * @data: Bytes to return

 * @len: Length of array

 *

 *	Read registers. Returns 0 on success or an error code. All

 *	locking between SCU accesses is handled for the caller.

 * Read registers. Returns %0 on success or an error code. All locking

 * between SCU accesses is handled for the caller.

 *

 * The largest array length permitted by the hardware is 5 items.

 *
@@ -274,17 +274,16 @@ EXPORT_SYMBOL(intel_scu_ipc_readv); 


/**

 * intel_scu_ipc_writev		-	write a set of registers

 *	@addr: register list

 *	@data: bytes to write

 *	@len: length of array

 * @addr: Register list

 * @data: Bytes to write

 * @len: Length of array

 *

 *	Write registers. Returns 0 on success or an error code. All

 *	locking between SCU accesses is handled for the caller.

 * Write registers. Returns %0 on success or an error code. All locking

 * between SCU accesses is handled for the caller.

 *

 * The largest array length permitted by the hardware is 5 items.

 *

 * This function may sleep.

 *

 */

int intel_scu_ipc_writev(u16 *addr, u8 *data, int len)

{
@@ -294,15 +293,14 @@ EXPORT_SYMBOL(intel_scu_ipc_writev); 


/**

 * intel_scu_ipc_update_register	-	r/m/w a register

 *	@addr: register address

 *	@bits: bits to update

 *	@mask: mask of bits to update

 * @addr: Register address

 * @bits: Bits to update

 * @mask: Mask of bits to update

 *

 * Read-modify-write power control unit register. The first data argument

 *	must be register value and second is mask value

 *	mask is a bitmap that indicates which bits to update.

 *	0 = masked. Don't modify this bit, 1 = modify this bit.

 *	returns 0 on success or an error code.

 * must be register value and second is mask value mask is a bitmap that

 * indicates which bits to update. %0 = masked. Don't modify this bit, %1 =

 * modify this bit. returns %0 on success or an error code.

 *

 * This function may sleep. Locking between SCU accesses is handled

 * for the caller.
@@ -316,15 +314,15 @@ EXPORT_SYMBOL(intel_scu_ipc_update_register); 


/**

 * intel_scu_ipc_simple_command	-	send a simple command

 *	@cmd: command

 *	@sub: sub type

 * @cmd: Command

 * @sub: Sub type

 *

 *	Issue a simple command to the SCU. Do not use this interface if

 *	you must then access data as any data values may be overwritten

 *	by another SCU access by the time this function returns.

 * Issue a simple command to the SCU. Do not use this interface if you must

 * then access data as any data values may be overwritten by another SCU

 * access by the time this function returns.

 *

 *	This function may sleep. Locking for SCU accesses is handled for

 *	the caller.

 * This function may sleep. Locking for SCU accesses is handled for the

 * caller.

 */

int intel_scu_ipc_simple_command(int cmd, int sub)

{
@@ -345,15 +343,15 @@ EXPORT_SYMBOL(intel_scu_ipc_simple_command); 


/**

 * intel_scu_ipc_command	-	command with data

 *	@cmd: command

 *	@sub: sub type

 *	@in: input data

 *	@inlen: input length in dwords

 *	@out: output data

 *	@outlein: output length in dwords

 * @cmd: Command

 * @sub: Sub type

 * @in: Input data

 * @inlen: Input length in dwords

 * @out: Output data

 * @outlen: Output length in dwords

 *

 * Issue a command to the SCU which involves data transfers. Do the

 *	data copies under the lock but leave it for the caller to interpret

 * data copies under the lock but leave it for the caller to interpret.

 */

int intel_scu_ipc_command(int cmd, int sub, u32 *in, int inlen,

			  u32 *out, int outlen)

CRA Git | Maintained and supported by SUSTech CRA and CCSE