diff mbox series

[v3,2/6] doc: Add a binding for sysinfo

Message ID 20201022030828.586067-3-sjg@chromium.org
State Superseded
Delegated to: Bin Meng
Headers show
Series x86: Updates to SMBIOS | expand

Commit Message

Simon Glass Oct. 22, 2020, 3:08 a.m. UTC
Add a simple binding file for this, so that it is clear what this binding
directory is for.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

(no changes since v1)

 doc/device-tree-bindings/sysinfo/sysinfo.txt | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 doc/device-tree-bindings/sysinfo/sysinfo.txt

Comments

Heinrich Schuchardt Oct. 22, 2020, 5:40 a.m. UTC | #1
On 10/22/20 5:08 AM, Simon Glass wrote:
> Add a simple binding file for this, so that it is clear what this binding
> directory is for.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> ---
>
> (no changes since v1)
>
>  doc/device-tree-bindings/sysinfo/sysinfo.txt | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>  create mode 100644 doc/device-tree-bindings/sysinfo/sysinfo.txt
>
> diff --git a/doc/device-tree-bindings/sysinfo/sysinfo.txt b/doc/device-tree-bindings/sysinfo/sysinfo.txt
> new file mode 100644
> index 00000000000..ed8830b8284
> --- /dev/null
> +++ b/doc/device-tree-bindings/sysinfo/sysinfo.txt
> @@ -0,0 +1,18 @@
> +Sysinfo
> +=======
> +
> +This provides capabilities to access information about a board/system, for
> +use by drivers.
> +
> +Required properties:
> +
> +  - compatible: any suitable string where the driver is in the UCLASS_SYSINFO
> +      class
> +
> +See also smbios.txt
> +
> +
> +Example
> +
> +sysinfo {
> +	compatible = "sandbox,sysinfo";
>

Most boards use don't use ACPI but device-trees for calling
the operating system.
We try to keep our device-trees in sync with Linux.
The device-tree available under $fdtcontroladdr should be
usable to boot the OS.
We should avoid anything that could lead now or in the future
to a conflict with the the OS usage of the device tree nodes.

Please, use in the example a compatibility string that is
unique to U-Boot.

How about: "uboot,sandbox-sysinfo"?

Best regards

Heinrich
Simon Glass Oct. 22, 2020, 12:29 p.m. UTC | #2
Hi Heinrich,

On Wed, 21 Oct 2020 at 23:41, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> On 10/22/20 5:08 AM, Simon Glass wrote:
> > Add a simple binding file for this, so that it is clear what this binding
> > directory is for.
> >
> > Signed-off-by: Simon Glass <sjg@chromium.org>
> > ---
> >
> > (no changes since v1)
> >
> >  doc/device-tree-bindings/sysinfo/sysinfo.txt | 18 ++++++++++++++++++
> >  1 file changed, 18 insertions(+)
> >  create mode 100644 doc/device-tree-bindings/sysinfo/sysinfo.txt
> >
> > diff --git a/doc/device-tree-bindings/sysinfo/sysinfo.txt b/doc/device-tree-bindings/sysinfo/sysinfo.txt
> > new file mode 100644
> > index 00000000000..ed8830b8284
> > --- /dev/null
> > +++ b/doc/device-tree-bindings/sysinfo/sysinfo.txt
> > @@ -0,0 +1,18 @@
> > +Sysinfo
> > +=======
> > +
> > +This provides capabilities to access information about a board/system, for
> > +use by drivers.
> > +
> > +Required properties:
> > +
> > +  - compatible: any suitable string where the driver is in the UCLASS_SYSINFO
> > +      class
> > +
> > +See also smbios.txt
> > +
> > +
> > +Example
> > +
> > +sysinfo {
> > +     compatible = "sandbox,sysinfo";
> >
>
> Most boards use don't use ACPI but device-trees for calling
> the operating system.
> We try to keep our device-trees in sync with Linux.
> The device-tree available under $fdtcontroladdr should be
> usable to boot the OS.
> We should avoid anything that could lead now or in the future
> to a conflict with the the OS usage of the device tree nodes.
>
> Please, use in the example a compatibility string that is
> unique to U-Boot.
>
> How about: "uboot,sandbox-sysinfo"?

We use "sandbox" as the vendor throughout U-Boot so I don't feel we
should change now. Perhaps as part of an effort to send our bindings
upstream?

Regards,
Simon
diff mbox series

Patch

diff --git a/doc/device-tree-bindings/sysinfo/sysinfo.txt b/doc/device-tree-bindings/sysinfo/sysinfo.txt
new file mode 100644
index 00000000000..ed8830b8284
--- /dev/null
+++ b/doc/device-tree-bindings/sysinfo/sysinfo.txt
@@ -0,0 +1,18 @@ 
+Sysinfo
+=======
+
+This provides capabilities to access information about a board/system, for
+use by drivers.
+
+Required properties:
+
+  - compatible: any suitable string where the driver is in the UCLASS_SYSINFO
+      class
+
+See also smbios.txt
+
+
+Example
+
+sysinfo {
+	compatible = "sandbox,sysinfo";