HID: sensor-hub: Fix typo and improve documentation
authorChelsy Ratnawat <chelsyratnawat2001@gmail.com>
Wed, 7 May 2025 05:57:45 +0000 (22:57 -0700)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Wed, 21 May 2025 13:21:34 +0000 (14:21 +0100)
Includes the following corrections -
 - Changed Measurment -> Measurement
 - Changed clode -> close
 - Gyro -> gyro

Signed-off-by: Chelsy Ratnawat <chelsyratnawat2001@gmail.com>
Reviewed-by: David Lechner <dlechner@baylibre.com>
Link: https://patch.msgid.link/20250507055745.4069933-1-chelsyratnawat2001@gmail.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
include/linux/hid-sensor-hub.h

index 0f9f7df..e710565 100644 (file)
@@ -17,7 +17,7 @@
  * @attrib_id:         Attribute id for this attribute.
  * @report_id:         Report id in which this information resides.
  * @index:             Field index in the report.
- * @units:             Measurment unit for this attribute.
+ * @units:             Measurement unit for this attribute.
  * @unit_expo:         Exponent used in the data.
  * @size:              Size in bytes for data size.
  * @logical_minimum:   Logical minimum value for this attribute.
@@ -39,8 +39,8 @@ struct hid_sensor_hub_attribute_info {
  * struct sensor_hub_pending - Synchronous read pending information
  * @status:            Pending status true/false.
  * @ready:             Completion synchronization data.
- * @usage_id:          Usage id for physical device, E.g. Gyro usage id.
- * @attr_usage_id:     Usage Id of a field, E.g. X-AXIS for a gyro.
+ * @usage_id:          Usage id for physical device, e.g. gyro usage id.
+ * @attr_usage_id:     Usage Id of a field, e.g. X-axis for a gyro.
  * @raw_size:          Response size for a read request.
  * @raw_data:          Place holder for received response.
  */
@@ -104,10 +104,10 @@ struct hid_sensor_hub_callbacks {
 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev);
 
 /**
-* sensor_hub_device_clode() - Close hub device
+* sensor_hub_device_close() - Close hub device
 * @hsdev:      Hub device instance.
 *
-* Used to clode hid device for sensor hub.
+* Used to close hid device for sensor hub.
 */
 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev);