Skip to contentSkip to conversation

Raspberry Pi Sense HAT driver

PATCH Superseded Charles Mirabile 4 participants 11 messages Mar 3, 2022 – Mar 10, 2022

Subsystems (6)

v7 of 10 Superseded Latest is v10 →

lore
Share & tools
lore
#0 lore raw

v7 cover Raspberry Pi Sense HAT driver

This patch series adds a set of drivers for operating the Sense HAT peripheral device. This board is an add on for the Raspberry Pi that is designed to connect using the GPIO connector and communicates via I2C.

It features:
- a joystick
- an 8x8 RGB LED matrix display
- a whole bunch of environmental sensors with their own drivers (those are already in upstream Linux)

This is a refactor of the work of Serge Schneider, the author of a version of this driver that is currently in the Raspberry Pi downstream kernel. We modified his code to make it suitable for upstream Linux.

A couple of tests are available for the driver in the test folder in this repo: https://github.com/underground-software/sensehat.git
- sensehat_joystick_test logs the input events from the joystick to the console
- sensehat_display_test displays various solid colors on the LED panel.
- full_sensehat_test displays a single lit cell that can be moved with the joystick. Pressing the joystick ends the program.

For more information about the Sense HAT, visit:
https://www.raspberrypi.org/products/sense-hat/

Changes since v6:
- we store the regmap for the sensehat inside the child structs so that we don't need to look it up every time in the functions that want to use it. Thanks to Nicolás Sáenz for the suggestion.
- Changed userspace layout of the display driver to rgb565 triples and removed the gamma table lookup and the associated ioctl. If the user wants to recreate linear brightness scaling, they can use a lookup table on their end. Doing this also removes a lot of error checking and general code complexity, so I think removing this feature is actually for the better.
- Replaced if statement with call to min_t function in display read and write functions.
- Replaced the custom llseek implementation with a call to fixed_size_llseek. Thanks to Miguel Ojeda for all of these great suggestions.
- Fixed issues with the yaml device tree bindings we missed last time due to not having yamllint installed. Thanks for Rob Herring (well his bot on his behalf :^)) for this suggestion.

Charles Mirabile (6):
drivers/mfd: sensehat: Add Raspberry Pi Sense HAT to simple_mfd_i2c drivers/input/joystick: sensehat: Raspberry Pi Sense HAT joystick
driver
drivers/auxdisplay: sensehat: Raspberry Pi Sense HAT display driver
dt-bindings: mfd: sensehat: Add Raspberry Pi Sense HAT schema
MAINTAINERS: Add sensehat driver authors to MAINTAINERS DO NOT MERGE: full sensehat device tree overlay for raspberry pi 4

 .../raspberrypi,sensehat-display.yaml         |  27 +++
 .../input/raspberrypi,sensehat-joystick.yaml  |  33 +++
 .../bindings/mfd/raspberrypi,sensehat.yaml    |  69 +++++++
 MAINTAINERS                                   |  11 +
 drivers/auxdisplay/Kconfig                    |   8 +
 drivers/auxdisplay/Makefile                   |   1 +
 drivers/auxdisplay/sensehat-display.c         | 188 ++++++++++++++++++
 drivers/input/joystick/Kconfig                |  11 +
 drivers/input/joystick/Makefile               |   1 +
 drivers/input/joystick/sensehat-joystick.c    | 128 ++++++++++++
 drivers/mfd/simple-mfd-i2c.c                  |   1 +
 sensehat.dtbs                                 |  54 +++++
 12 files changed, 532 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/auxdisplay/raspberrypi,sensehat-display.yaml
 create mode 100644 Documentation/devicetree/bindings/input/raspberrypi,sensehat-joystick.yaml
 create mode 100644 Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
 create mode 100644 drivers/auxdisplay/sensehat-display.c
 create mode 100644 drivers/input/joystick/sensehat-joystick.c
 create mode 100644 sensehat.dtbs
Signature · 1 line
2.31.1
#1 lore raw

PATCH v7 1/6 drivers/mfd: sensehat: Add Raspberry Pi Sense HAT to simple_mfd_i2c

