From patchwork Sat Sep 5 13:32:23 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?J=2E_Neusch=C3=A4fer?= X-Patchwork-Id: 1358005 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=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=linux-rtc-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=gmx.net Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.a=rsa-sha256 header.s=badeba3b8450 header.b=Wge91bLk; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4BkFt66Clvz9sSP for ; Sat, 5 Sep 2020 23:35:42 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728579AbgIENfF (ORCPT ); Sat, 5 Sep 2020 09:35:05 -0400 Received: from mout.gmx.net ([212.227.17.21]:38405 "EHLO mout.gmx.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728407AbgIENet (ORCPT ); Sat, 5 Sep 2020 09:34:49 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1599312843; bh=lFP4+48b1q9wMps2dhvfqju3YXkQySHJhiYh5hsMw8s=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=Wge91bLkSC8JeDMRv2xoC7qIr/ccP9aTthWA9Z/RA1ByqkvieReeA2RRMVrpoIBNN Jq3/x+3iCZlvr+tTN3FRE3T91dapHwktkOg9Cx/O0v7Cq7iiXPa6EX320kyNnx2Czm gteuOJDiciQz4Sz9iIICaUMdRlJXEvDzca/F3AOI= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Received: from longitude ([5.146.195.151]) by mail.gmx.com (mrgmx105 [212.227.17.168]) with ESMTPSA (Nemesis) id 1MnakX-1kxH5C1QLl-00jVm9; Sat, 05 Sep 2020 15:34:03 +0200 From: =?utf-8?q?Jonathan_Neusch=C3=A4fer?= To: linux-kernel@vger.kernel.org Cc: Lee Jones , Rob Herring , =?utf-8?q?Jonathan_Neusch=C3=A4fer?= , Thierry Reding , =?utf-8?q?Uwe_Kleine-K=C3=B6nig?= , Alessandro Zummo , Alexandre Belloni , Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , NXP Linux Team , Sam Ravnborg , Linus Walleij , Heiko Stuebner , Stephan Gerhold , Lubomir Rintel , Mark Brown , allen , Mauro Carvalho Chehab , "David S. Miller" , devicetree@vger.kernel.org, linux-pwm@vger.kernel.org, linux-rtc@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Heiko Stuebner , Josua Mayer , Andreas Kemnade , Arnd Bergmann , Daniel Palmer Subject: [PATCH v2 03/10] mfd: Add base driver for Netronix embedded controller Date: Sat, 5 Sep 2020 15:32:23 +0200 Message-Id: <20200905133230.1014581-4-j.neuschaefer@gmx.net> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20200905133230.1014581-1-j.neuschaefer@gmx.net> References: <20200905133230.1014581-1-j.neuschaefer@gmx.net> MIME-Version: 1.0 X-Provags-ID: V03:K1:9nyrMwTGKpf8aFfMoAAzhrvimxGgK1Ibt7IlLGUdrACY1CUOER5 2GSjH+eh6PDU9Iec7TWg/lwHJDr9kUkRIxU4QIXbZ5Ij/ubOVjhFySYN9zcRMiG5svJgC9O 2bb38VILsliYSS1xPc7zOFZhMKcMvAm6tnY2Cwlbc1kiYnozFVo8vB/qMBf/Wcngcon1aPP sudH74a8PDxuVW8o3iMVg== X-Spam-Flag: NO X-UI-Out-Filterresults: notjunk:1;V03:K0:tcXlN4wr7mI=:NkyhodHlWwhy65wMxx1icg MjIRdgKrVnGotYB8jNs+x0SEFFE3EB5RAA9Ya9TLtr8vK2gSQBxt6guFmrtUUmqJWUh5eAvpT WBMCWmI09MxjbT1ZbAcNfmumZaoDX215M4fJAWirCVj5+yEEOZspZnV2U8cPLdyJR2zyPJ/Gk FgV3DSYkpQiXwZ2d2qdPeLNHgYRyJbNomuP1QOg3NiV2GlpOH+ku4sPPqTUv/U4U2QnBfOVyi p2/3DKKZE3c+IQTus5IGA8gC26iTGFlA8w7Hz1Id7oPT7I80v2663Z1HgS/BLDsQGXhoLubJv cgKq9NWKxQyXh4ecypi6mN+UQQtlESx+LQvEgegqHj0mig02fgfKbaloWNPLG9DELDB4owNfw kK4H2q2erIWVbNTjfZVVqUlNa5m3qT6LVgoo2/dolNopaBmgOrIjO2KTmN0Y/om1U+Dz5wT/o i9YRNHjLxLcUTvtQowO8F/+G0MxVDOw0NoX4jStv/MelPWezFJqnbiFeLdnMNn3npPzlXQLzr 0FimdbaYLmjnJg3Y8b+XTUzRg+6bfURKiSMLjrGHhNTg+XF25Ns6sN1kOaoX+1RseVp5gY8pO v6DVKQ7BHePTYbS7L5gumW/KcIYAv5gIcAi6XQFBaDKcQKkW0nHxt0ERDxs3nxATmpBqE0oa+ wXdoR2ZMZEWgDPh1NzWi9+AXkFvItoCdhvQoeFGwp++J2oC5ZGztzxdlNKwtv3su7Nxv20dG3 cwRk/53AHHT712hOsZLCpkZDX2wVag3S9GnNh35F9apF/QIz6UbvJkTjDq7IE6iTeseP+h48E RBW0x1PPy0Xf0D1SX2eb5N1Y4/FSjBsciA//S3BSGS1jddIfA5Rwvanjq4EE39f4uKRV+jZoJ nGcnNLeSgsJLWnSN58HDebwfmHajzyvYc+kniw+OBwksvGU6F2DBOdgI330pjJPXyvadBBJEF ry7ZhPCOT3h0fcClSrMVhpDJA2PCGDQj8fUMcAj+t04ANO2/M83Drq9yJ6f9cu/yBCKDCUJJT dzkhKwKibheArntmVF8YzRZ9BWWjtcUwS/S6fK4gPITG1ZNGpfLWgnsa6Q6uIVu2PzdLxLIq/ nLP9PEHD8cjDCkkayNlOMHQfsh0P18s26aYm4RmioytR1896ILph/637feoQzlFdEU/SVFI+F 0WlF1+Cpu+goFEjskAIm3pq9BIAKgBgCJJJj6jfuQxDt871CY7S+/VjDh9KKfC8e50N5l0YsB FNGZlc0ZflJ5RokLud3oaTihbER+DAFOgR4RveA== Sender: linux-rtc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rtc@vger.kernel.org The Netronix embedded controller is a microcontroller found in some e-book readers designed by the ODM Netronix, Inc. It contains RTC, battery monitoring, system power management, and PWM functionality. This driver implements register access and version detection. Third-party hardware documentation is available at: https://github.com/neuschaefer/linux/wiki/Netronix-MSP430-embedded-controller The EC supports interrupts, but the driver doesn't make use of them so far. Signed-off-by: Jonathan Neuschäfer --- v2: - Add a description of the device to the patch text - Unify spelling as 'Netronix embedded controller'. 'Netronix' is the proper name of the manufacturer, but 'embedded controller' is just a label that I have assigned to the device. - Switch to regmap, avoid regmap use in poweroff and reboot handlers. Inspired by cf84dc0bb40f4 ("mfd: rn5t618: Make restart handler atomic safe") - Use a list of known-working firmware versions instead of checking for a known-incompatible version - Prefix registers with NTXEC_REG_ - Define register values as constants - Various style cleanups as suggested by Lee Jones - Don't align = signs in struct initializers [Uwe Kleine-König] - Don't use dev_dbg for an error message - Explain sleep in poweroff handler - Remove (struct ntxec).client - Switch to .probe_new in i2c driver - Add .remove callback - Make CONFIG_MFD_NTXEC a tristate option --- drivers/mfd/Kconfig | 7 ++ drivers/mfd/Makefile | 1 + drivers/mfd/ntxec.c | 217 ++++++++++++++++++++++++++++++++++++++ include/linux/mfd/ntxec.h | 24 +++++ 4 files changed, 249 insertions(+) create mode 100644 drivers/mfd/ntxec.c create mode 100644 include/linux/mfd/ntxec.h -- 2.28.0 diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig index 33df0837ab415..bab999081f32d 100644 --- a/drivers/mfd/Kconfig +++ b/drivers/mfd/Kconfig @@ -978,6 +978,13 @@ config MFD_VIPERBOARD You need to select the mfd cell drivers separately. The drivers do not support all features the board exposes. +config MFD_NTXEC + tristate "Netronix embedded controller" + depends on I2C && OF + help + Say yes here if you want to support the embedded controller found in + certain e-book readers designed by the ODM Netronix. + config MFD_RETU tristate "Nokia Retu and Tahvo multi-function device" select MFD_CORE diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile index a60e5f835283e..236a8acd917a0 100644 --- a/drivers/mfd/Makefile +++ b/drivers/mfd/Makefile @@ -217,6 +217,7 @@ obj-$(CONFIG_MFD_INTEL_MSIC) += intel_msic.o obj-$(CONFIG_MFD_INTEL_PMC_BXT) += intel_pmc_bxt.o obj-$(CONFIG_MFD_PALMAS) += palmas.o obj-$(CONFIG_MFD_VIPERBOARD) += viperboard.o +obj-$(CONFIG_MFD_NTXEC) += ntxec.o obj-$(CONFIG_MFD_RC5T583) += rc5t583.o rc5t583-irq.o obj-$(CONFIG_MFD_RK808) += rk808.o obj-$(CONFIG_MFD_RN5T618) += rn5t618.o diff --git a/drivers/mfd/ntxec.c b/drivers/mfd/ntxec.c new file mode 100644 index 0000000000000..49cc4fa35b9fe --- /dev/null +++ b/drivers/mfd/ntxec.c @@ -0,0 +1,217 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * The Netronix embedded controller is a microcontroller found in some + * e-book readers designed by the ODM Netronix, Inc. It contains RTC, + * battery monitoring, system power management, and PWM functionality. + * + * This driver implements register access, version detection, and system + * power-off/reset. + * + * Copyright 2020 Jonathan Neuschäfer + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define NTXEC_REG_VERSION 0x00 +#define NTXEC_REG_POWEROFF 0x50 +#define NTXEC_REG_POWERKEEP 0x70 +#define NTXEC_REG_RESET 0x90 + +#define NTXEC_POWEROFF_VALUE 0x0100 +#define NTXEC_POWERKEEP_VALUE 0x0800 +#define NTXEC_RESET_VALUE 0xff00 + +static struct i2c_client *poweroff_restart_client; + +static void ntxec_poweroff(void) +{ + int res; + + u8 buf[] = { + NTXEC_REG_POWEROFF, + (NTXEC_POWEROFF_VALUE >> 8) & 0xff, + NTXEC_POWEROFF_VALUE & 0xff, + }; + + struct i2c_msg msgs[] = { + { + .addr = poweroff_restart_client->addr, + .flags = 0, + .len = sizeof(buf), + .buf = buf + } + }; + + res = i2c_transfer(poweroff_restart_client->adapter, msgs, ARRAY_SIZE(msgs)); + + if (res < 0) + dev_alert(&poweroff_restart_client->dev, "Failed to power off (err = %d)\n", res); + + /* + * The time from the register write until the host CPU is powered off + * has been observed to be about 2.5 to 3 seconds. Sleep long enough to + * safely avoid returning from the poweroff handler. + */ + msleep(5000); +} + +static int ntxec_restart(struct notifier_block *nb, + unsigned long action, void *data) +{ + int res; + + /* + * NOTE: The lower half of the reset value is not sent, because sending + * it causes an error + */ + u8 buf[] = { + NTXEC_REG_RESET, + (NTXEC_RESET_VALUE >> 8) & 0xff, + }; + + struct i2c_msg msgs[] = { + { + .addr = poweroff_restart_client->addr, + .flags = 0, + .len = sizeof(buf), + .buf = buf + } + }; + + res = i2c_transfer(poweroff_restart_client->adapter, msgs, ARRAY_SIZE(msgs)); + + if (res < 0) + dev_alert(&poweroff_restart_client->dev, "Failed to restart (err = %d)\n", res); + + return NOTIFY_DONE; +} + +static struct notifier_block ntxec_restart_handler = { + .notifier_call = ntxec_restart, + .priority = 128 +}; + +static const struct regmap_config regmap_config = { + .name = "ntxec", + .reg_bits = 8, + .val_bits = 16, + .cache_type = REGCACHE_NONE, + .val_format_endian = REGMAP_ENDIAN_BIG, +}; + +static const struct ntxec_info ntxec_known_versions[] = { + { 0xd726 }, /* found in Kobo Aura */ +}; + +static const struct ntxec_info *ntxec_lookup_info(u16 version) +{ + int i; + + for (i = 0; i < ARRAY_SIZE(ntxec_known_versions); i++) { + const struct ntxec_info *info = &ntxec_known_versions[i]; + + if (info->version == version) + return info; + } + + return NULL; +} + +static int ntxec_probe(struct i2c_client *client) +{ + struct ntxec *ec; + unsigned int version; + int res; + + ec = devm_kmalloc(&client->dev, sizeof(*ec), GFP_KERNEL); + if (!ec) + return -ENOMEM; + + ec->dev = &client->dev; + + ec->regmap = devm_regmap_init_i2c(client, ®map_config); + if (IS_ERR(ec->regmap)) { + dev_err(ec->dev, "Failed to set up regmap for device\n"); + return res; + } + + /* Determine the firmware version */ + res = regmap_read(ec->regmap, NTXEC_REG_VERSION, &version); + if (res < 0) { + dev_err(ec->dev, "Failed to read firmware version number\n"); + return res; + } + dev_info(ec->dev, + "Netronix embedded controller version %04x detected.\n", + version); + + /* Bail out if we encounter an unknown firmware version */ + ec->info = ntxec_lookup_info(version); + if (!ec->info) + return -EOPNOTSUPP; + + if (of_device_is_system_power_controller(ec->dev->of_node)) { + /* + * Set the 'powerkeep' bit. This is necessary on some boards + * in order to keep the system running. + */ + res = regmap_write(ec->regmap, NTXEC_REG_POWERKEEP, + NTXEC_POWERKEEP_VALUE); + if (res < 0) + return res; + + /* Install poweroff handler */ + WARN_ON(poweroff_restart_client); + poweroff_restart_client = client; + if (pm_power_off) + dev_err(ec->dev, "pm_power_off already assigned\n"); + else + pm_power_off = ntxec_poweroff; + + /* Install board reset handler */ + res = register_restart_handler(&ntxec_restart_handler); + if (res) + dev_err(ec->dev, + "Failed to register restart handler: %d\n", res); + } + + i2c_set_clientdata(client, ec); + + return devm_of_platform_populate(ec->dev); +} + +static int ntxec_remove(struct i2c_client *i2c) +{ + if (i2c == poweroff_restart_client) { + poweroff_restart_client = NULL; + pm_power_off = NULL; + unregister_restart_handler(&ntxec_restart_handler); + } + + return 0; +} + +static const struct of_device_id of_ntxec_match_table[] = { + { .compatible = "netronix,ntxec", }, + {} +}; + +static struct i2c_driver ntxec_driver = { + .driver = { + .name = "ntxec", + .of_match_table = of_ntxec_match_table, + }, + .probe_new = ntxec_probe, + .remove = ntxec_remove, +}; +module_i2c_driver(ntxec_driver); diff --git a/include/linux/mfd/ntxec.h b/include/linux/mfd/ntxec.h new file mode 100644 index 0000000000000..65e389af79da6 --- /dev/null +++ b/include/linux/mfd/ntxec.h @@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ +/* + * Copyright 2020 Jonathan Neuschäfer + * + * Register access and version information for the Netronix embedded + * controller. + */ + +#ifndef NTXEC_H +#define NTXEC_H + +#include + +struct ntxec_info { + u16 version; +}; + +struct ntxec { + struct device *dev; + struct regmap *regmap; + const struct ntxec_info *info; +}; + +#endif