Turris Omnia MCU driver
Subsystems (7)
Marek Behún
maintainerv10 cover Turris Omnia MCU driver
Hello Andy, Hans, Ilpo, Arnd, Gregory, and others,
this is v10 of the series adding Turris Omnia MCU driver.
This series still depends on the immutable branch between LEDs and locking, introducing devm_mutex_init(), see the PR
https://lore.kernel.org/linux-leds/[email protected]/
See also cover letters for v1 to v9:
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
https://patchwork.kernel.org/project/linux-soc/cover/[email protected]/
Changes since v9:
- in functions where mcu->client is referred to multiple times added a helper variable client = mcu->client, suggested by Andy
- changed instances of
if (!err)
do_something;
return err;
patterns to the more traditional pattern
if (err)
return err;
do_something;
return 0; as suggested by Andy
- fixed some typos reported by Andy
- changed crc32_be(0xffffffff, ...) to crc32_be(~0, ...), as suggested by Andy
- changed to use the DECI unit macro from units.h instead of hardcoded 10, as suggested by Andy
- changed -EINTR to -ERESTARTSYS in trng read and signature read
- changed the mutex lock in signature read to interruptible mutex lock, as pointed out by Andy
Marek Behún (9):
dt-bindings: firmware: add cznic,turris-omnia-mcu binding
platform: cznic: Add preliminary support for Turris Omnia MCU
platform: cznic: turris-omnia-mcu: Add support for MCU connected GPIOs
platform: cznic: turris-omnia-mcu: Add support for poweroff and wakeup
platform: cznic: turris-omnia-mcu: Add support for MCU watchdog
platform: cznic: turris-omnia-mcu: Add support for MCU provided TRNG
platform: cznic: turris-omnia-mcu: Add support for digital message
signing via debugfs
ARM: dts: turris-omnia: Add MCU system-controller node
ARM: dts: turris-omnia: Add GPIO key node for front button
.../ABI/testing/debugfs-turris-omnia-mcu | 13 + .../sysfs-bus-i2c-devices-turris-omnia-mcu | 126 ++ .../firmware/cznic,turris-omnia-mcu.yaml | 86 ++ MAINTAINERS | 5 + .../dts/marvell/armada-385-turris-omnia.dts | 35 +- drivers/platform/Kconfig | 2 + drivers/platform/Makefile | 1 + drivers/platform/cznic/Kconfig | 50 + drivers/platform/cznic/Makefile | 9 + .../platform/cznic/turris-omnia-mcu-base.c | 450 +++++++ .../platform/cznic/turris-omnia-mcu-debugfs.c | 208 ++++ .../platform/cznic/turris-omnia-mcu-gpio.c | 1039 +++++++++++++++++ .../cznic/turris-omnia-mcu-sys-off-wakeup.c | 257 ++++ .../platform/cznic/turris-omnia-mcu-trng.c | 103 ++ .../cznic/turris-omnia-mcu-watchdog.c | 128 ++ drivers/platform/cznic/turris-omnia-mcu.h | 216 ++++ include/linux/turris-omnia-mcu-interface.h | 249 ++++ 17 files changed, 2976 insertions(+), 1 deletion(-) create mode 100644 Documentation/ABI/testing/debugfs-turris-omnia-mcu create mode 100644 Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu create mode 100644 Documentation/devicetree/bindings/firmware/cznic,turris-omnia-mcu.yaml create mode 100644 drivers/platform/cznic/Kconfig create mode 100644 drivers/platform/cznic/Makefile create mode 100644 drivers/platform/cznic/turris-omnia-mcu-base.c create mode 100644 drivers/platform/cznic/turris-omnia-mcu-debugfs.c create mode 100644 drivers/platform/cznic/turris-omnia-mcu-gpio.c create mode 100644 drivers/platform/cznic/turris-omnia-mcu-sys-off-wakeup.c create mode 100644 drivers/platform/cznic/turris-omnia-mcu-trng.c create mode 100644 drivers/platform/cznic/turris-omnia-mcu-watchdog.c create mode 100644 drivers/platform/cznic/turris-omnia-mcu.h create mode 100644 include/linux/turris-omnia-mcu-interface.h
Signature · 1 line
2.43.2
Marek Behún
maintainerPATCH v10 1/9 dt-bindings: firmware: add cznic,turris-omnia-mcu binding
Add binding for cznic,turris-omnia-mcu, the device-tree node representing the system-controller features provided by the MCU on the Turris Omnia router.
--- .../firmware/cznic,turris-omnia-mcu.yaml | 86 +++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 87 insertions(+) create mode 100644 Documentation/devicetree/bindings/firmware/cznic,turris-omnia-mcu.yaml
Documentation/devicetree/bindings/firmware/cznic,turris-omnia-mcu.yaml new file +86 -0
@@ -0,0 +1,86 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/firmware/cznic,turris-omnia-mcu.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: CZ.NIC's Turris Omnia MCU + +maintainers: + - Marek Behún <[email protected]> + +description: + The MCU on Turris Omnia acts as a system controller providing additional + GPIOs, interrupts, watchdog, system power off and wakeup configuration. + +properties: + compatible: + const: cznic,turris-omnia-mcu + + reg: + description: MCU I2C slave address + maxItems: 1 + + interrupts: + maxItems: 1 + + interrupt-controller: true + + '#interrupt-cells': + const: 2 + description: | + The first cell specifies the interrupt number (0 to 63), the second cell + specifies interrupt type (which can be one of IRQ_TYPE_EDGE_RISING, + IRQ_TYPE_EDGE_FALLING or IRQ_TYPE_EDGE_BOTH). + The interrupt numbers correspond sequentially to GPIO numbers, taking the + GPIO banks into account: + IRQ number GPIO bank GPIO pin within bank + 0 - 15 0 0 - 15 + 16 - 47 1 0 - 31 + 48 - 63 2 0 - 15 + There are several exceptions: + IRQ number meaning + 11 LED panel brightness changed by button press + 13 TRNG entropy ready + 14 ECDSA message signature computation done + + gpio-controller: true + + '#gpio-cells': + const: 3 + description: + The first cell is bank number (0, 1 or 2), the second cell is pin number + within the bank (0 to 15 for banks 0 and 2, 0 to 31 for bank 1), and the + third cell specifies consumer flags. + +required: + - compatible + - reg + - interrupts + - interrupt-controller + - gpio-controller + +additionalProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + + i2c { + #address-cells = <1>; + #size-cells = <0>; + + system-controller@2a { + compatible = "cznic,turris-omnia-mcu"; + reg = <0x2a>; + + interrupt-parent = <&gpio1>; + interrupts = <11 IRQ_TYPE_NONE>; + + gpio-controller; + #gpio-cells = <3>; + + interrupt-controller; + #interrupt-cells = <2>; + }; + };
MAINTAINERS +1 -0
@@ -2143,6 +2143,7 @@ F: Documentation/ABI/testing/sysfs-bus-moxtet-devices F: Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm F: Documentation/devicetree/bindings/bus/moxtet.txt F: Documentation/devicetree/bindings/firmware/cznic,turris-mox-rwtm.txt +F: Documentation/devicetree/bindings/firmware/cznic,turris-omnia-mcu.yaml F: Documentation/devicetree/bindings/gpio/gpio-moxtet.txt F: Documentation/devicetree/bindings/leds/cznic,turris-omnia-leds.yaml F: Documentation/devicetree/bindings/watchdog/armada-37xx-wdt.txt
Signature · 1 line
2.43.2
Marek Behún
maintainerPATCH v10 2/9 platform: cznic: Add preliminary support for Turris Omnia MCU
In reply to Marek BehúnAdd the basic skeleton for a new platform driver for the microcontroller found on the Turris Omnia board.
--- .../sysfs-bus-i2c-devices-turris-omnia-mcu | 81 ++++ MAINTAINERS | 3 + drivers/platform/Kconfig | 2 + drivers/platform/Makefile | 1 + drivers/platform/cznic/Kconfig | 25 ++ drivers/platform/cznic/Makefile | 4 + .../platform/cznic/turris-omnia-mcu-base.c | 393 ++++++++++++++++++ drivers/platform/cznic/turris-omnia-mcu.h | 70 ++++ include/linux/turris-omnia-mcu-interface.h | 249 +++++++++++ 9 files changed, 828 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu create mode 100644 drivers/platform/cznic/Kconfig create mode 100644 drivers/platform/cznic/Makefile create mode 100644 drivers/platform/cznic/turris-omnia-mcu-base.c create mode 100644 drivers/platform/cznic/turris-omnia-mcu.h create mode 100644 include/linux/turris-omnia-mcu-interface.h
Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu new file +81 -0
@@ -0,0 +1,81 @@ +What: /sys/bus/i2c/devices/<mcu_device>/board_revision +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Contains board revision number. + + Only available if board information is burned in the MCU (older + revisions have board information burned in the ATSHA204-A chip). + + Format: %u. + +What: /sys/bus/i2c/devices/<mcu_device>/first_mac_address +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Contains device first MAC address. Each Turris Omnia is + allocated 3 MAC addresses. The two additional addresses are + computed from the first one by incrementing it. + + Only available if board information is burned in the MCU (older + revisions have board information burned in the ATSHA204-A chip). + + Format: %pM. + +What: /sys/bus/i2c/devices/<mcu_device>/fw_features +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Newer versions of the microcontroller firmware report the + features they support. These can be read from this file. If the + MCU firmware is too old, this file reads 0x0. + + Format: 0x%x. + +What: /sys/bus/i2c/devices/<mcu_device>/fw_version_hash_application +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Contains the version hash (commit hash) of the application + part of the microcontroller firmware. + + Format: %s. + +What: /sys/bus/i2c/devices/<mcu_device>/fw_version_hash_bootloader +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Contains the version hash (commit hash) of the bootloader + part of the microcontroller firmware. + + Format: %s. + +What: /sys/bus/i2c/devices/<mcu_device>/mcu_type +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Contains the microcontroller type (STM32, GD32, MKL). + + Format: %s. + +What: /sys/bus/i2c/devices/<mcu_device>/reset_selector +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Contains the selected factory reset level, determined by + how long the rear reset button was held by the user during board + reset. + + Format: %i. + +What: /sys/bus/i2c/devices/<mcu_device>/serial_number +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Contains the 64-bit board serial number in hexadecimal + format. + + Only available if board information is burned in the MCU (older + revisions have board information burned in the ATSHA204-A chip). + + Format: %016X.
MAINTAINERS +3 -0
@@ -2139,6 +2139,7 @@ M: Marek Behún <[email protected]> S: Maintained W: https://www.turris.cz/ F: Documentation/ABI/testing/debugfs-moxtet +F: Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu F: Documentation/ABI/testing/sysfs-bus-moxtet-devices F: Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm F: Documentation/devicetree/bindings/bus/moxtet.txt
@@ -2152,10 +2153,12 @@ F: drivers/firmware/turris-mox-rwtm.c F: drivers/gpio/gpio-moxtet.c F: drivers/leds/leds-turris-omnia.c F: drivers/mailbox/armada-37xx-rwtm-mailbox.c +F: drivers/platform/cznic/ F: drivers/watchdog/armada_37xx_wdt.c F: include/dt-bindings/bus/moxtet.h F: include/linux/armada-37xx-rwtm-mailbox.h F: include/linux/moxtet.h +F: include/linux/turris-omnia-mcu-interface.h ARM/FARADAY FA526 PORT M: Hans Ulli Kroll <[email protected]>
drivers/platform/Kconfig +2 -0
@@ -7,6 +7,8 @@ source "drivers/platform/goldfish/Kconfig" source "drivers/platform/chrome/Kconfig" +source "drivers/platform/cznic/Kconfig" + source "drivers/platform/mellanox/Kconfig" source "drivers/platform/olpc/Kconfig"
drivers/platform/Makefile +1 -0
@@ -10,4 +10,5 @@ obj-$(CONFIG_MIPS) += mips/ obj-$(CONFIG_OLPC_EC) += olpc/ obj-$(CONFIG_GOLDFISH) += goldfish/ obj-$(CONFIG_CHROME_PLATFORMS) += chrome/ +obj-$(CONFIG_CZNIC_PLATFORMS) += cznic/ obj-$(CONFIG_SURFACE_PLATFORMS) += surface/
drivers/platform/cznic/Kconfig new file +25 -0
@@ -0,0 +1,25 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +# For a description of the syntax of this configuration file, +# see Documentation/kbuild/kconfig-language.rst. +# + +menuconfig CZNIC_PLATFORMS + bool "Platform support for CZ.NIC's Turris hardware" + help + Say Y here to be able to choose driver support for CZ.NIC's Turris + devices. This option alone does not add any kernel code. + +if CZNIC_PLATFORMS + +config TURRIS_OMNIA_MCU + tristate "Turris Omnia MCU driver" + depends on MACH_ARMADA_38X || COMPILE_TEST + depends on I2C + help + Say Y here to add support for the features implemented by the + microcontroller on the CZ.NIC's Turris Omnia SOHO router. + To compile this driver as a module, choose M here; the module will be + called turris-omnia-mcu. + +endif # CZNIC_PLATFORMS
drivers/platform/cznic/Makefile new file +4 -0
@@ -0,0 +1,4 @@ +# SPDX-License-Identifier: GPL-2.0-only + +obj-$(CONFIG_TURRIS_OMNIA_MCU) += turris-omnia-mcu.o +turris-omnia-mcu-y := turris-omnia-mcu-base.o
drivers/platform/cznic/turris-omnia-mcu-base.c new file +393 -0
393 lines not on this page · raw message
drivers/platform/cznic/turris-omnia-mcu.h new file +70 -0
70 lines not on this page · raw message
include/linux/turris-omnia-mcu-interface.h new file +249 -0
249 lines not on this page · raw message
Signature · 1 line
2.43.2
Re: [PATCH v10 2/9] platform: cznic: Add preliminary support for Turris Omnia MCU
Quoted 3 lines · Marek Behún
Add the basic skeleton for a new platform driver for the microcontroller found on the Turris Omnia board.
...
drivers/platform/cznic/turris-omnia-mcu.h line 48
Quoted 5 lines
drivers/platform/cznic/turris-omnia-mcu.h new file +5
-0+ err =omnia_cmd_read (client, cmd, &reply,sizeof (reply)); +if (!err) + *dst =le32_to_cpu (reply); + +return err;
Introduced here and "fixed" in the next patch. Something wrong with rebasing / squashing?
You will need a v11 anyway. And you have now much more time for it, don't forget to update the kernel version and date in the ABI documentation.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Marek Behún
maintainerRe: [PATCH v10 2/9] platform: cznic: Add preliminary support for Turris Omnia MCU
Quoted 13 lines · Andy Shevchenko
Quoted 3 lines · Marek Behún
Add the basic skeleton for a new platform driver for the microcontroller found on the Turris Omnia board.
...
drivers/platform/cznic/turris-omnia-mcu.h line 48
Quoted 5 lines
drivers/platform/cznic/turris-omnia-mcu.h new file +5
-0+ err =omnia_cmd_read (client, cmd, &reply,sizeof (reply)); +if (!err) + *dst =le32_to_cpu (reply); + +return err;
Quoted 6 lines
Introduced here and "fixed" in the next patch. Something wrong with rebasing / squashing?
You will need a v11 anyway. And you have now much more time for it, don't forget to update the kernel version and date in the ABI documentation.
It would seem so. I will send v11 also with the GPIO changes (to use __set_bit() and friends).
Marek
Re: [PATCH v10 2/9] platform: cznic: Add preliminary support for Turris Omnia MCU
Quoted 2 lines · Marek Behún
Quoted 1 line · Andy Shevchenko
On Fri, May 10, 2024 at 1:18 PM Marek Behún <[email protected]> wrote:
...
Quoted 9 lines
Quoted 9 lines
drivers/platform/cznic/turris-omnia-mcu.h line 48
Quoted 5 lines
drivers/platform/cznic/turris-omnia-mcu.h new file +5
-0+ err =omnia_cmd_read (client, cmd, &reply,sizeof (reply)); +if (!err) + *dst =le32_to_cpu (reply); + +return err;Introduced here and "fixed" in the next patch. Something wrong with rebasing / squashing?
Quoted 6 lines
Quoted 3 lines
You will need a v11 anyway. And you have now much more time for it, don't forget to update the kernel version and date in the ABI documentation.
It would seem so. I will send v11 also with the GPIO changes (to use
__set_bit()and friends).
I hope it will make v6.11.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Marek Behún
maintainerPATCH v10 3/9 platform: cznic: turris-omnia-mcu: Add support for MCU connected GPIOs
In reply to Marek BehúnAdd support for GPIOs connected to the MCU on the Turris Omnia board.
This includes:
- front button pin
- enable pins for USB regulators
- MiniPCIe / mSATA card presence pins in MiniPCIe port 0
- LED output pins from WAN ethernet PHY, LAN switch and MiniPCIe ports
- on board revisions 32+ also various peripheral resets and another voltage regulator enable pin
--- .../sysfs-bus-i2c-devices-turris-omnia-mcu | 16 + drivers/platform/cznic/Kconfig | 15 + drivers/platform/cznic/Makefile | 1 + .../platform/cznic/turris-omnia-mcu-base.c | 3 +- .../platform/cznic/turris-omnia-mcu-gpio.c | 1039 +++++++++++++++++ drivers/platform/cznic/turris-omnia-mcu.h | 83 +- 6 files changed, 1150 insertions(+), 7 deletions(-) create mode 100644 drivers/platform/cznic/turris-omnia-mcu-gpio.c
Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu +16 -0
@@ -22,6 +22,22 @@ Description: (RO) Contains device first MAC address. Each Turris Omnia is Format: %pM. +What: /sys/bus/i2c/devices/<mcu_device>/front_button_mode +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RW) The front button on the Turris Omnia router can be + configured either to change the intensity of all the LEDs on the + front panel, or to send the press event to the CPU as an + interrupt. + + This file switches between these two modes: + - "mcu" makes the button press event be handled by the MCU to + change the LEDs panel intensity. + - "cpu" makes the button press event be handled by the CPU. + + Format: %s. + What: /sys/bus/i2c/devices/<mcu_device>/fw_features Date: July 2024 KernelVersion: 6.10
drivers/platform/cznic/Kconfig +15 -0
@@ -16,9 +16,24 @@ config TURRIS_OMNIA_MCU tristate "Turris Omnia MCU driver" depends on MACH_ARMADA_38X || COMPILE_TEST depends on I2C + select GPIOLIB + select GPIOLIB_IRQCHIP help Say Y here to add support for the features implemented by the microcontroller on the CZ.NIC's Turris Omnia SOHO router. + The features include: + - GPIO pins + - to get front button press events (the front button can be + configured either to generate press events to the CPU or to change + front LEDs panel brightness) + - to enable / disable USB port voltage regulators and to detect + USB overcurrent + - to detect MiniPCIe / mSATA card presence in MiniPCIe port 0 + - to configure resets of various peripherals on board revisions 32+ + - to enable / disable the VHV voltage regulator to the SOC in order + to be able to program SOC's OTP on board revisions 32+ + - to get input from the LED output pins of the WAN ethernet PHY, LAN + switch and MiniPCIe ports To compile this driver as a module, choose M here; the module will be called turris-omnia-mcu.
drivers/platform/cznic/Makefile +1 -0
@@ -2,3 +2,4 @@ obj-$(CONFIG_TURRIS_OMNIA_MCU) += turris-omnia-mcu.o turris-omnia-mcu-y := turris-omnia-mcu-base.o +turris-omnia-mcu-y += turris-omnia-mcu-gpio.o
drivers/platform/cznic/turris-omnia-mcu-base.c +2 -1
@@ -196,6 +196,7 @@ static const struct attribute_group omnia_mcu_base_group = {static const struct attribute_group *omnia_mcu_groups[] = { &omnia_mcu_base_group, + &omnia_mcu_gpio_group,NULL };
@@ -370,7 +371,7 @@ static int omnia_mcu_probe(struct i2c_client *client) "Cannot read board info\n"); } -return 0 ; +return omnia_mcu_register_gpiochip (mcu); }static const struct of_device_id of_omnia_mcu_match[] = {
drivers/platform/cznic/turris-omnia-mcu-gpio.c new file +1039 -0
1,039 lines not on this page · raw message
drivers/platform/cznic/turris-omnia-mcu.h +77 -6
127 lines not on this page · raw message
Signature · 1 line
2.43.2
Marek Behún
maintainerPATCH v10 4/9 platform: cznic: turris-omnia-mcu: Add support for poweroff and wakeup
In reply to Marek BehúnAdd support for true board poweroff (MCU can disable all unnecessary voltage regulators) and wakeup at a specified time, implemented via a RTC driver so that the rtcwake utility can be used to configure it.
--- .../sysfs-bus-i2c-devices-turris-omnia-mcu | 16 ++ drivers/platform/cznic/Kconfig | 4 + drivers/platform/cznic/Makefile | 1 + .../platform/cznic/turris-omnia-mcu-base.c | 5 + .../cznic/turris-omnia-mcu-sys-off-wakeup.c | 257 ++++++++++++++++++ drivers/platform/cznic/turris-omnia-mcu.h | 20 ++ 6 files changed, 303 insertions(+) create mode 100644 drivers/platform/cznic/turris-omnia-mcu-sys-off-wakeup.c
Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu +16 -0
@@ -38,6 +38,22 @@ Description: (RW) The front button on the Turris Omnia router can be Format: %s. +What: /sys/bus/i2c/devices/<mcu_device>/front_button_poweron +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RW) Newer versions of the microcontroller firmware of the + Turris Omnia router support powering off the router into true + low power mode. The router can be powered on by pressing the + front button. + + This file configures whether front button power on is enabled. + + This file is present only if the power off feature is supported + by the firmware. + + Format: %i. + What: /sys/bus/i2c/devices/<mcu_device>/fw_features Date: July 2024 KernelVersion: 6.10
drivers/platform/cznic/Kconfig +4 -0
@@ -18,10 +18,14 @@ config TURRIS_OMNIA_MCU depends on I2C select GPIOLIB select GPIOLIB_IRQCHIP + select RTC_CLASS help Say Y here to add support for the features implemented by the microcontroller on the CZ.NIC's Turris Omnia SOHO router. The features include: + - board poweroff into true low power mode (with voltage regulators + disabled) and the ability to configure wake up from this mode (via + rtcwake) - GPIO pins - to get front button press events (the front button can be configured either to generate press events to the CPU or to change
drivers/platform/cznic/Makefile +1 -0
@@ -3,3 +3,4 @@ obj-$(CONFIG_TURRIS_OMNIA_MCU) += turris-omnia-mcu.o turris-omnia-mcu-y := turris-omnia-mcu-base.o turris-omnia-mcu-y += turris-omnia-mcu-gpio.o +turris-omnia-mcu-y += turris-omnia-mcu-sys-off-wakeup.o
drivers/platform/cznic/turris-omnia-mcu-base.c +5 -0
@@ -197,6 +197,7 @@ static const struct attribute_group omnia_mcu_base_group = {static const struct attribute_group *omnia_mcu_groups[] = { &omnia_mcu_base_group, &omnia_mcu_gpio_group, + &omnia_mcu_poweroff_group,NULL };
@@ -371,6 +372,10 @@ static int omnia_mcu_probe(struct i2c_client *client) "Cannot read board info\n"); } + err =omnia_mcu_register_sys_off_and_wakeup (mcu); +if (err) +return err; +return omnia_mcu_register_gpiochip (mcu); }
drivers/platform/cznic/turris-omnia-mcu-sys-off-wakeup.c new file +257 -0
257 lines not on this page · raw message
drivers/platform/cznic/turris-omnia-mcu.h +20 -0
@@ -12,9 +12,11 @@#include <linux/gpio/driver.h> #include <linux/if_ether.h> #include <linux/mutex.h> +#include <linux/rtc.h> #include <linux/types.h> #include <linux/workqueue.h> #include <asm/byteorder.h> +#include <asm/unaligned.h> struct i2c_client ;
@@ -36,6 +38,11 @@ struct omnia_mcu {struct delayed_work button_release_emul_work;u16 last_status;bool button_pressed_emul; + +/* RTC device for configuring wake-up */ +struct rtc_device *rtcdev; +u32 rtc_alarm; +bool front_button_poweron; }; int omnia_cmd_write_read(const struct i2c_client *client,
@@ -48,6 +55,17 @@ static inline int omnia_cmd_write(const struct i2c_client *client, void *cmd,return omnia_cmd_write_read (client, cmd, len,NULL ,0 ); } +static inline int omnia_cmd_write_u32 (const struct i2c_client *client,u8 cmd, +u32 val) +{ +u8 buf[5 ]; + + buf[0 ] = cmd; +put_unaligned_le32 (val, &buf[1 ]); + +return omnia_cmd_write (client, buf,sizeof (buf)); +} +static inline int omnia_cmd_read (const struct i2c_client *client,u8 cmd,void *reply,unsigned int len) {
@@ -135,7 +153,9 @@ static inline int omnia_cmd_read_u8(const struct i2c_client *client, u8 cmd, }extern const struct attribute_group omnia_mcu_gpio_group; +extern const struct attribute_group omnia_mcu_poweroff_group;int omnia_mcu_register_gpiochip (struct omnia_mcu *mcu); +int omnia_mcu_register_sys_off_and_wakeup (struct omnia_mcu *mcu);#endif /* __TURRIS_OMNIA_MCU_H */
Signature · 1 line
2.43.2
Marek Behún
maintainerPATCH v10 5/9 platform: cznic: turris-omnia-mcu: Add support for MCU watchdog
In reply to Marek BehúnAdd support for the watchdog mechanism provided by the MCU.
--- drivers/platform/cznic/Kconfig | 2 + drivers/platform/cznic/Makefile | 1 + .../platform/cznic/turris-omnia-mcu-base.c | 4 + .../cznic/turris-omnia-mcu-watchdog.c | 128 ++++++++++++++++++ drivers/platform/cznic/turris-omnia-mcu.h | 24 ++++ 5 files changed, 159 insertions(+) create mode 100644 drivers/platform/cznic/turris-omnia-mcu-watchdog.c
drivers/platform/cznic/Kconfig +2 -0
@@ -19,6 +19,7 @@ config TURRIS_OMNIA_MCU select GPIOLIB select GPIOLIB_IRQCHIP select RTC_CLASS + select WATCHDOG_CORE help Say Y here to add support for the features implemented by the microcontroller on the CZ.NIC's Turris Omnia SOHO router.
@@ -26,6 +27,7 @@ config TURRIS_OMNIA_MCU - board poweroff into true low power mode (with voltage regulators disabled) and the ability to configure wake up from this mode (via rtcwake) + - MCU watchdog - GPIO pins - to get front button press events (the front button can be configured either to generate press events to the CPU or to change
drivers/platform/cznic/Makefile +1 -0
@@ -4,3 +4,4 @@ obj-$(CONFIG_TURRIS_OMNIA_MCU) += turris-omnia-mcu.o turris-omnia-mcu-y := turris-omnia-mcu-base.o turris-omnia-mcu-y += turris-omnia-mcu-gpio.o turris-omnia-mcu-y += turris-omnia-mcu-sys-off-wakeup.o +turris-omnia-mcu-y += turris-omnia-mcu-watchdog.o
drivers/platform/cznic/turris-omnia-mcu-base.c +4 -0
@@ -376,6 +376,10 @@ static int omnia_mcu_probe(struct i2c_client *client)if (err)return err; + err =omnia_mcu_register_watchdog (mcu); +if (err) +return err; +return omnia_mcu_register_gpiochip (mcu); }
drivers/platform/cznic/turris-omnia-mcu-watchdog.c new file +128 -0
128 lines not on this page · raw message
drivers/platform/cznic/turris-omnia-mcu.h +24 -0
@@ -14,6 +14,7 @@#include <linux/mutex.h> #include <linux/rtc.h> #include <linux/types.h> +#include <linux/watchdog.h> #include <linux/workqueue.h> #include <asm/byteorder.h> #include <asm/unaligned.h>
@@ -43,6 +44,9 @@ struct omnia_mcu {struct rtc_device *rtcdev;u32 rtc_alarm;bool front_button_poweron; + +/* MCU watchdog */ +struct watchdog_device wdt; }; int omnia_cmd_write_read(const struct i2c_client *client,
@@ -55,6 +59,25 @@ static inline int omnia_cmd_write(const struct i2c_client *client, void *cmd,return omnia_cmd_write_read (client, cmd, len,NULL ,0 ); } +static inline int omnia_cmd_write_u8 (const struct i2c_client *client,u8 cmd, +u8 val) +{ +u8 buf[2 ] = { cmd, val }; + +return omnia_cmd_write (client, buf,sizeof (buf)); +} + +static inline int omnia_cmd_write_u16 (const struct i2c_client *client,u8 cmd, +u16 val) +{ +u8 buf[3 ]; + + buf[0 ] = cmd; +put_unaligned_le16 (val, &buf[1 ]); + +return omnia_cmd_write (client, buf,sizeof (buf)); +} +static inline int omnia_cmd_write_u32 (const struct i2c_client *client,u8 cmd,u32 val) {
@@ -157,5 +180,6 @@ extern const struct attribute_group omnia_mcu_poweroff_group;int omnia_mcu_register_gpiochip (struct omnia_mcu *mcu);int omnia_mcu_register_sys_off_and_wakeup (struct omnia_mcu *mcu); +int omnia_mcu_register_watchdog (struct omnia_mcu *mcu);#endif /* __TURRIS_OMNIA_MCU_H */
Signature · 1 line
2.43.2
Marek Behún
maintainerPATCH v10 6/9 platform: cznic: turris-omnia-mcu: Add support for MCU provided TRNG
In reply to Marek BehúnAdd support for true random number generator provided by the MCU. New Omnia boards come without the Atmel SHA204-A chip. Instead the crypto functionality is provided by new microcontroller, which has a TRNG peripheral.
--- drivers/platform/cznic/Kconfig | 2 + drivers/platform/cznic/Makefile | 1 + .../platform/cznic/turris-omnia-mcu-base.c | 6 +- .../platform/cznic/turris-omnia-mcu-gpio.c | 2 +- .../platform/cznic/turris-omnia-mcu-trng.c | 103 ++++++++++++++++++ drivers/platform/cznic/turris-omnia-mcu.h | 8 ++ 6 files changed, 120 insertions(+), 2 deletions(-) create mode 100644 drivers/platform/cznic/turris-omnia-mcu-trng.c
drivers/platform/cznic/Kconfig +2 -0
@@ -18,6 +18,7 @@ config TURRIS_OMNIA_MCU depends on I2C select GPIOLIB select GPIOLIB_IRQCHIP + select HW_RANDOM select RTC_CLASS select WATCHDOG_CORE help
@@ -27,6 +28,7 @@ config TURRIS_OMNIA_MCU - board poweroff into true low power mode (with voltage regulators disabled) and the ability to configure wake up from this mode (via rtcwake) + - true random number generator (if available on the MCU) - MCU watchdog - GPIO pins - to get front button press events (the front button can be
drivers/platform/cznic/Makefile +1 -0
@@ -4,4 +4,5 @@ obj-$(CONFIG_TURRIS_OMNIA_MCU) += turris-omnia-mcu.o turris-omnia-mcu-y := turris-omnia-mcu-base.o turris-omnia-mcu-y += turris-omnia-mcu-gpio.o turris-omnia-mcu-y += turris-omnia-mcu-sys-off-wakeup.o +turris-omnia-mcu-y += turris-omnia-mcu-trng.o turris-omnia-mcu-y += turris-omnia-mcu-watchdog.o
drivers/platform/cznic/turris-omnia-mcu-base.c +5 -1
@@ -380,7 +380,11 @@ static int omnia_mcu_probe(struct i2c_client *client)if (err)return err; -return omnia_mcu_register_gpiochip (mcu); + err =omnia_mcu_register_gpiochip (mcu); +if (err) +return err; + +return omnia_mcu_register_trng (mcu); }static const struct of_device_id of_omnia_mcu_match[] = {
drivers/platform/cznic/turris-omnia-mcu-gpio.c +1 -1
@@ -167,7 +167,7 @@ static const struct omnia_gpio omnia_gpios[64] = { };/* mapping from interrupts to indexes of GPIOs in the omnia_gpios array */ -static const u8 omnia_int_to_gpio_idx[32 ] = { +const u8 omnia_int_to_gpio_idx[32 ] = { [__bf_shf (OMNIA_INT_CARD_DET )] =4 , [__bf_shf (OMNIA_INT_MSATA_IND )] =5 , [__bf_shf (OMNIA_INT_USB30_OVC )] =6 ,
drivers/platform/cznic/turris-omnia-mcu-trng.c new file +103 -0
103 lines not on this page · raw message
drivers/platform/cznic/turris-omnia-mcu.h +8 -0
@@ -9,7 +9,9 @@#define __TURRIS_OMNIA_MCU_H#include <linux/bitops.h> +#include <linux/completion.h> #include <linux/gpio/driver.h> +#include <linux/hw_random.h> #include <linux/if_ether.h> #include <linux/mutex.h> #include <linux/rtc.h>
@@ -47,6 +49,10 @@ struct omnia_mcu {/* MCU watchdog */ struct watchdog_device wdt; + +/* true random number generator */ +struct hwrng trng; +struct completion trng_completion; }; int omnia_cmd_write_read(const struct i2c_client *client,
@@ -175,11 +181,13 @@ static inline int omnia_cmd_read_u8(const struct i2c_client *client, u8 cmd, return omnia_cmd_read(client, cmd, reply, sizeof(*reply)); } +extern const u8 omnia_int_to_gpio_idx[32 ];extern const struct attribute_group omnia_mcu_gpio_group;extern const struct attribute_group omnia_mcu_poweroff_group;int omnia_mcu_register_gpiochip (struct omnia_mcu *mcu);int omnia_mcu_register_sys_off_and_wakeup (struct omnia_mcu *mcu); +int omnia_mcu_register_trng (struct omnia_mcu *mcu);int omnia_mcu_register_watchdog (struct omnia_mcu *mcu);#endif /* __TURRIS_OMNIA_MCU_H */
Signature · 1 line
2.43.2
Marek Behún
maintainerPATCH v10 7/9 platform: cznic: turris-omnia-mcu: Add support for digital message signing via debugfs
In reply to Marek BehúnAdd support for digital message signing with private key stored in the MCU. Boards with MKL MCUs have a NIST256p ECDSA private key created when manufactured. The private key is not readable from the MCU, but MCU allows for signing messages with it and retrieving the public key.
As described in a similar commit 50524d787de3 ("firmware:
turris-mox-rwtm: support ECDSA signatures via debugfs"):
The optimal solution would be to register an akcipher provider via kernel's crypto API, but crypto API does not yet support accessing akcipher API from userspace (and probably won't for some time, see
https://www.spinics.net/lists/linux-crypto/msg38388.html).
Therefore we add support for accessing this signature generation mechanism via debugfs for now, so that userspace can access it.
--- .../ABI/testing/debugfs-turris-omnia-mcu | 13 ++ .../sysfs-bus-i2c-devices-turris-omnia-mcu | 13 ++ MAINTAINERS | 1 + drivers/platform/cznic/Kconfig | 2 + drivers/platform/cznic/Makefile | 1 + .../platform/cznic/turris-omnia-mcu-base.c | 45 +++- .../platform/cznic/turris-omnia-mcu-debugfs.c | 208 ++++++++++++++++++ drivers/platform/cznic/turris-omnia-mcu.h | 23 ++ 8 files changed, 305 insertions(+), 1 deletion(-) create mode 100644 Documentation/ABI/testing/debugfs-turris-omnia-mcu create mode 100644 drivers/platform/cznic/turris-omnia-mcu-debugfs.c
Documentation/ABI/testing/debugfs-turris-omnia-mcu new file +13 -0
@@ -0,0 +1,13 @@ +What: /sys/kernel/debug/turris-omnia-mcu/do_sign +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: + + ======= =========================================================== + (Write) Message to sign with the ECDSA private key stored in MCU. + The message must be exactly 32 bytes long (since this is + intended to be a SHA-256 hash). + (Read) The resulting signature, 64 bytes. This contains the R and + S values of the ECDSA signature, both in big-endian format. + ======= ===========================================================
Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu +13 -0
@@ -90,6 +90,19 @@ Description: (RO) Contains the microcontroller type (STM32, GD32, MKL). Format: %s. +What: /sys/bus/i2c/devices/<mcu_device>/public_key +Date: July 2024 +KernelVersion: 6.10 +Contact: Marek Behún <[email protected]> +Description: (RO) Contains board ECDSA public key. + + Only available if MCU supports signing messages with the ECDSA + algorithm. If so, the board has a private key stored in the MCU + that was generated during manufacture and cannot be retrieved + from the MCU. + + Format: %s. + What: /sys/bus/i2c/devices/<mcu_device>/reset_selector Date: July 2024 KernelVersion: 6.10
MAINTAINERS +1 -0
@@ -2139,6 +2139,7 @@ M: Marek Behún <[email protected]> S: Maintained W: https://www.turris.cz/ F: Documentation/ABI/testing/debugfs-moxtet +F: Documentation/ABI/testing/debugfs-turris-omnia-mcu F: Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu F: Documentation/ABI/testing/sysfs-bus-moxtet-devices F: Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm
drivers/platform/cznic/Kconfig +2 -0
@@ -29,6 +29,8 @@ config TURRIS_OMNIA_MCU disabled) and the ability to configure wake up from this mode (via rtcwake) - true random number generator (if available on the MCU) + - ECDSA message signing with board private key (if available on the + MCU) - MCU watchdog - GPIO pins - to get front button press events (the front button can be
drivers/platform/cznic/Makefile +1 -0
@@ -6,3 +6,4 @@ turris-omnia-mcu-y += turris-omnia-mcu-gpio.o turris-omnia-mcu-y += turris-omnia-mcu-sys-off-wakeup.o turris-omnia-mcu-y += turris-omnia-mcu-trng.o turris-omnia-mcu-y += turris-omnia-mcu-watchdog.o +turris-omnia-mcu-$(CONFIG_DEBUG_FS) += turris-omnia-mcu-debugfs.o
drivers/platform/cznic/turris-omnia-mcu-base.c +44 -1
81 lines not on this page · raw message
drivers/platform/cznic/turris-omnia-mcu-debugfs.c new file +208 -0
208 lines not on this page · raw message
drivers/platform/cznic/turris-omnia-mcu.h +23 -0
@@ -21,6 +21,9 @@#include <asm/byteorder.h> #include <asm/unaligned.h> +#define OMNIA_MCU_CRYPTO_PUBLIC_KEY_LEN (1 + 32) +#define OMNIA_MCU_CRYPTO_SIGNATURE_LEN 64 +struct i2c_client ;struct omnia_mcu {
@@ -32,6 +35,7 @@ struct omnia_mcu {u64 board_serial_number;u8 board_first_mac[ETH_ALEN ];u8 board_revision; +u8 board_public_key[OMNIA_MCU_CRYPTO_PUBLIC_KEY_LEN ];/* GPIO chip */ struct gpio_chip gc;
@@ -53,6 +57,16 @@ struct omnia_mcu {/* true random number generator */ struct hwrng trng;struct completion trng_completion; + +#ifdef CONFIG_DEBUG_FS +/* MCU ECDSA message signing via debugfs */ +struct dentry *debugfs_root; +struct completion msg_signed_completion; +struct mutex sign_lock; +unsigned int sign_state; +u8 signature[OMNIA_MCU_CRYPTO_SIGNATURE_LEN ]; +int sign_err; +#endif }; int omnia_cmd_write_read(const struct i2c_client *client,
@@ -190,4 +204,13 @@ int omnia_mcu_register_sys_off_and_wakeup(struct omnia_mcu *mcu);int omnia_mcu_register_trng (struct omnia_mcu *mcu);int omnia_mcu_register_watchdog (struct omnia_mcu *mcu); +#ifdef CONFIG_DEBUG_FS +int omnia_mcu_register_debugfs (struct omnia_mcu *mcu); +#else +static inline int omnia_mcu_register_debugfs (struct omnia_mcu *mcu) +{ +return 0 ; +} +#endif +#endif /* __TURRIS_OMNIA_MCU_H */
Signature · 1 line
2.43.2
Re: [PATCH v10 7/9] platform: cznic: turris-omnia-mcu: Add support for digital message signing via debugfs
Quoted 12 lines · Marek Behún
Add support for digital message signing with private key stored in the MCU. Boards with MKL MCUs have a NIST256p ECDSA private key created when manufactured. The private key is not readable from the MCU, but MCU allows for signing messages with it and retrieving the public key.
As described in a similar commit
50524d787de3("firmware:
turris-mox-rwtm: support ECDSA signatures via debugfs"):
The optimal solution would be to register an akcipher provider via kernel's crypto API, but crypto API does not yet support accessing akcipher API from userspace (and probably won't for some time, see
https://www.spinics.net/lists/linux-crypto/msg38388.html).
Quoted 2 lines
Therefore we add support for accessing this signature generation mechanism via debugfs for now, so that userspace can access it.
Having a "real" user/kernel api in debugfs feels wrong here, why would you not do this properly? On most, if not all, systems, debugfs is locked down so you do not have access to it, as it is only there for debugging. So how is a user supposed to use this feature if they can't get access to it?
And debugfs files can be changed at any time, so how can you ensure that your new api will always be there?
In other words, please solve this properly, do not just add a hack into debugfs that no one can use as that is not a good idea.
thanks,
greg k-h
Marek Behún
maintainerRe: [PATCH v10 7/9] platform: cznic: turris-omnia-mcu: Add support for digital message signing via debugfs
Quoted 22 lines · On Fri, 10 May 2024 11:52:56 +0100 Greg Kroah-Hartman…
Quoted 12 lines · Marek Behún
Add support for digital message signing with private key stored in the MCU. Boards with MKL MCUs have a NIST256p ECDSA private key created when manufactured. The private key is not readable from the MCU, but MCU allows for signing messages with it and retrieving the public key.
As described in a similar commit
50524d787de3("firmware:
turris-mox-rwtm: support ECDSA signatures via debugfs"):
The optimal solution would be to register an akcipher provider via kernel's crypto API, but crypto API does not yet support accessing akcipher API from userspace (and probably won't for some time, see
https://www.spinics.net/lists/linux-crypto/msg38388.html).Quoted 2 lines
Therefore we add support for accessing this signature generation mechanism via debugfs for now, so that userspace can access it.
Having a "real" user/kernel api in debugfs feels wrong here, why would you not do this properly? On most, if not all, systems, debugfs is locked down so you do not have access to it, as it is only there for debugging. So how is a user supposed to use this feature if they can't get access to it?
Quoted 5 lines
And debugfs files can be changed at any time, so how can you ensure that your new api will always be there?
In other words, please solve this properly, do not just add a hack into debugfs that no one can use as that is not a good idea.
Hi Greg,
this is the same thing we discussed 5 years ago, I wanted to implement it via crypto's akcipher, but was refused due to
https://www.spinics.net/lists/linux-crypto/msg38388.html
I've then exposed this via debugfs in the turris-mox-rwtm driver 4 years ago, and we have supported this in our utility scripts, with the plan that to reimplement it in the kernel via the correct ABI once akcipher (or other ABI) is available to userspace, but AFAIK after 5 years this is still not the case :-(
If not debugfs and not akcipher, another option is to expose this via sysfs, but that also doesn't seem right, and if I recall correctly you also disapproved of this 5 years ago.
The last option would be to create another device, something like /dev/turris-crypto for this. I wanted to avoid that and wait for akcipher to be exposed do crypto since another /dev device must be supported forever, while debugfs implementation can be removed once this is supported via standardized ABI.
Do you have any suggestions?
Marek
Re: [PATCH v10 7/9] platform: cznic: turris-omnia-mcu: Add support for digital message signing via debugfs
Quoted 43 lines · Marek Behún
Quoted 22 lines · On Fri, 10 May 2024 11:52:56 +0100 Greg Kroah-Hartman…
Quoted 12 lines · Marek Behún
Add support for digital message signing with private key stored in the MCU. Boards with MKL MCUs have a NIST256p ECDSA private key created when manufactured. The private key is not readable from the MCU, but MCU allows for signing messages with it and retrieving the public key.
As described in a similar commit
50524d787de3("firmware:
turris-mox-rwtm: support ECDSA signatures via debugfs"):
The optimal solution would be to register an akcipher provider via kernel's crypto API, but crypto API does not yet support accessing akcipher API from userspace (and probably won't for some time, see
https://www.spinics.net/lists/linux-crypto/msg38388.html).Quoted 2 lines
Therefore we add support for accessing this signature generation mechanism via debugfs for now, so that userspace can access it.
Having a "real" user/kernel api in debugfs feels wrong here, why would you not do this properly? On most, if not all, systems, debugfs is locked down so you do not have access to it, as it is only there for debugging. So how is a user supposed to use this feature if they can't get access to it?
Quoted 5 lines
And debugfs files can be changed at any time, so how can you ensure that your new api will always be there?
In other words, please solve this properly, do not just add a hack into debugfs that no one can use as that is not a good idea.
Hi Greg,
this is the same thing we discussed 5 years ago, I wanted to implement it via crypto's akcipher, but was refused due to
https://www.spinics.net/lists/linux-crypto/msg38388.htmlI've then exposed this via debugfs in the turris-mox-rwtm driver 4 years ago, and we have supported this in our utility scripts, with the plan that to reimplement it in the kernel via the correct ABI once akcipher (or other ABI) is available to userspace, but AFAIK after 5 years this is still not the case :-(
Quoted 3 lines
If not debugfs and not akcipher, another option is to expose this via sysfs, but that also doesn't seem right, and if I recall correctly you also disapproved of this 5 years ago.
Yeah, sysfs is not ok for this either.
Quoted 7 lines
The last option would be to create another device, something like
/dev/turris-cryptofor this. I wanted to avoid that and wait for akcipher to be exposed do crypto since another /dev device must be supported forever, while debugfs implementation can be removed once this is supported via standardized ABI.Do you have any suggestions?
Not really, I can't see the link above (no internet connection right now) but this should just be fixed properly at the crypto subsystem instead of these horrible debugfs hacks.
thanks,
greg k-h
Marek Behún
maintainerRe: [PATCH v10 7/9] platform: cznic: turris-omnia-mcu: Add support for digital message signing via debugfs
Quoted 58 lines · On Fri, 10 May 2024 12:37:04 +0100 Greg Kroah-Hartman…
Quoted 43 lines · Marek Behún
Quoted 22 lines · On Fri, 10 May 2024 11:52:56 +0100 Greg Kroah-Hartman…
Quoted 12 lines · Marek Behún
Add support for digital message signing with private key stored in the MCU. Boards with MKL MCUs have a NIST256p ECDSA private key created when manufactured. The private key is not readable from the MCU, but MCU allows for signing messages with it and retrieving the public key.
As described in a similar commit
50524d787de3("firmware:
turris-mox-rwtm: support ECDSA signatures via debugfs"):
The optimal solution would be to register an akcipher provider via kernel's crypto API, but crypto API does not yet support accessing akcipher API from userspace (and probably won't for some time, see
https://www.spinics.net/lists/linux-crypto/msg38388.html).Quoted 2 lines
Therefore we add support for accessing this signature generation mechanism via debugfs for now, so that userspace can access it.
Having a "real" user/kernel api in debugfs feels wrong here, why would you not do this properly? On most, if not all, systems, debugfs is locked down so you do not have access to it, as it is only there for debugging. So how is a user supposed to use this feature if they can't get access to it?
Quoted 5 lines
And debugfs files can be changed at any time, so how can you ensure that your new api will always be there?
In other words, please solve this properly, do not just add a hack into debugfs that no one can use as that is not a good idea.
Hi Greg,
this is the same thing we discussed 5 years ago, I wanted to implement it via crypto's akcipher, but was refused due to
https://www.spinics.net/lists/linux-crypto/msg38388.htmlI've then exposed this via debugfs in the turris-mox-rwtm driver 4 years ago, and we have supported this in our utility scripts, with the plan that to reimplement it in the kernel via the correct ABI once akcipher (or other ABI) is available to userspace, but AFAIK after 5 years this is still not the case :-(
Quoted 3 lines
If not debugfs and not akcipher, another option is to expose this via sysfs, but that also doesn't seem right, and if I recall correctly you also disapproved of this 5 years ago.
Yeah, sysfs is not ok for this either.
Quoted 7 lines
The last option would be to create another device, something like
/dev/turris-cryptofor this. I wanted to avoid that and wait for akcipher to be exposed do crypto since another /dev device must be supported forever, while debugfs implementation can be removed once this is supported via standardized ABI.Do you have any suggestions?
Quoted 7 lines
Not really, I can't see the link above (no internet connection right now) but this should just be fixed properly at the crypto subsystem instead of these horrible debugfs hacks.
thanks,
greg k-h
The mail is from Herbert Xu and it says the following:
The akcipher kernel API is still in a state of flux. See the recent work on ecrdsa for example which affected the RSA API.
Until that settles down I will not allow akcipher to be exported through af_alg as that would commit us to that API forever.
Marek
Re: [PATCH v10 7/9] platform: cznic: turris-omnia-mcu: Add support for digital message signing via debugfs
Quoted 69 lines · Marek Behún
Quoted 58 lines · On Fri, 10 May 2024 12:37:04 +0100 Greg Kroah-Hartman…
Quoted 43 lines · Marek Behún
Quoted 22 lines · On Fri, 10 May 2024 11:52:56 +0100 Greg Kroah-Hartman…
Quoted 12 lines · Marek Behún
Add support for digital message signing with private key stored in the MCU. Boards with MKL MCUs have a NIST256p ECDSA private key created when manufactured. The private key is not readable from the MCU, but MCU allows for signing messages with it and retrieving the public key.
As described in a similar commit
50524d787de3("firmware:
turris-mox-rwtm: support ECDSA signatures via debugfs"):
The optimal solution would be to register an akcipher provider via kernel's crypto API, but crypto API does not yet support accessing akcipher API from userspace (and probably won't for some time, see
https://www.spinics.net/lists/linux-crypto/msg38388.html).Quoted 2 lines
Therefore we add support for accessing this signature generation mechanism via debugfs for now, so that userspace can access it.
Having a "real" user/kernel api in debugfs feels wrong here, why would you not do this properly? On most, if not all, systems, debugfs is locked down so you do not have access to it, as it is only there for debugging. So how is a user supposed to use this feature if they can't get access to it?
Quoted 5 lines
And debugfs files can be changed at any time, so how can you ensure that your new api will always be there?
In other words, please solve this properly, do not just add a hack into debugfs that no one can use as that is not a good idea.
Hi Greg,
this is the same thing we discussed 5 years ago, I wanted to implement it via crypto's akcipher, but was refused due to
https://www.spinics.net/lists/linux-crypto/msg38388.htmlI've then exposed this via debugfs in the turris-mox-rwtm driver 4 years ago, and we have supported this in our utility scripts, with the plan that to reimplement it in the kernel via the correct ABI once akcipher (or other ABI) is available to userspace, but AFAIK after 5 years this is still not the case :-(
Quoted 3 lines
If not debugfs and not akcipher, another option is to expose this via sysfs, but that also doesn't seem right, and if I recall correctly you also disapproved of this 5 years ago.
Yeah, sysfs is not ok for this either.
Quoted 7 lines
The last option would be to create another device, something like
/dev/turris-cryptofor this. I wanted to avoid that and wait for akcipher to be exposed do crypto since another /dev device must be supported forever, while debugfs implementation can be removed once this is supported via standardized ABI.Do you have any suggestions?
Quoted 7 lines
Not really, I can't see the link above (no internet connection right now) but this should just be fixed properly at the crypto subsystem instead of these horrible debugfs hacks.
thanks,
greg k-h
Quoted 7 lines
The mail is from Herbert Xu and it says the following:
The akcipher kernel API is still in a state of flux. See the recent work on ecrdsa for example which affected the RSA API.
Until that settles down I will not allow akcipher to be exported through
af_algas that would commit us to that API forever.
5 years is a long time for "in a state of flux", perhaps work on getting that fixed up now that things are settled down?
thanks,
greg k-h
Marek Behún
maintainerPATCH v10 8/9 ARM: dts: turris-omnia: Add MCU system-controller node
In reply to Marek BehúnTurris Omnia's MCU provides various features that can be configured over I2C at address 0x2a. Add device-tree node.
This does not carry a Fixes tag - we do not want this to get backported to stable kernels for the following reason: U-Boot since v2022.10 inserts a phy-reset-gpio property into the WAN ethernet node pointing to the MCU node if it finds the MCU node with a cznic,turris-omnia-mcu compatible. Thus if this change got backported to a stable kernel, the WAN interface driver would defer probe indefinitely (since it would wait for the turris-omnia-mcu driver which would not be present).
--- .../dts/marvell/armada-385-turris-omnia.dts | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-)
arch/arm/boot/dts/marvell/armada-385-turris-omnia.dts +21 -1
@@ -218,7 +218,22 @@ i2c@0 { #size-cells = <0>; reg = <0>; - /* STM32F0 command interface at address 0x2a */ + mcu: system-controller@2a { + compatible = "cznic,turris-omnia-mcu"; + reg = <0x2a>; + + pinctrl-names = "default"; + pinctrl-0 = <&mcu_pins>; + + interrupt-parent = <&gpio1>; + interrupts = <11 IRQ_TYPE_NONE>; + + gpio-controller; + #gpio-cells = <3>; + + interrupt-controller; + #interrupt-cells = <2>; + }; led-controller@2b { compatible = "cznic,turris-omnia-leds";
@@ -501,6 +516,11 @@ fixed-link { }; &pinctrl { + mcu_pins: mcu-pins { + marvell,pins = "mpp43"; + marvell,function = "gpio"; + }; + pcawan_pins: pcawan-pins { marvell,pins = "mpp46"; marvell,function = "gpio";
Signature · 1 line
2.43.2
Marek Behún
maintainerPATCH v10 9/9 ARM: dts: turris-omnia: Add GPIO key node for front button
In reply to Marek BehúnNow that we have the MCU device-tree node, which acts as a GPIO controller, add GPIO key node for the front button.
--- .../boot/dts/marvell/armada-385-turris-omnia.dts | 13 +++++++++++++ 1 file changed, 13 insertions(+)
arch/arm/boot/dts/marvell/armada-385-turris-omnia.dts +13 -0
@@ -112,6 +112,19 @@ sfp: sfp { status = "disabled"; }; + gpio-keys { + compatible = "gpio-keys"; + + front-button { + label = "Front Button"; + linux,code = <KEY_VENDOR>; + linux,can-disable; + gpios = <&mcu 0 12 GPIO_ACTIVE_HIGH>; + /* debouncing is done by the microcontroller */ + debounce-interval = <0>; + }; + }; + sound { compatible = "simple-audio-card"; simple-audio-card,name = "SPDIF";
Signature · 1 line
2.43.2