All of lore.kernel.org
 help / color / mirror / Atom feed
From: Ralf Schlatterbeck <rsc@runtux.com>
To: Miguel Ojeda Sandonis <miguel.ojeda.sandonis@gmail.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 2/2] auxdisplay: devicetree doc for HD44780/PCF8574
Date: Tue, 5 Jan 2021 16:05:18 +0100	[thread overview]
Message-ID: <20210105150518.euxpkga3viadr3r6@runtux.com> (raw)
In-Reply-To: <20210105150124.dvlochv3qrp4wpre@runtux.com>

Add devicetree documentation with example.

Signed-off-by: Ralf Schlatterbeck <rsc@runtux.com>
---
 .../auxdisplay/hit,hd44780+nxp,pcf8575.yaml   | 65 +++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/auxdisplay/hit,hd44780+nxp,pcf8575.yaml

diff --git a/Documentation/devicetree/bindings/auxdisplay/hit,hd44780+nxp,pcf8575.yaml b/Documentation/devicetree/bindings/auxdisplay/hit,hd44780+nxp,pcf8575.yaml
new file mode 100644
index 000000000000..c8e822c43b10
--- /dev/null
+++ b/Documentation/devicetree/bindings/auxdisplay/hit,hd44780+nxp,pcf8575.yaml
@@ -0,0 +1,65 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/auxdisplay/hit,hd44780+nxp,pcf8575.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Hitachi HD44780 Character LCD Controller attached to I2C via PCF8575
+
+maintainers:
+  - Ralf Schlatterbeck <rsc@runtux.com>
+
+description:
+  The Hitachi HD44780 Character LCD Controller is commonly used on character
+  LCDs that can display one or more lines of text. The display itself
+  exposes a parallel connection but they're often used with a PCF8575
+  I/O expander to connect them to an I2C bus.
+
+properties:
+  compatible:
+    const: hit,hd44780+nxp,pcf8575
+
+  reg:
+    description: I2C-bus address
+    maxItems: 1
+
+  display-height-chars:
+    description: Height of the display, in character cells,
+    $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 1
+    maximum: 4
+
+  display-width-chars:
+    description: Width of the display, in character cells.
+    $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 1
+    maximum: 64
+
+  internal-buffer-width:
+    description:
+      Internal buffer width (default is 40 for displays with 1 or 2 lines, and
+      display-width-chars for displays with more than 2 lines).
+    $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 1
+    maximum: 64
+
+required:
+  - compatible
+  - display-height-chars
+  - display-width-chars
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c@2000 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      auxdisplay: hd44780@27 {
+        compatible = "hit,hd44780+nxp,pcf8575";
+        reg = <0x27>;
+        display-height-chars = <2>;
+        display-width-chars = <16>;
+      };
+    };
-- 
2.20.1

  parent reply	other threads:[~2021-01-05 15:16 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-05 15:01 [PATCH 0/2] auxdisplay: HD44780 connected to I2C via PCF8574 Ralf Schlatterbeck
2021-01-05 15:04 ` [PATCH 1/2] " Ralf Schlatterbeck
2021-01-06  2:42   ` Miguel Ojeda
2021-01-06  8:03     ` Geert Uytterhoeven
2021-01-06 10:37       ` Ralf Schlatterbeck
2021-01-05 15:05 ` Ralf Schlatterbeck [this message]
2021-01-06  2:47   ` [PATCH 2/2] auxdisplay: devicetree doc for HD44780/PCF8574 Miguel Ojeda

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=20210105150518.euxpkga3viadr3r6@runtux.com \
    --to=rsc@runtux.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=miguel.ojeda.sandonis@gmail.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.