xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/iio/afe/current-sense-amplifier.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981) 
1*4882a593SmuzhiyunCurrent Sense Amplifier
2*4882a593Smuzhiyun=======================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunWhen an io-channel measures the output voltage from a current sense
5*4882a593Smuzhiyunamplifier, the interesting measurement is almost always the current
6*4882a593Smuzhiyunthrough the sense resistor, not the voltage output. This binding
7*4882a593Smuzhiyundescribes such a current sense circuit.
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunRequired properties:
10*4882a593Smuzhiyun- compatible : "current-sense-amplifier"
11*4882a593Smuzhiyun- io-channels : Channel node of a voltage io-channel.
12*4882a593Smuzhiyun- sense-resistor-micro-ohms : The sense resistance in microohms.
13*4882a593Smuzhiyun
14*4882a593SmuzhiyunOptional properties:
15*4882a593Smuzhiyun- sense-gain-mult: Amplifier gain multiplier. The default is <1>.
16*4882a593Smuzhiyun- sense-gain-div: Amplifier gain divider. The default is <1>.
17*4882a593Smuzhiyun
18*4882a593SmuzhiyunExample:
19*4882a593Smuzhiyun
20*4882a593Smuzhiyunsysi {
21*4882a593Smuzhiyun	compatible = "current-sense-amplifier";
22*4882a593Smuzhiyun	io-channels = <&tiadc 0>;
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun	sense-resistor-micro-ohms = <20000>;
25*4882a593Smuzhiyun	sense-gain-mul = <50>;
26*4882a593Smuzhiyun};
27