Documentation/devicetree/bindings/gnss/gnss-common.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/gnss/gnss-common.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Common Properties for Global Navigation Satellite Systems (GNSS)
   8   receiver devices
   9
  10 maintainers:
  11   - Johan Hovold <johan@kernel.org>
  12
  13 description: |
  14   This document defines device tree properties common to Global Navigation
  15   Satellite System receivers.
  16
  17 properties:
  18   $nodename:
  19     pattern: "^gnss(@.*)?$"
  20
  21   lna-supply:
  22     description: A separate regulator supplying power for the Low Noise
  23       Amplifier (LNA). This is an amplifier connected between the GNSS
  24       device and the receiver antenna.
  25
  26   enable-gpios:
  27     description: A GPIO line that will enable the GNSS receiver when
  28       asserted. If this line is active low, the GPIO phandle should
  29       consequently be tagged with the GPIO_ACTIVE_LOW flag so the operating
  30       system can rely on asserting the line to enable the GNSS device.
  31     maxItems: 1
  32
  33   timepulse-gpios:
  34     description: When a timepulse is provided to the GNSS device using a
  35       GPIO line, this is used.
  36     maxItems: 1
  37
  38   current-speed:
  39     description: The baudrate in bits per second of the device as it comes
  40       online, current active speed.
  41     $ref: /schemas/types.yaml#/definitions/uint32
  42
  43 additionalProperties: true
  44
  45 examples:
  46   - |
  47     #include <dt-bindings/gpio/gpio.h>
  48     serial {
  49       gnss {
  50         compatible = "u-blox,neo-8";
  51         vcc-supply = <&gnss_reg>;
  52         timepulse-gpios = <&gpio0 16 GPIO_ACTIVE_HIGH>;
  53         current-speed = <4800>;
  54       };
  55     };