From patchwork Mon Oct 28 23:49:04 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tao Ren X-Patchwork-Id: 11216783 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id A1D75112B for ; Mon, 28 Oct 2019 23:49:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 759A521920 for ; Mon, 28 Oct 2019 23:49:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="jmgrSRXQ" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728704AbfJ1Xt2 (ORCPT ); Mon, 28 Oct 2019 19:49:28 -0400 Received: from mail-pl1-f194.google.com ([209.85.214.194]:42792 "EHLO mail-pl1-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728379AbfJ1Xt0 (ORCPT ); Mon, 28 Oct 2019 19:49:26 -0400 Received: by mail-pl1-f194.google.com with SMTP id c16so6549792plz.9; Mon, 28 Oct 2019 16:49:26 -0700 (PDT) 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=NeObGC1EVOm6spx2L51L+hiPcYQEKVP788D+xQH3iTs=; b=jmgrSRXQFYNKQm1hb2rj6HrFWqHgWaQ39FpQ0UpBcCmGfMxW781W8EHKBZmZpa/JGQ J099MviYtme/JO9ZJyJRpjURYu/lXNzYg4LS4XHB0n0ihf8uzWH6kN6NVxLeCOLGaDiH hXc9xQ+UQqBFzaRovTZkJD2Vucrz4mAJ/DwW0fsBEnFX8IhsNc1TPVRnT03M4fFMQoLv jTJFkoTLYF38ia2JARE2xqu3VP4Mq23QN9wN6SLsHUR+UpwnzeF/bbNAx6nH+n0FWYS2 U982G55vfGV+doZpsXO5pCN4tB/R2dpCpzsws24HnRpFHbEhZZuwb9KUwgFSvEyFq6dY 9oUA== 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=NeObGC1EVOm6spx2L51L+hiPcYQEKVP788D+xQH3iTs=; b=KsMRn/eHEW7jpOhFCQ8e35NFWOIBvM3LaS/vhM7CVNuKhdUOl+xbpJeBpSq34GnsaO QffB1FlUOIYQ9OTy+WJAirn3rhYeLB2KN4BTXzYtInpgH7mJEoxdyDnLr+/RkZUyl4hp vcq+pcZI8xJZccOAdgXm8/xR0U/uyp5e4QIup9/mNNUONDMMGPp5CgG9LOsJmpkbXQet m1GXQ5ecGlTLJpdjt2Mr2kpXe7I/fbsdvfooDKEozmrfxWI9YQ4SP0Qg266xFAe0kL4c Lma2yBmIP6SLBW+YcNG4K0RfHCISTVShcI0xndvNMLfkgBQsrCm4ef8y8yPRL4so3aWx B/Qw== X-Gm-Message-State: APjAAAU3R0kz5d15d/1GIge7eDXPJuhK9/KBBo7AF2ydSoab00KKPhuN IgvwgDrtd0ELqyiHAhKRj1o= X-Google-Smtp-Source: APXvYqyXhcsYcTw+hWCPyqQEdoxc4SNoZS1I6wVveEcHdz3y6Xf26+c4UD09iS+BSoFx40pyATYn4A== X-Received: by 2002:a17:902:a714:: with SMTP id w20mr753018plq.116.1572306565426; Mon, 28 Oct 2019 16:49:25 -0700 (PDT) Received: from taoren-ubuntu-R90MNF91.thefacebook.com ([2620:10d:c090:200::2:c0c7]) by smtp.gmail.com with ESMTPSA id d4sm597119pjs.9.2019.10.28.16.49.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 28 Oct 2019 16:49:24 -0700 (PDT) From: rentao.bupt@gmail.com To: Guenter Roeck , Jean Delvare , Jonathan Corbet , linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, openbmc@lists.ozlabs.org, taoren@fb.com Cc: Tao Ren Subject: [PATCH 3/3] docs: hwmon: Document bel-pfe pmbus driver Date: Mon, 28 Oct 2019 16:49:04 -0700 Message-Id: <20191028234904.12441-4-rentao.bupt@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20191028234904.12441-1-rentao.bupt@gmail.com> References: <20191028234904.12441-1-rentao.bupt@gmail.com> Sender: linux-hwmon-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-hwmon@vger.kernel.org From: Tao Ren Add documentation for bel-pfe pmbus driver which supports BEL PFE1100 and PFE3000 power supplies. Signed-off-by: Tao Ren --- Documentation/hwmon/bel-pfe.rst | 112 ++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 Documentation/hwmon/bel-pfe.rst diff --git a/Documentation/hwmon/bel-pfe.rst b/Documentation/hwmon/bel-pfe.rst new file mode 100644 index 000000000000..4b4a7d67854c --- /dev/null +++ b/Documentation/hwmon/bel-pfe.rst @@ -0,0 +1,112 @@ +Kernel driver bel-pfe +====================== + +Supported chips: + + * BEL PFE1100 + + Prefixes: 'pfe1100' + + Addresses scanned: - + + Datasheet: https://www.belfuse.com/resources/datasheets/powersolutions/ds-bps-pfe1100-12-054xa.pdf + + * BEL PFE3000 + + Prefixes: 'pfe3000' + + Addresses scanned: - + + Datasheet: https://www.belfuse.com/resources/datasheets/powersolutions/ds-bps-pfe3000-series.pdf + +Author: Tao Ren + + +Description +----------- + +This driver supports hardware monitoring for below power supply devices +which support PMBus Protocol: + + * BEL PFE1100 + + 1100 Watt AC to DC power-factor-corrected (PFC) power supply. + PMBus Communication Manual is not publicly available. + + * BEL PFE3000 + + 3000 Watt AC/DC power-factor-corrected (PFC) and DC-DC power supply. + PMBus Communication Manual is not publicly available. + +The driver is a client driver to the core PMBus driver. Please see +Documentation/hwmon/pmbus.rst for details on PMBus client drivers. + + +Usage Notes +----------- + +This driver does not auto-detect devices. You will have to instantiate the +devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for +details. + +Example: the following will load the driver for an PFE3000 at address 0x20 +on I2C bus #1:: + + $ modprobe bel-pfe + $ echo pfe3000 0x20 > /sys/bus/i2c/devices/i2c-1/new_device + + +Platform data support +--------------------- + +The driver supports standard PMBus driver platform data. + + +Sysfs entries +------------- + +======================= ======================================================= +curr1_label "iin" +curr1_input Measured input current +curr1_max Input current max value +curr1_max_alarm Input current max alarm + +curr[2-3]_label "iout[1-2]" +curr[2-3]_input Measured output current +curr[2-3]_max Output current max value +curr[2-3]_max_alarm Output current max alarm + +fan[1-2]_input Fan 1 and 2 speed in RPM +fan1_target Set fan speed reference for both fans + +in1_label "vin" +in1_input Measured input voltage +in1_crit Input voltage critical max value +in1_crit_alarm Input voltage critical max alarm +in1_lcrit Input voltage critical min value +in1_lcrit_alarm Input voltage critical min alarm +in1_max Input voltage max value +in1_max_alarm Input voltage max alarm + +in2_label "vcap" +in2_input Hold up capacitor voltage + +in[3-8]_label "vout[1-3,5-7]" +in[3-8]_input Measured output voltage +in[3-4]_alarm vout[1-2] output voltage alarm + +power[1-2]_label "pin[1-2]" +power[1-2]_input Measured input power +power[1-2]_alarm Input power high alarm + +power[3-4]_label "pout[1-2]" +power[3-4]_input Measured output power + +temp[1-3]_input Measured temperature +temp[1-3]_alarm Temperature alarm +======================= ======================================================= + +.. note:: + + - curr3, fan2, vout[2-7], vcap, pin2, pout2 and temp3 attributes only + exist for PFE3000.