From patchwork Tue Nov 21 05:07:55 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Delphine CC Chiu X-Patchwork-Id: 746987 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=wiwynn.com header.i=@wiwynn.com header.b="hbhKRPNo" Received: from APC01-SG2-obe.outbound.protection.outlook.com (mail-sgaapc01on2060.outbound.protection.outlook.com [40.107.215.60]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7B4D210C; Mon, 20 Nov 2023 21:08:19 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=LVyYe6NJn+cNkFLnYr0p8cWVO7FwDiTOJQ3IWpkxbiVIw/u1Taeu8ZhtYBE5dtwRPLKYXlhylNBGExZ2r4oDPQDNpQn/+krTel/Y9ThQ4wTkgSskjevcixEpXz2oqjfVtSGnKma/etPNuOwIqiG8fOBP8BtrAjNAg4OPmJk7tcJiEJyUKSwBnW5E8JZMHyS38mgQbcww44XENZ8utMcXEmIlIui/UXXq6XnUI+1WFU8kaj21GBiJQEgSfU6YsLVvoxpzKjicstzAPJvpi4pCQIWKGcsJ6QBjx/QdXlgbDTzxwHviOuco/+XizIpR9HDB73QKs75X82FxmQNUDpwaOw== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=T2tyqpMjfabqNaLs1TIUizo2P6McIzz4KLTylNODVHs=; b=SWAgt336vbBXJ1o1YTrtDNHJ8TeuFUpiinroRWgNNtFU2w59cORaOSE7ik/ZsViiIJrYO2eiQcu/STFtc4WXsH5lSWikgq1sEX1yYoTxDy2onoZhGU4cXSp8/zvN8la6KVxPV7UfWlEGE25A1irxCzkRE2v9jpGDfbJNq+7PVO4JNzMnWbuhEOjwbsdtcIOlB0a4Tqm6g5wiP0R3IwyeV9MwHoO/PJqeeOvvZRyOm+cz42pgiH17MyH53sz9PSKeL/srKfRaBX2jSpeSGouMDuHKgfRBaYmaW8OuE0dy2gq1OUEMBI59LTHxre67tqXCt9r9F5GeqFYcLEGHoZhdJg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=fail (sender ip is 211.20.1.79) smtp.rcpttodomain=stwcx.xyz smtp.mailfrom=wiwynn.com; dmarc=fail (p=quarantine sp=quarantine pct=100) action=quarantine header.from=wiwynn.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=wiwynn.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=T2tyqpMjfabqNaLs1TIUizo2P6McIzz4KLTylNODVHs=; b=hbhKRPNokwI5VCvtePG5jKbfvJxTl5v8zua6pGTRCMPuGaBsG5H1gKCtzy0u1acxKr2b9huUpqHv8ZvnJmmiP2Di5Z1PgiisMLeh9c1gSGK70LaOSjRv+4LOJHxUewuPX37lsaxATWryJRW4BB5Un1VWRkO3BEb53wPZtesyR0FMpnEPiKAyOm6sChpdabRkK5C2xRXcf0c44VzqoXqMIqQwK2ffeecEoImSn3SVDC28iclVgPE0PzUTp5GSsqY77VPCZumZ49Hijy9uiuC/WBd5xCfQHLO0CkzmEIoZxD8HwhzUPgGwGXm7Dtx52me2Krgj2LnmU4rD89bmcVZrEA== Received: from SG2PR01CA0117.apcprd01.prod.exchangelabs.com (2603:1096:4:40::21) by TYZPR04MB7178.apcprd04.prod.outlook.com (2603:1096:400:462::8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7002.27; Tue, 21 Nov 2023 05:08:14 +0000 Received: from SG2PEPF000B66CC.apcprd03.prod.outlook.com (2603:1096:4:40:cafe::5b) by SG2PR01CA0117.outlook.office365.com (2603:1096:4:40::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7002.28 via Frontend Transport; Tue, 21 Nov 2023 05:08:13 +0000 X-MS-Exchange-Authentication-Results: spf=fail (sender IP is 211.20.1.79) smtp.mailfrom=Wiwynn.com; dkim=none (message not signed) header.d=none;dmarc=fail action=quarantine header.from=Wiwynn.com; Received-SPF: Fail (protection.outlook.com: domain of Wiwynn.com does not designate 211.20.1.79 as permitted sender) receiver=protection.outlook.com; client-ip=211.20.1.79; helo=localhost.localdomain; Received: from localhost.localdomain (211.20.1.79) by SG2PEPF000B66CC.mail.protection.outlook.com (10.167.240.25) with Microsoft SMTP Server id 15.20.7025.12 via Frontend Transport; Tue, 21 Nov 2023 05:08:12 +0000 From: Delphine CC Chiu To: patrick@stwcx.xyz, Jean Delvare , Guenter Roeck , Jonathan Corbet , Delphine CC Chiu Cc: Rob Herring , Krzysztof Kozlowski , Conor Dooley , linux-i2c@vger.kernel.org, linux-hwmon@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH v6 2/2] hwmon: pmbus: Add ltc4286 driver Date: Tue, 21 Nov 2023 13:07:55 +0800 Message-Id: <20231121050757.2108786-3-Delphine_CC_Chiu@Wiwynn.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20231121050757.2108786-1-Delphine_CC_Chiu@Wiwynn.com> References: <20231121050757.2108786-1-Delphine_CC_Chiu@Wiwynn.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SG2PEPF000B66CC:EE_|TYZPR04MB7178:EE_ X-MS-Office365-Filtering-Correlation-Id: a786ba5d-bf05-450c-f5b2-08dbea4fdd1a X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: qSqaT+VspUWgFIcDnG6EJMC71yJHITlOlVhJeKceFXXUlKBX3ptHshskVjr5/lj95poBzCzGahTnNmdjlcJzgom+HTwrNqc9LTkHT918p0mPgM72LwdXb76Qj+aOM9uEDSgM/Ajm3lZHqH4XDeKUA/6pND5qYsRoR5Kk8d0pDpS3/6TM0tLHX77H0P8wnKMopbRmwC2yxA6Ne9TOr+V/CJ9jVbTB3Fq2sYgthjYanr2FBo+c184GpOds8AGuzpJos/MI1IaNhHkSd/ZutYZHZ5AoJDSbWHQc/oFFX1Vh6r5GUR9KGyPwAFlnERIAFMwTtGFNW5+VgAI3ALoLXIGxagfXnP3x4i1LLWTSMgUFJiDnmuf0f6/h3c/VJzBm46jPPgJG24xBq6+KcIMJa9Ss/DQCt67CZgD7irt0WRRG0SsYSKp4MHqHud06oBy9zjSeojpdmbvrGfh00/FYH8oOx0T7T+YumX7DaQGiN6j3eTV/Q7ANIaa/K6yCcs5ajVzJZ47a71G/TEz9QZhErRPEGa05L31gxqbmR4KZzMT7Vdm1EKiJnaYUsoqCYIRp3ySV+0EffEirRau9bZjQmPXbjLoTQS1bbE7MRllKZCTtG1DAL1K2XNiMyY8X+TVK1jlGZrbqw3BNmYLNkNudQ4zQ40dyzxMEb0lb/1W7k1ocseExSdMUHyfeCSlqxAO4EKPOqi6FUViLr7H2tqQkLVhJXpCEQFH+x0NHX+a56tMW19I= X-Forefront-Antispam-Report: CIP:211.20.1.79; CTRY:TW; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:localhost.localdomain; PTR:211-20-1-79.hinet-ip.hinet.net; CAT:NONE; SFS:(13230031)(6069001)(4636009)(136003)(396003)(376002)(39850400004)(346002)(230922051799003)(1800799012)(451199024)(82310400011)(186009)(64100799003)(46966006)(36840700001)(40480700001)(2906002)(8936002)(41300700001)(7049001)(4326008)(8676002)(7416002)(5660300002)(30864003)(316002)(110136005)(36736006)(54906003)(70586007)(47076005)(86362001)(966005)(478600001)(6486002)(1076003)(26005)(70206006)(6512007)(6666004)(36756003)(956004)(2616005)(6506007)(66574015)(336012)(81166007)(9316004)(356005)(83380400001)(36860700001)(82740400003); DIR:OUT; SFP:1101; X-OriginatorOrg: wiwynn.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Nov 2023 05:08:12.6685 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: a786ba5d-bf05-450c-f5b2-08dbea4fdd1a X-MS-Exchange-CrossTenant-Id: da6e0628-fc83-4caf-9dd2-73061cbab167 X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=da6e0628-fc83-4caf-9dd2-73061cbab167; Ip=[211.20.1.79]; Helo=[localhost.localdomain] X-MS-Exchange-CrossTenant-AuthSource: SG2PEPF000B66CC.apcprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: TYZPR04MB7178 Add a driver to support ltc4286 chip Signed-off-by: Delphine CC Chiu --- Changelog: v6 - Check VRANGE_SELECT before driver loading v5 - Check the overflow when reading rsense - Set default rsense value v4 - Add empty line before "config SENSORS_LTC4286" in Kconfig - Add ltc4286 to Documentation/hwmon/index.rst - Revise comment typo - Use devm_kmemdup instead of memcpy - Check MBR value before writting into v3 - Use dev_err_probe() instead of dev_err() - The VRANGE_SELECT bit only be written if it actually changed - Avoid the info pointer being overwritten - Check the MBR value range to avoid overflow - Revise ltc4286.rst to corrcet description v2 - Revise Linear Technologies LTC4286 to Analog Devices LTC4286 in Kconfig - Add more description for this driver in Kconfig - Add some comments for MBR setting in ltc4286.c - Add ltc4286.rst --- Documentation/hwmon/index.rst | 1 + Documentation/hwmon/ltc4286.rst | 95 +++++++++++++++++ drivers/hwmon/pmbus/Kconfig | 10 ++ drivers/hwmon/pmbus/Makefile | 1 + drivers/hwmon/pmbus/ltc4286.c | 183 ++++++++++++++++++++++++++++++++ 5 files changed, 290 insertions(+) create mode 100644 Documentation/hwmon/ltc4286.rst create mode 100644 drivers/hwmon/pmbus/ltc4286.c diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst index 72f4e6065bae..080827cc4c34 100644 --- a/Documentation/hwmon/index.rst +++ b/Documentation/hwmon/index.rst @@ -128,6 +128,7 @@ Hardware Monitoring Kernel Drivers ltc4245 ltc4260 ltc4261 + ltc4286 max127 max15301 max16064 diff --git a/Documentation/hwmon/ltc4286.rst b/Documentation/hwmon/ltc4286.rst new file mode 100644 index 000000000000..2cd149676d86 --- /dev/null +++ b/Documentation/hwmon/ltc4286.rst @@ -0,0 +1,95 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Kernel driver ltc4286 +===================== + +Supported chips: + + * Analog Devices LTC4286 + + Prefix: 'ltc4286' + + Addresses scanned: - + + Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ltc4286.pdf + + * Analog Devices LTC4287 + + Prefix: 'ltc4287' + + Addresses scanned: - + + Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ltc4287.pdf + +Author: Delphine CC Chiu + + +Description +----------- + +This driver supports hardware monitoring for Analog Devices LTC4286 +and LTC4287 Hot-Swap Controller and Digital Power Monitors. + +LTC4286 and LTC4287 are hot-swap controllers that allow a circuit board +to be removed from or inserted into a live backplane. They also feature +current and voltage readback via an integrated 12 bit analog-to-digital +converter (ADC), accessed using a PMBus interface. + +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. + +The shunt value in micro-ohms can be set via device tree at compile-time. Please +refer to the Documentation/devicetree/bindings/hwmon/lltc,ltc4286.yaml for bindings +if the device tree is used. + + +Platform data support +--------------------- + +The driver supports standard PMBus driver platform data. Please see +Documentation/hwmon/pmbus.rst for details. + + +Sysfs entries +------------- + +The following attributes are supported. Limits are read-write, history reset +attributes are write-only, all other attributes are read-only. + +======================= ======================================================= +in1_label "vin" +in1_input Measured voltage. +in1_alarm Input voltage alarm. +in1_min Minimum input voltage. +in1_max Maximum input voltage. + +in2_label "vout1" +in2_input Measured voltage. +in2_alarm Output voltage alarm. +in2_min Minimum output voltage. +in2_max Maximum output voltage. + +curr1_label "iout1" +curr1_input Measured current. +curr1_alarm Output current alarm. +curr1_max Maximum current. + +power1_label "pin" +power1_input Input power. +power1_alarm Input power alarm. +power1_max Maximum poewr. + +temp1_input Chip temperature. +temp1_min Minimum chip temperature. +temp1_max Maximum chip temperature. +temp1_crit Critical chip temperature. +temp1_alarm Chip temperature alarm. +======================= ======================================================= diff --git a/drivers/hwmon/pmbus/Kconfig b/drivers/hwmon/pmbus/Kconfig index b4e93bd5835e..2d4f972e5a65 100644 --- a/drivers/hwmon/pmbus/Kconfig +++ b/drivers/hwmon/pmbus/Kconfig @@ -227,6 +227,16 @@ config SENSORS_LTC3815 This driver can also be built as a module. If so, the module will be called ltc3815. +config SENSORS_LTC4286 + bool "Analog Devices LTC4286" + help + LTC4286 is an integrated solution for hot swap applications that + allows a board to be safely inserted and removed from a live + backplane. + This chip could be used to monitor voltage, current, ...etc. + If you say yes here you get hardware monitoring support for Analog + Devices LTC4286. + config SENSORS_MAX15301 tristate "Maxim MAX15301" help diff --git a/drivers/hwmon/pmbus/Makefile b/drivers/hwmon/pmbus/Makefile index 84ee960a6c2d..94e28f6d6a61 100644 --- a/drivers/hwmon/pmbus/Makefile +++ b/drivers/hwmon/pmbus/Makefile @@ -24,6 +24,7 @@ obj-$(CONFIG_SENSORS_LM25066) += lm25066.o obj-$(CONFIG_SENSORS_LT7182S) += lt7182s.o obj-$(CONFIG_SENSORS_LTC2978) += ltc2978.o obj-$(CONFIG_SENSORS_LTC3815) += ltc3815.o +obj-$(CONFIG_SENSORS_LTC4286) += ltc4286.o obj-$(CONFIG_SENSORS_MAX15301) += max15301.o obj-$(CONFIG_SENSORS_MAX16064) += max16064.o obj-$(CONFIG_SENSORS_MAX16601) += max16601.o diff --git a/drivers/hwmon/pmbus/ltc4286.c b/drivers/hwmon/pmbus/ltc4286.c new file mode 100644 index 000000000000..e43e05579be1 --- /dev/null +++ b/drivers/hwmon/pmbus/ltc4286.c @@ -0,0 +1,183 @@ +// SPDX-License-Identifier: GPL-2.0-or-later + +#include +#include +#include +#include +#include +#include +#include "pmbus.h" + +/* LTC4286 register */ +#define LTC4286_MFR_CONFIG1 0xF2 + +/* LTC4286 configuration */ +#define VRANGE_SELECT_BIT BIT(1) + +#define LTC4286_MFR_ID_SIZE 3 +#define VRANGE_102P4 1 + +/* + * Initialize the MBR as default settings which is referred to LTC4286 datasheet + * (March 22, 2022 version) table 3 page 16 + */ +static struct pmbus_driver_info ltc4286_info = { + .pages = 1, + .format[PSC_VOLTAGE_IN] = direct, + .format[PSC_VOLTAGE_OUT] = direct, + .format[PSC_CURRENT_OUT] = direct, + .format[PSC_POWER] = direct, + .format[PSC_TEMPERATURE] = direct, + .m[PSC_VOLTAGE_IN] = 32, + .b[PSC_VOLTAGE_IN] = 0, + .R[PSC_VOLTAGE_IN] = 1, + .m[PSC_VOLTAGE_OUT] = 32, + .b[PSC_VOLTAGE_OUT] = 0, + .R[PSC_VOLTAGE_OUT] = 1, + .m[PSC_CURRENT_OUT] = 1024, + .b[PSC_CURRENT_OUT] = 0, + /* + * The rsense value used in MBR formula in LTC4286 datasheet should be ohm unit. + * However, the rsense value that user input is micro ohm. + * Thus, the MBR setting which involves rsense should be shifted by 6 digits. + */ + .R[PSC_CURRENT_OUT] = 3 - 6, + .m[PSC_POWER] = 1, + .b[PSC_POWER] = 0, + /* + * The rsense value used in MBR formula in LTC4286 datasheet should be ohm unit. + * However, the rsense value that user input is micro ohm. + * Thus, the MBR setting which involves rsense should be shifted by 6 digits. + */ + .R[PSC_POWER] = 4 - 6, + .m[PSC_TEMPERATURE] = 1, + .b[PSC_TEMPERATURE] = 273, + .R[PSC_TEMPERATURE] = 0, + .func[0] = PMBUS_HAVE_VIN | PMBUS_HAVE_VOUT | PMBUS_HAVE_IOUT | + PMBUS_HAVE_PIN | PMBUS_HAVE_TEMP | PMBUS_HAVE_STATUS_VOUT | + PMBUS_HAVE_STATUS_IOUT | PMBUS_HAVE_STATUS_TEMP, +}; + +static const struct i2c_device_id ltc4286_id[] = { + { "ltc4286", 0 }, + { "ltc4287", 1 }, + {} +}; +MODULE_DEVICE_TABLE(i2c, ltc4286_id); + +static int ltc4286_probe(struct i2c_client *client) +{ + int ret; + const struct i2c_device_id *mid; + u8 block_buffer[I2C_SMBUS_BLOCK_MAX + 1]; + struct pmbus_driver_info *info; + u32 rsense; + + ret = i2c_smbus_read_block_data(client, PMBUS_MFR_ID, block_buffer); + if (ret < 0) { + return dev_err_probe(&client->dev, ret, + "Failed to read manufacturer id\n"); + } + + /* + * Refer to ltc4286 datasheet page 20 + * the manufacturer id is LTC + */ + if (ret != LTC4286_MFR_ID_SIZE || + strncmp(block_buffer, "LTC", LTC4286_MFR_ID_SIZE)) { + return dev_err_probe(&client->dev, ret, + "Manufacturer id mismatch\n"); + } + + ret = i2c_smbus_read_block_data(client, PMBUS_MFR_MODEL, block_buffer); + if (ret < 0) { + return dev_err_probe(&client->dev, ret, + "Failed to read manufacturer model\n"); + } + + for (mid = ltc4286_id; mid->name[0]; mid++) { + if (!strncasecmp(mid->name, block_buffer, strlen(mid->name))) + break; + } + if (!mid->name[0]) + return dev_err_probe(&client->dev, -ENODEV, + "Unsupported device\n"); + + if (of_property_read_u32(client->dev.of_node, + "shunt-resistor-micro-ohms", &rsense)) + rsense = 300; /* 0.3 mOhm if not set via DT */ + + if (rsense == 0) + return -EINVAL; + + /* Check for the latter MBR value won't overflow */ + if (rsense > (INT_MAX / 1024)) + return -EINVAL; + + info = devm_kmemdup(&client->dev, <c4286_info, sizeof(*info), + GFP_KERNEL); + if (!info) + return -ENOMEM; + + /* Check MFR1 CONFIG register bit 1 VRANGE_SELECT before driver loading */ + ret = i2c_smbus_read_word_data(client, LTC4286_MFR_CONFIG1); + if (ret < 0) + return dev_err_probe( + &client->dev, ret, + "Failed to read manufacturer configuration one\n"); + + if (device_property_read_bool(&client->dev, "adi,vrange-low-enable")) { + /* The voltage range is 102.4 volts now */ + if (ret == VRANGE_102P4) { + /* Set MFR1 CONFIG register bit 1 VRANGE_SELECT */ + ret &= ~VRANGE_SELECT_BIT; /* VRANGE_SELECT = 0, 25.6 volts */ + ret = i2c_smbus_write_word_data( + client, LTC4286_MFR_CONFIG1, ret); + if (ret < 0) + return dev_err_probe(&client->dev, ret, + "Failed to set vrange\n"); + } + + info->m[PSC_VOLTAGE_IN] = 128; + info->m[PSC_VOLTAGE_OUT] = 128; + info->m[PSC_POWER] = 4 * rsense; + } else { + /* The voltage range is 25.6 volts now */ + if (ret != VRANGE_102P4) { + /* Set MFR1 CONFIG register bit 1 VRANGE_SELECT */ + ret |= VRANGE_SELECT_BIT; /* VRANGE_SELECT = 1, 102.4 volts */ + ret = i2c_smbus_write_word_data( + client, LTC4286_MFR_CONFIG1, ret); + if (ret < 0) + return dev_err_probe(&client->dev, ret, + "Failed to set vrange\n"); + } + + info->m[PSC_POWER] = rsense; + } + + info->m[PSC_CURRENT_OUT] = 1024 * rsense; + + return pmbus_do_probe(client, info); +} + +static const struct of_device_id ltc4286_of_match[] = { + { .compatible = "lltc,ltc4286" }, + { .compatible = "lltc,ltc4287" }, + {} +}; + +static struct i2c_driver ltc4286_driver = { + .driver = { + .name = "ltc4286", + .of_match_table = ltc4286_of_match, + }, + .probe = ltc4286_probe, + .id_table = ltc4286_id, +}; + +module_i2c_driver(ltc4286_driver); + +MODULE_AUTHOR("Delphine CC Chiu "); +MODULE_DESCRIPTION("PMBUS driver for LTC4286 and compatibles"); +MODULE_LICENSE("GPL");