This patch adds the compatible string for the Sense HAT device to the list of compatible strings in the simple_mfd_i2c driver so that it can match against the device and load its children and their drivers.

---
 drivers/mfd/simple-mfd-i2c.c | 1 +
 1 file changed, 1 insertion(+)
drivers/mfd/simple-mfd-i2c.c +1 -0
index 51536691ad9d..f916a9c84563 100644
@@ -64,6 +64,7 @@ static int simple_mfd_i2c_probe(struct i2c_client *i2c)
 
 static const struct of_device_id simple_mfd_i2c_of_match[] = {
 	{ .compatible = "kontron,sl28cpld" },
+	{ .compatible = "raspberrypi,sensehat" },
 	{}
 };
 MODULE_DEVICE_TABLE(of, simple_mfd_i2c_of_match);
Signature · 1 line
2.31.1
#2 lore raw

PATCH v7 2/6 drivers/input/joystick: sensehat: Raspberry Pi Sense HAT joystick driver

In reply to Charles Mirabile

This patch adds the driver for the Sense HAT joystick. It outputs BTN_DPAD key events when moved in any of the four directions and the BTN_SELECT event when depressed.

---
 drivers/input/joystick/Kconfig             |  11 ++
 drivers/input/joystick/Makefile            |   1 +
 drivers/input/joystick/sensehat-joystick.c | 128 +++++++++++++++++++++
 3 files changed, 140 insertions(+)
 create mode 100644 drivers/input/joystick/sensehat-joystick.c
drivers/input/joystick/Kconfig +11 -0
index 3b23078bc7b5..505a032e2786 100644
@@ -399,4 +399,15 @@ config JOYSTICK_N64
 	  Say Y here if you want enable support for the four
 	  built-in controller ports on the Nintendo 64 console.
 
+config JOYSTICK_SENSEHAT
+	tristate "Raspberry Pi Sense HAT joystick"
+	depends on INPUT && I2C
+	select MFD_SIMPLE_MFD_I2C
+	help
+	  Say Y here if you want to enable the driver for the
+	  the Raspberry Pi Sense HAT.
+
+	  To compile this driver as a module, choose M here: the
+	  module will be called sensehat_joystick.
+
 endif
drivers/input/joystick/Makefile +1 -0
index 5174b8aba2dd..39c8b5c6e5ae 100644
@@ -28,6 +28,7 @@ obj-$(CONFIG_JOYSTICK_N64)		+= n64joy.o
 obj-$(CONFIG_JOYSTICK_PSXPAD_SPI)	+= psxpad-spi.o
 obj-$(CONFIG_JOYSTICK_PXRC)		+= pxrc.o
 obj-$(CONFIG_JOYSTICK_QWIIC)		+= qwiic-joystick.o
+obj-$(CONFIG_JOYSTICK_SENSEHAT)         += sensehat-joystick.o
 obj-$(CONFIG_JOYSTICK_SIDEWINDER)	+= sidewinder.o
 obj-$(CONFIG_JOYSTICK_SPACEBALL)	+= spaceball.o
 obj-$(CONFIG_JOYSTICK_SPACEORB)		+= spaceorb.o
drivers/input/joystick/sensehat-joystick.c new file +128 -0

128 lines not on this page · raw message

Signature · 1 line
2.31.1
#3 lore raw

PATCH v7 3/6 drivers/auxdisplay: sensehat: Raspberry Pi Sense HAT display driver

In reply to Charles Mirabile

This patch adds the driver for the 8x8 RGB LED matrix display on the Sense HAT. It appears as a character device named sense-hat in /dev/. That special file is 128 bytes large and contains 64 RGB565 triples (2 bytes each) one for each pixel.

---
 drivers/auxdisplay/Kconfig            |   8 ++
 drivers/auxdisplay/Makefile           |   1 +
 drivers/auxdisplay/sensehat-display.c | 188 ++++++++++++++++++++++++++
 3 files changed, 197 insertions(+)
 create mode 100644 drivers/auxdisplay/sensehat-display.c
