| Message ID | 20200525151117.32540-3-jonathan.albrieux@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | iio: magnetometer: ak8975: Add gpio reset support | expand |
On Mon, May 25, 2020 at 05:10:36PM +0200, Jonathan Albrieux wrote: > Converts documentation from txt format to yaml. I would have converted to yaml and do any re-formatting/wording, then added 'interrupts', but this is fine. > Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com> > --- > .../bindings/iio/magnetometer/ak8975.txt | 37 --------- > .../iio/magnetometer/asahi-kasei,ak8975.yaml | 78 +++++++++++++++++++ > 2 files changed, 78 insertions(+), 37 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt > create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml > > diff --git a/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt b/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt > deleted file mode 100644 > index 0576b9df0bf2..000000000000 > --- a/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt > +++ /dev/null > @@ -1,37 +0,0 @@ > -* AsahiKASEI AK8975 magnetometer sensor > - > -Required properties: > - > - - compatible : should be "asahi-kasei,ak8975". > - - reg : the I2C address of the magnetometer. > - > -Optional properties: > - > - - gpios : AK8975 has a "Data ready" pin (DRDY) which informs that data > - is ready to be read and is possible to listen on it. If used, > - this should be active high. Prefer interrupt over this. > - > - - interrupts : interrupt for DRDY pin. Triggered on rising edge. > - > - - vdd-supply: an optional regulator that needs to be on to provide VDD. > - > - - mount-matrix: an optional 3x3 mounting rotation matrix. > - > -Example: > - > -ak8975@c { > - compatible = "asahi-kasei,ak8975"; > - reg = <0x0c>; > - interrupt-parent = <&gpio6>; > - interrupts = <15 IRQ_TYPE_EDGE_RISING>; > - vdd-supply = <&ldo_3v3_gnss>; > - mount-matrix = "-0.984807753012208", /* x0 */ > - "0", /* y0 */ > - "-0.173648177666930", /* z0 */ > - "0", /* x1 */ > - "-1", /* y1 */ > - "0", /* z1 */ > - "-0.173648177666930", /* x2 */ > - "0", /* y2 */ > - "0.984807753012208"; /* z2 */ > -}; > diff --git a/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml b/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml > new file mode 100644 > index 000000000000..a603659d5fa5 > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml > @@ -0,0 +1,78 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/magnetometer/asahi-kasei,ak8975.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: AsahiKASEI AK8975 magnetometer sensor > + > +maintainers: > + - Jonathan Albrieux <jonathan.albrieux@gmail.com> > + > +properties: > + compatible: > + oneOf: > + - const: asahi-kasei,ak8975 > + - const: asahi-kasei,ak8963 > + - const: asahi-kasei,ak09911 > + - const: asahi-kasei,ak09912 These 4 can be an enum. > + - const: ak8975 > + deprecated: true > + - const: ak8963 > + deprecated: true > + - const: ak09911 > + deprecated: true > + - const: ak09912 > + deprecated: true And these 4 can be an enum+deprecated. > + > + reg: > + maxItems: 1 > + description: the I2C address of the magnetometer. Don't need a description. > + > + gpios: > + description: | > + AK8975 has a "Data ready" pin (DRDY) which informs that data > + is ready to be read and is possible to listen on it. If used, > + this should be active high. Prefer interrupt over this. Need to define how many GPIOs (maxItems: 1). > + > + interrupts: > + maxItems: 1 > + description: interrupt for DRDY pin. Triggered on rising edge. > + > + vdd-supply: > + maxItems: 1 > + description: | > + an optional regulator that needs to be on to provide VDD power to > + the sensor. > + > + mount-matrix: > + description: an optional 3x3 mounting rotation matrix. > + > +required: > + - compatible > + - reg > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + i2c { > + #address-cells = <1>; > + #size-cells = <0>; > + > + magnetometer@c { > + compatible = "asahi-kasei,ak8975"; > + reg = <0x0c>; > + interrupt-parent = <&gpio6>; > + interrupts = <15 IRQ_TYPE_EDGE_RISING>; > + vdd-supply = <&ldo_3v3_gnss>; > + mount-matrix = "-0.984807753012208", /* x0 */ > + "0", /* y0 */ > + "-0.173648177666930", /* z0 */ > + "0", /* x1 */ > + "-1", /* y1 */ > + "0", /* z1 */ > + "-0.173648177666930", /* x2 */ > + "0", /* y2 */ > + "0.984807753012208"; /* z2 */ > + }; > + }; > -- > 2.17.1 >
On Tue, May 26, 2020 at 04:28:47PM -0600, Rob Herring wrote: > On Mon, May 25, 2020 at 05:10:36PM +0200, Jonathan Albrieux wrote: > > Converts documentation from txt format to yaml. > > I would have converted to yaml and do any re-formatting/wording, then > added 'interrupts', but this is fine. > Thank you, I'll keep that in mind for future works like this one > > > Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com> > > --- > > .../bindings/iio/magnetometer/ak8975.txt | 37 --------- > > .../iio/magnetometer/asahi-kasei,ak8975.yaml | 78 +++++++++++++++++++ > > 2 files changed, 78 insertions(+), 37 deletions(-) > > delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt > > create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml > > > > diff --git a/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt b/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt > > deleted file mode 100644 > > index 0576b9df0bf2..000000000000 > > --- a/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt > > +++ /dev/null > > @@ -1,37 +0,0 @@ > > -* AsahiKASEI AK8975 magnetometer sensor > > - > > -Required properties: > > - > > - - compatible : should be "asahi-kasei,ak8975". > > - - reg : the I2C address of the magnetometer. > > - > > -Optional properties: > > - > > - - gpios : AK8975 has a "Data ready" pin (DRDY) which informs that data > > - is ready to be read and is possible to listen on it. If used, > > - this should be active high. Prefer interrupt over this. > > - > > - - interrupts : interrupt for DRDY pin. Triggered on rising edge. > > - > > - - vdd-supply: an optional regulator that needs to be on to provide VDD. > > - > > - - mount-matrix: an optional 3x3 mounting rotation matrix. > > - > > -Example: > > - > > -ak8975@c { > > - compatible = "asahi-kasei,ak8975"; > > - reg = <0x0c>; > > - interrupt-parent = <&gpio6>; > > - interrupts = <15 IRQ_TYPE_EDGE_RISING>; > > - vdd-supply = <&ldo_3v3_gnss>; > > - mount-matrix = "-0.984807753012208", /* x0 */ > > - "0", /* y0 */ > > - "-0.173648177666930", /* z0 */ > > - "0", /* x1 */ > > - "-1", /* y1 */ > > - "0", /* z1 */ > > - "-0.173648177666930", /* x2 */ > > - "0", /* y2 */ > > - "0.984807753012208"; /* z2 */ > > -}; > > diff --git a/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml b/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml > > new file mode 100644 > > index 000000000000..a603659d5fa5 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml > > @@ -0,0 +1,78 @@ > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/iio/magnetometer/asahi-kasei,ak8975.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: AsahiKASEI AK8975 magnetometer sensor > > + > > +maintainers: > > + - Jonathan Albrieux <jonathan.albrieux@gmail.com> > > + > > +properties: > > + compatible: > > + oneOf: > > + - const: asahi-kasei,ak8975 > > + - const: asahi-kasei,ak8963 > > + - const: asahi-kasei,ak09911 > > + - const: asahi-kasei,ak09912 > > These 4 can be an enum. > > > + - const: ak8975 > > + deprecated: true > > + - const: ak8963 > > + deprecated: true > > + - const: ak09911 > > + deprecated: true > > + - const: ak09912 > > + deprecated: true > > And these 4 can be an enum+deprecated. > > > + > > + reg: > > + maxItems: 1 > > + description: the I2C address of the magnetometer. > > Don't need a description. > > > + > > + gpios: > > + description: | > > + AK8975 has a "Data ready" pin (DRDY) which informs that data > > + is ready to be read and is possible to listen on it. If used, > > + this should be active high. Prefer interrupt over this. > > Need to define how many GPIOs (maxItems: 1). > Ok, I'll edit those fields as soon as possible, thank you, Best regards, Jonathan Albrieux > > + > > + interrupts: > > + maxItems: 1 > > + description: interrupt for DRDY pin. Triggered on rising edge. > > + > > + vdd-supply: > > + maxItems: 1 > > + description: | > > + an optional regulator that needs to be on to provide VDD power to > > + the sensor. > > + > > + mount-matrix: > > + description: an optional 3x3 mounting rotation matrix. > > + > > +required: > > + - compatible > > + - reg > > + > > +examples: > > + - | > > + #include <dt-bindings/interrupt-controller/irq.h> > > + i2c { > > + #address-cells = <1>; > > + #size-cells = <0>; > > + > > + magnetometer@c { > > + compatible = "asahi-kasei,ak8975"; > > + reg = <0x0c>; > > + interrupt-parent = <&gpio6>; > > + interrupts = <15 IRQ_TYPE_EDGE_RISING>; > > + vdd-supply = <&ldo_3v3_gnss>; > > + mount-matrix = "-0.984807753012208", /* x0 */ > > + "0", /* y0 */ > > + "-0.173648177666930", /* z0 */ > > + "0", /* x1 */ > > + "-1", /* y1 */ > > + "0", /* z1 */ > > + "-0.173648177666930", /* x2 */ > > + "0", /* y2 */ > > + "0.984807753012208"; /* z2 */ > > + }; > > + }; > > -- > > 2.17.1 > >
diff --git a/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt b/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt deleted file mode 100644 index 0576b9df0bf2..000000000000 --- a/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt +++ /dev/null @@ -1,37 +0,0 @@ -* AsahiKASEI AK8975 magnetometer sensor - -Required properties: - - - compatible : should be "asahi-kasei,ak8975". - - reg : the I2C address of the magnetometer. - -Optional properties: - - - gpios : AK8975 has a "Data ready" pin (DRDY) which informs that data - is ready to be read and is possible to listen on it. If used, - this should be active high. Prefer interrupt over this. - - - interrupts : interrupt for DRDY pin. Triggered on rising edge. - - - vdd-supply: an optional regulator that needs to be on to provide VDD. - - - mount-matrix: an optional 3x3 mounting rotation matrix. - -Example: - -ak8975@c { - compatible = "asahi-kasei,ak8975"; - reg = <0x0c>; - interrupt-parent = <&gpio6>; - interrupts = <15 IRQ_TYPE_EDGE_RISING>; - vdd-supply = <&ldo_3v3_gnss>; - mount-matrix = "-0.984807753012208", /* x0 */ - "0", /* y0 */ - "-0.173648177666930", /* z0 */ - "0", /* x1 */ - "-1", /* y1 */ - "0", /* z1 */ - "-0.173648177666930", /* x2 */ - "0", /* y2 */ - "0.984807753012208"; /* z2 */ -}; diff --git a/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml b/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml new file mode 100644 index 000000000000..a603659d5fa5 --- /dev/null +++ b/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml @@ -0,0 +1,78 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/magnetometer/asahi-kasei,ak8975.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: AsahiKASEI AK8975 magnetometer sensor + +maintainers: + - Jonathan Albrieux <jonathan.albrieux@gmail.com> + +properties: + compatible: + oneOf: + - const: asahi-kasei,ak8975 + - const: asahi-kasei,ak8963 + - const: asahi-kasei,ak09911 + - const: asahi-kasei,ak09912 + - const: ak8975 + deprecated: true + - const: ak8963 + deprecated: true + - const: ak09911 + deprecated: true + - const: ak09912 + deprecated: true + + reg: + maxItems: 1 + description: the I2C address of the magnetometer. + + gpios: + description: | + AK8975 has a "Data ready" pin (DRDY) which informs that data + is ready to be read and is possible to listen on it. If used, + this should be active high. Prefer interrupt over this. + + interrupts: + maxItems: 1 + description: interrupt for DRDY pin. Triggered on rising edge. + + vdd-supply: + maxItems: 1 + description: | + an optional regulator that needs to be on to provide VDD power to + the sensor. + + mount-matrix: + description: an optional 3x3 mounting rotation matrix. + +required: + - compatible + - reg + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + i2c { + #address-cells = <1>; + #size-cells = <0>; + + magnetometer@c { + compatible = "asahi-kasei,ak8975"; + reg = <0x0c>; + interrupt-parent = <&gpio6>; + interrupts = <15 IRQ_TYPE_EDGE_RISING>; + vdd-supply = <&ldo_3v3_gnss>; + mount-matrix = "-0.984807753012208", /* x0 */ + "0", /* y0 */ + "-0.173648177666930", /* z0 */ + "0", /* x1 */ + "-1", /* y1 */ + "0", /* z1 */ + "-0.173648177666930", /* x2 */ + "0", /* y2 */ + "0.984807753012208"; /* z2 */ + }; + };
Converts documentation from txt format to yaml. Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com> --- .../bindings/iio/magnetometer/ak8975.txt | 37 --------- .../iio/magnetometer/asahi-kasei,ak8975.yaml | 78 +++++++++++++++++++ 2 files changed, 78 insertions(+), 37 deletions(-) delete mode 100644 Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml