diff mbox series

[V2,1/5] dt-bindings: Added the yaml bindings for DCC

Message ID 5cd274f98b38d4b85c1ce212720b6b680f4a00f0.1616651305.git.schowdhu@codeaurora.org
State Superseded
Headers show
Series Add driver support for Data Capture and Compare Engine(DCC) for SM8150 | expand

Commit Message

Souradeep Chowdhury March 25, 2021, 8:02 a.m. UTC
Documentation for Data Capture and Compare(DCC) device tree bindings
in yaml format.

Signed-off-by: Souradeep Chowdhury <schowdhu@codeaurora.org>
---
 .../devicetree/bindings/arm/msm/qcom,dcc.yaml      | 49 ++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml

Comments

Rob Herring (Arm) March 27, 2021, 5:49 p.m. UTC | #1
On Thu, 25 Mar 2021 13:32:32 +0530, Souradeep Chowdhury wrote:
> Documentation for Data Capture and Compare(DCC) device tree bindings

> in yaml format.

> 

> Signed-off-by: Souradeep Chowdhury <schowdhu@codeaurora.org>

> ---

>  .../devicetree/bindings/arm/msm/qcom,dcc.yaml      | 49 ++++++++++++++++++++++

>  1 file changed, 49 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml

> 


Reviewed-by: Rob Herring <robh@kernel.org>
Stephen Boyd March 29, 2021, 7:34 p.m. UTC | #2
Quoting Souradeep Chowdhury (2021-03-25 01:02:32)
> diff --git a/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml b/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml

> new file mode 100644

> index 0000000..c6e0a9c

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml

> @@ -0,0 +1,49 @@

> +# SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/arm/msm/qcom,dcc.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title: Data Capture and Compare

> +

> +maintainers:

> +  - Souradeep Chowdhury <schowdhu@codeaurora.org>

> +

> +description: |

> +    DCC (Data Capture and Compare) is a DMA engine which is used to save

> +    configuration data or system memory contents during catastrophic failure

> +    or SW trigger.DCC is used to capture and store data for debugging purpose


Add space between trigger. and DCC?

> +

> +


Drop double newline?

> +properties:

> +  compatible:

> +    items:

> +      - enum:

> +          - qcom,sm8150-dcc

> +      - const: qcom,dcc

> +

> +  reg:

> +    items:

> +      - description: DCC base register region

> +      - description: DCC RAM base register region

> +

> +  reg-names:

> +    items:

> +      - const: dcc

> +      - const: dcc-ram

> +

> +required:

> +  - compatible

> +  - reg

> +  - reg-names


Do we really need reg names? Seems like we can assume the ordering.

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    dcc@10a2000{


dma@10a2000? Or debug@10a2000?

> +                compatible = "qcom,sm8150-dcc","qcom,dcc";

> +                reg = <0x010a2000  0x1000>,

> +                      <0x010ad000  0x2000>;

> +                reg-names = "dcc", "dcc-ram";

> +    };
Souradeep Chowdhury April 1, 2021, 8:22 a.m. UTC | #3
On 2021-03-30 01:04, Stephen Boyd wrote:
> Quoting Souradeep Chowdhury (2021-03-25 01:02:32)

>> diff --git a/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml 

>> b/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml

>> new file mode 100644

>> index 0000000..c6e0a9c

>> --- /dev/null

>> +++ b/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml

>> @@ -0,0 +1,49 @@

>> +# SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)

>> +%YAML 1.2

>> +---

>> +$id: http://devicetree.org/schemas/arm/msm/qcom,dcc.yaml#

>> +$schema: http://devicetree.org/meta-schemas/core.yaml#

>> +

>> +title: Data Capture and Compare

>> +

>> +maintainers:

>> +  - Souradeep Chowdhury <schowdhu@codeaurora.org>

>> +

>> +description: |

>> +    DCC (Data Capture and Compare) is a DMA engine which is used to 

>> save

>> +    configuration data or system memory contents during catastrophic 

>> failure

>> +    or SW trigger.DCC is used to capture and store data for debugging 

>> purpose

> 

> Add space between trigger. and DCC?


Ack

> 

>> +

>> +

> 

> Drop double newline?


Ack

> 

>> +properties:

>> +  compatible:

>> +    items:

>> +      - enum:

>> +          - qcom,sm8150-dcc

>> +      - const: qcom,dcc

>> +

>> +  reg:

>> +    items:

>> +      - description: DCC base register region

>> +      - description: DCC RAM base register region

>> +

>> +  reg-names:

>> +    items:

>> +      - const: dcc

>> +      - const: dcc-ram

>> +

>> +required:

>> +  - compatible

>> +  - reg

>> +  - reg-names

> 

> Do we really need reg names? Seems like we can assume the ordering.


Ack

> 

>> +

>> +additionalProperties: false

>> +

>> +examples:

>> +  - |

>> +    dcc@10a2000{

> 

> dma@10a2000? Or debug@10a2000?


Ack

> 

>> +                compatible = "qcom,sm8150-dcc","qcom,dcc";

>> +                reg = <0x010a2000  0x1000>,

>> +                      <0x010ad000  0x2000>;

>> +                reg-names = "dcc", "dcc-ram";

>> +    };
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml b/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml
new file mode 100644
index 0000000..c6e0a9c
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/msm/qcom,dcc.yaml
@@ -0,0 +1,49 @@ 
+# SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/arm/msm/qcom,dcc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Data Capture and Compare
+
+maintainers:
+  - Souradeep Chowdhury <schowdhu@codeaurora.org>
+
+description: |
+    DCC (Data Capture and Compare) is a DMA engine which is used to save
+    configuration data or system memory contents during catastrophic failure
+    or SW trigger.DCC is used to capture and store data for debugging purpose
+
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - qcom,sm8150-dcc
+      - const: qcom,dcc
+
+  reg:
+    items:
+      - description: DCC base register region
+      - description: DCC RAM base register region
+
+  reg-names:
+    items:
+      - const: dcc
+      - const: dcc-ram
+
+required:
+  - compatible
+  - reg
+  - reg-names
+
+additionalProperties: false
+
+examples:
+  - |
+    dcc@10a2000{
+                compatible = "qcom,sm8150-dcc","qcom,dcc";
+                reg = <0x010a2000  0x1000>,
+                      <0x010ad000  0x2000>;
+                reg-names = "dcc", "dcc-ram";
+    };