xref: /freebsd/sys/contrib/device-tree/Bindings/gnss/gnss.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1*c66ec88fSEmmanuel VadotGNSS Receiver DT binding
2*c66ec88fSEmmanuel Vadot
3*c66ec88fSEmmanuel VadotThis documents the binding structure and common properties for GNSS receiver
4*c66ec88fSEmmanuel Vadotdevices.
5*c66ec88fSEmmanuel Vadot
6*c66ec88fSEmmanuel VadotA GNSS receiver node is a node named "gnss" and typically resides on a serial
7*c66ec88fSEmmanuel Vadotbus (e.g. UART, I2C or SPI).
8*c66ec88fSEmmanuel Vadot
9*c66ec88fSEmmanuel VadotPlease refer to the following documents for generic properties:
10*c66ec88fSEmmanuel Vadot
11*c66ec88fSEmmanuel Vadot	Documentation/devicetree/bindings/serial/serial.yaml
12*c66ec88fSEmmanuel Vadot	Documentation/devicetree/bindings/spi/spi-bus.txt
13*c66ec88fSEmmanuel Vadot
14*c66ec88fSEmmanuel VadotRequired properties:
15*c66ec88fSEmmanuel Vadot
16*c66ec88fSEmmanuel Vadot- compatible	: A string reflecting the vendor and specific device the node
17*c66ec88fSEmmanuel Vadot		  represents
18*c66ec88fSEmmanuel Vadot
19*c66ec88fSEmmanuel VadotOptional properties:
20*c66ec88fSEmmanuel Vadot- lna-supply	: Separate supply for an LNA
21*c66ec88fSEmmanuel Vadot- enable-gpios	: GPIO used to enable the device
22*c66ec88fSEmmanuel Vadot- timepulse-gpios	: Time pulse GPIO
23*c66ec88fSEmmanuel Vadot
24*c66ec88fSEmmanuel VadotExample:
25*c66ec88fSEmmanuel Vadot
26*c66ec88fSEmmanuel Vadotserial@1234 {
27*c66ec88fSEmmanuel Vadot	compatible = "ns16550a";
28*c66ec88fSEmmanuel Vadot
29*c66ec88fSEmmanuel Vadot	gnss {
30*c66ec88fSEmmanuel Vadot		compatible = "u-blox,neo-8";
31*c66ec88fSEmmanuel Vadot
32*c66ec88fSEmmanuel Vadot		vcc-supply = <&gnss_reg>;
33*c66ec88fSEmmanuel Vadot		timepulse-gpios = <&gpio0 16 GPIO_ACTIVE_HIGH>;
34*c66ec88fSEmmanuel Vadot
35*c66ec88fSEmmanuel Vadot		current-speed = <4800>;
36*c66ec88fSEmmanuel Vadot	};
37*c66ec88fSEmmanuel Vadot};
38