Re: [PATCH v3 lora-next 2/4] dt-bindings: lora: sx125x: add basic documentation

From: Ben Whitten
Date: Thu Jan 24 2019 - 10:03:59 EST


Missed linux-lpwan

On Thu, 24 Jan 2019 at 14:53, Ben Whitten <ben.whitten@xxxxxxxxx> wrote:
>
> From: Ben Whitten <ben.whitten@xxxxxxxxx>
>
> The SX125x family are IQ radio transceivers from Semtech configured over
> SPI, they are typically connected to an SX130x series concentrator however
> may be connected to a host directly.
>
> Required properties include the radio number of the host or concentrator
> bus.
>
> Signed-off-by: Ben Whitten <ben.whitten@xxxxxxxxx>
> ---
> v2 -> v3:
> * Renamed example node name to be consistent with concentrator
> v1 -> v2:
> * Dropped spi-max-frequency binding
> * Wording changes to commit and descriptions
> * Added spi wrapper suggested by Rob H
> * Dual licence
> ---
> .../bindings/net/lora/semtech,sx125x.yaml | 44 +++++++++++++++++++
> 1 file changed, 44 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/net/lora/semtech,sx125x.yaml
>
> diff --git a/Documentation/devicetree/bindings/net/lora/semtech,sx125x.yaml b/Documentation/devicetree/bindings/net/lora/semtech,sx125x.yaml
> new file mode 100644
> index 000000000000..fe2d2a23c28b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/lora/semtech,sx125x.yaml
> @@ -0,0 +1,44 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/lora/semtech,sx125x.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Semtech IQ modulator/de-modulator transeiver
> +
> +maintainers:
> + - Andreas FÃrber <afaerber@xxxxxxx>
> + - Ben Whitten <ben.whitten@xxxxxxxxx>
> +
> +description: |
> + The SX125x family are transceivers capable of supporting multiple constant
> + and non-constant envelope modulation schemes.
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - semtech,sx1255
> + - semtech,sx1257
> + - semtech,sx1258
> +
> + reg:
> + maxItems: 1
> + description: The chip select on the SPI bus or radio number in concentrator
> + , with radio A = 0 and radio B = 1.
> +
> +required:
> + - compatible
> + - reg
> +
> +examples:
> + - |
> + spi {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + radio0: radio@0 {
> + compatible = "semtech,sx1257";
> + reg = <0>;
> + };
> + };
> --
> 2.17.1
>