platform/chrome: cros_ec_lpc_mec: Fix kernel-doc comment first line
kernel-doc comments have a prescribed format. To be _particularly_ correct we should also capitalise the brief description and terminate it with a period. Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com> Reviewed-by: Nick Crews <ncrews@chromium.org>
This commit is contained in:
@@ -17,10 +17,8 @@
|
|||||||
static struct mutex io_mutex;
|
static struct mutex io_mutex;
|
||||||
static u16 mec_emi_base, mec_emi_end;
|
static u16 mec_emi_base, mec_emi_end;
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* cros_ec_lpc_mec_emi_write_address
|
* cros_ec_lpc_mec_emi_write_address() - Initialize EMI at a given address.
|
||||||
*
|
|
||||||
* Initialize EMI read / write at a given address.
|
|
||||||
*
|
*
|
||||||
* @addr: Starting read / write address
|
* @addr: Starting read / write address
|
||||||
* @access_type: Type of access, typically 32-bit auto-increment
|
* @access_type: Type of access, typically 32-bit auto-increment
|
||||||
@@ -61,15 +59,15 @@ int cros_ec_lpc_mec_in_range(unsigned int offset, unsigned int length)
|
|||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* cros_ec_lpc_io_bytes_mec - Read / write bytes to MEC EMI port
|
* cros_ec_lpc_io_bytes_mec() - Read / write bytes to MEC EMI port.
|
||||||
*
|
*
|
||||||
* @io_type: MEC_IO_READ or MEC_IO_WRITE, depending on request
|
* @io_type: MEC_IO_READ or MEC_IO_WRITE, depending on request
|
||||||
* @offset: Base read / write address
|
* @offset: Base read / write address
|
||||||
* @length: Number of bytes to read / write
|
* @length: Number of bytes to read / write
|
||||||
* @buf: Destination / source buffer
|
* @buf: Destination / source buffer
|
||||||
*
|
*
|
||||||
* @return 8-bit checksum of all bytes read / written
|
* Return: 8-bit checksum of all bytes read / written
|
||||||
*/
|
*/
|
||||||
u8 cros_ec_lpc_io_bytes_mec(enum cros_ec_lpc_mec_io_type io_type,
|
u8 cros_ec_lpc_io_bytes_mec(enum cros_ec_lpc_mec_io_type io_type,
|
||||||
unsigned int offset, unsigned int length,
|
unsigned int offset, unsigned int length,
|
||||||
|
Reference in New Issue
Block a user