summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChelsy Ratnawat <chelsyratnawat2001@gmail.com>2025-05-01 17:36:55 -0700
committerJonathan Cameron <Jonathan.Cameron@huawei.com>2025-05-21 14:20:29 +0100
commit7e00d74eacf77c98a60e7c754a9e5f73d8832095 (patch)
tree38f0c61c37c9f6bb8c9c6f73b68e8de8d6a86a7a
parent413e1d6a95fcbbc048b6fce32c523e0a225275cb (diff)
HID: sensor-hub: Fix typo and improve documentation for sensor_hub_remove_callback()
Fixed a typo in "registered" and improved grammar for better readability and consistency with kernel-doc standards. No functional changes. Signed-off-by: Chelsy Ratnawat <chelsyratnawat2001@gmail.com> Reviewed-by: David Lechner <dlechner@baylibre.com> Link: https://patch.msgid.link/20250502003655.1943000-1-chelsyratnawat2001@gmail.com Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
-rw-r--r--include/linux/hid-sensor-hub.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/include/linux/hid-sensor-hub.h b/include/linux/hid-sensor-hub.h
index c27329e2a5ad..0f9f7df865db 100644
--- a/include/linux/hid-sensor-hub.h
+++ b/include/linux/hid-sensor-hub.h
@@ -128,12 +128,13 @@ int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
struct hid_sensor_hub_callbacks *usage_callback);
/**
-* sensor_hub_remove_callback() - Remove client callbacks
+* sensor_hub_remove_callback() - Remove client callback
* @hsdev: Hub device instance.
-* @usage_id: Usage id of the client (E.g. 0x200076 for Gyro).
+* @usage_id: Usage id of the client (e.g. 0x200076 for gyro).
*
-* If there is a callback registred, this call will remove that
-* callbacks, so that it will stop data and event notifications.
+* Removes a previously registered callback for the given usage_id
+* and hsdev. Once removed, the client will no longer receive data or
+* event notifications.
*/
int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
u32 usage_id);