drivers/auxdisplay/Kconfig +8 -0
index 64012cda4d12..9bad1aade7a0 100644
@@ -203,6 +203,14 @@ config ARM_CHARLCD
 	  line and the Linux version on the second line, but that's
 	  still useful.
 
+config SENSEHAT_DISPLAY
+	tristate "Raspberry Pi Sense HAT display driver"
+	depends on I2C
+	select MFD_SIMPLE_MFD_I2C
+	help
+	 This is a driver for the Raspberry Pi Sensehat 8x8 RBG-LED matrix
+	 you can access it as a misc device at /dev/sense-hat
+
 menuconfig PARPORT_PANEL
 	tristate "Parallel port LCD/Keypad Panel support"
 	depends on PARPORT
drivers/auxdisplay/Makefile +1 -0
index 6968ed4d3f0a..30b2b7934046 100644
@@ -14,3 +14,4 @@ obj-$(CONFIG_HT16K33)		+= ht16k33.o
 obj-$(CONFIG_PARPORT_PANEL)	+= panel.o
 obj-$(CONFIG_LCD2S)		+= lcd2s.o
 obj-$(CONFIG_LINEDISP)		+= line-display.o
+obj-$(CONFIG_SENSEHAT_DISPLAY)	+= sensehat-display.o
drivers/auxdisplay/sensehat-display.c new file +188 -0

188 lines not on this page · raw message

Signature · 1 line
2.31.1
#4 lore raw

Re: [PATCH v7 3/6] drivers/auxdisplay: sensehat: Raspberry Pi Sense HAT display driver

drivers/auxdisplay/sensehat-display.c line 54

Quoted 11 lines · Charles Mirabile
drivers/auxdisplay/sensehat-display.c new file +10 -0
+       u8 temp[8][3][8];
+
+       for (i = 0; i < 8; ++i) {
+               for (j = 0; j < 8; ++j)
+                       temp[i][0][j] = display->vmem[i][j].r;
+               for (j = 0; j < 8; ++j)
+                       temp[i][1][j] = display->vmem[i][j].g;
+               for (j = 0; j < 8; ++j)
+                       temp[i][2][j] = display->vmem[i][j].b;
+       }

I assume the hardware uses only rgb555, right? I think this is OK, but please consider if it would make sense to read a 8x8x3 bytes matrix anyway, even if some bits/values are ignored/discarded.

Review

Quoted 2 lines
(quoted diff) +2 -0
+       struct sensehat_display *sensehat_display =
+               devm_kmalloc(&pdev->dev, sizeof(*sensehat_display), GFP_KERNEL);

Missing some error handling, e.g. here and in dev_get_regmap.

Also, if sensehat_update_display could return an optional error, you could also fail if the first update did not work (assuming it is supposed to work), or maybe warn (if it can fail for some reason but it does not mean future updates would fail).

Quoted 1 line

+MODULE_AUTHOR("Serge Schneider <[email protected]>");

Please consider if you should/want to appear here alongside Serge.

Cheers,
Miguel

#5 lore raw

PATCH v7 4/6 dt-bindings: mfd: sensehat: Add Raspberry Pi Sense HAT schema

In reply to Charles Mirabile

This patch adds the device tree bindings for the Sense HAT and each of its children devices in yaml form.

---
 .../raspberrypi,sensehat-display.yaml         | 27 ++++++++
 .../input/raspberrypi,sensehat-joystick.yaml  | 33 +++++++++
 .../bindings/mfd/raspberrypi,sensehat.yaml    | 69 +++++++++++++++++++
 3 files changed, 129 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/auxdisplay/raspberrypi,sensehat-display.yaml
 create mode 100644 Documentation/devicetree/bindings/input/raspberrypi,sensehat-joystick.yaml
 create mode 100644 Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
