Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932414AbbEHNcE (ORCPT ); Fri, 8 May 2015 09:32:04 -0400 Received: from mga01.intel.com ([192.55.52.88]:18329 "EHLO mga01.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753562AbbEHNcA (ORCPT ); Fri, 8 May 2015 09:32:00 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.13,391,1427785200"; d="scan'208";a="707280449" From: Daniel Baluta To: jic23@kernel.org Cc: lars@metafoo.de, jlbec@evilplan.org, knaack.h@gmx.de, linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org, octavian.purdila@intel.com, pebolle@tiscali.nl, patrick.porlan@intel.com, adriana.reus@intel.com, constantin.musca@intel.com, marten@intuitiveaerial.com, daniel.baluta@intel.com Subject: [PATCH v6 4/4] iio: Documentation: Add IIO configfs documentation Date: Fri, 8 May 2015 16:33:45 +0300 Message-Id: <1431092025-14355-5-git-send-email-daniel.baluta@intel.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1431092025-14355-1-git-send-email-daniel.baluta@intel.com> References: <1431092025-14355-1-git-send-email-daniel.baluta@intel.com> Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 3418 Lines: 106 Signed-off-by: Daniel Baluta --- Documentation/ABI/testing/configfs-iio | 20 ++++++++++++ Documentation/iio/iio_configfs.txt | 58 ++++++++++++++++++++++++++++++++++ 2 files changed, 78 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..28ad893 --- /dev/null +++ b/Documentation/ABI/testing/configfs-iio @@ -0,0 +1,20 @@ +What: /config/iio +Date: May 2015 +KernelVersion: 4.2 +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: May 2015 +KernelVersion: 4.2 +Description: + Industrial IO software triggers directory. + +What: /config/iio/triggers/hrtimer-name +Date: May 2015 +KernelVersion: 4.2 +Description: + High resolution timer instance. diff --git a/Documentation/iio/iio_configfs.txt b/Documentation/iio/iio_configfs.txt new file mode 100644 index 0000000..3c8014a --- /dev/null +++ b/Documentation/iio/iio_configfs.txt @@ -0,0 +1,58 @@ +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" groups. It is +automagically accessible when the configfs is mounted and can be found +under /config/iio/triggers. + +Software triggers are created under /config/iio/triggers directory. A sofware +trigger name MUST be of the following form: + * -: +Where: + * , specifies the interrupt source (e.g: hrtimer) + * , spefcifies the IIO device trigger name + +We support now to following interrupt sources (trigger types): + * hrtimer, uses high resolution timers as interrupt source + +3.1 Software triggers creation and destruction + +As simply as: + +$ mkdir /config/triggers/- +$ rmdir /config/triggers/- +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/