From patchwork Thu Dec 14 20:50:58 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: William Breathitt Gray X-Patchwork-Id: 10113285 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 92DB3602B3 for ; Thu, 14 Dec 2017 20:51:23 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 86AD429D34 for ; Thu, 14 Dec 2017 20:51:23 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 7B99529D31; Thu, 14 Dec 2017 20:51:23 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED,FREEMAIL_FROM,RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 1EEBB29D1C for ; Thu, 14 Dec 2017 20:51:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753146AbdLNUvJ (ORCPT ); Thu, 14 Dec 2017 15:51:09 -0500 Received: from mail-yb0-f194.google.com ([209.85.213.194]:37243 "EHLO mail-yb0-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752433AbdLNUvI (ORCPT ); Thu, 14 Dec 2017 15:51:08 -0500 Received: by mail-yb0-f194.google.com with SMTP id 5so4522002ybp.4; Thu, 14 Dec 2017 12:51:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=A/0bPDb6HO+Xy5GfFg4WoIq8c1z5o5ngh+6vPdCW/EA=; b=AUf0CNjyR1kqgPqV8I7yax8kOzCs4lTp7E2eDHY56hhPLDD77w6XOVqo/MiqWnPR4D rCHzZpPTEYicqR7y6ArvizH68nmHhR76CTMQ0cd8bOQA3BcFzqNRValNpfoQwcliqa1X 8574nItnAU/gn719aDV8SobTlonwjgMINQBh9xKXzZavZyyYBLzQz6GybKEgC8bgbfJM iEBPD+kMnGNWJgDUkDW91lp2zsFkteQfd1Ga+utAthhoYpNe8S4XM8slZ7izyjFb/t7e 8crzTkWOlQtyCPO6KQu6ohFz6Tx/uglcgiXu35OnILJRu/aMHBok0nm9oej/HpUdzGwh wQRQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=A/0bPDb6HO+Xy5GfFg4WoIq8c1z5o5ngh+6vPdCW/EA=; b=tjznvhsjUx6ChRDeAfuVjCENNcoHZmC9sV9UjwqsgOS0WnIT3/9Zb/vF6NzBe7UyU0 qR/qYs1ewOMjOuTkwWpo7RZASju8FmJr3LNL05RoE25MJmkC/wRQrEMfZ7UgCHgud3Ah 94tinrhjYY6b6Z8H2MaVr7loiwxPjiprLIAAb+7TcwuOpO/SJYXeULr/mqdJpQgci1WP Rlkky9VyyUG5JmZ64jCGt5cvdoX0QHa2IKYXbw1a4YMezqBj+VY/U0mz3OaSdgKjIn/v oEr1DX1l8BTNgAtOYJvlUn5iCI4WWzmC4zYfynuEuIym5VbVmDK+ZuVR32RfVYIXAdls 4p+A== X-Gm-Message-State: AKGB3mJ3DOfyaiDCOGK1Kgvf3Ffld9NJOtV1qepuVjBSESmnEIt6YYDQ DxQoXiywgnmNkOE713/VH5w= X-Google-Smtp-Source: ACJfBouOdTpsEgSdBOGXQ620CIc3/Idd+GKCF0M7Fn16ge3snRW8wPxF/XsI/ydukj0YISvlAX65zA== X-Received: by 10.37.54.32 with SMTP id d32mr5191441yba.399.1513284667700; Thu, 14 Dec 2017 12:51:07 -0800 (PST) Received: from localhost ([72.188.97.40]) by smtp.gmail.com with ESMTPSA id n1sm1223955ywe.79.2017.12.14.12.51.07 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 14 Dec 2017 12:51:07 -0800 (PST) From: William Breathitt Gray To: jic23@kernel.org, knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net Cc: benjamin.gaignard@linaro.org, linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org, William Breathitt Gray Subject: [PATCH v4 02/11] counter: Documentation: Add Generic Counter sysfs documentation Date: Thu, 14 Dec 2017 15:50:58 -0500 Message-Id: X-Mailer: git-send-email 2.15.1 In-Reply-To: References: Sender: linux-iio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP This patch adds standard documentation for the userspace sysfs attributes of the Generic Counter interface. Signed-off-by: William Breathitt Gray --- .../ABI/testing/sysfs-bus-counter-generic-sysfs | 73 ++++++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 74 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-counter-generic-sysfs diff --git a/Documentation/ABI/testing/sysfs-bus-counter-generic-sysfs b/Documentation/ABI/testing/sysfs-bus-counter-generic-sysfs new file mode 100644 index 000000000000..3b1c3c4498d1 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-counter-generic-sysfs @@ -0,0 +1,73 @@ +What: /sys/bus/counter/devices/counterX/countY +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Count data of Count Y. Typically, this is an accumulated count + value. + +What: /sys/bus/counter/devices/counterX/countY_function +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Count function mode of Count Y; count function evaluation is + triggered by conditions specified by the countY_signalZ_action + attributes. + +What: /sys/bus/counter/devices/counterX/countY_function_available +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Discrete set of available count function modes for the + configuration of the respective Count Y are listed in this file. + +What: /sys/bus/counter/devices/counterX/countY_name +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Read-only attribute that indicates the device-specific name of + Count Y. + +What: /sys/bus/counter/devices/counterX/countY_signalZ_action +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Action mode of Count Y for Signal Z. This attribute indicates + the condition of Signal Z that triggers the count function + evaluation for Count Y. + +What: /sys/bus/counter/devices/counterX/countY_signalZ_action_available +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Discrete set of available action modes are listed in this file + for the configuration of the respective Synapse associating + Signal Z to Count Y. + +What: /sys/bus/counter/devices/counterX/counter_name +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Read-only attribute that indicates the device-specific name of + the Counter. + +What: /sys/bus/counter/devices/counterX/signalY +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Signal data of Signal Y. Typically, this is an input line level + state. + +What: /sys/bus/counter/devices/counterX/signalY_name +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + Read-only attribute that indicates the device-specific name of + Signal Y. + +What: /sys/bus/counter/devices/counterX/countY_synapses +KernelVersion: 4.16 +Contact: linux-iio@vger.kernel.org +Description: + List of Synapses associating Signals to Count Y. The columns + represent the following in the respective order: Signal ID, + Signal name, and current action mode. diff --git a/MAINTAINERS b/MAINTAINERS index 07dd7b933bfa..38da1bc615b3 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3665,6 +3665,7 @@ COUNTER INTERFACE M: William Breathitt Gray L: linux-iio@vger.kernel.org S: Maintained +F: Documentation/ABI/testing/sysfs-bus-counter-* F: drivers/iio/counter/ F: include/linux/iio/counter.h