Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1272224 > unrolled thread

[RFC 5/9] iio: Documentation: Add IIO configfs documentation

Back to article view | Back to linux.kernel

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  [RFC 5/9] iio: Documentation: Add IIO configfs documentation Marc Titinger <mtitinger@baylibre.com> - 2015-11-18 15:40 +0100
    Re: [RFC 5/9] iio: Documentation: Add IIO configfs documentation Crt Mori <cmo@melexis.com> - 2015-11-18 16:40 +0100
      Re: [RFC 5/9] iio: Documentation: Add IIO configfs documentation Marc Titinger <mtitinger@baylibre.com> - 2015-11-18 17:10 +0100
        Re: [RFC 5/9] iio: Documentation: Add IIO configfs documentation Daniel Baluta <daniel.baluta@intel.com> - 2015-11-18 17:20 +0100
          Re: [RFC 5/9] iio: Documentation: Add IIO configfs documentation Jonathan Cameron <jic23@jic23.retrosnub.co.uk> - 2015-11-18 18:40 +0100

#1272224 — [RFC 5/9] iio: Documentation: Add IIO configfs documentation

From: Daniel Baluta <daniel.baluta@intel.com>

Signed-off-by: Daniel Baluta <daniel.baluta@intel.com>
Acked-by: Crt Mori <cmo@melexis.com>
---
 Documentation/ABI/testing/configfs-iio | 21 ++++++++
 Documentation/iio/iio_configfs.txt     | 93 ++++++++++++++++++++++++++++++++++
 2 files changed, 114 insertions(+)
 create mode 100644 Documentation/ABI/testing/configfs-iio
 create mode 100644 Documentation/iio/iio_configfs.txt

diff --git a/Documentation/ABI/testing/configfs-iio b/Documentation/ABI/testing/configfs-iio
new file mode 100644
index 0000000..2483756
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-iio
@@ -0,0 +1,21 @@
+What:		/config/iio
+Date:		October 2015
+KernelVersion:	4.4
+Contact:	linux-iio@vger.kernel.org
+Description:
+		This represents Industrial IO configuration entry point
+		directory. It contains sub-groups corresponding to IIO
+		objects.
+
+What:		/config/iio/triggers
+Date:		October 2015
+KernelVersion:	4.4
+Description:
+		Industrial IO software triggers directory.
+
+What:		/config/iio/triggers/hrtimers
+Date:		October 2015
+KernelVersion:	4.4
+Description:
+		High resolution timers directory. Creating a directory here
+		will result in creating a hrtimer trigger in the IIO subsystem.
diff --git a/Documentation/iio/iio_configfs.txt b/Documentation/iio/iio_configfs.txt
new file mode 100644
index 0000000..f0add35
--- /dev/null
+++ b/Documentation/iio/iio_configfs.txt
@@ -0,0 +1,93 @@
+Industrial IIO configfs support
+
+1. Overview
+
+Configfs is a filesystem-based manager of kernel objects. IIO uses some
+objects that could be easily configured using configfs (e.g.: devices,
+triggers).
+
+See Documentation/filesystems/configfs/configfs.txt for more information
+about how configfs works.
+
+2. Usage
+
+In order to use configfs support in IIO we need to select it at compile
+time via CONFIG_IIO_CONFIGFS config option.
+
+Then, mount the configfs filesystem (usually under /config directory):
+
+$ mkdir /config
+$ mount -t configfs none /config
+
+At this point, all default IIO groups will be created and can be accessed
+under /config/iio. Next chapters will describe available IIO configuration
+objects.
+
+3. Software triggers
+
+One of the IIO default configfs groups is the "triggers" group. It is
+automagically accessible when the configfs is mounted and can be found
+under /config/iio/triggers.
+
+IIO software triggers implementation offers support for creating multiple
+trigger types. A new trigger type is usually implemented as a separate
+kernel module following the interface in include/linux/iio/sw_trigger.h:
+
+/*
+ * drivers/iio/trigger/iio-trig-sample.c
+ * sample kernel module implementing a new trigger type
+ */
+#include <linux/iio/sw_trigger.h>
+
+
+static struct iio_sw_trigger *iio_trig_sample_probe(const char *name)
+{
+	/*
+	 * This allocates and registers an IIO trigger plus other
+	 * trigger type specific initialization.
+	 */
+}
+
+static int iio_trig_hrtimer_remove(struct iio_sw_trigger *swt)
+{
+	/*
+	 * This undoes the actions in iio_trig_sample_probe
+	 */
+}
+
+static const struct iio_sw_trigger_ops iio_trig_sample_ops = {
+	.probe		= iio_trig_sample_probe,
+	.remove		= iio_trig_sample_remove,
+};
+
+static struct iio_sw_trigger_type iio_trig_sample = {
+	.name = "trig-sample",
+	.owner = THIS_MODULE,
+	.ops = &iio_trig_sample_ops,
+};
+
+module_iio_sw_trigger_driver(iio_trig_sample);
+
+Each trigger type has its own directory under /config/iio/triggers. Loading
+iio-trig-sample module will create 'trig-sample' trigger type directory
+/config/iio/triggers/trig-sample.
+
+We support the following interrupt sources (trigger types):
+	* hrtimer, uses high resolution timers as interrupt source
+
+3.1 Hrtimer triggers creation and destruction
+
+Loading iio-trig-hrtimer module will register hrtimer trigger types allowing
+users to create hrtimer triggers under /config/iio/triggers/hrtimer.
+
+e.g:
+
+$ mkdir /config/triggers/hrtimer/instance1
+$ rmdir /config/triggers/hrtimer/instance1
+
+Each trigger can have one or more attributes specific to the trigger type.
+
+3.2 "hrtimer" trigger types attributes
+
+"hrtimer" trigger type doesn't have any configurable attribute from /config dir.
+It does introduce the sampling_frequency attribute to trigger directory.
-- 
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [next] | [standalone]

