From patchwork Fri Feb 12 12:13:24 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: William Breathitt Gray X-Patchwork-Id: 12085129 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.7 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_SIGNED,DKIM_VALID,FREEMAIL_FORGED_FROMDOMAIN, FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_NONE,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 673F8C433DB for ; Fri, 12 Feb 2021 12:15:41 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id EABA064E2A for ; Fri, 12 Feb 2021 12:15:40 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org EABA064E2A Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:To:From: Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender :Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References:List-Owner; bh=+R5iQInmboBJXpMul5nXCPr0JvlYsC3wdhxr5mjiSls=; b=lX0XMpNguwyKupJEvWJK4o9vpQ k35EDxzMk6oVG2CHJFgeIDUdvR5ypicCt05TZl/wgQ/ZyVuW6RpzbKUsFWR+yy37GP3qEYoYUthS9 uTzcRYOZVij+Hfw2CXo2r3TWSilQbA9i04zhpthW5pzQlu0h4h6xDKfXoRkJ5jnmyHCN1xTFCaxtM Md1c9U4VvMTFWGr1rhxUjlH1Xryw4JHKew/fBEWc0ZA3F9GBOeEzYIbQVM+/50s2ZA5h5EmmsryLb oScjDRFFwTedtzEcsZoH8wLfH4CAmL8R/Ko9ytrZkT2xPJLZn4M5i4NWQbRW9D5PhMFIj5RhKrtfd SNzimLeg==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1lAXKw-0006Bv-DA; Fri, 12 Feb 2021 12:14:14 +0000 Received: from mail-qk1-x72f.google.com ([2607:f8b0:4864:20::72f]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1lAXKr-0006A0-HH for linux-arm-kernel@lists.infradead.org; Fri, 12 Feb 2021 12:14:11 +0000 Received: by mail-qk1-x72f.google.com with SMTP id t62so1883766qke.7 for ; Fri, 12 Feb 2021 04:14:00 -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:mime-version :content-transfer-encoding; bh=y4yEGF4AjXqnem5hKAuSPNf/U7YlqelstXtmTJWlhNI=; b=qeeJfbvFVl0h81JpFKFxtmMRQ10eHisgwd45W2GG7TM5yHTLOyZPV9gOdv7Mv2l2yg pnERECp342fv8J1aHQyL4PhoC9KoGNxukiqQR0YhWdjel+xmI8dPmMKImwLQywj1XEkv vW6lPFhEJl9q2mrvbwdJEiEajB1D6Tj47Jz2BMeEeJtpvK/y8fSYGYBuXBd6GlaN2mWa 2FMS2PQ+RSVavlXbBe+3QoPnzo7LGbyUGlf+u/9CSg/hY+ahHf2K5dD7q/+UBCDu/0kY N28fGB8xikKFjZWZfLxL7UnZKHDQ8X0ms9BM1JByMIxCgFIbDSvxhX3osq70Y/+XRhg4 7IYg== 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:mime-version :content-transfer-encoding; bh=y4yEGF4AjXqnem5hKAuSPNf/U7YlqelstXtmTJWlhNI=; b=bTF7z0K87uUqEM/oysDRAato7q/j8r4dk7bDn5/O3+nwS93VBGFmOOmR4AZicfmnQQ T6SNN6fp4PPytE0XR/Ox5b8waRvVzuWkGjlmjaTMIM/IEfviJnD6isEnvalpIAVi6m0w 9kke3d1iioJJ1HmVkpC55i2GcSaYy9qP0Ln0eHnnwzi2IBjtCbVl0EIMmPZQdRlFm1QL jPYXESMhCQjhqnvzeKDzghPerVCFFDfHuMLti9uEeuV2xBDnp2Kaamqtaz5qbx6PfnLD 65nHWiabt6ikOlRDiwN9yiOD7Wivzr6K0MVtrWuVSoJM/IXMHek18szsR7rQ0a1Tso4N ez8A== X-Gm-Message-State: AOAM533qzrIBkAYhKUoFPAagV0aiBa3IL/LsIVdpPjq6bKK6sTKqi73/ xYQFZzPCxukKmK+QYVtu8rY= X-Google-Smtp-Source: ABdhPJxFsiQwibCIY/jzrkMEOjGRvL/Umh2DVWmeMRwmBlG0UpNjfOXTGn7C2OIHJu2eh2qGMrCXXA== X-Received: by 2002:a37:992:: with SMTP id 140mr2317435qkj.349.1613132039638; Fri, 12 Feb 2021 04:13:59 -0800 (PST) Received: from localhost.localdomain ([193.27.12.132]) by smtp.gmail.com with ESMTPSA id y135sm6278534qkb.14.2021.02.12.04.13.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Feb 2021 04:13:59 -0800 (PST) From: William Breathitt Gray To: jic23@kernel.org Subject: [PATCH v8 00/22] Introduce the Counter character device interface Date: Fri, 12 Feb 2021 21:13:24 +0900 Message-Id: X-Mailer: git-send-email 2.30.0 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210212_071409_673842_91D49BF9 X-CRM114-Status: GOOD ( 17.30 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kamel.bouhara@bootlin.com, gwendal@chromium.org, a.fatoum@pengutronix.de, david@lechnology.com, linux-iio@vger.kernel.org, patrick.havelange@essensium.com, alexandre.belloni@bootlin.com, mcoquelin.stm32@gmail.com, linux-kernel@vger.kernel.org, o.rempel@pengutronix.de, kernel@pengutronix.de, William Breathitt Gray , fabrice.gasnier@st.com, syednwaris@gmail.com, linux-stm32@st-md-mailman.stormreply.com, linux-arm-kernel@lists.infradead.org, alexandre.torgue@st.com Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Changes in v8: - Consolidated Counter sysfs ABI documentation to single file - Added events_queue_size sysfs attribute to allow users to dynamically resize the events queue - Fixed markup syntax and typos in generic-counter.rst - Improved documentation in include/uapi/linux/counter.h and friends - Renamed COUNTER_LOAD_WATCHES_IOCTL to COUNTER_ENABLE_EVENTS_IOCTL; Renamed COUNTER_CLEAR_WATCHES_IOCTL to COUNTER_DISABLE_EVENTS_IOCTL - Renamed the struct counter_event "errno" member to "status" - Dropped the "irq_trigger" 104-QUAD-8 sysfs attribute; this functionality now occurs implicitly via the Counter chrdev interface - Return -ERANGE where appropriate instead of -EINVAL - Simplified switch exit paths; return early when possible - Call devm_request_irq() before devm_counter_register() for 104-quad-8 - Renamed devm_counter_unregister() to more apt devm_counter_release() - Use enum counter_scope for scope values in counter-sysfs.c - Use sysfs_emit() instead of sprintf() where appropriate - Renamed find_in_string_array() to more apt counter_find_enum() - Renamed *_action_get() and *_action_write() to *_action_read() and *_action_write() to match new naming convention of Counter callbacks - Use "Counter function" naming convention instead of "Counter count function" to avoid confusion about scope I pulled out a lot of bits and pieces to their own patches; hopefully that makes reviewing this patchset much simpler than before. This patchset is also available on my personal public git repo for anyone who wants a quick way to clone: https://gitlab.com/vilhelmgray/iio/-/tree/counter_chrdev_v8 The patches preceding "counter: Internalize sysfs interface code" are primarily cleanup and fixes that can be picked up and applied now to the IIO tree if so desired. The "counter: Internalize sysfs interface code" patch as well may be considered for pickup because it is relatively safe and makes no changes to the userspace interface. To summarize the main points of this patchset: there are no changes to the existing Counter sysfs userspace interface; a Counter character device interface is introduced that allows Counter events and associated data to be read() by userspace; the events_configure() and watch_validate() driver callbacks are introduced to support Counter events; and IRQ support is added to the 104-QUAD-8 driver, serving as an example of how to support the new Counter events functionality. Something that should still be discussed: should the struct counter_event "status" member be 8 bits or 32 bits wide? This member will provide the return status (system error number) of an event operation. William Breathitt Gray (22): docs: counter: Consolidate Counter sysfs attributes documentation docs: counter: Fix spelling counter: 104-quad-8: Return error when invalid mode during ceiling_write counter: 104-quad-8: Annotate hardware config module parameter counter: 104-quad-8: Add const qualifiers for quad8_preset_register_set counter: 104-quad-8: Add const qualifier for functions_list array counter: 104-quad-8: Add const qualifier for actions_list array counter: ftm-quaddec: Add const qualifier for actions_list array counter: Return error code on invalid modes counter: Standardize to ERANGE for limit exceeded errors counter: Rename counter_signal_value to counter_signal_level counter: Rename counter_count_function to counter_function counter: Internalize sysfs interface code counter: Update counter.h comments to reflect sysfs internalization docs: counter: Update to reflect sysfs internalization counter: Move counter enums to uapi header counter: Add character device interface docs: counter: Document character device interface counter: Implement extension*_name sysfs attributes counter: Implement events_queue_size sysfs attribute counter: 104-quad-8: Replace mutex with spinlock counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 Documentation/ABI/testing/sysfs-bus-counter | 100 +- .../ABI/testing/sysfs-bus-counter-104-quad-8 | 61 - .../ABI/testing/sysfs-bus-counter-ftm-quaddec | 16 - Documentation/driver-api/generic-counter.rst | 426 ++++- .../userspace-api/ioctl/ioctl-number.rst | 1 + MAINTAINERS | 6 +- drivers/counter/104-quad-8.c | 751 +++++---- drivers/counter/Kconfig | 6 +- drivers/counter/Makefile | 1 + drivers/counter/counter-chrdev.c | 519 ++++++ drivers/counter/counter-chrdev.h | 18 + drivers/counter/counter-core.c | 185 ++ drivers/counter/counter-sysfs.c | 889 ++++++++++ drivers/counter/counter-sysfs.h | 13 + drivers/counter/counter.c | 1496 ----------------- drivers/counter/ftm-quaddec.c | 69 +- drivers/counter/microchip-tcb-capture.c | 105 +- drivers/counter/stm32-lptimer-cnt.c | 186 +- drivers/counter/stm32-timer-cnt.c | 187 +-- drivers/counter/ti-eqep.c | 226 ++- include/linux/counter.h | 716 ++++---- include/linux/counter_enum.h | 45 - include/uapi/linux/counter.h | 126 ++ 23 files changed, 3363 insertions(+), 2785 deletions(-) delete mode 100644 Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 delete mode 100644 Documentation/ABI/testing/sysfs-bus-counter-ftm-quaddec create mode 100644 drivers/counter/counter-chrdev.c create mode 100644 drivers/counter/counter-chrdev.h create mode 100644 drivers/counter/counter-core.c create mode 100644 drivers/counter/counter-sysfs.c create mode 100644 drivers/counter/counter-sysfs.h delete mode 100644 drivers/counter/counter.c delete mode 100644 include/linux/counter_enum.h create mode 100644 include/uapi/linux/counter.h base-commit: b72d4f6a5122a78941ce5a3147685d6a44939a75 Reviewed-by: David Lechner Tested-by: David Lechner