Documentation for Data Capture and Compare(DCC) device tree bindings
in yaml format.
Signed-off-by: Souradeep Chowdhury <quic_schowdhu@quicinc.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Reviewed-by: Bjorn Andersson <andersson@kernel.org>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
---
.../devicetree/bindings/soc/qcom/qcom,dcc.yaml | 44 ++++++++++++++++++++++
1 file changed, 44 insertions(+)
create mode 100644 Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml
diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml b/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml
new file mode 100644
index 0000000..ac3b51b
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml
@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/soc/qcom/qcom,dcc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Data Capture and Compare
+
+maintainers:
+ - Souradeep Chowdhury <quic_schowdhu@quicinc.com>
+
+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
+ - qcom,sc7280-dcc
+ - qcom,sc7180-dcc
+ - qcom,sdm845-dcc
+ - const: qcom,dcc
+
+ reg:
+ items:
+ - description: DCC base
+ - description: DCC RAM base
+
+required:
+ - compatible
+ - reg
+
+additionalProperties: false
+
+examples:
+ - |
+ dma@10a2000{
+ compatible = "qcom,sm8150-dcc","qcom,dcc";
+ reg = <0x010a2000 0x1000>,
+ <0x010ad000 0x2000>;
+ };
--
2.7.4
On 26/12/2022 17:52, Souradeep Chowdhury wrote: > Documentation for Data Capture and Compare(DCC) device tree bindings > in yaml format. Use subject prefixes matching the subsystem (which you can get for example with `git log --oneline -- DIRECTORY_OR_FILE` on the directory your patch is touching). Subject: drop second, redundant "bindings". Drop "yaml" (also unrelated). Use proper imperative mode. https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95 > > Signed-off-by: Souradeep Chowdhury <quic_schowdhu@quicinc.com> > Reviewed-by: Rob Herring <robh@kernel.org> > Reviewed-by: Bjorn Andersson <andersson@kernel.org> > Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > --- > .../devicetree/bindings/soc/qcom/qcom,dcc.yaml | 44 ++++++++++++++++++++++ > 1 file changed, 44 insertions(+) > create mode 100644 Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml > > diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml b/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml > new file mode 100644 > index 0000000..ac3b51b > --- /dev/null > +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml > @@ -0,0 +1,44 @@ > +# SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/soc/qcom/qcom,dcc.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Data Capture and Compare > + > +maintainers: > + - Souradeep Chowdhury <quic_schowdhu@quicinc.com> > + > +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 > + - qcom,sc7280-dcc > + - qcom,sc7180-dcc > + - qcom,sdm845-dcc > + - const: qcom,dcc > + > + reg: > + items: > + - description: DCC base > + - description: DCC RAM base > + > +required: > + - compatible > + - reg > + > +additionalProperties: false > + > +examples: > + - | > + dma@10a2000{ > + compatible = "qcom,sm8150-dcc","qcom,dcc"; Missing space between compatibles. Best regards, Krzysztof
On 12/27/2022 1:51 PM, Krzysztof Kozlowski wrote: > On 26/12/2022 17:52, Souradeep Chowdhury wrote: >> Documentation for Data Capture and Compare(DCC) device tree bindings >> in yaml format. > > Use subject prefixes matching the subsystem (which you can get for > example with `git log --oneline -- DIRECTORY_OR_FILE` on the directory > your patch is touching). > > Subject: drop second, redundant "bindings". Drop "yaml" (also unrelated). > > Use proper imperative mode. > https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95 Ack > >> >> Signed-off-by: Souradeep Chowdhury <quic_schowdhu@quicinc.com> >> Reviewed-by: Rob Herring <robh@kernel.org> >> Reviewed-by: Bjorn Andersson <andersson@kernel.org> >> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> >> --- >> .../devicetree/bindings/soc/qcom/qcom,dcc.yaml | 44 ++++++++++++++++++++++ >> 1 file changed, 44 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml >> >> diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml b/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml >> new file mode 100644 >> index 0000000..ac3b51b >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/soc/qcom/qcom,dcc.yaml >> @@ -0,0 +1,44 @@ >> +# SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause) >> +%YAML 1.2 >> +--- >> +$id: http://devicetree.org/schemas/soc/qcom/qcom,dcc.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: Data Capture and Compare >> + >> +maintainers: >> + - Souradeep Chowdhury <quic_schowdhu@quicinc.com> >> + >> +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 >> + - qcom,sc7280-dcc >> + - qcom,sc7180-dcc >> + - qcom,sdm845-dcc >> + - const: qcom,dcc >> + >> + reg: >> + items: >> + - description: DCC base >> + - description: DCC RAM base >> + >> +required: >> + - compatible >> + - reg >> + >> +additionalProperties: false >> + >> +examples: >> + - | >> + dma@10a2000{ >> + compatible = "qcom,sm8150-dcc","qcom,dcc"; > > Missing space between compatibles. Ack > > Best regards, > Krzysztof >
© 2016 - 2025 Red Hat, Inc.