From patchwork Sat Feb 25 13:56:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matti Vaittinen X-Patchwork-Id: 13152210 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 DF1B7C64EC7 for ; Sat, 25 Feb 2023 13:56:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229470AbjBYN4b (ORCPT ); Sat, 25 Feb 2023 08:56:31 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48398 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229379AbjBYN4a (ORCPT ); Sat, 25 Feb 2023 08:56:30 -0500 Received: from mail-lj1-x233.google.com (mail-lj1-x233.google.com [IPv6:2a00:1450:4864:20::233]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EFDAE13DFB; Sat, 25 Feb 2023 05:56:28 -0800 (PST) Received: by mail-lj1-x233.google.com with SMTP id t14so1890935ljd.5; Sat, 25 Feb 2023 05:56:28 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=q5fi3vMtgShoH3fTT5V+ZWG+/EL8tE3fQZCBLYT0iXQ=; b=KK6mQrLFErLtfpWOVIfKT+MonHolhZkfKMJpKMAitJXdyqK2RkaV5BokmMP45g3am9 I5aIFjuXC44Pecf1/q+WzbhhLYCZWuIXHqc3RANHAi3xor/7xzE546pgp2IulKrG+SLW 3zyhZLML13+TGSITRSB5qs4bLJJyqP7NvlxGd3DCJjxGTSH32DYhaKt07EHwlJ5cX10R c9G1250G/ac9i/G4ayB3Un8cYEPi8pDZeiZsQtoX7zDceQ38r7IB59fDWM66xxTnihl5 teSLhtyTzls8o8vhQNoLzdoVmJgtQ5+J5PkduhsZRxV6WLzoUR7zP1cw4SP94nUmoIy8 0ixA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=q5fi3vMtgShoH3fTT5V+ZWG+/EL8tE3fQZCBLYT0iXQ=; b=oPqsre4SF2nGnlxxsWOexEVPYOz9/NNNlD2rOCRujom/hj5zoR62KZ5PHFjbd/z0yw WK6QHPF5Bd0RTemog7Ik8BNtzbewjwtlppquutgT9I6T3UBTXtnq4wejeuKfcNyMVb+D 26UWChq3nyn9q5f17DVy0i3YTzCb7cBUTKwJZPNXKf6MKlfNRKn1VqBh6PMjmXMEBfJJ QulxYwi2xp/PbfoA9Jglb1Or7tU0vhiZqjThOTsp7/gBIhY9oiPLuzRAR6MQrkXGveqR JJOpBo3dqzwfBFyE8jft9ol9lA/R8czHmcUYnXBzl9Ni0H+KrTalBSr9OJ7KC+SibDPM iqpw== X-Gm-Message-State: AO0yUKUQZQnBCt23TMG0G6hVVLWbPEJiNLPoYciFZbqbxVb37bXvMqNQ 954wnVIfVCSA2UuJ9POyrsiAw4yPgus= X-Google-Smtp-Source: AK7set/xqliacutc76cH3yk/k9WVc5FkgNhq5cmI12K16wEuE0IX0hJTLh5Qyabz7kttgR38X2qKLw== X-Received: by 2002:a2e:888c:0:b0:295:8f08:118b with SMTP id k12-20020a2e888c000000b002958f08118bmr5576580lji.18.1677333387126; Sat, 25 Feb 2023 05:56:27 -0800 (PST) Received: from dc75zzyyyyyyyyyyyyyyt-3.rev.dnainternet.fi (dc75zzyyyyyyyyyyyyyyt-3.rev.dnainternet.fi. [2001:14ba:16f3:4a00::1]) by smtp.gmail.com with ESMTPSA id s6-20020a05651c200600b002934b8d115csm173208ljo.51.2023.02.25.05.56.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 25 Feb 2023 05:56:26 -0800 (PST) Date: Sat, 25 Feb 2023 15:56:16 +0200 From: Matti Vaittinen To: Matti Vaittinen , Matti Vaittinen Cc: Jonathan Cameron , Lars-Peter Clausen , Andrea Merello , Andy Shevchenko , Matti Vaittinen , Jagath Jog J , linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 3/3] doc: Make sysfs-bus-iio doc more exact Message-ID: <41eafb0caa510cddf650cf5ff940639a184f3005.1677331779.git.mazziesaccount@gmail.com> References: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org A few IIC channel descriptions explained used units as: data is in foo "that can be processed into an" [unit] value. The "can be processed into" is quite broad statement as it does not really explain what this processing means. This makes units pretty much useless. After discussion with Jonathan, it seems the units for these channels should also be well-defined as for all other channels. The processing means the standard scale and offset application that is used throughout the IIO. Let's make it more obvious by stating that the units are [unit] after scale ane offset are applied. Signed-off-by: Matti Vaittinen --- Documentation/ABI/testing/sysfs-bus-iio | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio index 6ba34c0d9789..b435c6f065ae 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio +++ b/Documentation/ABI/testing/sysfs-bus-iio @@ -1807,8 +1807,8 @@ What: /sys/bus/iio/devices/iio:deviceX/out_resistanceX_raw KernelVersion: 4.3 Contact: linux-iio@vger.kernel.org Description: - Raw (unscaled no offset etc.) resistance reading that can be processed - into an ohm value. + Raw (unscaled no offset etc.) resistance reading. + Units after application of scale and offset are ohms. What: /sys/bus/iio/devices/iio:deviceX/heater_enable KernelVersion: 4.1.0 @@ -1894,8 +1894,9 @@ What: /sys/bus/iio/devices/iio:deviceX/in_electricalconductivity_raw KernelVersion: 4.8 Contact: linux-iio@vger.kernel.org Description: - Raw (unscaled no offset etc.) electric conductivity reading that - can be processed to siemens per meter. + Raw (unscaled no offset etc.) electric conductivity reading. + Units after application of scale and offset are siemens per + meter. What: /sys/bus/iio/devices/iio:deviceX/in_countY_raw KernelVersion: 4.10 @@ -1952,7 +1953,7 @@ KernelVersion: 4.18 Contact: linux-iio@vger.kernel.org Description: Raw (unscaled) phase difference reading from channel Y - that can be processed to radians. + Units after application of scale and offset are radians. What: /sys/bus/iio/devices/iio:deviceX/in_massconcentration_pm1_input What: /sys/bus/iio/devices/iio:deviceX/in_massconcentrationY_pm1_input