blob: 02d2a459385f390fb280453ad30a13798495d7de [file] [log] [blame]
Dirk Eibach8c22a8f2011-03-21 17:59:36 +01001Kernel driver ads1015
2=====================
3
4Supported chips:
5 * Texas Instruments ADS1015
6 Prefix: 'ads1015'
7 Datasheet: Publicly available at the Texas Instruments website :
8 http://focus.ti.com/lit/ds/symlink/ads1015.pdf
Evgeniy Dushistov60c1f312013-08-01 23:23:48 +04009 * Texas Instruments ADS1115
10 Prefix: 'ads1115'
11 Datasheet: Publicly available at the Texas Instruments website :
12 http://focus.ti.com/lit/ds/symlink/ads1115.pdf
Dirk Eibach8c22a8f2011-03-21 17:59:36 +010013
14Authors:
15 Dirk Eibach, Guntermann & Drunck GmbH <eibach@gdsys.de>
16
17Description
18-----------
19
Evgeniy Dushistov60c1f312013-08-01 23:23:48 +040020This driver implements support for the Texas Instruments ADS1015/ADS1115.
Dirk Eibach8c22a8f2011-03-21 17:59:36 +010021
Evgeniy Dushistov60c1f312013-08-01 23:23:48 +040022This device is a 12/16-bit A-D converter with 4 inputs.
Dirk Eibach8c22a8f2011-03-21 17:59:36 +010023
24The inputs can be used single ended or in certain differential combinations.
25
Dirk Eibachc0046862011-03-21 17:59:37 +010026The inputs can be made available by 8 sysfs input files in0_input - in7_input:
Dirk Eibach8c22a8f2011-03-21 17:59:36 +010027in0: Voltage over AIN0 and AIN1.
28in1: Voltage over AIN0 and AIN3.
29in2: Voltage over AIN1 and AIN3.
30in3: Voltage over AIN2 and AIN3.
31in4: Voltage over AIN0 and GND.
32in5: Voltage over AIN1 and GND.
33in6: Voltage over AIN2 and GND.
34in7: Voltage over AIN3 and GND.
35
Dirk Eibachc0046862011-03-21 17:59:37 +010036Which inputs are available can be configured using platform data or devicetree.
Dirk Eibach8c22a8f2011-03-21 17:59:36 +010037
38By default all inputs are exported.
39
40Platform Data
41-------------
42
Wolfram Sang90106242017-05-21 22:34:39 +020043In linux/platform_data/ads1015.h platform data is defined, channel_data contains
Dirk Eibachc0046862011-03-21 17:59:37 +010044configuration data for the used input combinations:
45- pga is the programmable gain amplifier (values are full scale)
46 0: +/- 6.144 V
47 1: +/- 4.096 V
48 2: +/- 2.048 V
49 3: +/- 1.024 V
50 4: +/- 0.512 V
51 5: +/- 0.256 V
52- data_rate in samples per second
53 0: 128
54 1: 250
55 2: 490
56 3: 920
57 4: 1600
58 5: 2400
59 6: 3300
Dirk Eibach8c22a8f2011-03-21 17:59:36 +010060
61Example:
62struct ads1015_platform_data data = {
Dirk Eibachc0046862011-03-21 17:59:37 +010063 .channel_data = {
64 [2] = { .enabled = true, .pga = 1, .data_rate = 0 },
65 [4] = { .enabled = true, .pga = 4, .data_rate = 5 },
66 }
Dirk Eibach8c22a8f2011-03-21 17:59:36 +010067};
68
Dirk Eibachc0046862011-03-21 17:59:37 +010069In this case only in2_input (FS +/- 4.096 V, 128 SPS) and in4_input
70(FS +/- 0.512 V, 2400 SPS) would be created.
Dirk Eibach8c22a8f2011-03-21 17:59:36 +010071
72Devicetree
73----------
74
Dirk Eibachc0046862011-03-21 17:59:37 +010075Configuration is also possible via devicetree:
76Documentation/devicetree/bindings/hwmon/ads1015.txt