Documentation/devicetree/bindings/gnss/brcm,bcm4751.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/brcm,bcm4751.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Broadcom BCM4751 family GNSS Receiver
   8
   9 maintainers:
  10   - Johan Hovold <johan@kernel.org>
  11   - Linus Walleij <linus.walleij@linaro.org>
  12
  13 description:
  14   Broadcom GPS chips can be used over the UART or I2C bus. The UART
  15   bus requires CTS/RTS support. The number of the capsule is more
  16   elaborate than the compatibles BCM4751 may be printed
  17   BCM4751IFBG for example.
  18
  19 allOf:
  20   - $ref: gnss-common.yaml#
  21
  22 properties:
  23   compatible:
  24     enum:
  25       - brcm,bcm4751
  26       - brcm,bcm4752
  27       - brcm,bcm4753
  28
  29   reg:
  30     description:
  31       The I2C Address, not required on UART buses.
  32
  33   vdd-auxin-supply:
  34     description:
  35       Main voltage supply, pin name VDD_AUXIN, typically connected
  36       directly to a battery such as LiIon 3.8V battery or a 2.6V supply.
  37
  38   vddio-supply:
  39     description:
  40       IO voltage supply, pin name VDDIO, typically 1.8V
  41
  42   reset-gpios:
  43     maxItems: 1
  44     description: An optional active low reset line, should be flagged with
  45       GPIO_ACTIVE_LOW.
  46
  47   enable-gpios:
  48     description: Enable GPIO line, connected to pins named REGPU or NSTANDBY.
  49       If the line is active low such as NSTANDBY, it should be tagged
  50       GPIO_ACTIVE_LOW.
  51
  52 required:
  53   - compatible
  54   - enable-gpios
  55
  56 unevaluatedProperties: false
  57
  58 examples:
  59   - |
  60     #include <dt-bindings/gpio/gpio.h>
  61     serial {
  62         gnss {
  63             compatible = "brcm,bcm4751";
  64             vdd-auxin-supply = <&vbat>;
  65             reset-gpios = <&gpio0 15 GPIO_ACTIVE_LOW>;
  66             enable-gpios = <&gpio0 16 GPIO_ACTIVE_HIGH>;
  67             current-speed = <38400>;
  68         };
  69     };