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