#1272306

This has my acked-by, yet it is missing a commit message? Can we get that
and the removed From: as I think this is a new patch and not resend of Daniel's?
Also it would need your signed-off-by in that case

On 18 November 2015 at 15:38, Marc Titinger <mtitinger@baylibre.com> wrote:
> From: Daniel Baluta <daniel.baluta@intel.com>
>
> Signed-off-by: Daniel Baluta <daniel.baluta@intel.com>
> Acked-by: Crt Mori <cmo@melexis.com>
> ---
>  Documentation/ABI/testing/configfs-iio | 21 ++++++++
>  Documentation/iio/iio_configfs.txt     | 93 ++++++++++++++++++++++++++++++++++
>  2 files changed, 114 insertions(+)
>  create mode 100644 Documentation/ABI/testing/configfs-iio
>  create mode 100644 Documentation/iio/iio_configfs.txt
>
> diff --git a/Documentation/ABI/testing/configfs-iio b/Documentation/ABI/testing/configfs-iio
> new file mode 100644
> index 0000000..2483756
> --- /dev/null
> +++ b/Documentation/ABI/testing/configfs-iio
> @@ -0,0 +1,21 @@
> +What:          /config/iio
> +Date:          October 2015
> +KernelVersion: 4.4
> +Contact:       linux-iio@vger.kernel.org
> +Description:
> +               This represents Industrial IO configuration entry point
> +               directory. It contains sub-groups corresponding to IIO
> +               objects.
> +
> +What:          /config/iio/triggers
> +Date:          October 2015
> +KernelVersion: 4.4
> +Description:
> +               Industrial IO software triggers directory.
> +
> +What:          /config/iio/triggers/hrtimers
> +Date:          October 2015
> +KernelVersion: 4.4
> +Description:
> +               High resolution timers directory. Creating a directory here
> +               will result in creating a hrtimer trigger in the IIO subsystem.
> diff --git a/Documentation/iio/iio_configfs.txt b/Documentation/iio/iio_configfs.txt
> new file mode 100644
> index 0000000..f0add35
> --- /dev/null
> +++ b/Documentation/iio/iio_configfs.txt
> @@ -0,0 +1,93 @@
> +Industrial IIO configfs support
> +
> +1. Overview
> +
> +Configfs is a filesystem-based manager of kernel objects. IIO uses some
> +objects that could be easily configured using configfs (e.g.: devices,
> +triggers).
> +
> +See Documentation/filesystems/configfs/configfs.txt for more information
> +about how configfs works.
> +
> +2. Usage
> +
> +In order to use configfs support in IIO we need to select it at compile
> +time via CONFIG_IIO_CONFIGFS config option.
> +
> +Then, mount the configfs filesystem (usually under /config directory):
> +
> +$ mkdir /config
> +$ mount -t configfs none /config
> +
> +At this point, all default IIO groups will be created and can be accessed
> +under /config/iio. Next chapters will describe available IIO configuration
> +objects.
> +
> +3. Software triggers
> +
> +One of the IIO default configfs groups is the "triggers" group. It is
> +automagically accessible when the configfs is mounted and can be found
> +under /config/iio/triggers.
> +
> +IIO software triggers implementation offers support for creating multiple
> +trigger types. A new trigger type is usually implemented as a separate
> +kernel module following the interface in include/linux/iio/sw_trigger.h:
> +
> +/*
> + * drivers/iio/trigger/iio-trig-sample.c
> + * sample kernel module implementing a new trigger type
> + */
> +#include <linux/iio/sw_trigger.h>
> +
> +
> +static struct iio_sw_trigger *iio_trig_sample_probe(const char *name)
> +{
> +       /*
> +        * This allocates and registers an IIO trigger plus other
> +        * trigger type specific initialization.
> +        */
> +}
> +
> +static int iio_trig_hrtimer_remove(struct iio_sw_trigger *swt)
> +{
> +       /*
> +        * This undoes the actions in iio_trig_sample_probe
> +        */
> +}
> +
> +static const struct iio_sw_trigger_ops iio_trig_sample_ops = {
> +       .probe          = iio_trig_sample_probe,
> +       .remove         = iio_trig_sample_remove,
> +};
> +
> +static struct iio_sw_trigger_type iio_trig_sample = {
> +       .name = "trig-sample",
> +       .owner = THIS_MODULE,
> +       .ops = &iio_trig_sample_ops,
> +};
> +
> +module_iio_sw_trigger_driver(iio_trig_sample);
> +
> +Each trigger type has its own directory under /config/iio/triggers. Loading
> +iio-trig-sample module will create 'trig-sample' trigger type directory
> +/config/iio/triggers/trig-sample.
> +
> +We support the following interrupt sources (trigger types):
> +       * hrtimer, uses high resolution timers as interrupt source
> +
> +3.1 Hrtimer triggers creation and destruction
> +
> +Loading iio-trig-hrtimer module will register hrtimer trigger types allowing
> +users to create hrtimer triggers under /config/iio/triggers/hrtimer.
> +
> +e.g:
> +
> +$ mkdir /config/triggers/hrtimer/instance1
> +$ rmdir /config/triggers/hrtimer/instance1
> +
> +Each trigger can have one or more attributes specific to the trigger type.
> +
> +3.2 "hrtimer" trigger types attributes
> +
> +"hrtimer" trigger type doesn't have any configurable attribute from /config dir.
> +It does introduce the sampling_frequency attribute to trigger directory.
> --
> 1.9.1
>
> --
> 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-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [prev] | [next] | [standalone]

