| Message ID | 20200108114201.27908-14-mika.westerberg@linux.intel.com (mailing list archive) |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | platform/x86: Rework intel_scu_ipc and intel_pmc_ipc drivers | expand |
On Wed, Jan 08, 2020 at 02:41:38PM +0300, Mika Westerberg wrote: > 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. > Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> > Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com> > --- > drivers/platform/x86/intel_scu_ipc.c | 112 +++++++++++++-------------- > 1 file changed, 55 insertions(+), 57 deletions(-) > > diff --git a/drivers/platform/x86/intel_scu_ipc.c b/drivers/platform/x86/intel_scu_ipc.c > index e3f658f1b40a..b1ac381bb7dd 100644 > --- a/drivers/platform/x86/intel_scu_ipc.c > +++ b/drivers/platform/x86/intel_scu_ipc.c > @@ -219,14 +219,14 @@ 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 > + * intel_scu_ipc_ioread8 - read a word via the SCU > + * @addr: Register on SCU > + * @data: Return pointer for read byte > * > - * Read a single register. Returns 0 on success or an error code. All > - * locking between SCU accesses is handled for the caller. > + * 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. > + * This function may sleep. > */ > int intel_scu_ipc_ioread8(u16 addr, u8 *data) > { > @@ -235,14 +235,14 @@ int intel_scu_ipc_ioread8(u16 addr, u8 *data) > EXPORT_SYMBOL(intel_scu_ipc_ioread8); > > /** > - * intel_scu_ipc_iowrite8 - write a byte via the SCU > - * @addr: register on SCU > - * @data: byte to write > + * intel_scu_ipc_iowrite8 - write a byte via the SCU > + * @addr: Register on SCU > + * @data: Byte to write > * > - * Write a single register. Returns 0 on success or an error code. All > - * locking between SCU accesses is handled for the caller. > + * 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. > + * This function may sleep. > */ > int intel_scu_ipc_iowrite8(u16 addr, u8 data) > { > @@ -251,17 +251,17 @@ int intel_scu_ipc_iowrite8(u16 addr, u8 data) > 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 > + * intel_scu_ipc_readvv - read a set of registers > + * @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. > + * The largest array length permitted by the hardware is 5 items. > * > - * This function may sleep. > + * This function may sleep. > */ > int intel_scu_ipc_readv(u16 *addr, u8 *data, int len) > { > @@ -270,18 +270,17 @@ int intel_scu_ipc_readv(u16 *addr, u8 *data, int len) > 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 > + * intel_scu_ipc_writev - write a set of registers > + * @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. > + * 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) > { > @@ -290,19 +289,18 @@ int intel_scu_ipc_writev(u16 *addr, u8 *data, int len) > 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 > + * intel_scu_ipc_update_register - r/m/w a register > + * @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. > + * 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. > * > - * This function may sleep. Locking between SCU accesses is handled > - * for the caller. > + * This function may sleep. Locking between SCU accesses is handled > + * for the caller. > */ > int intel_scu_ipc_update_register(u16 addr, u8 bits, u8 mask) > { > @@ -312,16 +310,16 @@ int intel_scu_ipc_update_register(u16 addr, u8 bits, u8 mask) > EXPORT_SYMBOL(intel_scu_ipc_update_register); > > /** > - * intel_scu_ipc_simple_command - send a simple command > - * @cmd: command > - * @sub: sub type > + * intel_scu_ipc_simple_command - send a simple command > + * @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) > { > @@ -341,16 +339,16 @@ int intel_scu_ipc_simple_command(int cmd, int sub) > 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 > + * intel_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. Do the > - * data copies under the lock but leave it for the caller to interpret > + * 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. > */ > int intel_scu_ipc_command(int cmd, int sub, u32 *in, int inlen, > u32 *out, int outlen) > -- > 2.24.1 >
diff --git a/drivers/platform/x86/intel_scu_ipc.c b/drivers/platform/x86/intel_scu_ipc.c index e3f658f1b40a..b1ac381bb7dd 100644 --- a/drivers/platform/x86/intel_scu_ipc.c +++ b/drivers/platform/x86/intel_scu_ipc.c @@ -219,14 +219,14 @@ 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 + * intel_scu_ipc_ioread8 - read a word via the SCU + * @addr: Register on SCU + * @data: Return pointer for read byte * - * Read a single register. Returns 0 on success or an error code. All - * locking between SCU accesses is handled for the caller. + * 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. + * This function may sleep. */ int intel_scu_ipc_ioread8(u16 addr, u8 *data) { @@ -235,14 +235,14 @@ int intel_scu_ipc_ioread8(u16 addr, u8 *data) EXPORT_SYMBOL(intel_scu_ipc_ioread8); /** - * intel_scu_ipc_iowrite8 - write a byte via the SCU - * @addr: register on SCU - * @data: byte to write + * intel_scu_ipc_iowrite8 - write a byte via the SCU + * @addr: Register on SCU + * @data: Byte to write * - * Write a single register. Returns 0 on success or an error code. All - * locking between SCU accesses is handled for the caller. + * 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. + * This function may sleep. */ int intel_scu_ipc_iowrite8(u16 addr, u8 data) { @@ -251,17 +251,17 @@ int intel_scu_ipc_iowrite8(u16 addr, u8 data) 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 + * intel_scu_ipc_readvv - read a set of registers + * @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. + * The largest array length permitted by the hardware is 5 items. * - * This function may sleep. + * This function may sleep. */ int intel_scu_ipc_readv(u16 *addr, u8 *data, int len) { @@ -270,18 +270,17 @@ int intel_scu_ipc_readv(u16 *addr, u8 *data, int len) 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 + * intel_scu_ipc_writev - write a set of registers + * @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. + * 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) { @@ -290,19 +289,18 @@ int intel_scu_ipc_writev(u16 *addr, u8 *data, int len) 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 + * intel_scu_ipc_update_register - r/m/w a register + * @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. + * 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. * - * This function may sleep. Locking between SCU accesses is handled - * for the caller. + * This function may sleep. Locking between SCU accesses is handled + * for the caller. */ int intel_scu_ipc_update_register(u16 addr, u8 bits, u8 mask) { @@ -312,16 +310,16 @@ int intel_scu_ipc_update_register(u16 addr, u8 bits, u8 mask) EXPORT_SYMBOL(intel_scu_ipc_update_register); /** - * intel_scu_ipc_simple_command - send a simple command - * @cmd: command - * @sub: sub type + * intel_scu_ipc_simple_command - send a simple command + * @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) { @@ -341,16 +339,16 @@ int intel_scu_ipc_simple_command(int cmd, int sub) 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 + * intel_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. Do the - * data copies under the lock but leave it for the caller to interpret + * 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. */ int intel_scu_ipc_command(int cmd, int sub, u32 *in, int inlen, u32 *out, int outlen)
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: Mika Westerberg <mika.westerberg@linux.intel.com> --- drivers/platform/x86/intel_scu_ipc.c | 112 +++++++++++++-------------- 1 file changed, 55 insertions(+), 57 deletions(-)