platform/chrome: cros_ec_spi: Document missing function parameters

Enric Balletbo i Serra · Enric Balletbo i Serra · commit 3c5ca501b46b · 2020-06-30T11:41:25.000+02:00
Kerneldoc expects all kernel function members to be documented.

Fixes the following W=1 level warnings:

  cros_ec_spi.c:153: warning: Function parameter or member 'ec_dev' not described in 'receive_n_bytes'
  cros_ec_spi.c:153: warning: Function parameter or member 'buf' not described in 'receive_n_bytes'
  cros_ec_spi.c:153: warning: Function parameter or member 'n' not described in 'receive_n_bytes'

Signed-off-by: Enric Balletbo i Serra &lt;enric.balletbo@collabora.com&gt;
Reviewed-by: Gwendal Grignou &lt;gwendal@chromium.org&gt;
diff --git a/drivers/platform/chrome/cros_ec_spi.c b/drivers/platform/chrome/cros_ec_spi.c
@@ -148,6 +148,10 @@ static int terminate_request(struct cros_ec_device *ec_dev)
  * receive_n_bytes - receive n bytes from the EC.
  *
  * Assumes buf is a pointer into the ec_dev->din buffer
+ *
+ * @ec_dev: ChromeOS EC device.
+ * @buf: Pointer to the buffer receiving the data.
+ * @n: Number of bytes received.
  */
 static int receive_n_bytes(struct cros_ec_device *ec_dev, u8 *buf, int n)
 {

Original file line number	Diff line number	Diff line change
`@@ -148,6 +148,10 @@ static int terminate_request(struct cros_ec_device *ec_dev)`
`148`	`148`	`* receive_n_bytes - receive n bytes from the EC.`
`149`	`149`	`*`
`150`	`150`	`* Assumes buf is a pointer into the ec_dev->din buffer`
	`151`	`+ *`
	`152`	`+ * @ec_dev: ChromeOS EC device.`
	`153`	`+ * @buf: Pointer to the buffer receiving the data.`
	`154`	`+ * @n: Number of bytes received.`
`151`	`155`	`*/`
`152`	`156`	`static int receive_n_bytes(struct cros_ec_device ec_dev, u8 buf, int n)`
`153`	`157`	`{`