x86: cpu: add docstring to scu_ipc_command()
authorGeorgii Staroselskii <georgii.staroselskii@emlid.com>
Tue, 11 Sep 2018 10:31:10 +0000 (13:31 +0300)
committerBin Meng <bmeng.cn@gmail.com>
Mon, 17 Sep 2018 09:35:53 +0000 (17:35 +0800)
These comments were copied from the Linux kernel driver in
drivers/platform/x86/intel_scu_ipc.c

Signed-off-by: Georgii Staroselskii <georgii.staroselskii@emlid.com>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
arch/x86/lib/scu.c

index af241efe83d9cfd1d69611b0ee0ac2312b36f8c7..a6f8297e72ed9bbee9b7da6eae073e97da404f9a 100644 (file)
@@ -180,6 +180,17 @@ int scu_ipc_simple_command(u32 cmd, u32 sub)
        return scu_ipc_check_status(scu->regs);
 }
 
+/**
+ *  scu_ipc_command - command with data
+ *  @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.
+ */
 int scu_ipc_command(u32 cmd, u32 sub, u32 *in, int inlen, u32 *out, int outlen)
 {
        struct scu *scu;