From patchwork Fri Feb 12 12:13:38 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: 12085183 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_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,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 C4623C433E0 for ; Fri, 12 Feb 2021 12:18:44 +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 356EA64E13 for ; Fri, 12 Feb 2021 12:18:44 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 356EA64E13 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:References:In-Reply-To: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:List-Owner; bh=IhRjmzlBDLo3xEuFFHF2MiiwuwKnI5FFMlv9hGKMmdc=; b=ujVeEktMrZSfcsv3uSLv+39Z1 py2IwxHP0WEVc3LLrG39+mqnuYs6QtYduYA0jobRZI07XuMjr9CASYXcD0v5rs/U99z+hVxBaenEE JSQmbGm3+cQXfMWUUXVmZ4HVCKlaPOoii6Rd9DEErDWWmBwRpUIYiayPhRCja4sG41UOQj8Rhc5Q9 cmJpXTTfrPkrY52Ds25tZUsGtw75GcUefMEQEpL3Ok3d11H+Boj6qhO+8LyRy4An0shMcPpZdSCVX x0tgP4F6lhn4SssovyQcttm7h7JpTj49z3BKu3TRGiFpta9Z1Z13DJVhFtLzT/a3xrzRKE/bwHGqf GV4GPb2Lw==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1lAXNY-0007PF-ID; Fri, 12 Feb 2021 12:16:56 +0000 Received: from mail-qv1-xf2e.google.com ([2607:f8b0:4864:20::f2e]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1lAXM5-0006fS-E2 for linux-arm-kernel@lists.infradead.org; Fri, 12 Feb 2021 12:15:26 +0000 Received: by mail-qv1-xf2e.google.com with SMTP id c25so299716qvb.4 for ; Fri, 12 Feb 2021 04:15:24 -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 :mime-version:content-transfer-encoding; bh=e7Ux/Zv3srwXqY0m4J4Hxv1kQ4CaGDRseKF+KFYaZgA=; b=THdQf51LqiHyTtRwpP/jkZ0pa0fqfnwcRXzewn4oNgW3qv1+1mBTSV56WQaEjAmllJ EGoBNHm9m1+E84oFB6q+pfZFe3nC6J52KfohS373lpqeLfJVRZTHbZ2TszHTHOobf78C XqlDtozKSK71v7VyZVaL8LuXiqYD3jo2CjdpeX5frBu+HZ0KtOlOO4uMXPjOZTmyDY1V Glg8lAh9ZsGfK2LOsmjpVZ1LAzSoUtr092hGKlsUCJO7MBxB9gP6acGOfJKuqTZw3S23 xY5cYG5eOzh8k2z+vAhwF+guALi30rHP16jJURUm42cPaHTFdiaSsVWALyYLr9nxFF5N r/lA== 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:mime-version:content-transfer-encoding; bh=e7Ux/Zv3srwXqY0m4J4Hxv1kQ4CaGDRseKF+KFYaZgA=; b=jz6P+BSm7AA+4L6zl28/Fntj3sJ7HL1OSlyXJgi+lKD7/ogvBSF0Liu5L2XILE4IEw R7DZjjRMrVW/8+XLlMxzS4wa/U9m6T5UPLHBxbcYIfjuQrd+Cz4yvFwUFjE6KGjqEwtE kFt1jD+xei/ofqJ6jst9rZ6gV4ZVy0bEawlyWH/w3zEyVyhkNMvGwd1MprQMSxBjnHQo VBwHIyAC3/P2vZCbpXxCL1DJ0/tE7heuRqG2qC4vKxNOexDcErGdSui8tnQVBW1Ta7JI MAkAYs8Dh2U8zv1KPEJMmOqDeb18dX9UidgOh0TdPx2Lr28lkFviWwiszVG4KNtuTghL RvMA== X-Gm-Message-State: AOAM533GirdLek4ras9BoKhGmZsWZRcy2kkGMmyDzp5OUxa+XAlXsxOo YfhnbOYkElmOjrraoXiZClU= X-Google-Smtp-Source: ABdhPJx0eMmFLBPmmIgWd4x1X0KThwe1Azvkuwb19abvL00i78ODiL5sjd4VVw+ytaTZBmuVhwTgvA== X-Received: by 2002:ad4:55aa:: with SMTP id f10mr2235053qvx.46.1613132122933; Fri, 12 Feb 2021 04:15:22 -0800 (PST) Received: from localhost.localdomain ([193.27.12.132]) by smtp.gmail.com with ESMTPSA id y135sm6278534qkb.14.2021.02.12.04.15.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Feb 2021 04:15:22 -0800 (PST) From: William Breathitt Gray To: jic23@kernel.org Subject: [PATCH v8 14/22] counter: Update counter.h comments to reflect sysfs internalization Date: Fri, 12 Feb 2021 21:13:38 +0900 Message-Id: <514843522c18867ec2bc7b82ba084d5e7cc22381.1613131238.git.vilhelm.gray@gmail.com> X-Mailer: git-send-email 2.30.0 In-Reply-To: References: MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210212_071525_552437_B3754361 X-CRM114-Status: GOOD ( 21.28 ) 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 The Counter subsystem architecture and driver implementations have changed in order to handle Counter sysfs interactions in a more consistent way. This patch updates the Generic Counter interface header file comments to reflect the changes. Signed-off-by: William Breathitt Gray --- drivers/counter/counter-core.c | 3 ++ include/linux/counter.h | 72 +++++++++++++++------------------- 2 files changed, 35 insertions(+), 40 deletions(-) diff --git a/drivers/counter/counter-core.c b/drivers/counter/counter-core.c index 1577a6562cad..bcf672e1fc0d 100644 --- a/drivers/counter/counter-core.c +++ b/drivers/counter/counter-core.c @@ -40,6 +40,9 @@ static struct bus_type counter_bus_type = { * This function registers a Counter to the system. A sysfs "counter" directory * will be created and populated with sysfs attributes correlating with the * Counter Signals, Synapses, and Counts respectively. + * + * RETURNS: + * 0 on success, negative error number on failure. */ int counter_register(struct counter_device *const counter) { diff --git a/include/linux/counter.h b/include/linux/counter.h index 76b0b06dd5db..2f01e1fec857 100644 --- a/include/linux/counter.h +++ b/include/linux/counter.h @@ -188,12 +188,10 @@ struct counter_comp { /** * struct counter_signal - Counter Signal node - * @id: unique ID used to identify signal - * @name: device-specific Signal name; ideally, this should match the name - * as it appears in the datasheet documentation - * @ext: optional array of Counter Signal extensions - * @num_ext: number of Counter Signal extensions specified in @ext - * @priv: optional private data supplied by driver + * @id: unique ID used to identify the Signal + * @name: device-specific Signal name + * @ext: optional array of Signal extensions + * @num_ext: number of Signal extensions specified in @ext */ struct counter_signal { int id; @@ -207,7 +205,7 @@ struct counter_signal { * struct counter_synapse - Counter Synapse node * @actions_list: array of available action modes * @num_actions: number of action modes specified in @actions_list - * @signal: pointer to associated signal + * @signal: pointer to the associated Signal */ struct counter_synapse { const enum counter_synapse_action *actions_list; @@ -218,17 +216,14 @@ struct counter_synapse { /** * struct counter_count - Counter Count node - * @id: unique ID used to identify Count - * @name: device-specific Count name; ideally, this should match - * the name as it appears in the datasheet documentation - * @function: index of current function mode - * @functions_list: array available function modes + * @id: unique ID used to identify the Count + * @name: device-specific Count name + * @functions_list: array of available function modes * @num_functions: number of function modes specified in @functions_list - * @synapses: array of synapses for initialization - * @num_synapses: number of synapses specified in @synapses - * @ext: optional array of Counter Count extensions - * @num_ext: number of Counter Count extensions specified in @ext - * @priv: optional private data supplied by driver + * @synapses: array of Synapses for initialization + * @num_synapses: number of Synapses specified in @synapses + * @ext: optional array of Count extensions + * @num_ext: number of Count extensions specified in @ext */ struct counter_count { int id; @@ -246,29 +241,26 @@ struct counter_count { /** * struct counter_ops - Callbacks from driver - * @signal_read: optional read callback for Signal attribute. The read - * level of the respective Signal should be passed back via - * the level parameter. - * @count_read: optional read callback for Count attribute. The read - * value of the respective Count should be passed back via - * the val parameter. - * @count_write: optional write callback for Count attribute. The write - * value for the respective Count is passed in via the val + * @signal_read: read callback for Signals. The read level of the + * respective Signal should be passed back via the level + * parameter. + * @count_read: read callback for Counts. The read value of the + * respective Count should be passed back via the value * parameter. - * @function_get: function to get the current count function mode. Returns - * 0 on success and negative error code on error. The index - * of the respective Count's returned function mode should - * be passed back via the function parameter. - * @function_set: function to set the count function mode. function is the - * index of the requested function mode from the respective - * Count's functions_list array. - * @action_get: function to get the current action mode. Returns 0 on - * success and negative error code on error. The index of - * the respective Synapse's returned action mode should be - * passed back via the action parameter. - * @action_set: function to set the action mode. action is the index of - * the requested action mode from the respective Synapse's - * actions_list array. + * @count_write: write callback for Counts. The write value for the + * respective Count is passed in via the value parameter. + * @function_read: read callback the Count function modes. The read + * function mode of the respective Count should be passed + * back via the function parameter. + * @function_write: write callback for Count function modes. The function + * mode to write for the respective Count is passed in via + * the function parameter. + * @action_read: read callback the Synapse action modes. The read action + * mode of the respective Synapse should be passed back via + * the action parameter. + * @action_write: write callback for Synapse action modes. The action mode + * to write for the respective Synapse is passed in via the + * action parameter. */ struct counter_ops { int (*signal_read)(struct counter_device *counter, @@ -296,7 +288,7 @@ struct counter_ops { /** * struct counter_device - Counter data structure - * @name: name of the device as it appears in the datasheet + * @name: name of the device * @parent: optional parent device providing the counters * @ops: callbacks from driver * @signals: array of Signals