* [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec
2012-06-12 12:42 [PATCH RESEND 1/4] iio: fix typos in iio.h Peter Meerwald
@ 2012-06-12 12:42 ` Peter Meerwald
2012-06-12 12:55 ` Jonathan Cameron
0 siblings, 1 reply; 6+ messages in thread
From: Peter Meerwald @ 2012-06-12 12:42 UTC (permalink / raw)
To: Jonathan Cameron; +Cc: linux-iio, Peter Meerwald
From: Peter Meerwald <p.meerwald@bct-electronic.com>
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
---
include/linux/iio/iio.h | 7 +++----
1 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index 9d9b55a..44b9660 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -196,7 +196,7 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
/**
* struct iio_chan_spec - specification of a single channel
* @type: What type of measurement is the channel making.
- * @channel: What number or name do we wish to assign the channel.
+ * @channel: What number do we wish to assign the channel.
* @channel2: If there is a second number for a differential
* channel then this is it. If modified is set then the
* value here specifies the modifier.
@@ -227,9 +227,8 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
* channel2. Examples are IIO_MOD_X for axial sensors about
* the 'x' axis.
* @indexed: Specify the channel has a numerical index. If not,
- * the value in channel will be suppressed for attribute
- * but not for event codes. Typically set it to 0 when
- * the index is false.
+ * the channel index number will be suppressed for sysfs
+ * attributes but not for event codes.
* @differential: Channel is differential.
*/
struct iio_chan_spec {
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec
2012-06-12 12:42 ` [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec Peter Meerwald
@ 2012-06-12 12:55 ` Jonathan Cameron
0 siblings, 0 replies; 6+ messages in thread
From: Jonathan Cameron @ 2012-06-12 12:55 UTC (permalink / raw)
To: Peter Meerwald; +Cc: Jonathan Cameron, linux-iio
On 6/12/2012 1:42 PM, Peter Meerwald wrote:
> From: Peter Meerwald<p.meerwald@bct-electronic.com>
>
> Signed-off-by: Peter Meerwald<pmeerw@pmeerw.net>
Acked-by: Jonathan Cameron <jic23@kernel.org>
>
> ---
> include/linux/iio/iio.h | 7 +++----
> 1 files changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index 9d9b55a..44b9660 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -196,7 +196,7 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
> /**
> * struct iio_chan_spec - specification of a single channel
> * @type: What type of measurement is the channel making.
> - * @channel: What number or name do we wish to assign the channel.
> + * @channel: What number do we wish to assign the channel.
> * @channel2: If there is a second number for a differential
> * channel then this is it. If modified is set then the
> * value here specifies the modifier.
> @@ -227,9 +227,8 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
> * channel2. Examples are IIO_MOD_X for axial sensors about
> * the 'x' axis.
> * @indexed: Specify the channel has a numerical index. If not,
> - * the value in channel will be suppressed for attribute
> - * but not for event codes. Typically set it to 0 when
> - * the index is false.
> + * the channel index number will be suppressed for sysfs
> + * attributes but not for event codes.
> * @differential: Channel is differential.
> */
> struct iio_chan_spec {
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH RESEND v2 1/4] iio: fix typos in iio.h
@ 2012-06-12 13:38 Peter Meerwald
2012-06-12 13:38 ` [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec Peter Meerwald
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Peter Meerwald @ 2012-06-12 13:38 UTC (permalink / raw)
To: Greg Kroah-Hartman; +Cc: linux-iio, Peter Meerwald
From: Peter Meerwald <p.meerwald@bct-electronic.com>
v2:
* "used in in-kernel" (Jonathan Cameron)
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
Acked-by: Jonathan Cameron <jic23@kernel.org>
---
include/linux/iio/iio.h | 6 +++---
1 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index 944c635..9d9b55a 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -131,7 +131,7 @@ struct iio_chan_spec_ext_info {
/**
* struct iio_enum - Enum channel info attribute
- * items: A array of strings.
+ * items: An array of strings.
* num_items: Length of the item array.
* set: Set callback function, may be NULL.
* get: Get callback function, may be NULL.
@@ -218,7 +218,7 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
* @extend_name: Allows labeling of channel attributes with an
* informative name. Note this has no effect codes etc,
* unlike modifiers.
- * @datasheet_name: A name used in in kernel mapping of channels. It should
+ * @datasheet_name: A name used in in-kernel mapping of channels. It should
* correspond to the first name that the channel is referred
* to by in the datasheet (e.g. IND), or the nearest
* possible compound name (e.g. IND-INC).
@@ -393,7 +393,7 @@ struct iio_buffer_setup_ops {
* @trig: [INTERN] current device trigger (buffer modes)
* @pollfunc: [DRIVER] function run on trigger being received
* @channels: [DRIVER] channel specification structure table
- * @num_channels: [DRIVER] number of chanels specified in @channels.
+ * @num_channels: [DRIVER] number of channels specified in @channels.
* @channel_attr_list: [INTERN] keep track of automatically created channel
* attributes
* @chan_attr_group: [INTERN] group for all attrs in base directory
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec
2012-06-12 13:38 [PATCH RESEND v2 1/4] iio: fix typos in iio.h Peter Meerwald
@ 2012-06-12 13:38 ` Peter Meerwald
2012-06-12 13:38 ` [PATCH RESEND 3/4] iio: mark struct iio_enum elements with @ in comment Peter Meerwald
2012-06-12 13:38 ` [PATCH 4/4] iio: cleanup iio/iio.h Peter Meerwald
2 siblings, 0 replies; 6+ messages in thread
From: Peter Meerwald @ 2012-06-12 13:38 UTC (permalink / raw)
To: Greg Kroah-Hartman; +Cc: linux-iio, Peter Meerwald
From: Peter Meerwald <p.meerwald@bct-electronic.com>
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
Acked-by: Jonathan Cameron <jic23@kernel.org>
---
include/linux/iio/iio.h | 7 +++----
1 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index 9d9b55a..44b9660 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -196,7 +196,7 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
/**
* struct iio_chan_spec - specification of a single channel
* @type: What type of measurement is the channel making.
- * @channel: What number or name do we wish to assign the channel.
+ * @channel: What number do we wish to assign the channel.
* @channel2: If there is a second number for a differential
* channel then this is it. If modified is set then the
* value here specifies the modifier.
@@ -227,9 +227,8 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
* channel2. Examples are IIO_MOD_X for axial sensors about
* the 'x' axis.
* @indexed: Specify the channel has a numerical index. If not,
- * the value in channel will be suppressed for attribute
- * but not for event codes. Typically set it to 0 when
- * the index is false.
+ * the channel index number will be suppressed for sysfs
+ * attributes but not for event codes.
* @differential: Channel is differential.
*/
struct iio_chan_spec {
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH RESEND 3/4] iio: mark struct iio_enum elements with @ in comment
2012-06-12 13:38 [PATCH RESEND v2 1/4] iio: fix typos in iio.h Peter Meerwald
2012-06-12 13:38 ` [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec Peter Meerwald
@ 2012-06-12 13:38 ` Peter Meerwald
2012-06-12 13:38 ` [PATCH 4/4] iio: cleanup iio/iio.h Peter Meerwald
2 siblings, 0 replies; 6+ messages in thread
From: Peter Meerwald @ 2012-06-12 13:38 UTC (permalink / raw)
To: Greg Kroah-Hartman; +Cc: linux-iio, Peter Meerwald
From: Peter Meerwald <p.meerwald@bct-electronic.com>
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
Acked-by: Jonathan Cameron <jic23@kernel.org>
---
include/linux/iio/iio.h | 8 ++++----
1 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index 44b9660..a35aa58 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -131,10 +131,10 @@ struct iio_chan_spec_ext_info {
/**
* struct iio_enum - Enum channel info attribute
- * items: An array of strings.
- * num_items: Length of the item array.
- * set: Set callback function, may be NULL.
- * get: Get callback function, may be NULL.
+ * @items: An array of strings.
+ * @num_items: Length of the item array.
+ * @set: Set callback function, may be NULL.
+ * @get: Get callback function, may be NULL.
*
* The iio_enum struct can be used to implement enum style channel attributes.
* Enum style attributes are those which have a set of strings which map to
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 4/4] iio: cleanup iio/iio.h
2012-06-12 13:38 [PATCH RESEND v2 1/4] iio: fix typos in iio.h Peter Meerwald
2012-06-12 13:38 ` [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec Peter Meerwald
2012-06-12 13:38 ` [PATCH RESEND 3/4] iio: mark struct iio_enum elements with @ in comment Peter Meerwald
@ 2012-06-12 13:38 ` Peter Meerwald
2 siblings, 0 replies; 6+ messages in thread
From: Peter Meerwald @ 2012-06-12 13:38 UTC (permalink / raw)
To: Greg Kroah-Hartman; +Cc: linux-iio, Peter Meerwald
From: Peter Meerwald <p.meerwald@bct-electronic.com>
indentation of parameter description,
fix parameter name (@dev -> @indio_dev) in comments,
IIO device info structure -> IIO device structure
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
Acked-by: Jonathan Cameron <jic23@kernel.org>
---
include/linux/iio/iio.h | 36 ++++++++++++++++++------------------
1 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index a35aa58..7711b4d 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -131,10 +131,10 @@ struct iio_chan_spec_ext_info {
/**
* struct iio_enum - Enum channel info attribute
- * @items: An array of strings.
- * @num_items: Length of the item array.
- * @set: Set callback function, may be NULL.
- * @get: Get callback function, may be NULL.
+ * @items: An array of strings.
+ * @num_items: Length of the item array.
+ * @set: Set callback function, may be NULL.
+ * @get: Get callback function, may be NULL.
*
* The iio_enum struct can be used to implement enum style channel attributes.
* Enum style attributes are those which have a set of strings which map to
@@ -162,9 +162,9 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
/**
* IIO_ENUM() - Initialize enum extended channel attribute
- * @_name: Attribute name
- * @_shared: Whether the attribute is shared between all channels
- * @_e: Pointer to a iio_enum struct
+ * @_name: Attribute name
+ * @_shared: Whether the attribute is shared between all channels
+ * @_e: Pointer to a iio_enum struct
*
* This should usually be used together with IIO_ENUM_AVAILABLE()
*/
@@ -179,8 +179,8 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
/**
* IIO_ENUM_AVAILABLE() - Initialize enum available extended channel attribute
- * @_name: Attribute name ("_available" will be appended to the name)
- * @_e: Pointer to a iio_enum struct
+ * @_name: Attribute name ("_available" will be appended to the name)
+ * @_e: Pointer to a iio_enum struct
*
* Creates a read only attribute which list all the available enum items in a
* space separated list. This should usually be used together with IIO_ENUM()
@@ -201,7 +201,7 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
* channel then this is it. If modified is set then the
* value here specifies the modifier.
* @address: Driver specific identifier.
- * @scan_index: Monotonic index to give ordering in scans when read
+ * @scan_index: Monotonic index to give ordering in scans when read
* from a buffer.
* @scan_type: Sign: 's' or 'u' to specify signed or unsigned
* realbits: Number of valid bits of data
@@ -211,7 +211,7 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
* endianness: little or big endian
* @info_mask: What information is to be exported about this channel.
* This includes calibbias, scale etc.
- * @event_mask: What events can this channel produce.
+ * @event_mask: What events can this channel produce.
* @ext_info: Array of extended info attributes for this channel.
* The array is NULL terminated, the last element should
* have it's name field set to NULL.
@@ -482,7 +482,7 @@ extern struct bus_type iio_bus_type;
/**
* iio_device_put() - reference counted deallocation of struct device
- * @dev: the iio_device containing the device
+ * @indio_dev: IIO device structure containing the device
**/
static inline void iio_device_put(struct iio_dev *indio_dev)
{
@@ -492,7 +492,7 @@ static inline void iio_device_put(struct iio_dev *indio_dev)
/**
* dev_to_iio_dev() - Get IIO device struct from a device struct
- * @dev: The device embedded in the IIO device
+ * @dev: The device embedded in the IIO device
*
* Note: The device must be a IIO device, otherwise the result is undefined.
*/
@@ -503,7 +503,7 @@ static inline struct iio_dev *dev_to_iio_dev(struct device *dev)
/**
* iio_device_get() - increment reference count for the device
- * @indio_dev: IIO device structure
+ * @indio_dev: IIO device structure
*
* Returns: The passed IIO device
**/
@@ -516,7 +516,7 @@ static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev)
#define IIO_ALIGN L1_CACHE_BYTES
/**
* iio_device_alloc() - allocate an iio_dev from a driver
- * @sizeof_priv: Space to allocate for private structure.
+ * @sizeof_priv: Space to allocate for private structure.
**/
struct iio_dev *iio_device_alloc(int sizeof_priv);
@@ -533,13 +533,13 @@ static inline struct iio_dev *iio_priv_to_dev(void *priv)
/**
* iio_device_free() - free an iio_dev from a driver
- * @dev: the iio_dev associated with the device
+ * @indio_dev: the iio_dev associated with the device
**/
void iio_device_free(struct iio_dev *indio_dev);
/**
* iio_buffer_enabled() - helper function to test if the buffer is enabled
- * @indio_dev: IIO device info structure for device
+ * @indio_dev: IIO device structure for device
**/
static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
{
@@ -549,7 +549,7 @@ static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
/**
* iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
- * @indio_dev: IIO device info structure for device
+ * @indio_dev: IIO device structure for device
**/
#if defined(CONFIG_DEBUG_FS)
static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
end of thread, other threads:[~2012-06-12 13:39 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-06-12 13:38 [PATCH RESEND v2 1/4] iio: fix typos in iio.h Peter Meerwald
2012-06-12 13:38 ` [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec Peter Meerwald
2012-06-12 13:38 ` [PATCH RESEND 3/4] iio: mark struct iio_enum elements with @ in comment Peter Meerwald
2012-06-12 13:38 ` [PATCH 4/4] iio: cleanup iio/iio.h Peter Meerwald
-- strict thread matches above, loose matches on Subject: below --
2012-06-12 12:42 [PATCH RESEND 1/4] iio: fix typos in iio.h Peter Meerwald
2012-06-12 12:42 ` [PATCH 2/4] iio: clarify channel and indexed in struct iio_chan_spec Peter Meerwald
2012-06-12 12:55 ` Jonathan Cameron
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).