Commit caa80275 authored by Maxime Ripard's avatar Maxime Ripard Committed by Rob Herring
Browse files

dt-bindings: gnss: Convert UBlox Neo-6M binding to a schema



The UBlox Neo 6M is supported by Linux thanks to its device tree
binding.

Now that we have the DT validation in place, let's convert the device
tree bindings for that driver over to a YAML schema.

Cc: Johan Hovold <johan@kernel.org>
Signed-off-by: default avatarMaxime Ripard <maxime@cerno.tech>
Link: https://lore.kernel.org/r/20210901091852.479202-22-maxime@cerno.tech


Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent ddf6cc9a
Loading
Loading
Loading
Loading
+62 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/gnss/u-blox,neo-6m.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: U-blox GNSS Receiver Device Tree Bindings

maintainers:
  - Johan Hovold <johan@kernel.org>

description: >
  The U-blox GNSS receivers can use UART, DDC (I2C), SPI and USB interfaces.

properties:
  compatible:
    enum:
      - u-blox,neo-6m
      - u-blox,neo-8
      - u-blox,neo-m8

  reg:
    description: >
      The DDC Slave Address, SPI chip select address, the number of the USB hub
      port or the USB host-controller port to which this device is attached,
      depending on the bus used. Required for the DDC, SPI or USB busses.

  vcc-supply:
    description: >
      Main voltage regulator

  timepulse-gpios:
    maxItems: 1
    description: >
      Time pulse GPIO

  u-blox,extint-gpios:
    maxItems: 1
    description: >
      GPIO connected to the "external interrupt" input pin
  
  v-bckp-supply:
    description: >
      Backup voltage regulator

  current-speed: true

required:
  - compatible
  - vcc-supply

additionalProperties: false

examples:
  - |
    serial {
        gnss {
            compatible = "u-blox,neo-8";
            v-bckp-supply = <&gnss_v_bckp_reg>;
            vcc-supply = <&gnss_vcc_reg>;
        };
    };
+0 −45
Original line number Diff line number Diff line
u-blox GNSS Receiver DT binding

The u-blox GNSS receivers can use UART, DDC (I2C), SPI and USB interfaces.

Please see Documentation/devicetree/bindings/gnss/gnss.txt for generic
properties.

Required properties:

- compatible	: Must be one of

			"u-blox,neo-6m"
			"u-blox,neo-8"
			"u-blox,neo-m8"

- vcc-supply	: Main voltage regulator

Required properties (DDC):
- reg		: DDC (I2C) slave address

Required properties (SPI):
- reg		: SPI chip select address

Required properties (USB):
- reg		: Number of the USB hub port or the USB host-controller port
                  to which this device is attached

Optional properties:

- timepulse-gpios	: Time pulse GPIO
- u-blox,extint-gpios	: GPIO connected to the "external interrupt" input pin
- v-bckp-supply	: Backup voltage regulator

Example:

serial@1234 {
	compatible = "ns16550a";

	gnss {
		compatible = "u-blox,neo-8";

		v-bckp-supply = <&gnss_v_bckp_reg>;
		vcc-supply = <&gnss_vcc_reg>;
	};
};