diff mbox

[1/2] HID: hid-sensor-hub: Correct documentation

Message ID 1420654484-6410-2-git-send-email-srinivas.pandruvada@linux.intel.com (mailing list archive)
State New, archived
Delegated to: Jiri Kosina
Headers show

Commit Message

srinivas pandruvada Jan. 7, 2015, 6:14 p.m. UTC
During changes to the interface, some documentation field comments
were missed. Added missing comments.

Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
---
 include/linux/hid-sensor-hub.h | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Jonathan Cameron Jan. 10, 2015, 10:21 p.m. UTC | #1
On 07/01/15 18:14, Srinivas Pandruvada wrote:
> During changes to the interface, some documentation field comments
> were missed. Added missing comments.
> 
> Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
Applied to the togreg branch of iio.git as absence of docs is irritating
rather than a bug ;)

Thanks,
> ---
>  include/linux/hid-sensor-hub.h | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/include/linux/hid-sensor-hub.h b/include/linux/hid-sensor-hub.h
> index 51f7cca..4173a8f 100644
> --- a/include/linux/hid-sensor-hub.h
> +++ b/include/linux/hid-sensor-hub.h
> @@ -33,6 +33,8 @@
>   * @units:		Measurment 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.
> + * @logical_maximum:	Logical maximum value for this attribute.
>   */
>  struct hid_sensor_hub_attribute_info {
>  	u32 usage_id;
> @@ -146,6 +148,7 @@ int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
>  
>  /**
>  * sensor_hub_input_attr_get_raw_value() - Synchronous read request
> +* @hsdev:	Hub device instance.
>  * @usage_id:	Attribute usage id of parent physical device as per spec
>  * @attr_usage_id:	Attribute usage id as per spec
>  * @report_id:	Report id to look for
> @@ -160,6 +163,7 @@ int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
>  			u32 attr_usage_id, u32 report_id);
>  /**
>  * sensor_hub_set_feature() - Feature set request
> +* @hsdev:	Hub device instance.
>  * @report_id:	Report id to look for
>  * @field_index:	Field index inside a report
>  * @value:	Value to set
> @@ -172,6 +176,7 @@ int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
>  
>  /**
>  * sensor_hub_get_feature() - Feature get request
> +* @hsdev:	Hub device instance.
>  * @report_id:	Report id to look for
>  * @field_index:	Field index inside a report
>  * @value:	Place holder for return value
> 

--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jonathan Cameron Jan. 10, 2015, 10:25 p.m. UTC | #2
On 10/01/15 22:21, Jonathan Cameron wrote:
> On 07/01/15 18:14, Srinivas Pandruvada wrote:
>> During changes to the interface, some documentation field comments
>> were missed. Added missing comments.
>>
>> Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
> Applied to the togreg branch of iio.git as absence of docs is irritating
> rather than a bug ;)
Sorry, dopey evening.  This one is Jiri's area not mine so over to him and
backed out of the togreg branch of iio.git.

Sorry about that.

J


> 
> Thanks,
>> ---
>>  include/linux/hid-sensor-hub.h | 5 +++++
>>  1 file changed, 5 insertions(+)
>>
>> diff --git a/include/linux/hid-sensor-hub.h b/include/linux/hid-sensor-hub.h
>> index 51f7cca..4173a8f 100644
>> --- a/include/linux/hid-sensor-hub.h
>> +++ b/include/linux/hid-sensor-hub.h
>> @@ -33,6 +33,8 @@
>>   * @units:		Measurment 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.
>> + * @logical_maximum:	Logical maximum value for this attribute.
>>   */
>>  struct hid_sensor_hub_attribute_info {
>>  	u32 usage_id;
>> @@ -146,6 +148,7 @@ int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
>>  
>>  /**
>>  * sensor_hub_input_attr_get_raw_value() - Synchronous read request
>> +* @hsdev:	Hub device instance.
>>  * @usage_id:	Attribute usage id of parent physical device as per spec
>>  * @attr_usage_id:	Attribute usage id as per spec
>>  * @report_id:	Report id to look for
>> @@ -160,6 +163,7 @@ int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
>>  			u32 attr_usage_id, u32 report_id);
>>  /**
>>  * sensor_hub_set_feature() - Feature set request
>> +* @hsdev:	Hub device instance.
>>  * @report_id:	Report id to look for
>>  * @field_index:	Field index inside a report
>>  * @value:	Value to set
>> @@ -172,6 +176,7 @@ int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
>>  
>>  /**
>>  * sensor_hub_get_feature() - Feature get request
>> +* @hsdev:	Hub device instance.
>>  * @report_id:	Report id to look for
>>  * @field_index:	Field index inside a report
>>  * @value:	Place holder for return value
>>
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-iio" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 

--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jiri Kosina Jan. 12, 2015, 8:52 a.m. UTC | #3
On Sat, 10 Jan 2015, Jonathan Cameron wrote:

> >> Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
> > Applied to the togreg branch of iio.git as absence of docs is irritating
> > rather than a bug ;)
> Sorry, dopey evening.  This one is Jiri's area not mine so over to him and
> backed out of the togreg branch of iio.git.
> 
> Sorry about that.

No problem. I guess we have to sort out which tree this whole lot will go 
through anyway.

I haven't yet unfortunately have time go to through the patches at all, so 
I don't know whether they are touching more the HID part or the IIO part. 
It's in my TODO queue.

Thanks,
diff mbox

Patch

diff --git a/include/linux/hid-sensor-hub.h b/include/linux/hid-sensor-hub.h
index 51f7cca..4173a8f 100644
--- a/include/linux/hid-sensor-hub.h
+++ b/include/linux/hid-sensor-hub.h
@@ -33,6 +33,8 @@ 
  * @units:		Measurment 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.
+ * @logical_maximum:	Logical maximum value for this attribute.
  */
 struct hid_sensor_hub_attribute_info {
 	u32 usage_id;
@@ -146,6 +148,7 @@  int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
 
 /**
 * sensor_hub_input_attr_get_raw_value() - Synchronous read request
+* @hsdev:	Hub device instance.
 * @usage_id:	Attribute usage id of parent physical device as per spec
 * @attr_usage_id:	Attribute usage id as per spec
 * @report_id:	Report id to look for
@@ -160,6 +163,7 @@  int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
 			u32 attr_usage_id, u32 report_id);
 /**
 * sensor_hub_set_feature() - Feature set request
+* @hsdev:	Hub device instance.
 * @report_id:	Report id to look for
 * @field_index:	Field index inside a report
 * @value:	Value to set
@@ -172,6 +176,7 @@  int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
 
 /**
 * sensor_hub_get_feature() - Feature get request
+* @hsdev:	Hub device instance.
 * @report_id:	Report id to look for
 * @field_index:	Field index inside a report
 * @value:	Place holder for return value