Skip to contentSkip to conversation

Netronix embedded controller driver for Kobo and Tolino ebook readers

PATCH Applied Jonathan Neuschäfer 7 participants 20 messages Jan 24, 2021 – Mar 12, 2021

Subsystems (6)
lore
Share & tools
lore

Jonathan Neuschäfer

author maintainer
#0 lore raw

v9 cover Netronix embedded controller driver for Kobo and Tolino ebook readers

This patchset adds basic support for the embedded controller found on older ebook reader boards designed by/with the ODM Netronix Inc.[1] and sold by Kobo or Tolino, for example the Kobo Aura and the Tolino Shine. These drivers are based on information contained in the vendor kernel sources, but in order to all information in a single place, I documented the register interface of the EC on GitHub[2].

[1]: http://www.netronixinc.com/products.aspx?ID=1
[2]: https://github.com/neuschaefer/linux/wiki/Netronix-MSP430-embedded-controller

v9:
- Fixed a bug in the error handling of ntxec_probe,

- Added Thierry Reding's ACK to the PWM patch

v8:
- https://lore.kernel.org/lkml/[email protected]/
- MFD: Add missing module metadata to the core driver
- PWM/RTC: Copy dev.of_node from the parent device, to ensure that these devices are linked to the devicetree node

v7:
- https://lore.kernel.org/lkml/[email protected]/
- Adjust the RTC patch to a change in the RTC API:
rtc_register_device is now devm_rtc_register_device.
- Add a #define for the known firmware version (0xd726).
Lee Jones suggested doing this in a follow-up patch, but since I'm respinning the series anyway, I'm doing it here.

Jonathan Neuschäfer (7):
dt-bindings: Add vendor prefix for Netronix, Inc.
dt-bindings: mfd: Add binding for Netronix embedded controller
mfd: Add base driver for Netronix embedded controller
pwm: ntxec: Add driver for PWM function in Netronix EC
rtc: New driver for RTC in Netronix embedded controller
MAINTAINERS: Add entry for Netronix embedded controller
ARM: dts: imx50-kobo-aura: Add Netronix embedded controller

 .../bindings/mfd/netronix,ntxec.yaml          |  76 ++++++
 .../devicetree/bindings/vendor-prefixes.yaml  |   2 +
 MAINTAINERS                                   |   9 +
 arch/arm/boot/dts/imx50-kobo-aura.dts         |  16 +-
 drivers/mfd/Kconfig                           |  11 +
 drivers/mfd/Makefile                          |   1 +
 drivers/mfd/ntxec.c                           | 221 ++++++++++++++++++
 drivers/pwm/Kconfig                           |   8 +
 drivers/pwm/Makefile                          |   1 +
 drivers/pwm/pwm-ntxec.c                       | 184 +++++++++++++++
 drivers/rtc/Kconfig                           |   8 +
 drivers/rtc/Makefile                          |   1 +
 drivers/rtc/rtc-ntxec.c                       | 145 ++++++++++++
 include/linux/mfd/ntxec.h                     |  37 +++
 14 files changed, 719 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/devicetree/bindings/mfd/netronix,ntxec.yaml
 create mode 100644 drivers/mfd/ntxec.c
 create mode 100644 drivers/pwm/pwm-ntxec.c
 create mode 100644 drivers/rtc/rtc-ntxec.c
 create mode 100644 include/linux/mfd/ntxec.h

--
2.29.2

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

author maintainer
#1 lore raw

PATCH v9 1/7 dt-bindings: Add vendor prefix for Netronix, Inc.

