tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
intel_pmc_ipc: Update kerneldoc formatting
Update kerneldoc formatting per Documentation/kernel-dec-nano-HOWTO.txt.
Signed-off-by: qipeng.zha <qipeng.zha@intel.com>
Signed-off-by: Darren Hart <dvhart@linux.intel.com>
authored by
qipeng.zha
and committed by
Darren Hart
02941007
22565ba0
+35
-49
-27
arch/x86/include/asm/intel_pmc_ipc.h
-27
arch/x86/include/asm/intel_pmc_ipc.h
···
25
25
26
26
#if IS_ENABLED(CONFIG_INTEL_PMC_IPC)
27
27
28
-
/*
29
-
* intel_pmc_ipc_simple_command
30
-
* @cmd: command
31
-
* @sub: sub type
32
-
*/
33
28
int intel_pmc_ipc_simple_command(int cmd, int sub);
34
-
35
-
/*
36
-
* intel_pmc_ipc_raw_cmd
37
-
* @cmd: command
38
-
* @sub: sub type
39
-
* @in: input data
40
-
* @inlen: input length in bytes
41
-
* @out: output data
42
-
* @outlen: output length in dwords
43
-
* @sptr: data writing to SPTR register
44
-
* @dptr: data writing to DPTR register
45
-
*/
46
29
int intel_pmc_ipc_raw_cmd(u32 cmd, u32 sub, u8 *in, u32 inlen,
47
30
u32 *out, u32 outlen, u32 dptr, u32 sptr);
48
-
49
-
/*
50
-
* intel_pmc_ipc_command
51
-
* @cmd: command
52
-
* @sub: sub type
53
-
* @in: input data
54
-
* @inlen: input length in bytes
55
-
* @out: output data
56
-
* @outlen: output length in dwords
57
-
*/
58
31
int intel_pmc_ipc_command(u32 cmd, u32 sub, u8 *in, u32 inlen,
59
32
u32 *out, u32 outlen);
60
33
+35
-22
drivers/platform/x86/intel_pmc_ipc.c
+35
-22
drivers/platform/x86/intel_pmc_ipc.c
···
210
210
return ret;
211
211
}
212
212
213
-
/*
214
-
* intel_pmc_ipc_simple_command
215
-
* @cmd: command
216
-
* @sub: sub type
213
+
/**
214
+
* intel_pmc_ipc_simple_command() - Simple IPC command
215
+
* @cmd: IPC command code.
216
+
* @sub: IPC command sub type.
217
+
*
218
+
* Send a simple IPC command to PMC when don't need to specify
219
+
* input/output data and source/dest pointers.
220
+
*
221
+
* Return: an IPC error code or 0 on success.
217
222
*/
218
223
int intel_pmc_ipc_simple_command(int cmd, int sub)
219
224
{
···
237
232
}
238
233
EXPORT_SYMBOL_GPL(intel_pmc_ipc_simple_command);
239
234
240
-
/*
241
-
* intel_pmc_ipc_raw_cmd
242
-
* @cmd: command
243
-
* @sub: sub type
244
-
* @in: input data
245
-
* @inlen: input length in bytes
246
-
* @out: output data
247
-
* @outlen: output length in dwords
248
-
* @sptr: data writing to SPTR register
249
-
* @dptr: data writing to DPTR register
235
+
/**
236
+
* intel_pmc_ipc_raw_cmd() - IPC command with data and pointers
237
+
* @cmd: IPC command code.
238
+
* @sub: IPC command sub type.
239
+
* @in: input data of this IPC command.
240
+
* @inlen: input data length in bytes.
241
+
* @out: output data of this IPC command.
242
+
* @outlen: output data length in dwords.
243
+
* @sptr: data writing to SPTR register.
244
+
* @dptr: data writing to DPTR register.
245
+
*
246
+
* Send an IPC command to PMC with input/output data and source/dest pointers.
247
+
*
248
+
* Return: an IPC error code or 0 on success.
250
249
*/
251
250
int intel_pmc_ipc_raw_cmd(u32 cmd, u32 sub, u8 *in, u32 inlen, u32 *out,
252
251
u32 outlen, u32 dptr, u32 sptr)
···
287
278
}
288
279
EXPORT_SYMBOL_GPL(intel_pmc_ipc_raw_cmd);
289
280
290
-
/*
291
-
* intel_pmc_ipc_command
292
-
* @cmd: command
293
-
* @sub: sub type
294
-
* @in: input data
295
-
* @inlen: input length in bytes
296
-
* @out: output data
297
-
* @outlen: output length in dwords
281
+
/**
282
+
* intel_pmc_ipc_command() - IPC command with input/output data
283
+
* @cmd: IPC command code.
284
+
* @sub: IPC command sub type.
285
+
* @in: input data of this IPC command.
286
+
* @inlen: input data length in bytes.
287
+
* @out: output data of this IPC command.
288
+
* @outlen: output data length in dwords.
289
+
*
290
+
* Send an IPC command to PMC with input/output data.
291
+
*
292
+
* Return: an IPC error code or 0 on success.
298
293
*/
299
294
int intel_pmc_ipc_command(u32 cmd, u32 sub, u8 *in, u32 inlen,
300
295
u32 *out, u32 outlen)