| Message ID | 20250502003655.1943000-1-chelsyratnawat2001@gmail.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v2] HID: sensor-hub: Fix typo and improve documentation for sensor_hub_remove_callback() | expand |
On Thu, 1 May 2025 17:36:55 -0700 Chelsy Ratnawat <chelsyratnawat2001@gmail.com> wrote: > 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> > --- Even though trivial reason for resend, this is v3. Posting it as v2 confuses some tooling such as b4. I manually grabbed the right patch and applied. Thanks, Jonathan > Changes in v2: > - Improved the kernel-doc comment for sensor_hub_remove_callback(). > - Changed "Gyro" to "gyro". > - Changed "usage ID" to "usage_id" for consistency with kernel-doc > style. > - Updated the comment to state that only one callback can be removed > per (usage_id, hsdev) pair. > > include/linux/hid-sensor-hub.h | 9 +++++---- > 1 file 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);
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);