mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzk@kernel.org>
To: "Markus Probst" <markus.probst@posteo.de>,
	"Lee Jones" <lee@kernel.org>, "Rob Herring" <robh@kernel.org>,
	"Krzysztof Kozlowski" <krzk+dt@kernel.org>,
	"Conor Dooley" <conor+dt@kernel.org>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Boqun Feng" <boqun@kernel.org>, "Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Danilo Krummrich" <dakr@kernel.org>
Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-staging@lists.linux.dev, rust-for-linux@vger.kernel.org
Subject: Re: [PATCH 1/2] dt-bindings: mfd: Add binding for synology,microp devices
Date: Sat, 7 Mar 2026 11:20:02 +0100	[thread overview]
Message-ID: <be179573-edc3-4b6c-8c91-ae7b0c61c1b1@kernel.org> (raw)
In-Reply-To: <20260306-synology_microp_initial-v1-1-fcffede6448c@posteo.de>

On 06/03/2026 20:38, Markus Probst wrote:
> Add the Synology Microp devicetree bindings. Those devices are
> microcontrollers found on Synology NAS devices. They are connected to a
> serial port on the host device.

A nit, subject: drop second/last, redundant "binding for". The
"dt-bindings" prefix is already stating that these are bindings.
See also:
https://elixir.bootlin.com/linux/v6.17-rc3/source/Documentation/devicetree/bindings/submitting-patches.rst#L18

> 
> Those devices are used to control certain LEDs, fan speeds, a beeper, to
> handle buttons, fan failures and to properly shutdown and reboot the
> device.
> 
> Signed-off-by: Markus Probst <markus.probst@posteo.de>
> ---
>  .../devicetree/bindings/mfd/synology,microp.yaml   | 75 ++++++++++++++++++++++
>  1 file changed, 75 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/mfd/synology,microp.yaml b/Documentation/devicetree/bindings/mfd/synology,microp.yaml
> new file mode 100644
> index 000000000000..0fcb0b750bf0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/synology,microp.yaml
> @@ -0,0 +1,75 @@
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mfd/synology,microp.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Synology NAS on-board Microcontroller
> +
> +maintainers:
> +  - Markus Probst <markus.probst@posteo.de>
> +
> +description: |

Do not need '|' unless you need to preserve formatting.

> +  Synology devices contain a microcontroller on their device to control
> +  certain leds, fan speeds, a beeper, to properly handle system shutdown
> +  and reboot, buttons and fan failures.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - synology,microp

Missing blank line. Look at other bindings how to write one.

> +  power-led:
> +    $ref: /schemas/leds/common.yaml
> +    unevaluatedProperties: false
> +  status-led:
> +    $ref: /schemas/leds/common.yaml
> +    unevaluatedProperties: false
> +  alert-led:
> +    $ref: /schemas/leds/common.yaml
> +    unevaluatedProperties: false
> +  usb-led:
> +    $ref: /schemas/leds/common.yaml
> +    unevaluatedProperties: false

That's pretty unreadable code.

> +  no-check-fan:

Vendor prefix

> +    type: boolean
> +    description: |
> +      Disable fan failure check.

You described the desired Linux feature or behavior, not the actual
hardware. The bindings are about the latter, so instead you need to
rephrase the property and its description to match actual hardware
capabilities/features/configuration etc.

> +
> +      The fan failure event is triggered on the device, even if the fan
> +      has been intentionally set to a low speed. This property prevents a
> +      hardware protection shutdown if a fan failure event is reported.
> +  no-check-cpu-fan:

You described the desired Linux feature or behavior, not the actual
hardware. The bindings are about the latter, so instead you need to
rephrase the property and its description to match actual hardware
capabilities/features/configuration etc.

> +    type: boolean
> +    description: |
> +      Disable cpu fan failure check.
> +
> +      The cpu fan failure event is triggered on the device, even if the cpu
> +      fan has been intentionally set to a low speed. This property prevents
> +      a hardware protection shutdown if a cpu fan failure event is
> +      reported.
> +
> +required:
> +  - compatible
> +  - power-led
> +  - status-led
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/leds/common.h>
> +
> +    uart {

Drop, unuesed

> +      microp {

Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation
If you cannot find a name matching your device, please check in kernel
sources for similar cases or you can grow the spec (via pull request to
DT spec repo).

> +        compatible = "synology,microp";
> +
> +        power-led {
> +          color = <LED_COLOR_ID_BLUE>;
> +          function = LED_FUNCTION_POWER;
> +        };
> +
> +        status-led {
> +          color = <LED_COLOR_ID_MULTI>;
> +          function = LED_FUNCTION_STATUS;
> +        };
> +      };
> +    };
> 


Best regards,
Krzysztof

  reply	other threads:[~2026-03-07 10:20 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-06 19:38 [PATCH 0/2] Introduce Synology Microp driver Markus Probst
2026-03-06 19:38 ` [PATCH 1/2] dt-bindings: mfd: Add binding for synology,microp devices Markus Probst
2026-03-07 10:20   ` Krzysztof Kozlowski [this message]
2026-03-07 14:25     ` Krzysztof Kozlowski
2026-03-07 14:43     ` Markus Probst
2026-03-07 15:10       ` Krzysztof Kozlowski
2026-03-07 15:03     ` Markus Probst
2026-03-07 15:12       ` Krzysztof Kozlowski
2026-03-07 15:42   ` Krzysztof Kozlowski
2026-03-06 19:38 ` [PATCH 2/2] staging: Add initial synology microp driver Markus Probst
2026-03-07  7:15   ` Greg Kroah-Hartman
2026-03-07 12:58     ` Markus Probst
2026-03-08  7:08       ` Greg Kroah-Hartman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=be179573-edc3-4b6c-8c91-ae7b0c61c1b1@kernel.org \
    --to=krzk@kernel.org \
    --cc=a.hindborg@kernel.org \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=dakr@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=gary@garyguo.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=krzk+dt@kernel.org \
    --cc=lee@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-staging@lists.linux.dev \
    --cc=lossin@kernel.org \
    --cc=markus.probst@posteo.de \
    --cc=ojeda@kernel.org \
    --cc=robh@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tmgross@umich.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®