Documentation/devicetree/bindings/auxdisplay/raspberrypi,sensehat-display.yaml new file +27 -0
new file mode 100644
index 000000000000..5e41d6b7817d
@@ -0,0 +1,27 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/auxdisplay/raspberrypi,sensehat-display.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Raspberry Pi Sensehat Display
+
+maintainers:
+  - Charles Mirabile <[email protected]>
+  - Mwesigwa Guma <[email protected]>
+  - Joel Savitz <[email protected]>
+
+description:
+  This device is part of the sensehat multi function device.
+  For more information see ../mfd/raspberrypi,sensehat.yaml.
+
+  This device features a programmable 8x8 RGB LED matrix.
+
+properties:
+  compatible:
+    const: raspberrypi,sensehat-display
+
+required:
+  - compatible
+
+additionalProperties: false
Documentation/devicetree/bindings/input/raspberrypi,sensehat-joystick.yaml new file +33 -0
new file mode 100644
index 000000000000..c97cd1d8eac6
@@ -0,0 +1,33 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/raspberrypi,sensehat-joystick.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Raspberry Pi Sensehat Joystick
+
+maintainers:
+  - Charles Mirabile <[email protected]>
+  - Mwesigwa Guma <[email protected]>
+  - Joel Savitz <[email protected]>
+
+description:
+  This device is part of the sensehat multi function device.
+  For more information see ../mfd/raspberrypi,sensehat.yaml.
+
+  This device features a five button joystick (up, down,left,
+  right, click)
+
+properties:
+  compatible:
+    const: raspberrypi,sensehat-joystick
+
+  interrupts:
+    items:
+      - description: pin number for joystick interrupt
+
+required:
+  - compatible
+  - interrupts
+
+additionalProperties: false
Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml new file +69 -0

69 lines not on this page · raw message

Signature · 1 line
2.31.1
maintainer Reviewed-by on v7 4/6
#6 lore raw

Re: [PATCH v7 4/6] dt-bindings: mfd: sensehat: Add Raspberry Pi Sense HAT schema

Quoted 8 lines · Charles Mirabile

This patch adds the device tree bindings for the Sense HAT and each of its children devices in yaml form.

Quoted 9 lines
---
 .../raspberrypi,sensehat-display.yaml         | 27 ++++++++
 .../input/raspberrypi,sensehat-joystick.yaml  | 33 +++++++++
 .../bindings/mfd/raspberrypi,sensehat.yaml    | 69 +++++++++++++++++++
 3 files changed, 129 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/auxdisplay/raspberrypi,sensehat-display.yaml
 create mode 100644 Documentation/devicetree/bindings/input/raspberrypi,sensehat-joystick.yaml
 create mode 100644 Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
#7 lore raw

PATCH v7 5/6 MAINTAINERS: Add sensehat driver authors to MAINTAINERS

In reply to Charles Mirabile

This patch adds the driver authors to MAINAINERS.

---
 MAINTAINERS | 11 +++++++++++
 1 file changed, 11 insertions(+)
MAINTAINERS +11 -0
index 4383949ff654..d6cb046ff751 100644
@@ -17417,6 +17417,17 @@ F:	Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2
 F:	Documentation/devicetree/bindings/iio/chemical/senseair,sunrise.yaml
 F:	drivers/iio/chemical/sunrise_co2.c
 
+SENSEHAT DRIVER
+M:	Charles Mirabile <[email protected]>
+M:	Mwesigwa Guma <[email protected]>
+M:	Joel Savitz <[email protected]>
+S:	Maintained
+F:	Documentation/devicetree/bindings/auxdisplay/raspberrypi,sensehat-display.yaml
+F:	Documentation/devicetree/bindings/input/raspberrypi,sensehat-joystick.yaml
+F:	Documentation/devicetree/bindings/mfd/raspberrypi,sensehat.yaml
+F:	drivers/auxdisplay/sensehat-display.c
+F:	drivers/input/joystick/sensehat-joystick.c
+
 SENSIRION SCD30 CARBON DIOXIDE SENSOR DRIVER
 M:	Tomasz Duszynski <[email protected]>
 S:	Maintained
Signature · 1 line
2.31.1
#8 lore raw

PATCH v7 6/6 DO NOT MERGE: full sensehat device tree overlay for raspberry pi 4

In reply to Charles Mirabile

This patch should not be merged - dtbs files are not stored in the kernel tree. We just provide this file so the code can be tested.