Netronix, Inc. (http://www.netronixinc.com/) makes ebook reader board designs, which are for example used in Kobo and Tolino devices.

An alternative prefix for Netronix would be "ntx", which is already used in code released by Netronix. It is shorter, but perhaps less clear.

---
v4-v9:
- No changes

v3:
- https://lore.kernel.org/lkml/[email protected]/
- Add Acked-by tag

v2:
- No changes

---
 Documentation/devicetree/bindings/vendor-prefixes.yaml | 2 ++
 1 file changed, 2 insertions(+)
Documentation/devicetree/bindings/vendor-prefixes.yaml +2 -0
index 041ae90b0d8fd..4d36b8173b568 100644
@@ -756,6 +756,8 @@ patternProperties:
     description: Broadcom Corporation (formerly NetLogic Microsystems)
   "^netron-dy,.*":
     description: Netron DY
+  "^netronix,.*":
+    description: Netronix, Inc.
   "^netxeon,.*":
     description: Shenzhen Netxeon Technology CO., LTD
   "^neweast,.*":

--
2.29.2

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

author maintainer
#2 lore raw

PATCH v9 2/7 dt-bindings: mfd: Add binding for Netronix embedded controller

In reply to Jonathan Neuschäfer

This EC is found in e-book readers of multiple brands (e.g. Kobo, Tolino), and is typically implemented as a TI MSP430 microcontroller.

It controls different functions of the system, such as power on/off, RTC, PWM for the backlight. The exact functionality provided can vary between boards.

---
v5-v9:
- no changes

v4:
- Add R-b tag

v3:
- https://lore.kernel.org/lkml/[email protected]/
- Remove binding in text form patch description again
- Add additionalProperties: false
- Remove interrupt-controller property from example
- Merge pwm/rtc nodes into main node

v2:
- Add the plaintext DT binding for comparison

---
 .../bindings/mfd/netronix,ntxec.yaml          | 76 +++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/netronix,ntxec.yaml
Documentation/devicetree/bindings/mfd/netronix,ntxec.yaml new file +76 -0
new file mode 100644
index 0000000000000..59a630025f52f
@@ -0,0 +1,76 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/netronix,ntxec.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Netronix Embedded Controller
+
+maintainers:
+  - Jonathan Neuschäfer <[email protected]>
+
+description: |
+  This EC is found in e-book readers of multiple brands (e.g. Kobo, Tolino), and
+  is typically implemented as a TI MSP430 microcontroller.
+
+properties:
+  compatible:
+    const: netronix,ntxec
+
+  reg:
+    items:
+      - description: The I2C address of the EC
+
+  system-power-controller:
+    type: boolean
+    description: See Documentation/devicetree/bindings/power/power-controller.txt
+
+  interrupts:
+    minItems: 1
+    description:
+      The EC can signal interrupts via a GPIO line
+
+  "#pwm-cells":
+    const: 2
+    description: |
+      Number of cells in a PWM specifier.
+
+      The following PWM channels are supported:
+        - 0: The PWM channel controlled by registers 0xa1-0xa7
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            ec: embedded-controller@43 {
+                    pinctrl-names = "default";
+                    pinctrl-0 = <&pinctrl_ntxec>;
+
+                    compatible = "netronix,ntxec";
+                    reg = <0x43>;
+                    system-power-controller;
+                    interrupt-parent = <&gpio4>;
+                    interrupts = <11 IRQ_TYPE_EDGE_FALLING>;
+                    #pwm-cells = <2>;
+            };
+    };
+
+    backlight {
+            compatible = "pwm-backlight";
+            pwms = <&ec 0 50000>;
+            power-supply = <&backlight_regulator>;
+    };
+
+    backlight_regulator: regulator-dummy {
+            compatible = "regulator-fixed";
+            regulator-name = "backlight";
+    };

--
2.29.2

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

author maintainer
#3 lore raw

PATCH v9 3/7 mfd: Add base driver for Netronix embedded controller

In reply to Jonathan Neuschäfer

The Netronix embedded controller is a microcontroller found in some e-book readers designed by the original design manufacturer 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.

---
v9:
- Fix return value after regmap failure (bug found by kernel test robot <[email protected]>)

v8:
- https://lore.kernel.org/lkml/[email protected]/
- Add missing MODULE_DEVICE_TABLE
- Add module metadata (author, description, license)

v7:
- Add #define for version number (suggested by Lee Jones).

v6:
- Add Lee Jones' ACK

v5:
- no changes

v4:
- include asm/unaligned.h after linux/*
- Use put_unaligned_be16 instead of open-coded big-endian packing
- Clarify that 0x90=0xff00 causes an error in downstream kernel too
- Add commas after non-sentinel positions
- ntxec.h: declare structs device and regmap
- Replace WARN_ON usage and add comments to explain errors
- Replace dev_alert with dev_warn when the result isn't handled
- Change subdevice registration error message to dev_err
- Declare ntxec_reg8 as returning __be16
- Restructure version detection code
- Spell out ODM

v3:
- Add (EC) to CONFIG_MFD_NTXEC prompt
- Relicense as GPLv2 or later
- Add email address to copyright line
- remove empty lines in ntxec_poweroff and ntxec_restart functions
- Split long lines
- Remove 'Install ... handler' comments
- Make naming of struct i2c_client parameter consistent
- Remove struct ntxec_info
- Rework 'depends on' lines in Kconfig, hard-depend on I2C, select REGMAP_I2C and MFD_CORE
- Register subdevices via mfd_cells
- Move 8-bit register conversion to ntxec.h

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       |  11 ++
 drivers/mfd/Makefile      |   1 +
 drivers/mfd/ntxec.c       | 221 ++++++++++++++++++++++++++++++++++++++
 include/linux/mfd/ntxec.h |  37 +++++++
 4 files changed, 270 insertions(+)
 create mode 100644 drivers/mfd/ntxec.c
 create mode 100644 include/linux/mfd/ntxec.h
drivers/mfd/Kconfig +11 -0
index bdfce7b156216..4280bcd47ec7d 100644
@@ -976,6 +976,17 @@ 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 (EC)"
+	depends on OF || COMPILE_TEST
+	depends on I2C
+	select REGMAP_I2C
+	select MFD_CORE
+	help
+	  Say yes here if you want to support the embedded controller found in
+	  certain e-book readers designed by the original design manufacturer
+	  Netronix.
+
 config MFD_RETU
 	tristate "Nokia Retu and Tahvo multi-function device"
 	select MFD_CORE
drivers/mfd/Makefile +1 -0
index 14fdb188af022..948a3bf8e3e57 100644
@@ -219,6 +219,7 @@ obj-$(CONFIG_MFD_INTEL_PMC_BXT)	+= intel_pmc_bxt.o
 obj-$(CONFIG_MFD_INTEL_PMT)	+= intel_pmt.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
drivers/mfd/ntxec.c new file +221 -0

221 lines not on this page · raw message

include/linux/mfd/ntxec.h new file +37 -0
new file mode 100644
index 0000000000000..361204d125f1a
@@ -0,0 +1,37 @@
+/* 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 <linux/types.h>
+
+struct device;
+struct regmap;
+
+struct ntxec {
+	struct device *dev;
+	struct regmap *regmap;
+};
+
+/*
+ * Some registers, such as the battery status register (0x41), are in
+ * big-endian, but others only have eight significant bits, which are in the
+ * first byte transmitted over I2C (the MSB of the big-endian value).
+ * This convenience function converts an 8-bit value to 16-bit for use in the
+ * second kind of register.
+ */
+static inline __be16 ntxec_reg8(u8 value)
+{
+	return value << 8;
+}
+
+/* Known firmware versions */
+#define NTXEC_VERSION_KOBO_AURA	0xd726	/* found in Kobo Aura */
+
+#endif

