From mboxrd@z Thu Jan 1 00:00:00 1970 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=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,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 6326FC56201 for ; Thu, 19 Nov 2020 17:58:56 +0000 (UTC) Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (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 9F63522202 for ; Thu, 19 Nov 2020 17:58:55 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="SPWvYU2D" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 9F63522202 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=openbmc-bounces+openbmc=archiver.kernel.org@lists.ozlabs.org Received: from bilbo.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 4CcS994gjHzDqrm for ; Fri, 20 Nov 2020 04:58:53 +1100 (AEDT) Authentication-Results: lists.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=gmail.com (client-ip=2607:f8b0:4864:20::441; helo=mail-pf1-x441.google.com; envelope-from=rentao.bupt@gmail.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: lists.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=SPWvYU2D; dkim-atps=neutral Received: from mail-pf1-x441.google.com (mail-pf1-x441.google.com [IPv6:2607:f8b0:4864:20::441]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 4CcS380XQ1zDqcH for ; Fri, 20 Nov 2020 04:53:39 +1100 (AEDT) Received: by mail-pf1-x441.google.com with SMTP id b63so5185168pfg.12 for ; Thu, 19 Nov 2020 09:53:39 -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=ohg0oJ87lTSLWpA2Zkajq7Ec19JHlvcX3mrDjoh7A+4=; b=SPWvYU2D1eVcQ+2w65iVGl6q6+jVTpgUw6pDny2n4jrNj7rmt3cUTzZiIQ99HHK91C q+2dl9IfxOD/LVL6WfRkI2e7KZ8wFVljPXrACM2voGt0m4glw3em/VZu66t+BIdIUbfW aZmUNft6r0lH7XxXvNy3S4L7eqYhsdMoORwW8SsYoleoy/7q/gvqK//hBvZJ1PVE3gFy maAy+n2BY4tu+F7gDVvi9VKKpybuRpmL3J0qI1IG+gDe/mgneH+BgmwBijiidvvDxX8X ooJYQ9RB8YXOsl+KMtDuqaca3OMQq86YVCuVafECchW+A+E4Q9pkqM3q6LFXiTk8LFRM bVGQ== 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=ohg0oJ87lTSLWpA2Zkajq7Ec19JHlvcX3mrDjoh7A+4=; b=RpbiqsqnLmmdER1ns2h0XgkHRRfp9RkL7Bdp9EOY74GRc6O3Oq3989egwfB5aZm2Tx ASU6Hw3vB361z1CThUvvpQB2p6BvQ+Abm425QsX5GaUHed3NCeVMkP/qqMR1IKrtHTmR BgxcgQ0E5CepSALLkEofJWZ9WTPLBPNjJq0SrMqY7RJvzNbSDz5Hpv+SwkrWeKoKxVUW TWRcW8TQuwazTdWY7en7NxAOnBAnsYKVahHLur6DmFWyO6c/nfqTd/eOZxFro0fZ5bL/ sUCCZGKvQiwiZ9K14PtwZJ2uc06fC8dihuXGoSCQEr3Rtj/ndhG+xMtekaRO919d9FUW VDZw== X-Gm-Message-State: AOAM530yNzVBPBEBUlk0BA0fije9xKRF3H/X1NfgyZADkJUd2UrDLRTB M7jkLQGvZPMSMmstRvWZQvc= X-Google-Smtp-Source: ABdhPJyBohN3X1dbPoB5yZrMXkCYfOLlvE8+V0Q6voVdgLbu5TjNEaqQp2A9zwKfkl3gKwtJJ1Uc0g== X-Received: by 2002:a17:90a:940f:: with SMTP id r15mr5639577pjo.219.1605808416714; Thu, 19 Nov 2020 09:53:36 -0800 (PST) Received: from taoren-ubuntu-R90MNF91.thefacebook.com (c-73-252-146-110.hsd1.ca.comcast.net. [73.252.146.110]) by smtp.gmail.com with ESMTPSA id 144sm482858pfb.71.2020.11.19.09.53.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 19 Nov 2020 09:53:36 -0800 (PST) From: rentao.bupt@gmail.com To: Jean Delvare , Guenter Roeck , Jonathan Corbet , linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, openbmc@lists.ozlabs.org, taoren@fb.com, mikechoi@fb.com Subject: [PATCH v3 2/2] docs: hwmon: Document max127 driver Date: Thu, 19 Nov 2020 09:53:24 -0800 Message-Id: <20201119175324.22472-3-rentao.bupt@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20201119175324.22472-1-rentao.bupt@gmail.com> References: <20201119175324.22472-1-rentao.bupt@gmail.com> X-BeenThere: openbmc@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development list for OpenBMC List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tao Ren Errors-To: openbmc-bounces+openbmc=archiver.kernel.org@lists.ozlabs.org Sender: "openbmc" From: Tao Ren Add documentation for the max127 hardware monitoring driver. Signed-off-by: Tao Ren --- Changes in v3: - no code change. xdp maintainers were removed from to/cc list. Changes in v2: - add more description for min/max sysfs nodes. - convert values from volt to millivolt in the document. Documentation/hwmon/index.rst | 1 + Documentation/hwmon/max127.rst | 45 ++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 Documentation/hwmon/max127.rst diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst index 408760d13813..0a07b6000c20 100644 --- a/Documentation/hwmon/index.rst +++ b/Documentation/hwmon/index.rst @@ -111,6 +111,7 @@ Hardware Monitoring Kernel Drivers ltc4245 ltc4260 ltc4261 + max127 max16064 max16065 max1619 diff --git a/Documentation/hwmon/max127.rst b/Documentation/hwmon/max127.rst new file mode 100644 index 000000000000..dc192dd9c37c --- /dev/null +++ b/Documentation/hwmon/max127.rst @@ -0,0 +1,45 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Kernel driver max127 +==================== + +Author: + + * Tao Ren + +Supported chips: + + * Maxim MAX127 + + Prefix: 'max127' + + Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX127-MAX128.pdf + +Description +----------- + +The MAX127 is a multirange, 12-bit data acquisition system (DAS) providing +8 analog input channels that are independently software programmable for +a variety of ranges. The available ranges are {0,5V}, {0,10V}, {-5,5V} +and {-10,10V}. + +The MAX127 features a 2-wire, I2C-compatible serial interface that allows +communication among multiple devices using SDA and SCL lines. + +Sysfs interface +--------------- + + ============== ============================================================== + in[0-7]_input The input voltage (in mV) of the corresponding channel. + RO + + in[0-7]_min The lower input limit (in mV) for the corresponding channel. + ADC range and LSB will be updated when the limit is changed. + For the MAX127, it will be adjusted to -10000, -5000, or 0. + RW + + in[0-7]_max The higher input limit (in mV) for the corresponding channel. + ADC range and LSB will be updated when the limit is changed. + For the MAX127, it will be adjusted to 0, 5000, or 10000. + RW + ============== ============================================================== -- 2.17.1