From patchwork Thu Apr 22 09:08:43 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quan Nguyen X-Patchwork-Id: 1469114 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.ozlabs.org (client-ip=2404:9400:2:0:216:3eff:fee1:b9f1; helo=lists.ozlabs.org; envelope-from=linux-aspeed-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=os.amperecomputing.com header.i=@os.amperecomputing.com header.a=rsa-sha256 header.s=selector2 header.b=rB4bDemz; dkim-atps=neutral Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2404:9400:2:0:216:3eff:fee1:b9f1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4FQs9c3K5Tz9sVw for ; Thu, 22 Apr 2021 19:11:32 +1000 (AEST) Received: from boromir.ozlabs.org (localhost [IPv6:::1]) by lists.ozlabs.org (Postfix) with ESMTP id 4FQs9c2VqJz3035 for ; Thu, 22 Apr 2021 19:11:32 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=os.amperecomputing.com header.i=@os.amperecomputing.com header.a=rsa-sha256 header.s=selector2 header.b=rB4bDemz; dkim-atps=neutral X-Original-To: linux-aspeed@lists.ozlabs.org Delivered-To: linux-aspeed@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=os.amperecomputing.com (client-ip=40.107.223.129; helo=nam11-dm6-obe.outbound.protection.outlook.com; envelope-from=quan@os.amperecomputing.com; receiver=) Authentication-Results: lists.ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=os.amperecomputing.com header.i=@os.amperecomputing.com header.a=rsa-sha256 header.s=selector2 header.b=rB4bDemz; dkim-atps=neutral Received: from NAM11-DM6-obe.outbound.protection.outlook.com (mail-dm6nam11on2129.outbound.protection.outlook.com [40.107.223.129]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 4FQs7C3zhDz2yys; Thu, 22 Apr 2021 19:09:27 +1000 (AEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Z6vklRxQoDLUJfuQ7GIp05eBngkBEfFctg2EXadYzw/6zWunkWAnO/pdzWuUDU/Pxh24OZsMGdtYqBf7PuhV4QtcQL3KGgQzlCXAD2u56r1HYUDpxfNiFj9auIdLiw9NGBQtlNcn6UBrtMfYvKey9i18oQPd71loTGFIKhD7BNYEWxm8DItiOmH2uE+rRUYf8WEL7en4bxJHdNN2AualSSOYFJxTfvDZxr1+Eyz7I/q14RXwh3G9UplMC3Ekmt8Gn84lU8KDtLC53QG+8JAmI7k6fNLsVe4wTVFfRk0GFtY84Bvkf53HbwMVjAD836l8Nv3SfddP8/G91Es7ADe2Cg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=jmRWFMCUEMT+cz4GcPH/zDJcrRXlqg8GmLXCr741EyQ=; b=WzzQxFWhAik/V6NtmWycw5QX1cCKvnmTSfTv89sQj3Koo4i+9lnXoesUrAhWcO4D4EgDKIQoXdNAZa29QNrktoaO/lEtXxKXCT71cNzKnQe7ObtyIZJ4Lg3UR2aklcw23Uf3xd/ZrcnN4wIJ6BcljftdYJTnTg5j8+Bmm/pGMqb9EkZzmpBQROk2coV9XH2NWkoZF39pSyF0vSIk6I29BmP4VFGzKSxcJ5xU0uLuRo8hCERSn5ZZuMbEOt2aCm5bbv9ehG8gw40SuahF7SCwiguSI6WGoQVqE6lwVM539MExa+lWcU2yfbpLrm0dQgiowM3lAKcNHysrXbXuTAmXnA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=os.amperecomputing.com; dmarc=pass action=none header.from=os.amperecomputing.com; dkim=pass header.d=os.amperecomputing.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=os.amperecomputing.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=jmRWFMCUEMT+cz4GcPH/zDJcrRXlqg8GmLXCr741EyQ=; b=rB4bDemzBcEz0pmBplkhP4a81ooc80VYvCaeqLyU/aqKxaSWvLum0cJ8upJ6hN7ZPSOI811BGtLD7OhKyRRdtZImj210gboRHJnb70Zjl0IRtMgcUbNeceLsLKyr3dukicuyTWIF7CeWtWE6tTqSR2Q/t/YS0ho5LVgdHIC6t14= Authentication-Results: jms.id.au; dkim=none (message not signed) header.d=none;jms.id.au; dmarc=none action=none header.from=os.amperecomputing.com; Received: from MW2PR0102MB3482.prod.exchangelabs.com (2603:10b6:302:c::32) by MW4PR01MB6356.prod.exchangelabs.com (2603:10b6:303:66::11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4042.16; Thu, 22 Apr 2021 09:09:22 +0000 Received: from MW2PR0102MB3482.prod.exchangelabs.com ([fe80::d840:7aa7:58d4:b503]) by MW2PR0102MB3482.prod.exchangelabs.com ([fe80::d840:7aa7:58d4:b503%5]) with mapi id 15.20.4042.024; Thu, 22 Apr 2021 09:09:22 +0000 From: Quan Nguyen To: Joel Stanley , Andrew Jeffery , Jean Delvare , Guenter Roeck , Rob Herring , Lee Jones , Jonathan Corbet , linux-hwmon@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, linux-aspeed@lists.ozlabs.org, openbmc@lists.ozlabs.org Subject: [PATCH v4 4/4] docs: hwmon: (smpro-hwmon) Add documentation Date: Thu, 22 Apr 2021 16:08:43 +0700 Message-Id: <20210422090843.4614-5-quan@os.amperecomputing.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20210422090843.4614-1-quan@os.amperecomputing.com> References: <20210422090843.4614-1-quan@os.amperecomputing.com> X-Originating-IP: [118.69.219.201] X-ClientProxiedBy: HKAPR04CA0011.apcprd04.prod.outlook.com (2603:1096:203:d0::21) To MW2PR0102MB3482.prod.exchangelabs.com (2603:10b6:302:c::32) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from hcm-sw-17.amperecomputing.com (118.69.219.201) by HKAPR04CA0011.apcprd04.prod.outlook.com (2603:1096:203:d0::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4065.22 via Frontend Transport; Thu, 22 Apr 2021 09:09:18 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: d6257fa2-3e15-406a-15fa-08d9056e515b X-MS-TrafficTypeDiagnostic: MW4PR01MB6356: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:7691; X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: OGutW08rP8lwUNv3Zgs9Q//bWIgfqkJjuUuWBRY21RSoqOCdI+tJvTNgZ30PF4eF9mOvf1fkQqa/g16LHC1RXD1UzT9lpphylTge+gldaPvIq3mfXCBKW0rBeK1F3fkx9SySr2pnWTRInJyvvQIlMAGu9XtU7SMbJQFARP2rACar/6ZEMUKVBBHVOtwoVwkhkhh9DdaYOyJoZzSVQad0jP9NovCuvK107K91Z1AZ4ar6GyJrdl1apTnEpSFhf4XMz37IdNmgMIXX6I1/kjzeLJM7XDdszBRD1ZDuVV6ThIQiyQIPaVTRScKFvQSoWpsZoVzqbILp8CjU3EVKsLgwE0uspNWt7EUsxIBfWJV4WWbG/vD/ydBRkN8/WdcPplAZs1BhyElvAfPSmAIMb2WW9phZshgwc1+qusa4uk8xo6yF3rD7DysjvToVYGmcjOq92tJIQGtjbKDEFfEcRL4YMUf9PowG0a31Srl0jeonnJSMLJt/9MJDQ0AldcunJTNhYcLmMHToJP6eWKtPggvP+M3uPU6xsVXBwwzJdsFWygPHLHLA9mz8O6WRDW1CHQJzDTv5yJtMA/9jfdmjVYgaZuDrlRIsQdJwvMeGPJd5fdfswJ1AL81on+XcZ6Pwx5UJAUKprTTTudo5HD5GiDo1K4owcudCK959cr5yu34utMg= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:MW2PR0102MB3482.prod.exchangelabs.com; PTR:; CAT:NONE; SFS:(4636009)(396003)(136003)(39850400004)(376002)(366004)(346002)(110136005)(38100700002)(26005)(107886003)(5660300002)(86362001)(956004)(2906002)(6512007)(1076003)(6666004)(316002)(8676002)(186003)(83380400001)(66476007)(4326008)(16526019)(66556008)(52116002)(38350700002)(921005)(7416002)(2616005)(8936002)(478600001)(6486002)(66946007)(54906003)(6506007); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData: M0xsnyCf5rcBQ7TkwE2TB5XkBMs3L/nO7EZ3tZkHxX1VVGSt1pjmIXa9TKyJqaQDwerfb/xbBQXzMHG73qtuLxAf4TkypuZWlTI0q8Z5J7Xt7AhyuHQPUBSkexFzvyuerg78wqBKLa/UwP2s51JKCT3sgFXMmkNT0DMGe4Av1uJg337PTP8yO3UysX3YVOw6y+q+uKACGbTt+SkU4mqD17+aBUAz/ASRRohMwzKMcddwwmqbOzP4GimAuqV4B2YNHws6I/8wPNL0ERheb1imP0NL5lPeqjXfK9ZIFk5lk8Sil6DDtFAOxXTgAerwrvOP/lH6AjeD8ea1uu4YbockThxJiGMHMP/TPZTK6ePBOOMf7kgpj4hYQn+M9v9uao5qv9k4w6JhZH2G6/LGqV1OhsTqcYmUHsRXsaz+o8CQnZvZZP6aeUshbAaoe7vch4q6FQ9NUtp+PCnV7ehrPPVzFVfWpSguF6ZYmuxQlmM2VcGn4AL9uWrIr80pAye+gSFH4UcOzgpMN8bJnLJIVK9RLBacZq4MnJX3cobEEwnG52HsQic+ovJ5hGvX2oEvXyf/cy30+vpCf7Jz6zNojemj42KDyDVkPYoSGZLcDBWvKccF5pe7u5emiiy7gW9foDjHXUM5b7J2POjKWROX7puLXwVnYiVcgEDBM6cDi77ArnvoP4VQehJUPTH7gqNetVvRsO/wV4QKYOHF7zw8/a2ryN4YTfWg3iorZUg7/mHZI5Q7gl3G92EZQnkuLVK8ZydjdYP8ciY1kYI2A32H6Coqy2tSbNdV77860BnQc8riCLoh6+QGG/dWHpYHFP33+HiWiuH+wyVryMqC2hSFOLp/8QUDwEOrFp6o7eDtLSt+xBNsplvaMGqLdJzPmnirYTJgP3yOVdw8KgSEN9LmOGmW9uw52YWUfPX/yfumf8CBCXUdild9AnrbN+1GlhK2yX80rHwK7USHSFnBJ0T66mw+4JlZepKK4XXMQ6OPQU8TBUE4NMkTnve74W08fzeqs1eSysCpeJLJvOwj1C69ZeuvZGwHFYNYm5+UnZr1fb0DypkxvgmXXD4k38nVE0zh72h1m4ASTvqlkqzGgzqbraz3eaveE87/W1QH8mah74Hs7BvKMyAwi2yuusUF2o8PyqrOHmGOtXHSQ3fEWqmxFSh2ZU66QTycfgpd4VS413T6s7+TsQNTxzNi0xnW+dcukkv8MpqCPnG++abo3MhiMAvklBJB9A83krhIWIoHyVG7D+CM/g8+qLNf4EvfFuk+Oko5HoxFIAPFXKtJBQtdYrORK9TahtoJBAsOUXr0sW5dp6evghcTQoERP66CZYisuPAL X-OriginatorOrg: os.amperecomputing.com X-MS-Exchange-CrossTenant-Network-Message-Id: d6257fa2-3e15-406a-15fa-08d9056e515b X-MS-Exchange-CrossTenant-AuthSource: MW2PR0102MB3482.prod.exchangelabs.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Apr 2021 09:09:22.2868 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7 X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: JzqU6EJjqfwyS2nZ5DwcgNul7Y4XCachP0kmZ2VFJa7zhLi0msAXznWgdOcCIhVzNsQWWcchwVpzehfIGHooMZxual2UoKdI5ByEaY99Ins= X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR01MB6356 X-BeenThere: linux-aspeed@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Linux ASPEED SoC development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Open Source Submission , "Thang Q . Nguyen" , Phong Vo Errors-To: linux-aspeed-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Linux-aspeed" Add documentation for the Ampere(R)'s Altra(R) SMpro hwmon driver. Signed-off-by: Thu Nguyen Signed-off-by: Quan Nguyen Reviewed-by: Guenter Roeck --- Changes in v4: + None Changes in v3: + None Changes in v2: + Removed "virtual" sensors [Guenter] + Fixed typo "mili" to "milli", "nanoWatt" to "microWatt" [Guenter] + Reported SOC_TDP as "Socket TDP" using max attributes [Guenter] + Clarified "highest" meaning in documentation [Guenter] + Reported MEM HOT Threshold for all DIMMs as temp*_crit [Guenter] + Removed Socket TDP sensor [Quan] + Included sensor type and channel in labels [Quan] Documentation/hwmon/index.rst | 1 + Documentation/hwmon/smpro-hwmon.rst | 101 ++++++++++++++++++++++++++++ 2 files changed, 102 insertions(+) create mode 100644 Documentation/hwmon/smpro-hwmon.rst diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst index 48bfa7887dd4..3e3631b253b6 100644 --- a/Documentation/hwmon/index.rst +++ b/Documentation/hwmon/index.rst @@ -166,6 +166,7 @@ Hardware Monitoring Kernel Drivers sis5595 sl28cpld smm665 + smpro-hwmon smsc47b397 smsc47m192 smsc47m1 diff --git a/Documentation/hwmon/smpro-hwmon.rst b/Documentation/hwmon/smpro-hwmon.rst new file mode 100644 index 000000000000..f978b1370e16 --- /dev/null +++ b/Documentation/hwmon/smpro-hwmon.rst @@ -0,0 +1,101 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Kernel driver Ampere(R)'s Altra(R) SMpro hwmon +============================================== + +Supported chips: + + * Ampere(R) Altra(R) + + Prefix: 'smpro' + + Reference: Altra SoC BMC Interface Specification + +Author: Thu Nguyen + +Description +----------- +This driver supports hardware monitoring for Ampere(R) Altra(R) SoC's based on the +SMpro co-processor (SMpro). +The following sensor types are supported by the driver: + + * temperature + * voltage + * current + * power + +The SMpro interface provides the registers to query the various sensors and +their values which are then exported to userspace by this driver. + +Usage Notes +----------- + +SMpro hwmon driver creates at least two sysfs files for each sensor. + +* File ``_label`` reports the sensor label. +* File ``_input`` returns the sensor value. + +The sysfs files are allocated in the SMpro root fs folder. +There is one root folder for each SMpro instance. + +When the SoC is turned off, the driver will fail to read registers +and return -ENXIO. + +Sysfs entries +------------- + +The following sysfs files are supported: + +* Ampere(R) Altra(R): + +============ ============= ====== =============================================== +Name Unit Perm Description +temp1_input milli Celsius RO SoC temperature +temp2_input milli Celsius RO Max temperature reported among SoC VRDs +temp2_crit milli Celsius RO SoC VRD HOT Threshold temperature +temp3_input milli Celsius RO Max temperature reported among DIMM VRDs +temp4_input milli Celsius RO Max temperature reported among Core VRDs +temp5_input milli Celsius RO Temperature of DIMM0 on CH0 +temp5_crit milli Celsius RO MEM HOT Threshold for all DIMMs +temp6_input milli Celsius RO Temperature of DIMM0 on CH1 +temp6_crit milli Celsius RO MEM HOT Threshold for all DIMMs +temp7_input milli Celsius RO Temperature of DIMM0 on CH2 +temp7_crit milli Celsius RO MEM HOT Threshold for all DIMMs +temp8_input milli Celsius RO Temperature of DIMM0 on CH3 +temp8_crit milli Celsius RO MEM HOT Threshold for all DIMMs +temp9_input milli Celsius RO Temperature of DIMM0 on CH4 +temp9_crit milli Celsius RO MEM HOT Threshold for all DIMMs +temp10_input milli Celsius RO Temperature of DIMM0 on CH5 +temp10_crit milli Celsius RO MEM HOT Threshold for all DIMMs +temp11_input milli Celsius RO Temperature of DIMM0 on CH6 +temp11_crit milli Celsius RO MEM HOT Threshold for all DIMMs +temp12_input milli Celsius RO Temperature of DIMM0 on CH7 +temp12_crit milli Celsius RO MEM HOT Threshold for all DIMMs +temp13_input milli Celsius RO Max temperature reported among RCA VRDs +in0_input milli Volts RO Core voltage +in1_input milli Volts RO SoC voltage +in2_input milli Volts RO DIMM VRD1 voltage +in3_input milli Volts RO DIMM VRD2 voltage +in4_input milli Volts RO RCA VRD voltage +cur1_input milli Amperes RO Core VRD current +cur2_input milli Amperes RO SoC VRD current +cur3_input milli Amperes RO DIMM VRD1 current +cur4_input milli Amperes RO DIMM VRD2 current +cur5_input milli Amperes RO RCA VRD current +power1_input micro Watts RO Core VRD power +power2_input micro Watts RO SoC VRD power +power3_input micro Watts RO DIMM VRD1 power +power4_input micro Watts RO DIMM VRD2 power +power5_input micro Watts RO RCA VRD power +============ ============= ====== =============================================== + +Example:: + + # cat in0_input + 830 + # cat temp1_input + 37000 + # cat curr1_input + 9000 + # cat power5_input + 19500000