--
2.29.2

author maintainer
#4 lore raw

PATCH v9 4/7 pwm: ntxec: Add driver for PWM function in Netronix EC

In reply to Jonathan Neuschäfer

The Netronix EC provides a PWM output which is used for the backlight on some ebook readers. This patches adds a driver for the PWM output.

The .get_state callback is not implemented, because the PWM state can't be read back from the hardware.

---
v9:
- Add Thierry Reding's A-b tag

v8:
- https://lore.kernel.org/lkml/[email protected]/
- Add Uwe Kleine-König's R-b tag
- Copy dev.of_node from parent device

v7:
- no changes

v6:
- Move period / duty cycle setting code to a function
- Rename pwmchip_to_priv to ntxec_pwm_from_chip
- Set period and duty cycle only before enabling the output
- Mention that duty=0, enable=1 is assumed not to happen
- Interleave writes to the period and duty cycle registers, to minimize the window of time that an inconsistent state is configured

v5:
- Avoid truncation of period and duty cycle to 32 bits
- Make ntxec_pwm_ops const
- Use regmap_multi_reg_write
- Add comment about get_state to ntxec_pwm_ops
- Add comments about non-atomicity of (period, duty cycle) update

v4:
- Document hardware/driver limitations
- Only accept normal polarity
- Fix a typo ("zone" -> "zero")
- change MAX_PERIOD_NS to 0xffff * 125
- Clamp period to the maximum rather than returning an error
- Rename private struct pointer to priv
- Rearrage control flow in _probe to save a few lines and a temporary variable
- Add missing MODULE_ALIAS line
- Spell out ODM

v3:
- Relicense as GPLv2 or later
- Add email address to copyright line
- Remove OF compatible string and don't include linux/of_device.h
- Fix bogus ?: in return line
- Don't use a comma after sentinels
- Avoid ret |= ... pattern
- Move 8-bit register conversion to ntxec.h

v2:
- Various grammar and style improvements, as suggested by Uwe Kleine-König, Lee Jones, and Alexandre Belloni
- Switch to regmap
- Prefix registers with NTXEC_REG_
- Add help text to the Kconfig option
- Use the .apply callback instead of the old API
- Add a #define for the time base (125ns)
- Don't change device state in .probe; this avoids multiple problems
- Rework division and overflow check logic to perform divisions in 32 bits
- Avoid setting duty cycle to zero, to work around a hardware quirk

---
 drivers/pwm/Kconfig     |   8 ++
 drivers/pwm/Makefile    |   1 +
 drivers/pwm/pwm-ntxec.c | 184 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 193 insertions(+)
 create mode 100644 drivers/pwm/pwm-ntxec.c
drivers/pwm/Kconfig +8 -0
index 0937e1c047acb..a2830b8832b97 100644
@@ -393,6 +393,14 @@ config PWM_MXS
 	  To compile this driver as a module, choose M here: the module
 	  will be called pwm-mxs.
 
+config PWM_NTXEC
+	tristate "Netronix embedded controller PWM support"
+	depends on MFD_NTXEC
+	help
+	  Say yes here if you want to support the PWM output of the embedded
+	  controller found in certain e-book readers designed by the original
+	  design manufacturer Netronix.
+
 config PWM_OMAP_DMTIMER
 	tristate "OMAP Dual-Mode Timer PWM support"
 	depends on OF
drivers/pwm/Makefile +1 -0
index 18b89d7fd092a..7d97eb595bbef 100644
@@ -35,6 +35,7 @@ obj-$(CONFIG_PWM_MESON)		+= pwm-meson.o
 obj-$(CONFIG_PWM_MEDIATEK)	+= pwm-mediatek.o
 obj-$(CONFIG_PWM_MTK_DISP)	+= pwm-mtk-disp.o
 obj-$(CONFIG_PWM_MXS)		+= pwm-mxs.o
+obj-$(CONFIG_PWM_NTXEC)		+= pwm-ntxec.o
 obj-$(CONFIG_PWM_OMAP_DMTIMER)	+= pwm-omap-dmtimer.o
 obj-$(CONFIG_PWM_PCA9685)	+= pwm-pca9685.o
 obj-$(CONFIG_PWM_PXA)		+= pwm-pxa.o
