Merge tag 'csky-for-linus-4.21' of git://github.com/c-sky/csky-linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / iio / adc / 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 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                         Must be "samsung,s5pv210-adc" for
32                                 the ADC in s5pv210 and compatibles
33 - reg:                  List of ADC register address range
34                         - The base address and range of ADC register
35                         - The base address and range of ADC_PHY register (every
36                           SoC except for s3c24xx/s3c64xx ADC)
37 - interrupts:           Contains the interrupt information for the timer. The
38                         format is being dependent on which interrupt controller
39                         the Samsung device uses.
40 - #io-channel-cells = <1>; As ADC has multiple outputs
41 - clocks                From common clock bindings: handles to clocks specified
42                         in "clock-names" property, in the same order.
43 - clock-names           From common clock bindings: list of clock input names
44                         used by ADC block:
45                         - "adc" : ADC bus clock
46                         - "sclk" : ADC special clock (only for Exynos3250 and
47                                    compatible ADC block)
48 - vdd-supply            VDD input supply.
49
50 - samsung,syscon-phandle Contains the PMU system controller node
51                         (To access the ADC_PHY register on Exynos5250/5420/5800/3250)
52 Optional properties:
53 - has-touchscreen:      If present, indicates that a touchscreen is
54                         connected an usable.
55
56 Note: child nodes can be added for auto probing from device tree.
57
58 Example: adding device info in dtsi file
59
60 adc: adc@12d10000 {
61         compatible = "samsung,exynos-adc-v1";
62         reg = <0x12D10000 0x100>;
63         interrupts = <0 106 0>;
64         #io-channel-cells = <1>;
65         io-channel-ranges;
66
67         clocks = <&clock 303>;
68         clock-names = "adc";
69
70         vdd-supply = <&buck5_reg>;
71         samsung,syscon-phandle = <&pmu_system_controller>;
72 };
73
74 Example: adding device info in dtsi file for Exynos3250 with additional sclk
75
76 adc: adc@126c0000 {
77         compatible = "samsung,exynos3250-adc", "samsung,exynos-adc-v2;
78         reg = <0x126C0000 0x100>;
79         interrupts = <0 137 0>;
80         #io-channel-cells = <1>;
81         io-channel-ranges;
82
83         clocks = <&cmu CLK_TSADC>, <&cmu CLK_SCLK_TSADC>;
84         clock-names = "adc", "sclk";
85
86         vdd-supply = <&buck5_reg>;
87         samsung,syscon-phandle = <&pmu_system_controller>;
88 };
89
90 Example: Adding child nodes in dts file
91
92 adc@12d10000 {
93
94         /* NTC thermistor is a hwmon device */
95         ncp15wb473@0 {
96                 compatible = "murata,ncp15wb473";
97                 pullup-uv = <1800000>;
98                 pullup-ohm = <47000>;
99                 pulldown-ohm = <0>;
100                 io-channels = <&adc 4>;
101         };
102 };
103
104 Note: Does not apply to ADC driver under arch/arm/plat-samsung/
105 Note: The child node can be added under the adc node or separately.