Merge tag 'pci-v4.16-fixes-1' of git://git.kernel.org/pub/scm/linux/kernel/git/helgaa...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / media / samsung-s5c73m3.txt
1 Samsung S5C73M3 8Mp camera ISP
2 ------------------------------
3
4 The S5C73M3 camera ISP supports MIPI CSI-2 and parallel (ITU-R BT.656) video
5 data busses. The I2C bus is the main control bus and additionally the SPI bus
6 is used, mostly for transferring the firmware to and from the device. Two
7 slave device nodes corresponding to these control bus interfaces are required
8 and should be placed under respective bus controller nodes.
9
10 I2C slave device node
11 ---------------------
12
13 Required properties:
14
15 - compatible        : "samsung,s5c73m3";
16 - reg               : I2C slave address of the sensor;
17 - vdd-int-supply    : digital power supply (1.2V);
18 - vdda-supply       : analog power supply (1.2V);
19 - vdd-reg-supply    : regulator input power supply (2.8V);
20 - vddio-host-supply : host I/O power supply (1.8V to 2.8V);
21 - vddio-cis-supply  : CIS I/O power supply (1.2V to 1.8V);
22 - vdd-af-supply     : lens power supply (2.8V);
23 - xshutdown-gpios   : specifier of GPIO connected to the XSHUTDOWN pin;
24 - standby-gpios     : specifier of GPIO connected to the STANDBY pin;
25 - clocks            : should contain list of phandle and clock specifier pairs
26                       according to common clock bindings for the clocks described
27                       in the clock-names property;
28 - clock-names       : should contain "cis_extclk" entry for the CIS_EXTCLK clock;
29
30 Optional properties:
31
32 - clock-frequency   : the frequency at which the "cis_extclk" clock should be
33                       configured to operate, in Hz; if this property is not
34                       specified default 24 MHz value will be used.
35
36 The common video interfaces bindings (see video-interfaces.txt) should be used
37 to specify link from the S5C73M3 to an external image data receiver. The S5C73M3
38 device node should contain one 'port' child node with an 'endpoint' subnode for
39 this purpose. The data link from a raw image sensor to the S5C73M3 can be
40 similarly specified, but it is optional since the S5C73M3 ISP and a raw image
41 sensor are usually inseparable and form a hybrid module.
42
43 Following properties are valid for the endpoint node(s):
44
45 endpoint subnode
46 ----------------
47
48 - data-lanes : (optional) specifies MIPI CSI-2 data lanes as covered in
49   video-interfaces.txt. This sensor doesn't support data lane remapping
50   and physical lane indexes in subsequent elements of the array should
51   be only consecutive ascending values.
52
53 SPI device node
54 ---------------
55
56 Required properties:
57
58 - compatible        : "samsung,s5c73m3";
59
60 For more details see description of the SPI busses bindings
61 (../spi/spi-bus.txt) and bindings of a specific bus controller.
62
63 Example:
64
65 i2c@138a000000 {
66         ...
67         s5c73m3@3c {
68                 compatible = "samsung,s5c73m3";
69                 reg = <0x3c>;
70                 vdd-int-supply = <&buck9_reg>;
71                 vdda-supply = <&ldo17_reg>;
72                 vdd-reg-supply = <&cam_io_reg>;
73                 vddio-host-supply = <&ldo18_reg>;
74                 vddio-cis-supply = <&ldo9_reg>;
75                 vdd-af-supply = <&cam_af_reg>;
76                 clock-frequency = <24000000>;
77                 clocks = <&clk 0>;
78                 clock-names = "cis_extclk";
79                 reset-gpios = <&gpf1 3 1>;
80                 standby-gpios = <&gpm0 1 1>;
81                 port {
82                         s5c73m3_ep: endpoint {
83                                 remote-endpoint = <&csis0_ep>;
84                                 data-lanes = <1 2 3 4>;
85                         };
86                 };
87         };
88 };
89
90 spi@1392000 {
91         ...
92         s5c73m3_spi: s5c73m3@0 {
93                 compatible = "samsung,s5c73m3";
94                 reg = <0>;
95                 ...
96         };
97 };