This overlay is suitable for testing the driver, it can be compiled with dtc and put in the /boot/overlays/ folder then specified in config.txt by putting the lines:

dtoverlay= #suppress loading of default overlay for HAT
dtoverlay=sensehat #load custom overlay

at the beginning before any other lines in config.txt

---
 sensehat.dtbs | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 sensehat.dtbs
sensehat.dtbs new file +54 -0
new file mode 100644
index 000000000000..82d129c847fb
@@ -0,0 +1,54 @@
+/dts-v1/;
+/plugin/;
+
+/ {
+	compatible = "brcm,bcm2835";
+};
+
+&i2c1 {
+	#address-cells = <0x01>;
+	#size-cells = <0x00>;
+	status = "okay";
+
+	sensehat@46 {
+		#address-cells = <0x01>;
+		#size-cells = <0x00>;
+		compatible = "raspberrypi,sensehat";
+		reg = <0x46>;
+		interrupt-parent = <&gpio>;
+		status = "okay";
+		display {
+			compatible = "raspberrypi,sensehat-display";
+			status = "okay";
+		};
+		joystick {
+			compatible = "raspberrypi,sensehat-joystick";
+			interrupts = <23 1>;
+			status = "okay";
+		};
+	};
+
+	lsm9ds1-magn@1c {
+		compatible = "st,lsm9ds1-magn";
+		reg = <0x1c>;
+		status = "okay";
+	};
+
+	lsm9ds1-accel@6a {
+		compatible = "st,lsm9ds1-accel";
+		reg = <0x6a>;
+		status = "okay";
+	};
+
+	lps25h-press@5c {
+		compatible = "st,lps25h-press";
+		reg = <0x5c>;
+		status = "okay";
+	};
+
+	hts221-humid@5f {
+		compatible = "st,hts221-humid\0st,hts221";
+		reg = <0x5f>;
+		status = "okay";
+	};
+};
Signature · 1 line
2.31.1
#9 lore raw

Re: [PATCH v7 6/6] DO NOT MERGE: full sensehat device tree overlay for raspberry pi 4

Quoted 2 lines · Charles Mirabile

This patch should not be merged - dtbs files are not stored in the kernel tree. We just provide this file so the code can be tested.

A problem with that approach is that the DTS files are not reviewed and that causes quality problems, and another problem is that the kernel lack examples of real-world systems so people have to scout to find those and that costs developer time.

I know many people are opposed to having this kind of stuff in the kernel tree, but I am *for* having this kind of stuff in the kernel tree.

Mainly because there is no working community to shepherd it otherwise, while we (the kernel maintainers) are still dependent on there being one.

sensehat.dtbs line 41

Quoted 11 lines
sensehat.dtbs new file +11 -0
+       lsm9ds1-magn@1c {
+               compatible = "st,lsm9ds1-magn";
+               reg = <0x1c>;
+               status = "okay";
+       };
+
+       lsm9ds1-accel@6a {
+               compatible = "st,lsm9ds1-accel";
+               reg = <0x6a>;
+               status = "okay";
+       };

These should typically have mounting matrices. I doubt they are mounted according to the identity matrix, because electronics designers usually have other concerns when layouting PCBs.

See Documentation/devicetree/bindings/iio/mount-matrix.txt

Yours,
Linus Walleij

Yours,
Linus Walleij

#10 lore raw
In reply to Charles Mirabile
Quoted 7 lines · Charles Mirabile

- Changed userspace layout of the display driver to rgb565 triples and removed the gamma table lookup and the associated ioctl. If the user wants to recreate linear brightness scaling, they can use a lookup table on their end. Doing this also removes a lot of error checking and general code complexity, so I think removing this feature is actually for the better.

Sounds better indeed! If I understood correctly how it worked in the previous round, it should also allow to use the hardware to a fuller extent.

Quoted 5 lines

- Replaced if statement with call to min_t function in display read and write functions.
- Replaced the custom llseek implementation with a call to fixed_size_llseek. Thanks to Miguel Ojeda for all of these great suggestions.

You're very welcome!

Cheers,
Miguel