diff mbox series

[3/5,v2] dt-bindings: gnss: Rewrite sirfstar binding in YAML

Message ID 20220317225844.1262643-3-linus.walleij@linaro.org
State Accepted
Commit 5505409e423f61c981d84f53dee2a93bf3ba5913
Headers show
Series [1/5,v2] dt-bindings: gnss: Rewrite common bindings in YAML | expand

Commit Message

Linus Walleij March 17, 2022, 10:58 p.m. UTC
This rewrites the SiRFstar DT bindings in YAML.

Cc: devicetree@vger.kernel.org
Cc: Krzysztof Kozlowski <krzk@kernel.org>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
---
ChangeLog v1->v2:
- Change additionalProperties: false to uneavaluatedProperties: false
  so new common properties get available immediately
- This should also make the checker robot happy about
  lna-supply
---
 .../devicetree/bindings/gnss/sirfstar.txt     | 46 ------------
 .../devicetree/bindings/gnss/sirfstar.yaml    | 71 +++++++++++++++++++
 2 files changed, 71 insertions(+), 46 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/gnss/sirfstar.txt
 create mode 100644 Documentation/devicetree/bindings/gnss/sirfstar.yaml

Comments

Rob Herring (Arm) March 20, 2022, 6:58 p.m. UTC | #1
On Fri, Mar 18, 2022 at 10:29:03AM +0100, Krzysztof Kozlowski wrote:
> On 17/03/2022 23:58, Linus Walleij wrote:
> > This rewrites the SiRFstar DT bindings in YAML.
> > 
> > Cc: devicetree@vger.kernel.org
> > Cc: Krzysztof Kozlowski <krzk@kernel.org>
> > Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
> > ---
> > ChangeLog v1->v2:
> > - Change additionalProperties: false to uneavaluatedProperties: false
> >   so new common properties get available immediately
> > - This should also make the checker robot happy about
> >   lna-supply
> > ---
> >  .../devicetree/bindings/gnss/sirfstar.txt     | 46 ------------
> >  .../devicetree/bindings/gnss/sirfstar.yaml    | 71 +++++++++++++++++++
> >  2 files changed, 71 insertions(+), 46 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/gnss/sirfstar.txt
> >  create mode 100644 Documentation/devicetree/bindings/gnss/sirfstar.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/gnss/sirfstar.txt b/Documentation/devicetree/bindings/gnss/sirfstar.txt
> > deleted file mode 100644
> > index f4252b6b660b..000000000000
> > --- a/Documentation/devicetree/bindings/gnss/sirfstar.txt
> > +++ /dev/null
> > @@ -1,46 +0,0 @@
> > -SiRFstar-based GNSS Receiver DT binding
> > -
> > -SiRFstar chipsets are used in GNSS-receiver modules produced by several
> > -vendors and can use UART, SPI or I2C interfaces.
> > -
> > -Please see Documentation/devicetree/bindings/gnss/gnss.txt for generic
> > -properties.
> > -
> > -Required properties:
> > -
> > -- compatible	: Must be one of
> > -
> > -			"fastrax,uc430"
> > -			"linx,r4"
> > -			"wi2wi,w2sg0004"
> > -			"wi2wi,w2sg0008i"
> > -			"wi2wi,w2sg0084i"
> > -
> > -- vcc-supply	: Main voltage regulator (pin name: 3V3_IN, VCC, VDD)
> > -
> > -Required properties (I2C):
> > -- reg		: I2C slave address
> > -
> > -Required properties (SPI):
> > -- reg		: SPI chip select address
> > -
> > -Optional properties:
> > -
> > -- sirf,onoff-gpios	: GPIO used to power on and off device (pin name: ON_OFF)
> > -- sirf,wakeup-gpios	: GPIO used to determine device power state
> > -			  (pin name: RFPWRUP, WAKEUP)
> > -- timepulse-gpios	: Time pulse GPIO (pin name: 1PPS, TM)
> > -
> > -Example:
> > -
> > -serial@1234 {
> > -	compatible = "ns16550a";
> > -
> > -	gnss {
> > -		compatible = "wi2wi,w2sg0084i";
> > -
> > -		vcc-supply = <&gnss_reg>;
> > -		sirf,onoff-gpios = <&gpio0 16 GPIO_ACTIVE_HIGH>;
> > -		sirf,wakeup-gpios = <&gpio0 17 GPIO_ACTIVE_HIGH>;
> > -	};
> > -};
> > diff --git a/Documentation/devicetree/bindings/gnss/sirfstar.yaml b/Documentation/devicetree/bindings/gnss/sirfstar.yaml
> > new file mode 100644
> > index 000000000000..9f80add3e61b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/gnss/sirfstar.yaml
> > @@ -0,0 +1,71 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/gnss/sirfstar.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: SiRFstar GNSS Receiver Device Tree Bindings
> > +
> > +allOf:
> > +  - $ref: gnss-common.yaml#
> 
> The allOf should be just before "properties:" (also in patch #2).
> 
> > +
> > +maintainers:
> > +  - Johan Hovold <johan@kernel.org>
> > +
> > +description:
> > +  The SiRFstar GNSS receivers have incarnated over the years in different
> > +  chips, starting from the SiRFstarIII which was a chip that was introduced in
> > +  2004 and used in a lot of dedicated GPS devices. In 2009 SiRF was acquired
> > +  by CSR (Cambridge Silicon Radio) and in 2012 the CSR GPS business was
> > +  acquired by Samsung, while some products remained with CSR. In 2014 CSR
> > +  was acquired by Qualcomm who still sell some of the SiRF products.
> > +
> > +  SiRF chips can be used over UART, I2C or SPI buses.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - fastrax,uc430
> > +      - linx,r4
> > +      - wi2wi,w2sg0004
> > +      - wi2wi,w2sg0008i
> > +      - wi2wi,w2sg0084i
> > +
> > +  reg:
> > +    description:
> > +      The I2C Address, SPI chip select address. Not required on UART buses.
> > +
> > +  vcc-supply:
> > +    description:
> > +      Main voltage regulator, pin names such as 3V3_IN, VCC, VDD.
> > +
> > +  timepulse-gpios:
> > +    description: Comes with pin names such as 1PPS or TM
> 
> You don't need this, I think. It's coming from gnss-common.yaml.

I fixed up both and applied.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/gnss/sirfstar.txt b/Documentation/devicetree/bindings/gnss/sirfstar.txt
deleted file mode 100644
index f4252b6b660b..000000000000
--- a/Documentation/devicetree/bindings/gnss/sirfstar.txt
+++ /dev/null
@@ -1,46 +0,0 @@ 
-SiRFstar-based GNSS Receiver DT binding
-
-SiRFstar chipsets are used in GNSS-receiver modules produced by several
-vendors and can use UART, SPI or I2C interfaces.
-
-Please see Documentation/devicetree/bindings/gnss/gnss.txt for generic
-properties.
-
-Required properties:
-
-- compatible	: Must be one of
-
-			"fastrax,uc430"
-			"linx,r4"
-			"wi2wi,w2sg0004"
-			"wi2wi,w2sg0008i"
-			"wi2wi,w2sg0084i"
-
-- vcc-supply	: Main voltage regulator (pin name: 3V3_IN, VCC, VDD)
-
-Required properties (I2C):
-- reg		: I2C slave address
-
-Required properties (SPI):
-- reg		: SPI chip select address
-
-Optional properties:
-
-- sirf,onoff-gpios	: GPIO used to power on and off device (pin name: ON_OFF)
-- sirf,wakeup-gpios	: GPIO used to determine device power state
-			  (pin name: RFPWRUP, WAKEUP)
-- timepulse-gpios	: Time pulse GPIO (pin name: 1PPS, TM)
-
-Example:
-
-serial@1234 {
-	compatible = "ns16550a";
-
-	gnss {
-		compatible = "wi2wi,w2sg0084i";
-
-		vcc-supply = <&gnss_reg>;
-		sirf,onoff-gpios = <&gpio0 16 GPIO_ACTIVE_HIGH>;
-		sirf,wakeup-gpios = <&gpio0 17 GPIO_ACTIVE_HIGH>;
-	};
-};
diff --git a/Documentation/devicetree/bindings/gnss/sirfstar.yaml b/Documentation/devicetree/bindings/gnss/sirfstar.yaml
new file mode 100644
index 000000000000..9f80add3e61b
--- /dev/null
+++ b/Documentation/devicetree/bindings/gnss/sirfstar.yaml
@@ -0,0 +1,71 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/gnss/sirfstar.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: SiRFstar GNSS Receiver Device Tree Bindings
+
+allOf:
+  - $ref: gnss-common.yaml#
+
+maintainers:
+  - Johan Hovold <johan@kernel.org>
+
+description:
+  The SiRFstar GNSS receivers have incarnated over the years in different
+  chips, starting from the SiRFstarIII which was a chip that was introduced in
+  2004 and used in a lot of dedicated GPS devices. In 2009 SiRF was acquired
+  by CSR (Cambridge Silicon Radio) and in 2012 the CSR GPS business was
+  acquired by Samsung, while some products remained with CSR. In 2014 CSR
+  was acquired by Qualcomm who still sell some of the SiRF products.
+
+  SiRF chips can be used over UART, I2C or SPI buses.
+
+properties:
+  compatible:
+    enum:
+      - fastrax,uc430
+      - linx,r4
+      - wi2wi,w2sg0004
+      - wi2wi,w2sg0008i
+      - wi2wi,w2sg0084i
+
+  reg:
+    description:
+      The I2C Address, SPI chip select address. Not required on UART buses.
+
+  vcc-supply:
+    description:
+      Main voltage regulator, pin names such as 3V3_IN, VCC, VDD.
+
+  timepulse-gpios:
+    description: Comes with pin names such as 1PPS or TM
+
+  sirf,onoff-gpios:
+    maxItems: 1
+    description: GPIO used to power on and off device, pin name ON_OFF.
+
+  sirf,wakeup-gpios:
+    maxItems: 1
+    description: GPIO used to determine device power state, pin names such
+      as RFPWRUP, WAKEUP.
+
+required:
+  - compatible
+  - vcc-supply
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    serial {
+        gnss {
+            compatible = "wi2wi,w2sg0084i";
+            vcc-supply = <&gnss_vcc_reg>;
+            sirf,onoff-gpios = <&gpio0 16 GPIO_ACTIVE_HIGH>;
+            sirf,wakeup-gpios = <&gpio0 17 GPIO_ACTIVE_HIGH>;
+            current-speed = <38400>;
+        };
+    };