Commit e2bbf91c authored by Enric Balletbo i Serra's avatar Enric Balletbo i Serra Committed by Benson Leung

mfd: cros_ec: Fix and improve kerneldoc comments.

cros-ec includes inside the MFD subsystem, specially the file
cros_ec_commands.h, has been modified several times and it has grown a
lot, unfortunately, we didn't have care too much about the documentation.
This patch tries to improve the documentation and also fixes all the
issues reported by kerneldoc script.
Signed-off-by: default avatarEnric Balletbo i Serra <enric.balletbo@collabora.com>
Signed-off-by: default avatarBenson Leung <bleung@chromium.org>
parent cc8a4ea1
...@@ -26,12 +26,13 @@ ...@@ -26,12 +26,13 @@
#define CROS_EC_DEV_VERSION "1.0.0" #define CROS_EC_DEV_VERSION "1.0.0"
/* /**
* @offset: within EC_LPC_ADDR_MEMMAP region * struct cros_ec_readmem - Struct used to read mapped memory.
* @bytes: number of bytes to read. zero means "read a string" (including '\0') * @offset: Within EC_LPC_ADDR_MEMMAP region.
* (at most only EC_MEMMAP_SIZE bytes can be read) * @bytes: Number of bytes to read. Zero means "read a string" (including '\0')
* @buffer: where to store the result * At most only EC_MEMMAP_SIZE bytes can be read.
* ioctl returns the number of bytes read, negative on error * @buffer: Where to store the result. The ioctl returns the number of bytes
* read or negative on error.
*/ */
struct cros_ec_readmem { struct cros_ec_readmem {
uint32_t offset; uint32_t offset;
......
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment