Skip to contentSkip to conversation

drm/solomon: Add support for the SSD133x controller family

PATCH Superseded Javier Martinez Canillas 3 participants 8 messages Dec 18, 2023 – Dec 19, 2023

Subsystems (4)

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore

Javier Martinez Canillas

author maintainer
#0 lore raw

v2 cover drm/solomon: Add support for the SSD133x controller family

Hello,

This patch-set adds support for the family of SSD133x Solomon controllers, such as the SSD1331. These are used for RGB Dot Matrix OLED/PLED panels.

This is a v2 that addresses issues pointed out in v1:

https://lore.kernel.org/lkml/[email protected]/T/

The patches were tested on a Waveshare SSD1331 display using glmark2-drm, fbcon, fbtests and the retroarch emulator.

Patch #1 adds a DT binding schema for the SSD133x controllers and patch #2 extends the ssd130x DRM driver to support the SSD133x controller family.

Best regards,
Javier

Changes in v2:
- Unconditionally set the width and height constraints (Conor Dooley).
- Fix indentation in the DTS examples (Krzysztof Kozlowski).

Javier Martinez Canillas (2):
dt-bindings: display: Add SSD133x OLED controllers drm/ssd130x: Add support for the SSD133x OLED controller family

 .../bindings/display/solomon,ssd133x.yaml     |  57 +++
 drivers/gpu/drm/solomon/ssd130x-i2c.c         |   5 +
 drivers/gpu/drm/solomon/ssd130x-spi.c         |   7 +
 drivers/gpu/drm/solomon/ssd130x.c             | 370 ++++++++++++++++++
 drivers/gpu/drm/solomon/ssd130x.h             |   5 +-
 5 files changed, 443 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/devicetree/bindings/display/solomon,ssd133x.yaml
Signature · 1 line
2.43.0
author maintainer
#1 lore raw

PATCH v2 1/2 dt-bindings: display: Add SSD133x OLED controllers

Add a Device Tree binding schema for the OLED panels based on the Solomon SSD133x family of controllers.

---

Changes in v2:
- Unconditionally set the width and height constraints (Conor Dooley).
- Fix indentation in the DTS examples (Krzysztof Kozlowski).

 .../bindings/display/solomon,ssd133x.yaml     | 57 +++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/display/solomon,ssd133x.yaml
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml new file +57 -0
new file mode 100644
index 000000000000..8feee9eef0fd
@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/solomon,ssd133x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Solomon SSD133x OLED Display Controllers
+
+maintainers:
+  - Javier Martinez Canillas <[email protected]>
+
+properties:
+  compatible:
+    enum:
+      - solomon,ssd1331
+
+required:
+  - compatible
+  - reg
+
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+
+  - properties:
+      width:
+        default: 96
+      height:
+        default: 64
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        oled@3c {
+            compatible = "solomon,ssd1331";
+            reg = <0x3c>;
+            reset-gpios = <&gpio2 7>;
+        };
+
+    };
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        oled@0 {
+            compatible = "solomon,ssd1331";
+            reg = <0x0>;
+            reset-gpios = <&gpio2 7>;
+            dc-gpios = <&gpio2 8>;
+            spi-max-frequency = <10000000>;
+        };
+    };
Signature · 1 line
2.43.0
#2 lore raw

Re: [PATCH v2 1/2] dt-bindings: display: Add SSD133x OLED controllers

Quoted 38 lines · Javier Martinez Canillas

Add a Device Tree binding schema for the OLED panels based on the Solomon SSD133x family of controllers.

---

Changes in v2:
- Unconditionally set the width and height constraints (Conor Dooley).
- Fix indentation in the DTS examples (Krzysztof Kozlowski).

 .../bindings/display/solomon,ssd133x.yaml     | 57 +++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/display/solomon,ssd133x.yaml
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml new file +18 -0
new file mode 100644
index 000000000000..8feee9eef0fd
@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/solomon,ssd133x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Solomon SSD133x OLED Display Controllers
+
+maintainers:
+  - Javier Martinez Canillas <[email protected]>
+
+properties:
+  compatible:
+    enum:
+      - solomon,ssd1331
+
+required:
+  - compatible

Documentation/devicetree/bindings/display/solomon,ssd133x.yaml line 28

Quoted 10 lines
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml new file +10 -0
+  - reg
+
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+
+  - properties:
+      width:
+        default: 96
+      height:
+        default: 64
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +9 -9
index 8feee9eef0fd..ffc939c782eb 100644
@@ -9,24 +9,24 @@ title: Solomon SSD133x OLED Display Controllers
 maintainers:
   - Javier Martinez Canillas <[email protected]>
 
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+
 properties:
   compatible:
     enum:
       - solomon,ssd1331
 
+  width:
+    default: 96
+
+  height:
+    default: 64
+
 required:
   - compatible
   - reg
 
-allOf:
-  - $ref: solomon,ssd-common.yaml#
-
-  - properties:
-      width:
-        default: 96
-      height:
-        default: 64
-
 unevaluatedProperties: false
 
 examples:

The properties stuff doesn't need to be in the allOf. Although, I took the opportunity to look at ssd-common.yaml. How do the height/width here differ from the vendor prefixed versions in that file?

author maintainer
#3 lore raw

Re: [PATCH v2 1/2] dt-bindings: display: Add SSD133x OLED controllers

Conor Dooley <[email protected]> writes:

Hello Conor,

Thanks a lot for your feedback.

Quoted 1 line · Javier Martinez Canillas

[...]

Quoted 46 lines
Quoted 6 lines
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +6 -0
+
+  - properties:
+      width:
+        default: 96
+      height:
+        default: 64
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +9 -9
index 8feee9eef0fd..ffc939c782eb 100644
@@ -9,24 +9,24 @@ title: Solomon SSD133x OLED Display Controllers
 maintainers:
   - Javier Martinez Canillas <[email protected]>
 
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+
 properties:
   compatible:
     enum:
       - solomon,ssd1331
 
+  width:
+    default: 96
+
+  height:
+    default: 64
+
 required:
   - compatible
   - reg
 
-allOf:
-  - $ref: solomon,ssd-common.yaml#
-
-  - properties:
-      width:
-        default: 96
-      height:
-        default: 64
-
 unevaluatedProperties: false
 
 examples:
Quoted 1 line

The properties stuff doesn't need to be in the allOf. Although, I took

Ok.

Quoted 2 lines

the opportunity to look at ssd-common.yaml. How do the height/width here differ from the vendor prefixed versions in that file?

Oh! That is an error in the schema that I introduced when adding the binding for the SSD132x family in commit 2d23e7d6bacb ("dt-bindings:
display: Add SSD132x OLED controllers"), and I just copied it to this binding as well making the same mistake...

I'll fix that with a preparatory patch to use "solomon,{width,height}" everywhere in v3 and also include your suggested changes for this patch.

Signature · 5 lines
Best regards,

Javier Martinez Canillas
Core Platforms
Red Hat
author maintainer
#4 lore raw

Re: [PATCH v2 1/2] dt-bindings: display: Add SSD133x OLED controllers

In reply to Conor Dooley

Conor Dooley <[email protected]> writes:

Hello Conor,

Quoted 1 line · Javier Martinez Canillas

[...]

Quoted 14 lines
Quoted 8 lines
(quoted diff) +8 -0
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+
+  - properties:
+      width:
+        default: 96
+      height:
+        default: 64
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +0 -0
index 8feee9eef0fd..ffc939c782eb 100644

Documentation/devicetree/bindings/display/solomon,ssd133x.yaml title: Solomon SSD133x OLED Display Controllers · line 14

Quoted 6 lines
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +3 -0
@@ -9,24 +9,24 @@ title: Solomon SSD133x OLED Display Controllers
 maintainers:
   - Javier Martinez Canillas <[email protected]>
 
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+

This part worked correctly...

Documentation/devicetree/bindings/display/solomon,ssd133x.yaml title: Solomon SSD133x OLED Display Controllers · line 25

Quoted 11 lines
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +6 -0
 properties:
   compatible:
     enum:
       - solomon,ssd1331
 
+  width:
+    default: 96
+
+  height:
+    default: 64
+

...but when trying move the default for the "solomon,width" and "solomon,height" to the properties section, make dt_binding_check complains as follows:

LINT Documentation/devicetree/bindings
CHKDT Documentation/devicetree/bindings/processed-schema.json
/home/javier/devel/linux/Documentation/devicetree/bindings/display/solomon,ssd133x.yaml: properties:solomon,height: 'oneOf' conditional failed, one must be fixed:
'type' is a required property
hint: A vendor boolean property can use "type: boolean"
'description' is a required property
hint: A vendor boolean property can use "type: boolean"
Additional properties are not allowed ('default' was unexpected)
hint: A vendor boolean property can use "type: boolean"
/home/javier/devel/linux/Documentation/devicetree/bindings/display/solomon,ssd133x.yaml: properties:solomon,height: 'oneOf' conditional failed, one must be fixed:
'enum' is a required property
'const' is a required property
hint: A vendor string property with exact values has an implicit type
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
/home/javier/devel/linux/Documentation/devicetree/bindings/display/solomon,ssd133x.yaml: properties:solomon,height: 'oneOf' conditional failed, one must be fixed:
'$ref' is a required property
'allOf' is a required property
hint: A vendor property needs a $ref to types.yaml
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
hint: Vendor specific properties must have a type and description unless they have a defined, common suffix.
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
/home/javier/devel/linux/Documentation/devicetree/bindings/display/solomon,ssd133x.yaml: properties:solomon,width: 'oneOf' conditional failed, one must be fixed:
'type' is a required property
hint: A vendor boolean property can use "type: boolean"
'description' is a required property
hint: A vendor boolean property can use "type: boolean"
Additional properties are not allowed ('default' was unexpected)
hint: A vendor boolean property can use "type: boolean"
/home/javier/devel/linux/Documentation/devicetree/bindings/display/solomon,ssd133x.yaml: properties:solomon,width: 'oneOf' conditional failed, one must be fixed:
'enum' is a required property
'const' is a required property
hint: A vendor string property with exact values has an implicit type
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
/home/javier/devel/linux/Documentation/devicetree/bindings/display/solomon,ssd133x.yaml: properties:solomon,width: 'oneOf' conditional failed, one must be fixed:
'$ref' is a required property
'allOf' is a required property
hint: A vendor property needs a $ref to types.yaml
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
hint: Vendor specific properties must have a type and description unless they have a defined, common suffix.
from schema $id: http://devicetree.org/meta-schemas/vendor-props.yaml#
SCHEMA Documentation/devicetree/bindings/processed-schema.json
DTEX Documentation/devicetree/bindings/display/solomon,ssd133x.example.dts
/home/javier/.local/bin/dt-extract-example:75: SyntaxWarning: invalid escape sequence '\s'
root_node = re.search('/\s*{', ex)
/home/javier/.local/bin/dt-extract-example:79: SyntaxWarning: invalid escape sequence '\s'
int_val = re.search('\sinterrupts\s*=\s*<([0-9a-zA-Z |()_]+)>', ex).group(1)
DTC_CHK Documentation/devicetree/bindings/display/solomon,ssd133x.example.dtb

The warning goes away if I follow the hints and add a type and description to the properties, i.e:

Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +14 -0
index 880c71fdec68..0f4d9ca7456b 100644
@@ -17,6 +17,20 @@ properties:
     enum:
       - solomon,ssd1331
 
+  solomon,width:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Width in pixel of the screen driven by the controller.
+      The default value is controller-dependent.
+    default: 96
+
+  solomon,height:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Height in pixel of the screen driven by the controller.
+      The default value is controller-dependent.
+    default: 64
+
 required:
   - compatible
   - reg

But that would duplicate information that is already present in the included solomon,ssd-common.yaml schema. Do you know what is the proper way to do this?

Or maybe should I just drop the default values for the width and height properties? I just think that is good information to have in the schema.

Signature · 5 lines
Best regards,

Javier Martinez Canillas
Core Platforms
Red Hat
#5 lore raw

Re: [PATCH v2 1/2] dt-bindings: display: Add SSD133x OLED controllers

Quoted 25 lines · Javier Martinez Canillas

Conor Dooley <[email protected]> writes:

Hello Conor,

Quoted 1 line · Javier Martinez Canillas

[...]

Quoted 17 lines
Quoted 8 lines
(quoted diff) +8 -0
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+
+  - properties:
+      width:
+        default: 96
+      height:
+        default: 64
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +0 -0
index 8feee9eef0fd..ffc939c782eb 100644
@@ -9,24 +9,24 @@ title: Solomon SSD133x OLED Display Controllers
 maintainers:
   - Javier Martinez Canillas <[email protected]>
 
Quoted 16 lines

Documentation/devicetree/bindings/display/solomon,ssd133x.yaml title: Solomon SSD133x OLED Display Controllers · line 14

Quoted 3 lines
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +3 -0
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+

This part worked correctly...

Quoted 10 lines
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +5 -0
 properties:
   compatible:
     enum:
       - solomon,ssd1331
 
+  width:
+    default: 96
+
+  height:
+    default: 64

Which also looks wrong on its own. Where is the definition of these properties? IOW, where do they come from?

Quoted 5 lines

Documentation/devicetree/bindings/display/solomon,ssd133x.yaml title: Solomon SSD133x OLED Display Controllers · line 25

Quoted 1 line
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +1 -0
+

...but when trying move the default for the "solomon,width" and "solomon,height" to the properties section, make dt_binding_check complains as follows:

Worked for me.

...

Quoted 4 lines

DTC_CHK Documentation/devicetree/bindings/display/solomon,ssd133x.example.dtb

The warning goes away if I follow the hints and add a type and description to the properties, i.e:

Hm, I wonder what's different in your case. I assume you run the latest dtschema.

Quoted 27 lines
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +14 -0
index 880c71fdec68..0f4d9ca7456b 100644
@@ -17,6 +17,20 @@ properties:
     enum:
       - solomon,ssd1331
 
+  solomon,width:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Width in pixel of the screen driven by the controller.
+      The default value is controller-dependent.
+    default: 96
+
+  solomon,height:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Height in pixel of the screen driven by the controller.
+      The default value is controller-dependent.
+    default: 64
+
 required:
   - compatible
   - reg
Quoted 3 lines

But that would duplicate information that is already present in the included solomon,ssd-common.yaml schema. Do you know what is the proper way to do this?

Works for me, so please paste somewhere proper diff so we can compare.

Best regards,
Krzysztof

author maintainer
#6 lore raw

Re: [PATCH v2 1/2] dt-bindings: display: Add SSD133x OLED controllers

Krzysztof Kozlowski <[email protected]> writes:

Hello Krzysztof,

Quoted 1 line · Javier Martinez Canillas

[...]

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
(quoted diff) +3 -0
+allOf:
+  - $ref: solomon,ssd-common.yaml#
+

[...]

Quoted 8 lines
Quoted 6 lines

Documentation/devicetree/bindings/display/solomon,ssd133x.yaml properties: · line 32

Quoted 6 lines
Documentation/devicetree/bindings/display/solomon,ssd133x.yaml +5 -0
+  width:
+    default: 96
+
+  height:
+    default: 64

Which also looks wrong on its own. Where is the definition of these

Yes, I already discussed this with Conor and mentioned to him that is a typo but already fixed it locally and I'm testing with the correct ones.

Quoted 2 lines

properties? IOW, where do they come from?

The "solomon,width" and "solomon,height" properties are defined in the solomon,ssd-common.yaml binding schema file that is referenced.

Quoted 8 lines
Quoted 5 lines
Quoted 1 line

+

...but when trying move the default for the "solomon,width" and "solomon,height" to the properties section, make dt_binding_check complains as follows:

Worked for me.

Oh, that's good to know. I wonder what's the difference...

Quoted 10 lines

...

Quoted 4 lines

DTC_CHK Documentation/devicetree/bindings/display/solomon,ssd133x.example.dtb

The warning goes away if I follow the hints and add a type and description to the properties, i.e:

Hm, I wonder what's different in your case. I assume you run the latest dtschema.

Not the latest but had a recent one. I've updated it, so I do now :)

$ pip list | grep dtschema
dtschema                      2023.9
$ pip install --upgrade dtschema
$ pip list | grep dtschema
dtschema                      2023.11

[...]

Quoted 6 lines
Quoted 3 lines

But that would duplicate information that is already present in the included solomon,ssd-common.yaml schema. Do you know what is the proper way to do this?

Works for me, so please paste somewhere proper diff so we can compare.

With the latest dtschema version it works indeed. Thanks for the pointer!

$ make W=1 dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/display/solomon,ssd133x.yaml 
  LINT    Documentation/devicetree/bindings
  CHKDT   Documentation/devicetree/bindings/processed-schema.json
  SCHEMA  Documentation/devicetree/bindings/processed-schema.json
  DTEX    Documentation/devicetree/bindings/display/solomon,ssd133x.example.dts
  DTC_CHK Documentation/devicetree/bindings/display/solomon,ssd133x.example.dtb
Quoted 3 lines

Best regards,
Krzysztof

Signature · 5 lines
Best regards,

Javier Martinez Canillas
Core Platforms
Red Hat
author maintainer
#7 lore raw

PATCH v2 2/2 drm/ssd130x: Add support for the SSD133x OLED controller family

In reply to Javier Martinez Canillas

The Solomon SSD133x controllers (such as the SSD1331) are used by RGB dot matrix OLED panels, add a modesetting pipeline to support the chip family.

The SSD133x controllers support 256 (8-bit) and 65k (16-bit) color depths but only the former is implemented for now. This is because the 256 color depth format matches a fourcc code already present in DRM (RGB8), but the 65k pixel format does not match the existing RG16 fourcc code format.

Instead of a R:G:B 5:6:5, the controller expects the 16-bit pixels to be R:G:B 6:5:6, and so a new fourcc needs to be added to support this format.

---

(no changes since v1)

 drivers/gpu/drm/solomon/ssd130x-i2c.c |   5 +
 drivers/gpu/drm/solomon/ssd130x-spi.c |   7 +
 drivers/gpu/drm/solomon/ssd130x.c     | 370 ++++++++++++++++++++++++++
 drivers/gpu/drm/solomon/ssd130x.h     |   5 +-
 4 files changed, 386 insertions(+), 1 deletion(-)
drivers/gpu/drm/solomon/ssd130x-i2c.c +5 -0
index f2ccab9c06d9..a047dbec4e48 100644
@@ -105,6 +105,11 @@ static const struct of_device_id ssd130x_of_match[] = {
 		.compatible = "solomon,ssd1327",
 		.data = &ssd130x_variants[SSD1327_ID],
 	},
+	/* ssd133x family */
+	{
+		.compatible = "solomon,ssd1331",
+		.data = &ssd130x_variants[SSD1331_ID],
+	},
 	{ /* sentinel */ }
 };
 MODULE_DEVICE_TABLE(of, ssd130x_of_match);
drivers/gpu/drm/solomon/ssd130x-spi.c +7 -0
index 84e035a7ab3f..84bfde31d172 100644
@@ -142,6 +142,11 @@ static const struct of_device_id ssd130x_of_match[] = {
 		.compatible = "solomon,ssd1327",
 		.data = &ssd130x_variants[SSD1327_ID],
 	},
+	/* ssd133x family */
+	{
+		.compatible = "solomon,ssd1331",
+		.data = &ssd130x_variants[SSD1331_ID],
+	},
 	{ /* sentinel */ }
 };
 MODULE_DEVICE_TABLE(of, ssd130x_of_match);
@@ -166,6 +171,8 @@ static const struct spi_device_id ssd130x_spi_table[] = {
 	{ "ssd1322", SSD1322_ID },
 	{ "ssd1325", SSD1325_ID },
 	{ "ssd1327", SSD1327_ID },
+	/* ssd133x family */
+	{ "ssd1331", SSD1331_ID },
 	{ /* sentinel */ }
 };
 MODULE_DEVICE_TABLE(spi, ssd130x_spi_table);
drivers/gpu/drm/solomon/ssd130x.c +370 -0

454 lines not on this page · raw message

drivers/gpu/drm/solomon/ssd130x.h +4 -1
index 075c5c3ee75a..a4554018bb2a 100644
@@ -25,7 +25,8 @@
 
 enum ssd130x_family_ids {
 	SSD130X_FAMILY,
-	SSD132X_FAMILY
+	SSD132X_FAMILY,
+	SSD133X_FAMILY
 };
 
 enum ssd130x_variants {
@@ -39,6 +40,8 @@ enum ssd130x_variants {
 	SSD1322_ID,
 	SSD1325_ID,
 	SSD1327_ID,
+	/* ssd133x family */
+	SSD1331_ID,
 	NR_SSD130X_VARIANTS
 };
 
Signature · 1 line
2.43.0