GNU Linux-libre 5.19-rc6-gnu
[releases.git] / Documentation / devicetree / bindings / gnss / sirfstar.yaml
1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/gnss/sirfstar.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: SiRFstar GNSS Receiver Device Tree Bindings
8
9 maintainers:
10   - Johan Hovold <johan@kernel.org>
11
12 description:
13   The SiRFstar GNSS receivers have incarnated over the years in different
14   chips, starting from the SiRFstarIII which was a chip that was introduced in
15   2004 and used in a lot of dedicated GPS devices. In 2009 SiRF was acquired
16   by CSR (Cambridge Silicon Radio) and in 2012 the CSR GPS business was
17   acquired by Samsung, while some products remained with CSR. In 2014 CSR
18   was acquired by Qualcomm who still sell some of the SiRF products.
19
20   SiRF chips can be used over UART, I2C or SPI buses.
21
22 allOf:
23   - $ref: gnss-common.yaml#
24
25 properties:
26   compatible:
27     enum:
28       - csr,gsd4t
29       - csr,csrg05ta03-icje-r
30       - fastrax,uc430
31       - linx,r4
32       - wi2wi,w2sg0004
33       - wi2wi,w2sg0008i
34       - wi2wi,w2sg0084i
35
36   reg:
37     description:
38       The I2C Address, SPI chip select address. Not required on UART buses.
39
40   vcc-supply:
41     description:
42       Main voltage regulator, pin names such as 3V3_IN, VCC, VDD.
43
44   reset-gpios:
45     maxItems: 1
46     description: An optional active low reset line, should be flagged with
47       GPIO_ACTIVE_LOW.
48
49   sirf,onoff-gpios:
50     maxItems: 1
51     description: GPIO used to power on and off device, pin name ON_OFF.
52
53   sirf,wakeup-gpios:
54     maxItems: 1
55     description: GPIO used to determine device power state, pin names such
56       as RFPWRUP, WAKEUP.
57
58 required:
59   - compatible
60   - vcc-supply
61
62 unevaluatedProperties: false
63
64 examples:
65   - |
66     #include <dt-bindings/gpio/gpio.h>
67     serial {
68         gnss {
69             compatible = "wi2wi,w2sg0084i";
70             vcc-supply = <&gnss_vcc_reg>;
71             reset-gpios = <&gpio0 15 GPIO_ACTIVE_LOW>;
72             sirf,onoff-gpios = <&gpio0 16 GPIO_ACTIVE_HIGH>;
73             sirf,wakeup-gpios = <&gpio0 17 GPIO_ACTIVE_HIGH>;
74             current-speed = <38400>;
75         };
76     };