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

Commit 02941007 authored by qipeng.zha's avatar qipeng.zha Committed by Darren Hart
Browse files

intel_pmc_ipc: Update kerneldoc formatting



Update kerneldoc formatting per Documentation/kernel-dec-nano-HOWTO.txt.

Signed-off-by: default avatarqipeng.zha <qipeng.zha@intel.com>
Signed-off-by: default avatarDarren Hart <dvhart@linux.intel.com>
parent 22565ba0
Loading
Loading
Loading
Loading
+0 −27
Original line number Original line Diff line number Diff line
@@ -25,36 +25,9 @@


#if IS_ENABLED(CONFIG_INTEL_PMC_IPC)
#if IS_ENABLED(CONFIG_INTEL_PMC_IPC)


/*
 * intel_pmc_ipc_simple_command
 * @cmd: command
 * @sub: sub type
 */
int intel_pmc_ipc_simple_command(int cmd, int sub);
int intel_pmc_ipc_simple_command(int cmd, int sub);

/*
 * intel_pmc_ipc_raw_cmd
 * @cmd: command
 * @sub: sub type
 * @in: input data
 * @inlen: input length in bytes
 * @out: output data
 * @outlen: output length in dwords
 * @sptr: data writing to SPTR register
 * @dptr: data writing to DPTR register
 */
int intel_pmc_ipc_raw_cmd(u32 cmd, u32 sub, u8 *in, u32 inlen,
int intel_pmc_ipc_raw_cmd(u32 cmd, u32 sub, u8 *in, u32 inlen,
		u32 *out, u32 outlen, u32 dptr, u32 sptr);
		u32 *out, u32 outlen, u32 dptr, u32 sptr);

/*
 * intel_pmc_ipc_command
 * @cmd: command
 * @sub: sub type
 * @in: input data
 * @inlen: input length in bytes
 * @out: output data
 * @outlen: output length in dwords
 */
int intel_pmc_ipc_command(u32 cmd, u32 sub, u8 *in, u32 inlen,
int intel_pmc_ipc_command(u32 cmd, u32 sub, u8 *in, u32 inlen,
		u32 *out, u32 outlen);
		u32 *out, u32 outlen);


+35 −22
Original line number Original line Diff line number Diff line
@@ -210,10 +210,15 @@ static int intel_pmc_ipc_check_status(void)
	return ret;
	return ret;
}
}


/*
/**
 * intel_pmc_ipc_simple_command
 * intel_pmc_ipc_simple_command() - Simple IPC command
 * @cmd: command
 * @cmd:	IPC command code.
 * @sub: sub type
 * @sub:	IPC command sub type.
 *
 * Send a simple IPC command to PMC when don't need to specify
 * input/output data and source/dest pointers.
 *
 * Return:	an IPC error code or 0 on success.
 */
 */
int intel_pmc_ipc_simple_command(int cmd, int sub)
int intel_pmc_ipc_simple_command(int cmd, int sub)
{
{
@@ -232,16 +237,20 @@ int intel_pmc_ipc_simple_command(int cmd, int sub)
}
}
EXPORT_SYMBOL_GPL(intel_pmc_ipc_simple_command);
EXPORT_SYMBOL_GPL(intel_pmc_ipc_simple_command);


/*
/**
 * intel_pmc_ipc_raw_cmd
 * intel_pmc_ipc_raw_cmd() - IPC command with data and pointers
 * @cmd: command
 * @cmd:	IPC command code.
 * @sub: sub type
 * @sub:	IPC command sub type.
 * @in: input data
 * @in:		input data of this IPC command.
 * @inlen: input length in bytes
 * @inlen:	input data length in bytes.
 * @out: output data
 * @out:	output data of this IPC command.
 * @outlen: output length in dwords
 * @outlen:	output data length in dwords.
 * @sptr: data writing to SPTR register
 * @sptr:	data writing to SPTR register.
 * @dptr: data writing to DPTR register
 * @dptr:	data writing to DPTR register.
 *
 * Send an IPC command to PMC with input/output data and source/dest pointers.
 *
 * Return:	an IPC error code or 0 on success.
 */
 */
int intel_pmc_ipc_raw_cmd(u32 cmd, u32 sub, u8 *in, u32 inlen, u32 *out,
int intel_pmc_ipc_raw_cmd(u32 cmd, u32 sub, u8 *in, u32 inlen, u32 *out,
			  u32 outlen, u32 dptr, u32 sptr)
			  u32 outlen, u32 dptr, u32 sptr)
@@ -278,14 +287,18 @@ int intel_pmc_ipc_raw_cmd(u32 cmd, u32 sub, u8 *in, u32 inlen, u32 *out,
}
}
EXPORT_SYMBOL_GPL(intel_pmc_ipc_raw_cmd);
EXPORT_SYMBOL_GPL(intel_pmc_ipc_raw_cmd);


/*
/**
 * intel_pmc_ipc_command
 * intel_pmc_ipc_command() -  IPC command with input/output data
 * @cmd: command
 * @cmd:	IPC command code.
 * @sub: sub type
 * @sub:	IPC command sub type.
 * @in: input data
 * @in:		input data of this IPC command.
 * @inlen: input length in bytes
 * @inlen:	input data length in bytes.
 * @out: output data
 * @out:	output data of this IPC command.
 * @outlen: output length in dwords
 * @outlen:	output data length in dwords.
 *
 * Send an IPC command to PMC with input/output data.
 *
 * Return:	an IPC error code or 0 on success.
 */
 */
int intel_pmc_ipc_command(u32 cmd, u32 sub, u8 *in, u32 inlen,
int intel_pmc_ipc_command(u32 cmd, u32 sub, u8 *in, u32 inlen,
			  u32 *out, u32 outlen)
			  u32 *out, u32 outlen)