mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-09-16 07:35:14 +00:00
Code Issues Releases Wiki Activity

dt-bindings:iio:afe:current-sense-amplifier: txt to yaml conversion.

Browse source 
Note this includes a fix in the example where we had *-mul instead of
*-mult.  The binding doc and driver agree that it should be *-mult

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Cc: Peter Rosin <peda@axentia.se>
Link: https://lore.kernel.org/r/20201031181242.742301-6-jic23@kernel.org
This commit is contained in:
Jonathan Cameron 2020-10-31 18:12:37 +00:00
parent 66a6dcc20e
commit fbac26b9ad
2 changed files with 54 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.txt
View file

@ -1,26 +0,0 @@
Current Sense Amplifier
=======================
When an io-channel measures the output voltage from a current sense
amplifier, the interesting measurement is almost always the current
through the sense resistor, not the voltage output. This binding
describes such a current sense circuit.
Required properties:
- compatible : "current-sense-amplifier"
- io-channels : Channel node of a voltage io-channel.
- sense-resistor-micro-ohms : The sense resistance in microohms.
Optional properties:
- sense-gain-mult: Amplifier gain multiplier. The default is <1>.
- sense-gain-div: Amplifier gain divider. The default is <1>.
Example:
sysi {
compatible = "current-sense-amplifier";
io-channels = <&tiadc 0>;
sense-resistor-micro-ohms = <20000>;
sense-gain-mul = <50>;
};

54
Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.yaml Normal file
View file

@ -0,0 +1,54 @@
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/afe/current-sense-amplifier.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: Current Sense Amplifier
maintainers:
- Peter Rosin <peda@axentia.se>
description: |
When an io-channel measures the output voltage from a current sense
amplifier, the interesting measurement is almost always the current
through the sense resistor, not the voltage output. This binding
describes such a current sense circuit.
properties:
compatible:
const: current-sense-amplifier
io-channels:
maxItems: 1
description: |
Channel node of a voltage io-channel.
sense-resistor-micro-ohms:
description: The sense resistance.
sense-gain-mult:
$ref: /schemas/types.yaml#/definitions/uint32
description: Amplifier gain multiplier. The default is <1>.
sense-gain-div:
$ref: /schemas/types.yaml#/definitions/uint32
description: Amplifier gain divider. The default is <1>.
required:
- compatible
- io-channels
- sense-resistor-micro-ohms
additionalProperties: false
examples:
- |
sysi {
compatible = "current-sense-amplifier";
io-channels = <&tiadc 0>;
sense-resistor-micro-ohms = <20000>;
sense-gain-mult = <50>;
};
...