From: Matt Porter <mporter-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>
To: Devicetree List
<devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
Devicetree Spec List
<devicetree-spec-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
Grant Likely
<grant.likely-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org>,
Frank Rowand
<frowand.list-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>,
Rob Herring <robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
Cc: Mark Rutland <mark.rutland-5wv7dgnIgG8@public.gmane.org>,
Pantelis Antoniou
<pantelis.antoniou-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>,
Behan Webster
<behanw-k/hB3zQhLwledRVtV/plodBPR1lH4CV8@public.gmane.org>
Subject: [RFC PATCH 2/5] Documentation: dt-bindings: add example DT binding document
Date: Fri, 28 Aug 2015 01:23:50 -0400 [thread overview]
Message-ID: <1440739433-6799-3-git-send-email-mporter@konsulko.com> (raw)
In-Reply-To: <1440739433-6799-1-git-send-email-mporter-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>
Add a skeleton DT binding document that serves as the canonical
example for implementing YAML-based DT bindings documentation.
The skeleton binding illustrates use of all fields and variations
described in the dt-binding-format.txt documentation.
Signed-off-by: Matt Porter <mporter-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>
---
Documentation/devicetree/bindings/skeleton.yaml | 98 +++++++++++++++++++++++++
1 file changed, 98 insertions(+)
create mode 100644 Documentation/devicetree/bindings/skeleton.yaml
diff --git a/Documentation/devicetree/bindings/skeleton.yaml b/Documentation/devicetree/bindings/skeleton.yaml
new file mode 100644
index 0000000..175965f
--- /dev/null
+++ b/Documentation/devicetree/bindings/skeleton.yaml
@@ -0,0 +1,98 @@
+%YAML 1.2
+---
+id: skel-device
+
+title: Skeleton Device
+
+maintainer:
+ - name: Skeleton Person <skel-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
+
+description: >
+ The Skeleton Device binding represents the SK11 device produced by
+ the Skeleton Corporation. The binding can also support compatible
+ clones made by second source vendors.
+
+compatible:
+ - name: "skel,sk11"
+ - name: "faux,fx11"
+ description: A clone of the original sk11 device
+
+required:
+ - name: "reg"
+ description: chip select address of skeleton device
+ reference: spi-slave
+ - name: "spi-max-frequency"
+ description: >
+ Maximum SPI clocking speed of skeleton device in Hz, must be
+ 1000000
+ reference: spi-slave
+
+optional:
+ - name: "spi-cs-high"
+ description: >
+ Set if skeleton device configuration straps are set for chip
+ select polarity high
+ reference: spi-slave
+
+deprecated:
+ - name: "skel,deprecated1"
+ description: >
+ First of two deprecated properties.
+ - name: "skel,deprecated2"
+ description: >
+ Second of two deprecated properties.
+
+example:
+ - dts: |
+ sk11@0 {
+ compatible = "skel,sk11";
+ reg = <0>;
+ spi-max-frequency = <1000000>;
+ spi-cs-high;
+ };
+...
+
+---
+id: skel-mini
+
+title: Skeleton Mini Device
+
+maintainer:
+ - name: Rogue Developer <rogue-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
+
+description: >
+ The Skeleton Mini Device binding represents the SK47x series devices
+ produced by the Skeleton Corporation.
+
+compatible:
+ - name: "skel,sk472"
+ - name: "skel,sk473"
+ - name: "skel,sk474"
+ - deprecated: "skel,sk47x"
+
+required:
+ - name: "reg"
+ description: offset and length of the registers
+
+optional:
+ - name: "skel,sync-mode"
+ description: Enable synchronous transfer mode
+
+example:
+ - dts: |
+ sk472@beef0000 {
+ compatible = "skel,sk472";
+ reg = <0xbeef0000 0x100>;
+ };
+ description: >
+ Demonstrates an SK472 in normal mode.
+
+ - dts: |
+ sk474@dead0000 {
+ compatible = "skel,sk474";
+ reg = <0xdead0000 0x100>;
+ skel,sync-mode;
+ };
+ description: >
+ Demonstrates an SK474 in synchronous mode.
+...
--
2.1.4
next prev parent reply other threads:[~2015-08-28 5:23 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-28 5:23 [RFC PATCH 0/5] DT binding documents using text markup Matt Porter
[not found] ` <1440739433-6799-1-git-send-email-mporter-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>
2015-08-28 5:23 ` [RFC PATCH 1/5] Documentation: dt-bindings: add documentation on new DT binding format Matt Porter
[not found] ` <1440739433-6799-2-git-send-email-mporter-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>
2015-08-30 22:04 ` Frank Rowand
[not found] ` <55E37DF1.3080102-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2015-09-08 17:38 ` Matt Porter
2015-09-01 16:59 ` Tim Bird
[not found] ` <CA+bK7J76Z6H4gh-UXxMWqUYrdRx1GYKFkAAtDUszpT_8k=RCQw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-09-08 7:55 ` David Gibson
2015-09-22 4:14 ` Matt Porter
2015-09-08 7:36 ` David Gibson
2015-08-28 5:23 ` Matt Porter [this message]
[not found] ` <1440739433-6799-3-git-send-email-mporter-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>
2015-08-28 14:53 ` [RFC PATCH 2/5] Documentation: dt-bindings: add example DT binding document Rob Herring
[not found] ` <CAL_Jsq+FE4MCCfZC5hDhQBmM1gHibY82S9a8PC1GwsnWsPNxkg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-08-28 14:57 ` Pantelis Antoniou
2015-08-28 17:49 ` Matt Porter
2015-08-28 18:55 ` Rob Herring
[not found] ` <CAL_JsqJy21yBGe161MrTEC1kL4UD=h+skH=mPm-vjwZ7yEHoUA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-08-30 22:18 ` Frank Rowand
[not found] ` <55E3812B.2090105-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2015-09-08 14:56 ` Matt Porter
2015-09-01 17:30 ` Matt Porter
2015-09-01 17:35 ` Tim Bird
[not found] ` <CA+bK7J4x2vY-tzUFWjM9KFMtvE+qW6jzmz=ZxWU9L8Mpe8Lduw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-09-02 8:45 ` Nicolas Ferre
[not found] ` <55E6B719.6080203-AIFe0yeh4nAAvxtiuMwx3w@public.gmane.org>
2015-09-08 15:06 ` Matt Porter
2015-09-08 15:01 ` Matt Porter
2015-09-10 7:08 ` David Gibson
2015-09-11 4:46 ` Rob Herring
[not found] ` <55F25C95.3010104-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2015-09-14 8:15 ` David Gibson
2015-09-22 4:06 ` Matt Porter
2015-08-28 5:23 ` [RFC PATCH 3/5] Documentation: dt-bindings: add YAML eeprom binding Matt Porter
2015-08-28 5:23 ` [RFC PATCH 4/5] Documentation: dt-bindings: phy: add YAML generic PHY binding Matt Porter
2015-08-28 5:23 ` [RFC PATCH 5/5] Documentation: dt-bindings: phy: add YAML TI " Matt Porter
[not found] ` <1440739433-6799-6-git-send-email-mporter-OWPKS81ov/FWk0Htik3J/w@public.gmane.org>
2015-09-01 17:42 ` Tim Bird
[not found] ` <CA+bK7J5jz0wxgA-0jY4LFUWWoTk4YzGaGSQZsdF83BnomoBx6w-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-09-08 13:47 ` Matt Porter
2015-08-28 14:26 ` [RFC PATCH 0/5] DT binding documents using text markup Rob Herring
[not found] ` <CAL_Jsq+qCJfLYxVfyQ4gAxPWLZ2=WNa0H21+cRcBi7dGVG0PMA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-08-28 17:13 ` Matt Porter
2015-08-31 14:05 ` Rob Herring
[not found] ` <CAL_JsqJ7C4JtjGjFJjLQpLEdzbs2rw0K0TzVNB2VjOz4Sr9Nbw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-09-08 14:15 ` Matt Porter
2015-09-01 17:14 ` Tim Bird
[not found] ` <CA+bK7J4Ha55oFhCYDnUcBu8ZHCP3ReB6B=7Y9Fw7CknxPcaoWQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-09-01 17:35 ` Frank Rowand
[not found] ` <55E5E1E2.6040607-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2015-09-01 18:03 ` Tim Bird
[not found] ` <CA+bK7J6kErnKPHs=r+X9T8KBn45HptPmtMe31CoapunKpuY34Q-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-09-01 18:24 ` Rob Herring
[not found] ` <CAL_Jsq+7NQdZivTpwRDwcGrCzpcQQoV5gvSkjz3NNOWNXdBhMA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-09-08 14:36 ` Matt Porter
2015-09-08 19:38 ` Rob Herring
2015-09-08 14:28 ` Matt Porter
2015-09-08 14:23 ` Matt Porter
2015-09-08 14:19 ` Matt Porter
2015-08-30 22:04 ` Frank Rowand
[not found] ` <55E37DE4.4090503-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2015-09-01 17:34 ` Matt Porter
2015-09-01 16:14 ` Tim Bird
[not found] ` <CA+bK7J5MriF95d2OGAZRT8PyJkK_x5r1J1yPq2Ke=SZkit6xHA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2015-09-08 13:42 ` Matt Porter
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=1440739433-6799-3-git-send-email-mporter@konsulko.com \
--to=mporter-owpks81ov/fwk0htik3j/w@public.gmane.org \
--cc=behanw-k/hB3zQhLwledRVtV/plodBPR1lH4CV8@public.gmane.org \
--cc=devicetree-spec-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
--cc=devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
--cc=frowand.list-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
--cc=grant.likely-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org \
--cc=mark.rutland-5wv7dgnIgG8@public.gmane.org \
--cc=pantelis.antoniou-OWPKS81ov/FWk0Htik3J/w@public.gmane.org \
--cc=robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).