drivers/pwm/pwm-ntxec.c new file +184 -0

184 lines not on this page · raw message

--
2.29.2

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

author maintainer
#5 lore raw

PATCH v9 5/7 rtc: New driver for RTC in Netronix embedded controller

In reply to Jonathan Neuschäfer

With this driver, mainline Linux can keep its time and date in sync with the vendor kernel.

Advanced functionality like alarm and automatic power-on is not yet supported.

---
v9:
- no changes

v8:
- https://lore.kernel.org/lkml/[email protected]/
- Copy dev.of_node from parent device

v7:
- Adjust to recent RTC API change (rtc_register_device -> devm_rtc_register_device)

v6:
- no changes

v5:
- Add Alexandre Belloni's A-b
- Use regmap_multi_reg_write

v4:
- Remove "driver" from Kconfig entry for consistency with most other entries
- Add missing MODULE_ALIAS line
- Give NTXEC_REG_READ_ macros longer names
- Solve the read tearing issue using Alexandre Belloni's algorithm
- Solve the write tearing issue using Uwe Kleine-König's algorithm
- Spell out ODM

v3:
- Add email address to copyright line
- Remove OF compatible string and don't include linux/of_device.h
- Don't use a comma after sentinels
- Avoid ret |= ... pattern
- Move 8-bit register conversion to ntxec.h
- Relicense as GPLv2 or later

v2:
- Rework top-of-file comment [Lee Jones]
- Sort the #include lines [Alexandre Belloni]
- don't align = signs in struct initializers [Uwe Kleine-König]
- Switch to regmap
- Fix register number used to read minutes and seconds
- Prefix registers with NTXEC_REG_
- Add help text to the Kconfig option
- Use devm_rtc_allocate_device and rtc_register_device, set ->range_min and ->range_max

---
 drivers/rtc/Kconfig     |   8 +++
 drivers/rtc/Makefile    |   1 +
 drivers/rtc/rtc-ntxec.c | 145 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 154 insertions(+)
 create mode 100644 drivers/rtc/rtc-ntxec.c
drivers/rtc/Kconfig +8 -0
index 6123f9f4fbc90..d49cf387add14 100644
@@ -1315,6 +1315,14 @@ config RTC_DRV_CROS_EC
 	  This driver can also be built as a module. If so, the module
 	  will be called rtc-cros-ec.
 
+config RTC_DRV_NTXEC
+	tristate "Netronix embedded controller RTC"
+	depends on MFD_NTXEC
+	help
+	  Say yes here if you want to support the RTC functionality of the
+	  embedded controller found in certain e-book readers designed by the
+	  original design manufacturer Netronix.
+
 comment "on-CPU RTC drivers"
 
 config RTC_DRV_ASM9260
drivers/rtc/Makefile +1 -0
index bb8f319b09fbf..92c26eafe70ce 100644
@@ -110,6 +110,7 @@ obj-$(CONFIG_RTC_DRV_MT7622)	+= rtc-mt7622.o
 obj-$(CONFIG_RTC_DRV_MV)	+= rtc-mv.o
 obj-$(CONFIG_RTC_DRV_MXC)	+= rtc-mxc.o
 obj-$(CONFIG_RTC_DRV_MXC_V2)	+= rtc-mxc_v2.o
+obj-$(CONFIG_RTC_DRV_NTXEC)	+= rtc-ntxec.o
 obj-$(CONFIG_RTC_DRV_OMAP)	+= rtc-omap.o
 obj-$(CONFIG_RTC_DRV_OPAL)	+= rtc-opal.o
 obj-$(CONFIG_RTC_DRV_PALMAS)	+= rtc-palmas.o
drivers/rtc/rtc-ntxec.c new file +145 -0

145 lines not on this page · raw message

--
2.29.2

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

author maintainer
#6 lore raw

PATCH v9 6/7 MAINTAINERS: Add entry for Netronix embedded controller

In reply to Jonathan Neuschäfer

Let's make sure I'll notice when there are patches for the NTXEC drivers.

---
v4-v9:
- no changes

v3:
- https://lore.kernel.org/lkml/[email protected]/
- Remove pwm and rtc bindings

v2:
- No changes

---
 MAINTAINERS | 9 +++++++++
 1 file changed, 9 insertions(+)
MAINTAINERS +9 -0
index 546aa66428c9f..0c6e739e3afb7 100644
@@ -12298,6 +12298,15 @@ F:	include/net/netrom.h
 F:	include/uapi/linux/netrom.h
 F:	net/netrom/
 
+NETRONIX EMBEDDED CONTROLLER
+M:	Jonathan Neuschäfer <[email protected]>
+S:	Maintained
+F:	Documentation/devicetree/bindings/mfd/netronix,ntxec.yaml
+F:	drivers/mfd/ntxec.c
+F:	drivers/pwm/pwm-ntxec.c
+F:	drivers/rtc/rtc-ntxec.c
+F:	include/linux/mfd/ntxec.h
+
 NETRONOME ETHERNET DRIVERS
 M:	Simon Horman <[email protected]>
 R:	Jakub Kicinski <[email protected]>