#1272336

On 18/11/2015 16:38, Crt Mori wrote:
> This has my acked-by, yet it is missing a commit message? Can we get that
> and the removed From: as I think this is a new patch and not resend of Daniel's?
> Also it would need your signed-off-by in that case

You've lost me: I think the commit message is the brief line only.
The patch is as-is from Daniel's series.

Cheers,
M.


>
> On 18 November 2015 at 15:38, Marc Titinger <mtitinger@baylibre.com> wrote:
>> From: Daniel Baluta <daniel.baluta@intel.com>
>>
>> Signed-off-by: Daniel Baluta <daniel.baluta@intel.com>
>> Acked-by: Crt Mori <cmo@melexis.com>
>> ---
>>   Documentation/ABI/testing/configfs-iio | 21 ++++++++
>>   Documentation/iio/iio_configfs.txt     | 93 ++++++++++++++++++++++++++++++++++
>>   2 files changed, 114 insertions(+)
>>   create mode 100644 Documentation/ABI/testing/configfs-iio
>>   create mode 100644 Documentation/iio/iio_configfs.txt

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [prev] | [next] | [standalone]

#1272347

On Wed, Nov 18, 2015 at 6:06 PM, Marc Titinger <mtitinger@baylibre.com> wrote:
> On 18/11/2015 16:38, Crt Mori wrote:
>>
>> This has my acked-by, yet it is missing a commit message? Can we get that
>> and the removed From: as I think this is a new patch and not resend of
>> Daniel's?
>> Also it would need your signed-off-by in that case
>
>
> You've lost me: I think the commit message is the brief line only.
> The patch is as-is from Daniel's series.

Hi Marc, Crt,

Configfs patches should soon be merged into linux-next tree, so there is
no need for them to be resent here.

Not sure how/when/where they'll be pulled back to linux-iio tree.

Daniel.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [prev] | [next] | [standalone]

#1272405

On 18 November 2015 16:15:57 GMT+00:00, Daniel Baluta <daniel.baluta@intel.com> wrote:
>On Wed, Nov 18, 2015 at 6:06 PM, Marc Titinger <mtitinger@baylibre.com>
>wrote:
>> On 18/11/2015 16:38, Crt Mori wrote:
>>>
>>> This has my acked-by, yet it is missing a commit message? Can we get
>that
>>> and the removed From: as I think this is a new patch and not resend
>of
>>> Daniel's?
>>> Also it would need your signed-off-by in that case
>>
>>
>> You've lost me: I think the commit message is the brief line only.
>> The patch is as-is from Daniel's series.
>
>Hi Marc, Crt,
>
>Configfs patches should soon be merged into linux-next tree, so there
>is
>no need for them to be resent here.
>
>Not sure how/when/where they'll be pulled back to linux-iio tree.
>
>Daniel.
It got a little complex as Christoph wanted the configfs change to hit
 mainline asap.

Andrew Morton will be sending Linus the change to configfs sometime in the next
 week. The other patches might show in Linux next after that via Andrew's tree.
Once I fast forward to a version of Greg's
 tree which has picked up the configfs change I will apply the patches to the IIO
 tree and send Greg a pull request sharpish to get them into Linux next.
 Andrew will then drop them from his tree and all will be lined up for the next merge
 window.

Simple :)

At a guess we are talking 2 to 3 weeks, maybe more, unfortunately but we'll
 before the next merge window.

Jonathan
-- 
Sent from my Android device with K-9 Mail. Please excuse my brevity.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web