From: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
To: jkosina@suse.cz, jic23@kernel.org
Cc: linux-iio@vger.kernel.org, linux-input@vger.kernel.org,
Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
Subject: [PATCH] HID: hid-sensor-hub: Correct documentation
Date: Tue, 6 Jan 2015 16:58:24 -0800 [thread overview]
Message-ID: <1420592328-9942-1-git-send-email-srinivas.pandruvada@linux.intel.com> (raw)
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(+)
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
--
1.9.1
next reply other threads:[~2015-01-07 0:58 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-07 0:58 Srinivas Pandruvada [this message]
2015-01-07 0:58 ` [PATCH] HID: sensor-hub: correct dyn_callback_lock IRQ-safe change Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 1/4] HID: hid-sensor-hub: Enhance feature report API Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 2/4] iio: hid_sensor_hub: update parameters to get feature report Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 3/4] HID: hid-sensor-hub: Enhance feature report set API Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 4/4] iio: hid_sensor_hub: update parameters to set feature report Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH] HID: hid-sensor-hub: Allow parallel synchronous reads Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 1/9] HID: hid-sensor-hub: Extend API for async reads Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 2/9] iio: hid-sensor-accel-3d: Adjust parameter for attribute read Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 3/9] iio: hid-sensor-gyro-3d: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 4/9] iio: hid-sensor-als: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 5/9] iio: hid-sensor-prox: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 6/9] iio: hid-sensor-magn-3d: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 7/9] iio: hid-sensor-incl-3d: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 8/9] iio: hid-sensor-press: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 9/9] drivers/rtc/rtc-hid-sensor-time.c: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 1/8] iio: hid_sensor_hub: Common PM functions Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 2/8] iio: hid-sensor-accel-3d: Introduce PM Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 3/8] iio: hid-sensor-gyro-3d: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 4/8] iio: hid-sensor-als: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 5/8] iio: hid-sensor-prox: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 6/8] iio: hid-sensor-magn-3d: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 7/8] iio: hid-sensor-incl-3d: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH 8/8] iio: hid-sensor-press: " Srinivas Pandruvada
2015-01-07 0:58 ` [PATCH] HID: hid-sensor-hub: Add collection device Srinivas Pandruvada
2015-01-07 8:48 ` [PATCH] HID: hid-sensor-hub: Correct documentation Jiri Kosina
2015-01-07 16:01 ` Srinivas Pandruvada
2015-01-07 16:27 ` Jiri Kosina
2015-01-07 16:35 ` Srinivas Pandruvada
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1420592328-9942-1-git-send-email-srinivas.pandruvada@linux.intel.com \
--to=srinivas.pandruvada@linux.intel.com \
--cc=jic23@kernel.org \
--cc=jkosina@suse.cz \
--cc=linux-iio@vger.kernel.org \
--cc=linux-input@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).