--
2.29.2

author maintainer
#7 lore raw

PATCH v9 7/7 ARM: dts: imx50-kobo-aura: Add Netronix embedded controller

In reply to Jonathan Neuschäfer

Enable the Netronix EC on the Kobo Aura ebook reader.

Several features are still missing:
- Frontlight/backlight. The vendor kernel drives the frontlight LED using the PWM output of the EC and an additional boost pin that increases the brightness.
- Battery monitoring
- Interrupts for RTC alarm and low-battery events

---
v5-v9:
- no changes

v4:
- https://lore.kernel.org/lkml/[email protected]/
- Add 'grp' suffix to pinctrl node

v3:
- Remove interrupt-controller property from embedded-controller node
- subnodes of embedded-controller node in to the main node

v2:
- Fix pwm-cells property (should be 2, not 1)

---
 arch/arm/boot/dts/imx50-kobo-aura.dts | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)
arch/arm/boot/dts/imx50-kobo-aura.dts +15 -1
index 97cfd970fe742..82ce8c43be867 100644
@@ -143,10 +143,24 @@ &i2c3 {
 	pinctrl-0 = <&pinctrl_i2c3>;
 	status = "okay";
 
-	/* TODO: embedded controller at 0x43 */
+	embedded-controller@43 {
+		pinctrl-names = "default";
+		pinctrl-0 = <&pinctrl_ec>;
+		compatible = "netronix,ntxec";
+		reg = <0x43>;
+		system-power-controller;
+		interrupts-extended = <&gpio4 11 IRQ_TYPE_EDGE_FALLING>;
+		#pwm-cells = <2>;
+	};
 };
 
 &iomuxc {
+	pinctrl_ec: ecgrp {
+		fsl,pins = <
+			MX50_PAD_CSPI_SS0__GPIO4_11		0x0	/* INT */
+		>;
+	};
+
 	pinctrl_gpiokeys: gpiokeysgrp {
 		fsl,pins = <
 			MX50_PAD_CSPI_MISO__GPIO4_10		0x0

--
2.29.2

_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

#8 lore raw

PATCH 1/1 ARM: dts: imx6sl-tolino-shine2hd: Add Netronix embedded controller

For now, the driver detects an incompatible version, but since that can be handled by auto-detection, add the controller to the devicetree now. Only PWM seems to be available, there is no RTC in that controller.

---
 arch/arm/boot/dts/imx6sl-tolino-shine2hd.dts | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
arch/arm/boot/dts/imx6sl-tolino-shine2hd.dts +5 -2
index caa279608803..c26bc5e10593 100644
@@ -97,8 +97,11 @@ &i2c1 {
 	pinctrl-1 = <&pinctrl_i2c1_sleep>;
 	status = "okay";
 
-	/* TODO: embedded controller at 0x43 (driver missing) */
-
+	ec: embedded-controller@43 {
+		compatible = "netronix,ntxec";
+		reg = <0x43>;
+		#pwm-cells = <2>;
+	};
 };
 
 &i2c2 {
Signature · 1 line
2.29.2
author maintainer Reviewed-by on v1 1/1
#9 lore raw

Re: [PATCH] ARM: dts: imx6sl-tolino-shine2hd: Add Netronix embedded controller

Quoted 7 lines · Andreas Kemnade

For now, the driver detects an incompatible version, but since that can be handled by auto-detection, add the controller to the devicetree now. Only PWM seems to be available, there is no RTC in that controller.

---

Quoted 8 lines
 arch/arm/boot/dts/imx6sl-tolino-shine2hd.dts | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
arch/arm/boot/dts/imx6sl-tolino-shine2hd.dts +0 -0
index caa279608803..c26bc5e10593 100644

arch/arm/boot/dts/imx6sl-tolino-shine2hd.dts &i2c1 { · line 104

Quoted 10 lines
arch/arm/boot/dts/imx6sl-tolino-shine2hd.dts +5 -2
@@ -97,8 +97,11 @@ &i2c1 {
 	pinctrl-1 = <&pinctrl_i2c1_sleep>;
 	status = "okay";
 
-	/* TODO: embedded controller at 0x43 (driver missing) */
-
+	ec: embedded-controller@43 {
+		compatible = "netronix,ntxec";
+		reg = <0x43>;
+		#pwm-cells = <2>;
+	};

Looks good.

Thanks,
Jonathan

Applied
#10 lore raw

Re: [PATCH] ARM: dts: imx6sl-tolino-shine2hd: Add Netronix embedded controller

In reply to Andreas Kemnade
Quoted 6 lines · Andreas Kemnade

For now, the driver detects an incompatible version, but since that can be handled by auto-detection, add the controller to the devicetree now. Only PWM seems to be available, there is no RTC in that controller.

Applied, thanks.

Applied
#11 lore raw

Re: [PATCH v9 7/7] ARM: dts: imx50-kobo-aura: Add Netronix embedded controller

In reply to Jonathan Neuschäfer
Quoted 10 lines · Jonathan Neuschäfer

Enable the Netronix EC on the Kobo Aura ebook reader.

Several features are still missing:
- Frontlight/backlight. The vendor kernel drives the frontlight LED using the PWM output of the EC and an additional boost pin that increases the brightness.
- Battery monitoring
- Interrupts for RTC alarm and low-battery events

Applied, thanks.

#12 lore raw
In reply to Jonathan Neuschäfer
Quoted 7 lines · On Sun, 24 Jan 2021 22:41:20 +0100 Jonathan Neuschäfer <[email protected]>…

This patchset adds basic support for the embedded controller found on older ebook reader boards designed by/with the ODM Netronix Inc.[1] and sold by Kobo or Tolino, for example the Kobo Aura and the Tolino Shine. These drivers are based on information contained in the vendor kernel sources, but in order to all information in a single place, I documented the register interface of the EC on GitHub[2].

Quoted 8 lines

[1]: http://www.netronixinc.com/products.aspx?ID=1
[2]: https://github.com/neuschaefer/linux/wiki/Netronix-MSP430-embedded-controller

v9:
- Fixed a bug in the error handling of ntxec_probe,

- Added Thierry Reding's ACK to the PWM patch

what is the fate of this one, looks like it got all acks from maintainers.

Regards,
Andreas

#13 lore raw
Quoted 13 lines · Andreas Kemnade
Quoted 10 lines · On Sun, 24 Jan 2021 22:41:20 +0100 Jonathan Neuschäfer <[email protected]>…

This patchset adds basic support for the embedded controller found on older ebook reader boards designed by/with the ODM Netronix Inc.[1] and sold by Kobo or Tolino, for example the Kobo Aura and the Tolino Shine. These drivers are based on information contained in the vendor kernel sources, but in order to all information in a single place, I documented the register interface of the EC on GitHub[2].

[1]: http://www.netronixinc.com/products.aspx?ID=1
[2]: https://github.com/neuschaefer/linux/wiki/Netronix-MSP430-embedded-controller

Quoted 7 lines
Quoted 5 lines

v9:
- Fixed a bug in the error handling of ntxec_probe,

- Added Thierry Reding's ACK to the PWM patch

what is the fate of this one, looks like it got all acks from maintainers.

I'll apply it when -rc1 is out.

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
#14 lore raw

[GIT PULL] Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

In reply to Jonathan Neuschäfer

Enjoy!

The following changes since commit fe07bfda2fb9cdef8a4d4008a409bb02f35f1bd8:

Linux 5.12-rc1 (2021-02-28 16:05:19 -0800)

are available in the Git repository at:

git://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git ib-mfd-pwm-rtc-v5.13

for you to fetch changes up to 80629611215d1c5d52ed3cf723fd6d24a5872504:

MAINTAINERS: Add entry for Netronix embedded controller (2021-03-01 10:26:17 +0000)

----------------------------------------------------------------
Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

----------------------------------------------------------------
Jonathan Neuschäfer (6):
dt-bindings: Add vendor prefix for Netronix, Inc.
dt-bindings: mfd: Add binding for Netronix embedded controller
mfd: Add base driver for Netronix embedded controller
pwm: ntxec: Add driver for PWM function in Netronix EC
rtc: New driver for RTC in Netronix embedded controller
MAINTAINERS: Add entry for Netronix embedded controller

 .../devicetree/bindings/mfd/netronix,ntxec.yaml    |  76 +++++++
 .../devicetree/bindings/vendor-prefixes.yaml       |   2 +
 MAINTAINERS                                        |   9 +
 drivers/mfd/Kconfig                                |  11 +
 drivers/mfd/Makefile                               |   1 +
 drivers/mfd/ntxec.c                                | 221 +++++++++++++++++++++
 drivers/pwm/Kconfig                                |   8 +
 drivers/pwm/Makefile                               |   1 +
 drivers/pwm/pwm-ntxec.c                            | 184 +++++++++++++++++
 drivers/rtc/Kconfig                                |   8 +
 drivers/rtc/Makefile                               |   1 +
 drivers/rtc/rtc-ntxec.c                            | 145 ++++++++++++++
 include/linux/mfd/ntxec.h                          |  37 ++++
 13 files changed, 704 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/netronix,ntxec.yaml
 create mode 100644 drivers/mfd/ntxec.c
 create mode 100644 drivers/pwm/pwm-ntxec.c
 create mode 100644 drivers/rtc/rtc-ntxec.c
 create mode 100644 include/linux/mfd/ntxec.h
Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
#15 lore raw

Re: [GIT PULL] Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

Quoted 37 lines · Lee Jones

Enjoy!

The following changes since commit fe07bfda2fb9cdef8a4d4008a409bb02f35f1bd8:

Linux 5.12-rc1 (2021-02-28 16:05:19 -0800)

are available in the Git repository at:

git://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git ib-mfd-pwm-rtc-v5.13

for you to fetch changes up to 80629611215d1c5d52ed3cf723fd6d24a5872504:

MAINTAINERS: Add entry for Netronix embedded controller (2021-03-01 10:26:17 +0000)

----------------------------------------------------------------
Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

----------------------------------------------------------------
Jonathan Neuschäfer (6):
dt-bindings: Add vendor prefix for Netronix, Inc.
dt-bindings: mfd: Add binding for Netronix embedded controller
mfd: Add base driver for Netronix embedded controller
pwm: ntxec: Add driver for PWM function in Netronix EC
rtc: New driver for RTC in Netronix embedded controller
MAINTAINERS: Add entry for Netronix embedded controller

 .../devicetree/bindings/mfd/netronix,ntxec.yaml    |  76 +++++++
 .../devicetree/bindings/vendor-prefixes.yaml       |   2 +
 MAINTAINERS                                        |   9 +
 drivers/mfd/Kconfig                                |  11 +
 drivers/mfd/Makefile                               |   1 +
 drivers/mfd/ntxec.c                                | 221 +++++++++++++++++++++
 drivers/pwm/Kconfig                                |   8 +
 drivers/pwm/Makefile                               |   1 +
 drivers/pwm/pwm-ntxec.c                            | 184 +++++++++++++++++
 drivers/rtc/Kconfig                                |   8 +
 drivers/rtc/Makefile                               |   1 +
Quoted 8 lines
 drivers/rtc/rtc-ntxec.c                            | 145 ++++++++++++++
 include/linux/mfd/ntxec.h                          |  37 ++++
 13 files changed, 704 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/netronix,ntxec.yaml
 create mode 100644 drivers/mfd/ntxec.c
 create mode 100644 drivers/pwm/pwm-ntxec.c
 create mode 100644 drivers/rtc/rtc-ntxec.c
 create mode 100644 include/linux/mfd/ntxec.h

FYI, if anyone has pulled this, they should probably rebase it onto v5.12-rc2 and delete the v5.12-rc1 tag from their tree:

https://lwn.net/Articles/848431/

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
#16 lore raw

Re: [GIT PULL] Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

Quoted 48 lines · Lee Jones
Quoted 37 lines · Lee Jones

Enjoy!

The following changes since commit fe07bfda2fb9cdef8a4d4008a409bb02f35f1bd8:

Linux 5.12-rc1 (2021-02-28 16:05:19 -0800)

are available in the Git repository at:

git://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git ib-mfd-pwm-rtc-v5.13

for you to fetch changes up to 80629611215d1c5d52ed3cf723fd6d24a5872504:

MAINTAINERS: Add entry for Netronix embedded controller (2021-03-01 10:26:17 +0000)

----------------------------------------------------------------
Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

----------------------------------------------------------------
Jonathan Neuschäfer (6):
dt-bindings: Add vendor prefix for Netronix, Inc.
dt-bindings: mfd: Add binding for Netronix embedded controller
mfd: Add base driver for Netronix embedded controller
pwm: ntxec: Add driver for PWM function in Netronix EC
rtc: New driver for RTC in Netronix embedded controller
MAINTAINERS: Add entry for Netronix embedded controller

 .../devicetree/bindings/mfd/netronix,ntxec.yaml    |  76 +++++++
 .../devicetree/bindings/vendor-prefixes.yaml       |   2 +
 MAINTAINERS                                        |   9 +
 drivers/mfd/Kconfig                                |  11 +
 drivers/mfd/Makefile                               |   1 +
 drivers/mfd/ntxec.c                                | 221 +++++++++++++++++++++
 drivers/pwm/Kconfig                                |   8 +
 drivers/pwm/Makefile                               |   1 +
 drivers/pwm/pwm-ntxec.c                            | 184 +++++++++++++++++
 drivers/rtc/Kconfig                                |   8 +
 drivers/rtc/Makefile                               |   1 +
Quoted 8 lines
 drivers/rtc/rtc-ntxec.c                            | 145 ++++++++++++++
 include/linux/mfd/ntxec.h                          |  37 ++++
 13 files changed, 704 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/netronix,ntxec.yaml
 create mode 100644 drivers/mfd/ntxec.c
 create mode 100644 drivers/pwm/pwm-ntxec.c
 create mode 100644 drivers/rtc/rtc-ntxec.c
 create mode 100644 include/linux/mfd/ntxec.h
Quoted 4 lines

FYI, if anyone has pulled this, they should probably rebase it onto v5.12-rc2 and delete the v5.12-rc1 tag from their tree:

https://lwn.net/Articles/848431/

In case you haven't pulled this in yet, I have created a new tag:

ib-mfd-pwm-rtc-v5.13-1

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
#17 lore raw

Re: [GIT PULL] Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

In reply to Lee Jones

Hello Lee,

Quoted 17 lines · Lee Jones
Quoted 15 lines · Lee Jones

The following changes since commit fe07bfda2fb9cdef8a4d4008a409bb02f35f1bd8:

Linux 5.12-rc1 (2021-02-28 16:05:19 -0800)

are available in the Git repository at:

git://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git ib-mfd-pwm-rtc-v5.13

for you to fetch changes up to 80629611215d1c5d52ed3cf723fd6d24a5872504:

MAINTAINERS: Add entry for Netronix embedded controller (2021-03-01 10:26:17 +0000)

----------------------------------------------------------------
Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

Quoted 7 lines
Quoted 2 lines

----------------------------------------------------------------
[...]

FYI, if anyone has pulled this, they should probably rebase it onto v5.12-rc2 and delete the v5.12-rc1 tag from their tree:

https://lwn.net/Articles/848431/

I'm not directly affected, but I wonder: The idea of an immutable branch is that the same history gets included in different trees. If now each maintainer rebases individually the result isn't the same history any more in each tree which somewhat defeats the idea of using immutable branches.

IMHO there are two ways forward: Either someone (Lee again?) creates a new pull request for this series rebased on -rc2; or we accept that these few patches are based on -rc1. For the latter it would be beneficial to merge the tag into a tree that is already based on -rc2.

Currently this branch makes it into next only via mfd[1].

A little bit of statistics for the interested: Between the broken commit 48d15436fde6 and its fix (caf6912f3f4a) there are 655 commits that are broken (git rev-list --ancestry-path 48d15436fde6..caf6912f3f4a | wc -l). We won't get rid of these. (Well unless Linus descides to rewrite history which would surprise me.)

In current next (b01d57bfdc41c8f635b08b8a5af8a31217d46936) there are 3244 commits that include the broken commit 48d15436fde6 (git rev-list --ancestry-path 48d15436fde6..next/master | wc -l) and only 1411 of them also include the fix
(git rev-list --ancestry-path caf6912f3f4a..next/master | wc -l). So next currently introduces 3244 - 1411 - 655 = 1178 additional broken commits. My feeling is that unless this number goes down considerably, we don't have to recourse to special measures to fix the 6 commits in this pull request and merging it based on -rc1-dontuse should be fine.

A list of merges into next that contain the problematic commit but not its fix can be generated using

git rev-list --merges --first-parent linus/master..next/master | while read c; do

	if git merge-base --is-ancestor 48d15436fde6 $c^2 && ! git merge-base --is-ancestor caf6912f3f4a $c^2; then
		git show -s --pretty=oneline "$c";
	fi;

done | nl

It currently shows 37 merges.

Best regards
Uwe

[1] git rev-list --merges --first-parent 80629611215d1c5d52ed3cf723fd6d24a5872504..next/master | while read c; do if git merge-base --is-ancestor 80629611215d1c5d52ed3cf723fd6d24a5872504 $c^2; then git show -s --pretty=oneline "$c"; fi; done

Signature · 2 lines
Pengutronix e.K.                           | Uwe Kleine-König            |
Industrial Linux Solutions                 | https://www.pengutronix.de/ |
#18 lore raw

Re: [GIT PULL] Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

Quoted 34 lines · Uwe Kleine-König

Hello Lee,

Quoted 17 lines · Lee Jones
Quoted 15 lines · Lee Jones

The following changes since commit fe07bfda2fb9cdef8a4d4008a409bb02f35f1bd8:

Linux 5.12-rc1 (2021-02-28 16:05:19 -0800)

are available in the Git repository at:

git://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git ib-mfd-pwm-rtc-v5.13

for you to fetch changes up to 80629611215d1c5d52ed3cf723fd6d24a5872504:

MAINTAINERS: Add entry for Netronix embedded controller (2021-03-01 10:26:17 +0000)

----------------------------------------------------------------
Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

Quoted 7 lines
Quoted 2 lines

----------------------------------------------------------------
[...]

FYI, if anyone has pulled this, they should probably rebase it onto v5.12-rc2 and delete the v5.12-rc1 tag from their tree:

https://lwn.net/Articles/848431/

I'm not directly affected, but I wonder: The idea of an immutable branch is that the same history gets included in different trees. If now each maintainer rebases individually the result isn't the same history any more in each tree which somewhat defeats the idea of using immutable branches.

Quoted 5 lines

IMHO there are two ways forward: Either someone (Lee again?) creates a new pull request for this series rebased on -rc2; or we accept that these few patches are based on -rc1. For the latter it would be beneficial to merge the tag into a tree that is already based on -rc2.

The solution is simply for the maintainers merging the immutable branch to do that in a branch based on -rc2. Eg. I've rebased rtc-next on -rc2 (fast forward, I didn't have any patch). I can now merge this branch if necessary, problem solved. If you can't rebased, nothing prevents you from merging -rc2 in any branch.

Signature · 3 lines
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#19 lore raw

Re: [GIT PULL] Immutable branch between MFD, PWM and RTC due for the v5.13 merge window

Quoted 7 lines · Alexandre Belloni
Quoted 4 lines · Uwe Kleine-König

IMHO there are two ways forward: Either someone (Lee again?) creates a new pull request for this series rebased on -rc2; or we accept that these few patches are based on -rc1. For the latter it would be beneficial to merge the tag into a tree that is already based on -rc2.

Quoted 5 lines

The solution is simply for the maintainers merging the immutable branch to do that in a branch based on -rc2. Eg. I've rebased rtc-next on -rc2 (fast forward, I didn't have any patch). I can now merge this branch if necessary, problem solved. If you can't rebased, nothing prevents you from merging -rc2 in any branch.

That doesn't exactly address the issue - the goal was to reduce the number of commits that a bisect could hit which have the swapfile bug but lack the fix. How serious a few extra commits on a shared branch really are is of course an open question though.