From patchwork Sun Jun 26 16:55:08 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Cameron X-Patchwork-Id: 12895803 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CAE71CCA480 for ; Sun, 26 Jun 2022 16:45:56 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231652AbiFZQpz (ORCPT ); Sun, 26 Jun 2022 12:45:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51652 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231642AbiFZQpw (ORCPT ); Sun, 26 Jun 2022 12:45:52 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [IPv6:2604:1380:4601:e00::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 65992DFBE for ; Sun, 26 Jun 2022 09:45:50 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id 23CA3B80D39 for ; Sun, 26 Jun 2022 16:45:49 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 56A2DC341CB; Sun, 26 Jun 2022 16:45:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1656261947; bh=QQL2KzFC3RhSW4JT0GruPu+IOICbC8UOR45TlYI79rQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Q/tR+q6jodlsKK52Jmxem+7IpS5BRqSKtf3J2fhbl2t9ZM+je1IWYnySgSeN536mD mMHVlVbe3YRWHD9CZdcW9VVqqxKAMlWNxSpf1fpj/iGMThLMRvz/ZrE9dOVdKC0Uqc gHLReJG+pNzYcsLsvXHwmSTZl2/RkLUXbHAsUYRvR1bWeqc3GGdtAX/DPjBOh9SZ87 JEzGnSqZAdLyMtEYWjavoiOk6PzW86QizjASTex/xmY8IwUbbRaqote0lFVieWFdwK URZAlbhin3MPk6A6oiChzyUaUaVsMA/Ev+2d+RUts30tjL1Odlt8qzi+NSHEAf3BT+ devCnqxkcjoJg== From: Jonathan Cameron To: linux-iio@vger.kernel.org Cc: Mauro Carvalho Chehab , Jonathan Cameron , Navin Sankar Velliangiri , Paresh Chaudhary Subject: [PATCH 1/4] iio: ABI: temperature: Unify documentation for thermocouple fault detection. Date: Sun, 26 Jun 2022 17:55:08 +0100 Message-Id: <20220626165511.602202-2-jic23@kernel.org> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220626165511.602202-1-jic23@kernel.org> References: <20220626165511.602202-1-jic23@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org From: Jonathan Cameron The kernel build docs do not support having multiple definitions for the same sysfs filename. Hence generalize the documentation a little and pull it out of device specific files and into sysfs-bus-iio-thermocouple These may well be more general and need pulling into a more generic file in the future, but we can do that when it is needed. Signed-off-by: Jonathan Cameron Cc: Navin Sankar Velliangiri Cc: Paresh Chaudhary Reviewed-by: Mauro Carvalho Chehab --- .../sysfs-bus-iio-temperature-max31856 | 31 ------------------- .../sysfs-bus-iio-temperature-max31865 | 12 ------- .../ABI/testing/sysfs-bus-iio-thermocouple | 18 +++++++++++ 3 files changed, 18 insertions(+), 43 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856 b/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856 deleted file mode 100644 index e5ef6d8e5da1..000000000000 --- a/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856 +++ /dev/null @@ -1,31 +0,0 @@ -What: /sys/bus/iio/devices/iio:deviceX/fault_oc -KernelVersion: 5.1 -Contact: linux-iio@vger.kernel.org -Description: - Open-circuit fault. The detection of open-circuit faults, - such as those caused by broken thermocouple wires. - Reading returns either '1' or '0'. - - === ======================================================= - '1' An open circuit such as broken thermocouple wires - has been detected. - '0' No open circuit or broken thermocouple wires are detected - === ======================================================= - -What: /sys/bus/iio/devices/iio:deviceX/fault_ovuv -KernelVersion: 5.1 -Contact: linux-iio@vger.kernel.org -Description: - Overvoltage or Undervoltage Input Fault. The internal circuitry - is protected from excessive voltages applied to the thermocouple - cables by integrated MOSFETs at the T+ and T- inputs, and the - BIAS output. These MOSFETs turn off when the input voltage is - negative or greater than VDD. - - Reading returns either '1' or '0'. - - === ======================================================= - '1' The input voltage is negative or greater than VDD. - '0' The input voltage is positive and less than VDD (normal - state). - === ======================================================= diff --git a/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865 b/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865 index 4b072da92218..349089e4f2d6 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865 +++ b/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865 @@ -1,15 +1,3 @@ -What: /sys/bus/iio/devices/iio:deviceX/fault_ovuv -KernelVersion: 5.11 -Contact: linux-iio@vger.kernel.org -Description: - Overvoltage or Undervoltage Input fault. The internal circuitry - is protected from excessive voltages applied to the thermocouple - cables at FORCE+, FORCE2, RTDIN+ & RTDIN-. This circuitry turn - off when the input voltage is negative or greater than VDD. - - Reading returns '1' if input voltage is negative or greater - than VDD, otherwise '0'. - What: /sys/bus/iio/devices/iio:deviceX/in_filter_notch_center_frequency KernelVersion: 5.11 Contact: linux-iio@vger.kernel.org diff --git a/Documentation/ABI/testing/sysfs-bus-iio-thermocouple b/Documentation/ABI/testing/sysfs-bus-iio-thermocouple new file mode 100644 index 000000000000..01259df297ca --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-thermocouple @@ -0,0 +1,18 @@ +What: /sys/bus/iio/devices/iio:deviceX/fault_ovuv +KernelVersion: 5.1 +Contact: linux-iio@vger.kernel.org +Description: + Overvoltage or Undervoltage Input Fault. The internal circuitry + is protected from excessive voltages applied to the thermocouple + cables. The device can also detect if such a condition occurs. + + Reading returns '1' if input voltage is negative or greater + than VDD, otherwise '0'. + +What: /sys/bus/iio/devices/iio:deviceX/fault_oc +KernelVersion: 5.1 +Contact: linux-iio@vger.kernel.org +Description: + Open-circuit fault. The detection of open-circuit faults, + such as those caused by broken thermocouple wires. + Reading returns '1' if fault, '0' otherwise. From patchwork Sun Jun 26 16:55:09 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Cameron X-Patchwork-Id: 12895802 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 327E0CCA482 for ; Sun, 26 Jun 2022 16:45:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231642AbiFZQp4 (ORCPT ); Sun, 26 Jun 2022 12:45:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51656 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231648AbiFZQpw (ORCPT ); Sun, 26 Jun 2022 12:45:52 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3B018DFFD for ; Sun, 26 Jun 2022 09:45:51 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 767FC60C48 for ; Sun, 26 Jun 2022 16:45:50 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 95DDCC341C7; Sun, 26 Jun 2022 16:45:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1656261949; bh=nHu7Yp7CZ2tHvUgaPSxmi0PTkqnINCmbbl9RTphOu7E=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=m0ixtDxVSp59vhMPk9TU11Seh3JL6YQW1hV7wAkni4iE4PLiwX1JPwFdi7hHitYSO JuJfxTbF4OTdIo0AqOADwu9GQJG0LknS23v8BFk2K/RLc0IxLhCSzjOMmNX5gDyQbN DhFHRV2HGJ8EZ5naMi2EpoeKWrLrjXI2/NqSPCs8pBKlxkXa1i/JU9vXnHsqzIhzBT XqZKO1EixAj8Dyxp2UGeCgG2OMCKYYgYZojItb4l14x18R1Iiyk5kw9Ej9+571Zv3z D6u81lIovjFLY2eHPIQL5o9US8S3Q2w4SKxIa/jeZm/TA41cJ99qnNzwNxBhgyVo3r z1ybsx+47zF2A== From: Jonathan Cameron To: linux-iio@vger.kernel.org Cc: Mauro Carvalho Chehab , Jonathan Cameron , Navin Sankar Velliangiri Subject: [PATCH 2/4] iio: ABI: max31865: Drop in_filter_notch_centre_frequency as in main docs. Date: Sun, 26 Jun 2022 17:55:09 +0100 Message-Id: <20220626165511.602202-3-jic23@kernel.org> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220626165511.602202-1-jic23@kernel.org> References: <20220626165511.602202-1-jic23@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org From: Jonathan Cameron As this is the last element in the file, also delete the file. Signed-off-by: Jonathan Cameron Cc: Navin Sankar Velliangiri Reviewed-by: Mauro Carvalho Chehab --- .../ABI/testing/sysfs-bus-iio-temperature-max31865 | 8 -------- 1 file changed, 8 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865 b/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865 deleted file mode 100644 index 349089e4f2d6..000000000000 --- a/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865 +++ /dev/null @@ -1,8 +0,0 @@ -What: /sys/bus/iio/devices/iio:deviceX/in_filter_notch_center_frequency -KernelVersion: 5.11 -Contact: linux-iio@vger.kernel.org -Description: - Notch frequency in Hz for a noise rejection filter. Used i.e for - line noise rejection. - - Valid notch filter values are 50 Hz and 60 Hz. From patchwork Sun Jun 26 16:55:10 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Cameron X-Patchwork-Id: 12895801 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1A45CCCA47C for ; Sun, 26 Jun 2022 16:45:56 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231689AbiFZQpz (ORCPT ); Sun, 26 Jun 2022 12:45:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51674 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231652AbiFZQpx (ORCPT ); Sun, 26 Jun 2022 12:45:53 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B716BE01E for ; Sun, 26 Jun 2022 09:45:52 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 537BA60C4E for ; Sun, 26 Jun 2022 16:45:52 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 6E3B4C385A2; Sun, 26 Jun 2022 16:45:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1656261951; bh=R8u/rHNKgyxdVEdWnyXjIbILPZqGYc/sVTmiNosoNsk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=hcrgYBYLxZXtOXlD/DyfHNjsM5Dq3Yvtf0SLHBkA8HrP41HMrbbwB3jPg4jiT/fa4 2cvsb1QYl6q/dWKHLqs0A+Rih/IT42AYLhd7aUZkl7ohxEYgrp0wKe6D0q6vquVcK+ O8DxvJ2/fPGcDFUqy74Qo63vObkFMrCPPNuSEau/BHBH4pU9/jpEBITdWxjtjVppuj r/qTZIrWNardJBQLZ91YSHQTCZoeAum6kSEGHjnHgoDLOh18TLwtIiENhgH3g7Ggqx IJmSFjegdxDPqFJDIxee5aznEj/OStS/c1msukpfIyMksMy7iw9prDlz+iAnp5ZcXD BtIAVUyRrfY4g== From: Jonathan Cameron To: linux-iio@vger.kernel.org Cc: Mauro Carvalho Chehab , Jonathan Cameron , Fabrice Gasnier Subject: [PATCH 3/4] iio: ABI: stm32-timer-trigger: Fuse unusual ABI into main doc. Date: Sun, 26 Jun 2022 17:55:10 +0100 Message-Id: <20220626165511.602202-4-jic23@kernel.org> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220626165511.602202-1-jic23@kernel.org> References: <20220626165511.602202-1-jic23@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org From: Jonathan Cameron We can't duplicate the description of sampling_frequency. This device has some unusual requirements which we solved by giving a sampling_frequency of 0 special meaning. As such add a note about this unusual usage to the main documentation. Whilst I don't particularly like this resolution, it is the best I could come up with given earlier discussion on this topic. Link: https://lore.kernel.org/linux-iio/20210315101217.00002c50@Huawei.com/ Signed-off-by: Jonathan Cameron Cc: Fabrice Gasnier Reviewed-by: Mauro Carvalho Chehab --- Documentation/ABI/testing/sysfs-bus-iio | 3 +++ Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 | 8 -------- 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio index 3e00d7f7ee22..e81ba6f5e1c8 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio +++ b/Documentation/ABI/testing/sysfs-bus-iio @@ -107,6 +107,9 @@ Description: relevant directories. If it affects all of the above then it is to be found in the base device directory. + The stm32-timer-trigger has the additional characteristic that + a sampling_frequency of 0 is defined to stop sampling. + What: /sys/bus/iio/devices/iio:deviceX/sampling_frequency_available What: /sys/bus/iio/devices/iio:deviceX/in_intensity_sampling_frequency_available What: /sys/bus/iio/devices/iio:deviceX/in_proximity_sampling_frequency_available diff --git a/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 b/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 index c4a4497c249a..05074c4a65e2 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 +++ b/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 @@ -90,14 +90,6 @@ Description: Reading returns the current master modes. Writing set the master mode -What: /sys/bus/iio/devices/triggerX/sampling_frequency -KernelVersion: 4.11 -Contact: benjamin.gaignard@st.com -Description: - Reading returns the current sampling frequency. - Writing an value different of 0 set and start sampling. - Writing 0 stop sampling. - What: /sys/bus/iio/devices/iio:deviceX/in_count0_preset KernelVersion: 4.12 Contact: benjamin.gaignard@st.com From patchwork Sun Jun 26 16:55:11 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Cameron X-Patchwork-Id: 12895804 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9A583CCA481 for ; Sun, 26 Jun 2022 16:45:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231605AbiFZQp5 (ORCPT ); Sun, 26 Jun 2022 12:45:57 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51700 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231753AbiFZQp4 (ORCPT ); Sun, 26 Jun 2022 12:45:56 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [IPv6:2604:1380:4601:e00::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DC44DD11A for ; Sun, 26 Jun 2022 09:45:55 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id 9BF24B80D38 for ; Sun, 26 Jun 2022 16:45:54 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 2ED48C385A9; Sun, 26 Jun 2022 16:45:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1656261953; bh=ZY19fXt0aAtMpIahGd5nNw9Oz6qYoxqQ/fP98SnyAzo=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=tgnJFnr4ovWdk4xLxgAzZMvKN6AcFfESye7BRnEjeMarYjg+TnYAx2kLUsBAnUTLO aWfSs0chyBsyhVh2Nt0Zu6YmK7IOdXDYNMGOqGKKegeULbujSC5h8a1XKin//7wAR7 3DByJSDOzb1TEDhjekWBZ3p4IRRxcAb4/FCjTdjZpKzeCRGk/WKyRst98vnVvMKLkr 7OeqHK5BhTbCs+N1F2vPNx+AN0t+7HYUn0t2XtOo9Zx1SsD8BXbb1ACOsU3MMpEMK3 TBzWNnu0cKCp8GvVIRRLcZyXm3BVaHSk88KEOpufL25ikDI47TPpnBH1MrToCEAMGY NRCmbtN9AoJ+A== From: Jonathan Cameron To: linux-iio@vger.kernel.org Cc: Mauro Carvalho Chehab , Jonathan Cameron , Gwendal Grignou Subject: [PATCH 4/4] iio: ABI: sx9324: Squash some formatting to keep scripting happy. Date: Sun, 26 Jun 2022 17:55:11 +0100 Message-Id: <20220626165511.602202-5-jic23@kernel.org> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220626165511.602202-1-jic23@kernel.org> References: <20220626165511.602202-1-jic23@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org From: Jonathan Cameron The indenting added in here to give bullet points is nice to read but unfortunately our docs building scripts trip up on it. make htmldocs gives ../iio/Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: ERROR: Unexpected indentation. So drop the pretty indenting to avoid that error message. Signed-off-by: Jonathan Cameron Cc: Gwendal Grignou --- Documentation/ABI/testing/sysfs-bus-iio-sx9324 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/ABI/testing/sysfs-bus-iio-sx9324 b/Documentation/ABI/testing/sysfs-bus-iio-sx9324 index 632e3321f5a3..9c1e8884a738 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio-sx9324 +++ b/Documentation/ABI/testing/sysfs-bus-iio-sx9324 @@ -8,7 +8,7 @@ Description: + not connected (HZ), + grounded (GD), + connected to an antenna where it can act as a base - (DS - data shield), or measured input (MI). + (DS - data shield), or measured input (MI). The sensor rotates measurement across 4 phases (PH0, PH1, PH2, PH3), where the inputs are configured