Merge tag 'rproc-v4.16' of git://github.com/andersson/remoteproc
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / arm / samsung / exynos-adc.txt
1 Samsung Exynos Analog to Digital Converter bindings
2
3 The devicetree bindings are for the new ADC driver written for
4 Exynos4 and upward SoCs from Samsung.
5
6 New driver handles the following
7 1. Supports ADC IF found on EXYNOS4412/EXYNOS5250
8    and future SoCs from Samsung
9 2. Add ADC driver under iio/adc framework
10 3. Also adds the Documentation for device tree bindings
11
12 Required properties:
13 - compatible:           Must be "samsung,exynos-adc-v1"
14                                 for exynos4412/5250 and s5pv210 controllers.
15                         Must be "samsung,exynos-adc-v2" for
16                                 future controllers.
17                         Must be "samsung,exynos3250-adc" for
18                                 controllers compatible with ADC of Exynos3250.
19                         Must be "samsung,exynos7-adc" for
20                                 the ADC in Exynos7 and compatibles
21                         Must be "samsung,s3c2410-adc" for
22                                 the ADC in s3c2410 and compatibles
23                         Must be "samsung,s3c2416-adc" for
24                                 the ADC in s3c2416 and compatibles
25                         Must be "samsung,s3c2440-adc" for
26                                 the ADC in s3c2440 and compatibles
27                         Must be "samsung,s3c2443-adc" for
28                                 the ADC in s3c2443 and compatibles
29                         Must be "samsung,s3c6410-adc" for
30                                 the ADC in s3c6410 and compatibles
31 - reg:                  List of ADC register address range
32                         - The base address and range of ADC register
33                         - The base address and range of ADC_PHY register (every
34                           SoC except for s3c24xx/s3c64xx ADC)
35 - interrupts:           Contains the interrupt information for the timer. The
36                         format is being dependent on which interrupt controller
37                         the Samsung device uses.
38 - #io-channel-cells = <1>; As ADC has multiple outputs
39 - clocks                From common clock bindings: handles to clocks specified
40                         in "clock-names" property, in the same order.
41 - clock-names           From common clock bindings: list of clock input names
42                         used by ADC block:
43                         - "adc" : ADC bus clock
44                         - "sclk" : ADC special clock (only for Exynos3250 and
45                                    compatible ADC block)
46 - vdd-supply            VDD input supply.
47
48 - samsung,syscon-phandle Contains the PMU system controller node
49                         (To access the ADC_PHY register on Exynos5250/5420/5800/3250)
50 Optional properties:
51 - has-touchscreen:      If present, indicates that a touchscreen is
52                         connected an usable.
53
54 Note: child nodes can be added for auto probing from device tree.
55
56 Example: adding device info in dtsi file
57
58 adc: adc@12d10000 {
59         compatible = "samsung,exynos-adc-v1";
60         reg = <0x12D10000 0x100>;
61         interrupts = <0 106 0>;
62         #io-channel-cells = <1>;
63         io-channel-ranges;
64
65         clocks = <&clock 303>;
66         clock-names = "adc";
67
68         vdd-supply = <&buck5_reg>;
69         samsung,syscon-phandle = <&pmu_system_controller>;
70 };
71
72 Example: adding device info in dtsi file for Exynos3250 with additional sclk
73
74 adc: adc@126c0000 {
75         compatible = "samsung,exynos3250-adc", "samsung,exynos-adc-v2;
76         reg = <0x126C0000 0x100>;
77         interrupts = <0 137 0>;
78         #io-channel-cells = <1>;
79         io-channel-ranges;
80
81         clocks = <&cmu CLK_TSADC>, <&cmu CLK_SCLK_TSADC>;
82         clock-names = "adc", "sclk";
83
84         vdd-supply = <&buck5_reg>;
85         samsung,syscon-phandle = <&pmu_system_controller>;
86 };
87
88 Example: Adding child nodes in dts file
89
90 adc@12d10000 {
91
92         /* NTC thermistor is a hwmon device */
93         ncp15wb473@0 {
94                 compatible = "murata,ncp15wb473";
95                 pullup-uv = <1800000>;
96                 pullup-ohm = <47000>;
97                 pulldown-ohm = <0>;
98                 io-channels = <&adc 4>;
99         };
100 };
101
102 Note: Does not apply to ADC driver under arch/arm/plat-samsung/
103 Note: The child node can be added under the adc node or separately.