[deliverable/linux.git] / Documentation / devicetree / bindings / hwmon / ads1015.txt

ADS1015 (I2C)

This device is a 12-bit A-D converter with 4 inputs.

The inputs can be used single ended or in certain differential combinations.

For configuration all possible combinations are mapped to 8 channels:
  0: Voltage over AIN0 and AIN1.
  1: Voltage over AIN0 and AIN3.
  2: Voltage over AIN1 and AIN3.
  3: Voltage over AIN2 and AIN3.
  4: Voltage over AIN0 and GND.
  5: Voltage over AIN1 and GND.
  6: Voltage over AIN2 and GND.
  7: Voltage over AIN3 and GND.

Each channel can be configured individually:
 - pga is the programmable gain amplifier (values are full scale)
    0: +/- 6.144 V
    1: +/- 4.096 V
    2: +/- 2.048 V (default)
    3: +/- 1.024 V
    4: +/- 0.512 V
    5: +/- 0.256 V
 - data_rate in samples per second
    0: 128
    1: 250
    2: 490
    3: 920
    4: 1600 (default)
    5: 2400
    6: 3300

1) The /ads1015 node

  Required properties:

   - compatible : must be "ti,ads1015"
   - reg : I2C bus address of the device
   - #address-cells : must be <1>
   - #size-cells : must be <0>

  The node contains child nodes for each channel that the platform uses.

  Example ADS1015 node:

    ads1015@49 {
	    compatible = "ti,ads1015";
	    reg = <0x49>;
	    #address-cells = <1>;
	    #size-cells = <0>;

	    [ child node definitions... ]
    }

2) channel nodes

  Required properties:

   - reg : the channel number

  Optional properties:

   - ti,gain : the programmable gain amplifier setting
   - ti,datarate : the converter data rate

  Example ADS1015 channel node:

    channel@4 {
	    reg = <4>;
	    ti,gain = <3>;
	    ti,datarate = <5>;
    };
Commit	Line	Data
8c22a8f5 DE	1	ADS1015 (I2C)
	2
	3	This device is a 12-bit A-D converter with 4 inputs.
	4
	5	The inputs can be used single ended or in certain differential combinations.
	6
	7	For configuration all possible combinations are mapped to 8 channels:
c0046867 DE	8	0: Voltage over AIN0 and AIN1.
	9	1: Voltage over AIN0 and AIN3.
	10	2: Voltage over AIN1 and AIN3.
	11	3: Voltage over AIN2 and AIN3.
	12	4: Voltage over AIN0 and GND.
	13	5: Voltage over AIN1 and GND.
	14	6: Voltage over AIN2 and GND.
	15	7: Voltage over AIN3 and GND.
	16
	17	Each channel can be configured individually:
	18	- pga is the programmable gain amplifier (values are full scale)
	19	0: +/- 6.144 V
	20	1: +/- 4.096 V
	21	2: +/- 2.048 V (default)
	22	3: +/- 1.024 V
	23	4: +/- 0.512 V
	24	5: +/- 0.256 V
	25	- data_rate in samples per second
	26	0: 128
	27	1: 250
	28	2: 490
	29	3: 920
	30	4: 1600 (default)
	31	5: 2400
	32	6: 3300
	33
	34	1) The /ads1015 node
	35
	36	Required properties:
	37
	38	- compatible : must be "ti,ads1015"
	39	- reg : I2C bus address of the device
	40	- #address-cells : must be <1>
	41	- #size-cells : must be <0>
	42
	43	The node contains child nodes for each channel that the platform uses.
	44
	45	Example ADS1015 node:
	46
	47	ads1015@49 {
	48	compatible = "ti,ads1015";
	49	reg = <0x49>;
	50	#address-cells = <1>;
	51	#size-cells = <0>;
	52
	53	[ child node definitions... ]
	54	}
	55
	56	2) channel nodes
	57
	58	Required properties:
	59
	60	- reg : the channel number
	61
	62	Optional properties:
	63
	64	- ti,gain : the programmable gain amplifier setting
	65	- ti,datarate : the converter data rate
	66
	67	Example ADS1015 channel node:
	68
	69	channel@4 {
	70	reg = <4>;
	71	ti,gain = <3>;
72	ti,datarate = <5>;
73	};