2021-10-29 21:56:33

by Charles Mirabile

Subject: [PATCH 4/5] Documentation: bindings/mfd: sensehat: Raspberry Pi Sense HAT device tree binding

This patch adds the device tree binding
for the Sense HAT in yaml form.

Signed-off-by: Charles Mirabile <[email protected]>
Signed-off-by: Mwesigwa Guma <[email protected]>
Signed-off-by: Joel Savitz <[email protected]>
---
.../bindings/mfd/raspberrypi,sensehat.yaml | 50 +++++++++++++++++++
1 file changed, 50 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml

diff --git a/Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml b/Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
new file mode 100644
index 000000000000..e00cd02a3752
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+$id: http://devicetree.org/schemas/mfd/raspberrypi,sensehat.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Raspberry Pi Sensehat
+
+maintainers:
+ - Charles Mirabile <[email protected]>
+ - Mwesigwa Guma <[email protected]>
+ - Joel Savitz <[email protected]>
+
+description: |
+ The Raspberry Pi Sensehat is an addon board originally developed
+ for the Raspberry Pi that has a joystick and an 8x8 RGB LED display
+ as well as several environmental sensors. It connects via i2c and
+ a gpio for irq.
+
+properties:
+ compatible:
+ oneOf:
+ - enum:
+ - raspberrypi,sensehat
+ - rpi,rpisense
+
+ reg:
+ items:
+ - description: i2c bus address
+
+ keys-int-gpios:
+ items:
+ - description: gpio pin for joystick interrupt
+
+required:
+ - compatible
+ - reg
+ - keys-int-gpios
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ sensehat@46 {
+ compatible = "raspberrypi,sensehat";
+ reg = <0x46>;
+ keys-int-gpios = <&gpio 23 GPIO_ACTIVE_HIGH>;
+ };
+ };
--
2.31.1

2021-11-02 12:54:26

by Rob Herring (Arm)

Subject: Re: [PATCH 4/5] Documentation: bindings/mfd: sensehat: Raspberry Pi Sense HAT device tree binding

On Fri, Oct 29, 2021 at 05:55:15PM -0400, Charles Mirabile wrote:
> This patch adds the device tree binding
> for the Sense HAT in yaml form.

For the subject, follow the format of the subsystem (run git log
--oneline) and no need to say 'binding' multiple times:

dt-bindings: mfd: Add Raspberry Pi Sense HAT schema

>
> Signed-off-by: Charles Mirabile <[email protected]>
> Signed-off-by: Mwesigwa Guma <[email protected]>
> Signed-off-by: Joel Savitz <[email protected]>
> ---
> .../bindings/mfd/raspberrypi,sensehat.yaml | 50 +++++++++++++++++++
> 1 file changed, 50 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
>
> diff --git a/Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml b/Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
> new file mode 100644
> index 000000000000..e00cd02a3752
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +$id: http://devicetree.org/schemas/mfd/raspberrypi,sensehat.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Raspberry Pi Sensehat
> +
> +maintainers:
> + - Charles Mirabile <[email protected]>
> + - Mwesigwa Guma <[email protected]>
> + - Joel Savitz <[email protected]>
> +
> +description: |

'|' is not needed if there is no formatting to preserve.

> + The Raspberry Pi Sensehat is an addon board originally developed
> + for the Raspberry Pi that has a joystick and an 8x8 RGB LED display
> + as well as several environmental sensors. It connects via i2c and
> + a gpio for irq.
> +
> +properties:
> + compatible:
> + oneOf:
> + - enum:

Don't need oneOf when there is only one entry.

> + - raspberrypi,sensehat
> + - rpi,rpisense

'rpi' is not a vendor prefix.

What's the fallback for anyways?

> +
> + reg:
> + items:
> + - description: i2c bus address
> +
> + keys-int-gpios:
> + items:
> + - description: gpio pin for joystick interrupt

For an interrupt, use 'interrupts'.

> +
> +required:
> + - compatible
> + - reg
> + - keys-int-gpios
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + sensehat@46 {
> + compatible = "raspberrypi,sensehat";
> + reg = <0x46>;
> + keys-int-gpios = <&gpio 23 GPIO_ACTIVE_HIGH>;
> + };
> + };
> --
> 2.31.1
>
>