diff mbox series

[6/6] dt-bindings: power: supply: qcom,smb2: add bindings for smb2 driver

Message ID 20220401202643.877609-7-caleb.connolly@linaro.org
State New
Headers show
Series [1/6] power: supply: add Qualcomm SMB2 driver | expand

Commit Message

Caleb Connolly April 1, 2022, 8:26 p.m. UTC
Add devicetree bindings for the Qualcomm PMI8998/PM660 SMB2 charger
drivers.

Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>
---
 .../bindings/power/supply/qcom,smb2.yaml      | 68 +++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/supply/qcom,smb2.yaml

Comments

Kuldeep Singh April 3, 2022, 7:14 a.m. UTC | #1
On Fri, Apr 01, 2022 at 09:26:43PM +0100, Caleb Connolly wrote:
> Add devicetree bindings for the Qualcomm PMI8998/PM660 SMB2 charger
> drivers.
> 
> Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>
> ---
>  .../bindings/power/supply/qcom,smb2.yaml      | 68 +++++++++++++++++++
>  1 file changed, 68 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/power/supply/qcom,smb2.yaml
> 
> diff --git a/Documentation/devicetree/bindings/power/supply/qcom,smb2.yaml b/Documentation/devicetree/bindings/power/supply/qcom,smb2.yaml
> new file mode 100644
> index 000000000000..1bea1fef78b8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/supply/qcom,smb2.yaml
> @@ -0,0 +1,68 @@
> +# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/power/supply/qcom,smb2.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm PMI8998/PM660 Switch-Mode Battery Charger "2"
> +
> +maintainers:
> +  - Caleb Connolly <caleb.connolly@linaro.org>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - qcom,pmi8998-smb2

Since there's only 1 entry, please use const.

> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    items:
> +      - description: usb plugin
> +
> +  interrupt-names:
> +    items:
> +      - const: usb-plugin
> +
> +  io-channels:
> +    items:
> +      - description: USB in current in uA
> +      - description: USB in voltage in uV
> +
> +  io-channel-names:
> +    items:
> +      - const: usbin_i
> +      - const: usbin_v
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-names
> +  - io-channels
> +  - io-channel-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>

New line here. Looks nice.

> +    pmic {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      #interrupt-cells = <4>;
> +
> +      smb2@1000 {
> +        compatible = "qcom,pmi8998-smb2";
> +        reg = <0x1000>;
> +
> +        interrupts = <0x2 0x13 0x4 IRQ_TYPE_EDGE_BOTH>;
> +        interrupt-names = "usb-plugin";
> +

In-between new lines may not be required.
And DTs use tabs instead of 2 spaces, we can follow that here also.

> +        io-channels = <&pmi8998_rradc 3>,
> +                      <&pmi8998_rradc 4>;
> +        io-channel-names = "usbin_i",
> +                           "usbin_v";

Channel-names can be written in one line.

> +      };
> +    };
> -- 
> 2.35.1
>
Krzysztof Kozlowski April 3, 2022, 7:56 a.m. UTC | #2
On 03/04/2022 09:14, Kuldeep Singh wrote:
> On Fri, Apr 01, 2022 at 09:26:43PM +0100, Caleb Connolly wrote:
>> Add devicetree bindings for the Qualcomm PMI8998/PM660 SMB2 charger
>> drivers.
>>

(...)

> 
>> +    pmic {
>> +      #address-cells = <1>;
>> +      #size-cells = <0>;
>> +      #interrupt-cells = <4>;
>> +
>> +      smb2@1000 {
>> +        compatible = "qcom,pmi8998-smb2";
>> +        reg = <0x1000>;
>> +
>> +        interrupts = <0x2 0x13 0x4 IRQ_TYPE_EDGE_BOTH>;
>> +        interrupt-names = "usb-plugin";
>> +
> 
> In-between new lines may not be required.
> And DTs use tabs instead of 2 spaces, we can follow that here also.

The DT examples in bindings use spaces. Either two (like YAML) or four
(for easier reading).

> 
>> +        io-channels = <&pmi8998_rradc 3>,
>> +                      <&pmi8998_rradc 4>;
>> +        io-channel-names = "usbin_i",
>> +                           "usbin_v";
> 
> Channel-names can be written in one line.

They match the format of io-channels, so this is quite readable.



Best regards,
Krzysztof
Kuldeep Singh April 3, 2022, 1:31 p.m. UTC | #3
On Sun, Apr 03, 2022 at 09:56:25AM +0200, Krzysztof Kozlowski wrote:
> On 03/04/2022 09:14, Kuldeep Singh wrote:
> > On Fri, Apr 01, 2022 at 09:26:43PM +0100, Caleb Connolly wrote:
> >> Add devicetree bindings for the Qualcomm PMI8998/PM660 SMB2 charger
> >> drivers.
> >>
> 
> (...)
> 
> > 
> >> +    pmic {
> >> +      #address-cells = <1>;
> >> +      #size-cells = <0>;
> >> +      #interrupt-cells = <4>;
> >> +
> >> +      smb2@1000 {
> >> +        compatible = "qcom,pmi8998-smb2";
> >> +        reg = <0x1000>;
> >> +
> >> +        interrupts = <0x2 0x13 0x4 IRQ_TYPE_EDGE_BOTH>;
> >> +        interrupt-names = "usb-plugin";
> >> +
> > 
> > In-between new lines may not be required.
> > And DTs use tabs instead of 2 spaces, we can follow that here also.
> 
> The DT examples in bindings use spaces. Either two (like YAML) or four
> (for easier reading).

ok, since example snippet is taken from DT that's why I said four
spaces(tab) as it will be closest to actual env.

> 
> > 
> >> +        io-channels = <&pmi8998_rradc 3>,
> >> +                      <&pmi8998_rradc 4>;
> >> +        io-channel-names = "usbin_i",
> >> +                           "usbin_v";
> > 
> > Channel-names can be written in one line.
> 
> They match the format of io-channels, so this is quite readable.

io-channels doesn't exceed max characters in line(i.e 75) even after
being clubbed. Won't be better if kept in one line?
This might be personal perspective but I thought it's worth mentioning.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/power/supply/qcom,smb2.yaml b/Documentation/devicetree/bindings/power/supply/qcom,smb2.yaml
new file mode 100644
index 000000000000..1bea1fef78b8
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/qcom,smb2.yaml
@@ -0,0 +1,68 @@ 
+# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/power/supply/qcom,smb2.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm PMI8998/PM660 Switch-Mode Battery Charger "2"
+
+maintainers:
+  - Caleb Connolly <caleb.connolly@linaro.org>
+
+properties:
+  compatible:
+    enum:
+      - qcom,pmi8998-smb2
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    items:
+      - description: usb plugin
+
+  interrupt-names:
+    items:
+      - const: usb-plugin
+
+  io-channels:
+    items:
+      - description: USB in current in uA
+      - description: USB in voltage in uV
+
+  io-channel-names:
+    items:
+      - const: usbin_i
+      - const: usbin_v
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-names
+  - io-channels
+  - io-channel-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    pmic {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      #interrupt-cells = <4>;
+
+      smb2@1000 {
+        compatible = "qcom,pmi8998-smb2";
+        reg = <0x1000>;
+
+        interrupts = <0x2 0x13 0x4 IRQ_TYPE_EDGE_BOTH>;
+        interrupt-names = "usb-plugin";
+
+        io-channels = <&pmi8998_rradc 3>,
+                      <&pmi8998_rradc 4>;
+        io-channel-names = "usbin_i",
+                           "usbin_v";
+      };
+    };