diff options
| author |   Enric Balletbo i Serra <enric.balletbo@collabora.com> | 2019-06-14 23:43:02 +0200 |
|---|---|---|
| committer | Enric Balletbo i Serra <enric.balletbo@collabora.com> | 2019-06-20 12:00:32 +0200 |
| commit | 9eecd07b34507de9d6a9c264d13d30e1ee5fabe8 (patch) | |
| tree | 3adf06235479b8029c687c21d3c479618b73608c /drivers/platform | |
| parent | platform/chrome: cros_ec_lpc: Choose Microchip EC at runtime (diff) | |
| download | linux-dev-9eecd07b34507de9d6a9c264d13d30e1ee5fabe8.tar.xz linux-dev-9eecd07b34507de9d6a9c264d13d30e1ee5fabe8.zip | |
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>
Diffstat (limited to 'drivers/platform')
| -rw-r--r-- | drivers/platform/chrome/cros_ec_lpc_mec.c | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/drivers/platform/chrome/cros_ec_lpc_mec.c b/drivers/platform/chrome/cros_ec_lpc_mec.c index d8890bafb55d..9035b17e8c86 100644 --- a/drivers/platform/chrome/cros_ec_lpc_mec.c +++ b/drivers/platform/chrome/cros_ec_lpc_mec.c @@ -17,12 +17,10 @@ static struct mutex io_mutex; static u16 mec_emi_base, mec_emi_end; -/* - * cros_ec_lpc_mec_emi_write_address - * - * Initialize EMI read / write at a given address. +/** + * cros_ec_lpc_mec_emi_write_address() - Initialize EMI at a given address. * - * @addr: Starting read / write address + * @addr: Starting read / write address * @access_type: Type of access, typically 32-bit auto-increment */ static void cros_ec_lpc_mec_emi_write_address(u16 addr, @@ -61,15 +59,15 @@ int cros_ec_lpc_mec_in_range(unsigned int offset, unsigned int length) 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 * @offset: Base read / write address * @length: Number of bytes to read / write * @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, unsigned int offset, unsigned int length, |