| Message ID | 20190124145309.21698-2-ben.whitten@lairdtech.com |
|---|---|
| State | Not Applicable |
| Delegated to: | David Miller |
| Headers | show |
| Series | net: lora: Add documentation for SX130x and SX125x parts | expand |
Missed linux-lpwan On Thu, 24 Jan 2019 at 14:53, Ben Whitten <ben.whitten@gmail.com> wrote: > > From: Ben Whitten <ben.whitten@gmail.com> > > Add basic documentation in YAML format for the SX130x series concentrators > from Semtech. > Required is; the location on the SPI bus and the compatible string. > > Signed-off-by: Ben Whitten <ben.whitten@gmail.com> > --- > v2 -> v3: > * Corrected fallback notation > * Limited radio node names from anything to 'radio@' > v1 -> v2: > * Dropped reset-gpios, radio-spi from required. > * Dropped spi-max-frequency from binding. > * Changed compatible to allow fallback from SX1308 to SX1301. > * Wording changes in commit and descriptions. > * Dual licence > * Incorperate Robs comments on child node and spi wrapper > --- > .../bindings/net/lora/semtech,sx130x.yaml | 101 ++++++++++++++++++ > 1 file changed, 101 insertions(+) > create mode 100644 Documentation/devicetree/bindings/net/lora/semtech,sx130x.yaml > > diff --git a/Documentation/devicetree/bindings/net/lora/semtech,sx130x.yaml b/Documentation/devicetree/bindings/net/lora/semtech,sx130x.yaml > new file mode 100644 > index 000000000000..24fad1218735 > --- /dev/null > +++ b/Documentation/devicetree/bindings/net/lora/semtech,sx130x.yaml > @@ -0,0 +1,101 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/net/lora/semtech,sx130x.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Semtech LoRa concentrator > + > +maintainers: > + - Andreas Färber <afaerber@suse.de> > + - Ben Whitten <ben.whitten@gmail.com> > + > +description: | > + Semtech LoRa concentrator SX130x digital baseband chip is capable of > + demodulating LoRa signals on 8 channels simultaneously. > + > + It is typically paired with two SX125x IQ radios controlled over an > + SPI directly from the concentrator. > + > + The concentrator itself is controlled over SPI. > + > +properties: > + compatible: > + oneOf: > + - items: > + - enum: > + - semtech,sx1308 > + - const: semtech,sx1301 > + - items: > + - const: semtech,sx1301 > + > + reg: > + maxItems: 1 > + description: The chip select on the SPI bus. > + > + reset-gpios: > + maxItems: 1 > + description: A connection of the reset gpio line. > + > + radio-spi: > + type: object > + description: The concentrator can have two radios connected which are > + contained within the following node. > + > + properties: > + '#address-cells': > + const: 1 > + > + '#size-cells': > + const: 0 > + > + patternProperties: > + "^radio@[0-1]$": > + type: object > + properties: > + reg: > + maxItems: 1 > + minimum: 0 > + maximum: 1 > + required: > + - reg > + > + required: > + - '#address-cells' > + - '#size-cells' > + > +required: > + - compatible > + - reg > + > +examples: > + - | > + > + #include <dt-bindings/gpio/gpio.h> > + > + spi { > + #address-cells = <1>; > + #size-cells = <0>; > + > + concentrator0: lora@0 { > + compatible = "semtech,sx1301"; > + reg = <0>; > + reset-gpios = <&pioB 27 GPIO_ACTIVE_HIGH>; > + spi-max-frequency = <8000000>; > + > + radio-spi { > + #address-cells = <1>; > + #size-cells = <0>; > + > + radio0: radio@0 { > + compatible = "semtech,sx1257"; > + reg = <0>; > + }; > + > + radio1: radio@1 { > + compatible = "semtech,sx1257"; > + reg = <1>; > + }; > + }; > + }; > + }; > -- > 2.17.1 >
On Thu, Jan 24, 2019 at 8:53 AM Ben Whitten <ben.whitten@gmail.com> wrote: > > From: Ben Whitten <ben.whitten@gmail.com> > > Add basic documentation in YAML format for the SX130x series concentrators > from Semtech. > Required is; the location on the SPI bus and the compatible string. > > Signed-off-by: Ben Whitten <ben.whitten@gmail.com> > --- > v2 -> v3: > * Corrected fallback notation > * Limited radio node names from anything to 'radio@' > v1 -> v2: > * Dropped reset-gpios, radio-spi from required. > * Dropped spi-max-frequency from binding. > * Changed compatible to allow fallback from SX1308 to SX1301. > * Wording changes in commit and descriptions. > * Dual licence > * Incorperate Robs comments on child node and spi wrapper > --- > .../bindings/net/lora/semtech,sx130x.yaml | 101 ++++++++++++++++++ > 1 file changed, 101 insertions(+) > create mode 100644 Documentation/devicetree/bindings/net/lora/semtech,sx130x.yaml Reviewed-by: Rob Herring <robh@kernel.org>
diff --git a/Documentation/devicetree/bindings/net/lora/semtech,sx130x.yaml b/Documentation/devicetree/bindings/net/lora/semtech,sx130x.yaml new file mode 100644 index 000000000000..24fad1218735 --- /dev/null +++ b/Documentation/devicetree/bindings/net/lora/semtech,sx130x.yaml @@ -0,0 +1,101 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/net/lora/semtech,sx130x.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Semtech LoRa concentrator + +maintainers: + - Andreas Färber <afaerber@suse.de> + - Ben Whitten <ben.whitten@gmail.com> + +description: | + Semtech LoRa concentrator SX130x digital baseband chip is capable of + demodulating LoRa signals on 8 channels simultaneously. + + It is typically paired with two SX125x IQ radios controlled over an + SPI directly from the concentrator. + + The concentrator itself is controlled over SPI. + +properties: + compatible: + oneOf: + - items: + - enum: + - semtech,sx1308 + - const: semtech,sx1301 + - items: + - const: semtech,sx1301 + + reg: + maxItems: 1 + description: The chip select on the SPI bus. + + reset-gpios: + maxItems: 1 + description: A connection of the reset gpio line. + + radio-spi: + type: object + description: The concentrator can have two radios connected which are + contained within the following node. + + properties: + '#address-cells': + const: 1 + + '#size-cells': + const: 0 + + patternProperties: + "^radio@[0-1]$": + type: object + properties: + reg: + maxItems: 1 + minimum: 0 + maximum: 1 + required: + - reg + + required: + - '#address-cells' + - '#size-cells' + +required: + - compatible + - reg + +examples: + - | + + #include <dt-bindings/gpio/gpio.h> + + spi { + #address-cells = <1>; + #size-cells = <0>; + + concentrator0: lora@0 { + compatible = "semtech,sx1301"; + reg = <0>; + reset-gpios = <&pioB 27 GPIO_ACTIVE_HIGH>; + spi-max-frequency = <8000000>; + + radio-spi { + #address-cells = <1>; + #size-cells = <0>; + + radio0: radio@0 { + compatible = "semtech,sx1257"; + reg = <0>; + }; + + radio1: radio@1 { + compatible = "semtech,sx1257"; + reg = <1>; + }; + }; + }; + };