diff mbox series

[v1,2/3] dt-bindings: soc: meta: Add meta cld driver bindings

Message ID 20230117094425.19004-3-Delphine_CC_Chiu@Wiwynn.com
State New
Headers show
Series Meta control logic device support | expand

Commit Message

Delphine CC Chiu Jan. 17, 2023, 9:44 a.m. UTC
Add a device tree bindings for Meta control logic device.

Signed-off-by: Delphine CC Chiu <Delphine_CC_Chiu@Wiwynn.com>
---
 .../misc/meta,control-logic-device.txt        | 37 +++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/misc/meta,control-logic-device.txt

Comments

Delphine CC Chiu March 13, 2023, 8:47 a.m. UTC | #1
Hi Krzysztof,

Thanks for your comment.

> -----Original Message-----
> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Sent: Tuesday, January 17, 2023 6:50 PM
> To: Delphine_CC_Chiu/WYHQ/Wiwynn <Delphine_CC_Chiu@wiwynn.com>;
> patrick@stwcx.xyz; Rob Herring <robh+dt@kernel.org>; Krzysztof Kozlowski
> <krzysztof.kozlowski+dt@linaro.org>
> Cc: garnermic@fb.com; Derek Kiernan <derek.kiernan@xilinx.com>; Dragan
> Cvetic <dragan.cvetic@xilinx.com>; Arnd Bergmann <arnd@arndb.de>; Greg
> Kroah-Hartman <gregkh@linuxfoundation.org>; Stanislav Jakubek
> <stano.jakubek@gmail.com>; Daniel Palmer <daniel@0x0f.com>; Linus Walleij
> <linus.walleij@linaro.org>; Samuel Holland <samuel@sholland.org>;
> linux-i2c@vger.kernel.org; devicetree@vger.kernel.org;
> linux-kernel@vger.kernel.org
> Subject: Re: [PATCH v1 2/3] dt-bindings: soc: meta: Add meta cld driver
> bindings
> 
>   Security Reminder: Please be aware that this email is sent by an external
> sender.
> 
> On 17/01/2023 10:44, Delphine CC Chiu wrote:
> > Add a device tree bindings for Meta control logic device.
> 
> Subject: drop second/last, redundant "bindings". The "dt-bindings"
> prefix is already stating that these are bindings.

We will remove the bindings from the subject.

> 
> Subject: Drop "driver"

We will revise the subject.

> 
> >
> > Signed-off-by: Delphine CC Chiu <Delphine_CC_Chiu@Wiwynn.com>
> > ---
> >  .../misc/meta,control-logic-device.txt        | 37 +++++++++++++++++++
> >  1 file changed, 37 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/misc/meta,control-logic-device.txt
> >
> > diff --git
> > a/Documentation/devicetree/bindings/misc/meta,control-logic-device.txt
> > b/Documentation/devicetree/bindings/misc/meta,control-logic-device.txt
> > new file mode 100644
> > index 000000000000..e966368e2fd6
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/misc/meta,control-logic-device
> > +++ .txt
> 
> New bindings only in DT schema format. Start
> Documentation/devicetree/bindings/writing-schema.rst,
> example-schema.yaml and other docs.

We will rewrite the binding document following the schema.

> 
> 
> 
> Best regards,
> Krzysztof

Thanks,
Delphine
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/misc/meta,control-logic-device.txt b/Documentation/devicetree/bindings/misc/meta,control-logic-device.txt
new file mode 100644
index 000000000000..e966368e2fd6
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/meta,control-logic-device.txt
@@ -0,0 +1,37 @@ 
+* Meta Control Logic Device(CLD) Driver
+
+PROPERTIES
+
+- compatible:
+  Usage:      required
+  Type:       <string-list>
+  Definition: must include "meta,control-logic-device-<driver version>."
+              For v1, the register number, name and mode can be set in dts file.
+              Driver exports the filesystem following the dts setting.
+
+- reg:
+  Usage:      required
+  Definition: physical address
+
+- register-map:
+	Usage:      optional
+	type:       <string-list>
+	Definition: this property is an array of strings defining the names, modes
+		    and offsets of the CLD registers. The string format is "<name>:<mode>:<offset>".
+		<name>: the system file name
+		<mode>: the system file access mode. Should be r, w or rw.
+		<offset>: the register offset. If it begins with 0x the number will be
+			  parsed as a hexadecimal, if it otherwise begins with 0, it will
+			  be parsed as an octal number. Otherwise it will be parsed as a
+			  decimal.
+
+EXAMPLE
+	cld: cld@0f {
+		compatible = "meta,control-logic-device-v1";
+		reg = <0x0f>;
+		registers-map =
+			"uart-selection:rw:0x00",
+			"led-identify:rw:0x01",
+			"led-critical:rw:0x02";
+	};
+