platform/chrome: cros_ec_proto: Fix cros_ec_get_host_event_wake_mask kdoc

t-8ch · Tzung-Bi Shih · commit d1019a74e0f5 · 2024-05-27T02:41:12.000Z
Mark the documentation block as kernel doc and drop the documentation of the non-existing parameter "@msg". Signed-off-by: Thomas Weißschuh <linux@weissschuh.net> Link: https://lore.kernel.org/r/20240524-cros_ec-cmd_versions-v1-1-8a148647d051@weissschuh.net Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
diff --git a/drivers/platform/chrome/cros_ec_proto.c b/drivers/platform/chrome/cros_ec_proto.c
@@ -239,13 +239,12 @@ int cros_ec_check_result(struct cros_ec_device *ec_dev,
 }
 EXPORT_SYMBOL(cros_ec_check_result);
 
-/*
+/**
  * cros_ec_get_host_event_wake_mask
  *
  * Get the mask of host events that cause wake from suspend.
  *
  * @ec_dev: EC device to call
- * @msg: message structure to use
  * @mask: result when function returns 0.
  *
  * LOCKING:

Original file line number	Diff line number	Diff line change
`@@ -239,13 +239,12 @@ int cros_ec_check_result(struct cros_ec_device *ec_dev,`
`239`	`239`	`}`
`240`	`240`	`EXPORT_SYMBOL(cros_ec_check_result);`
`241`	`241`
`242`		`-/*`
	`242`	`+/**`
`243`	`243`	`* cros_ec_get_host_event_wake_mask`
`244`	`244`	`*`
`245`	`245`	`* Get the mask of host events that cause wake from suspend.`
`246`	`246`	`*`
`247`	`247`	`* @ec_dev: EC device to call`
`248`		`- * @msg: message structure to use`
`249`	`248`	`* @mask: result when function returns 0.`
`250`	`249`	`*`
`251`	`250`	`* LOCKING:`