dt-bindings: media: nokia,smia: eliminate yamllint warnings
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / media / i2c / mipi-ccs.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 # Copyright (C) 2014--2020 Intel Corporation
3 %YAML 1.2
4 ---
5 $id: http://devicetree.org/schemas/media/i2c/mipi-ccs.yaml#
6 $schema: http://devicetree.org/meta-schemas/core.yaml#
7
8 title: MIPI CCS, SMIA++ and SMIA compliant camera sensors
9
10 maintainers:
11   - Sakari Ailus <sakari.ailus@linux.intel.com>
12
13 description:
14
15   CCS (Camera Command Set) is a raw Bayer camera sensor standard defined by the
16   MIPI Alliance; see
17   <URL:https://www.mipi.org/specifications/camera-command-set>.
18
19   SMIA (Standard Mobile Imaging Architecture) is an image sensor standard
20   defined jointly by Nokia and ST. SMIA++, defined by Nokia, is an extension of
21   that.
22
23   More detailed documentation can be found in
24   Documentation/devicetree/bindings/media/video-interfaces.txt .
25
26 properties:
27   compatible:
28     oneOf:
29       - items:
30           - const: mipi-ccs-1.1
31           - const: mipi-ccs
32       - items:
33           - const: mipi-ccs-1.0
34           - const: mipi-ccs
35       - const: nokia,smia
36
37   reg:
38     maxItems: 1
39
40   vana-supply:
41     description: Analogue voltage supply (VANA), sensor dependent.
42     maxItems: 1
43
44   vcore-supply:
45     description: Core voltage supply (VCore), sensor dependent.
46     maxItems: 1
47
48   vio-supply:
49     description: I/O voltage supply (VIO), sensor dependent.
50     maxItems: 1
51
52   clocks:
53     description: External clock to the sensor.
54     maxItems: 1
55
56   clock-frequency:
57     description: Frequency of the external clock to the sensor in Hz.
58
59   reset-gpios:
60     description: Reset GPIO. Also commonly called XSHUTDOWN in hardware
61       documentation.
62     maxItems: 1
63
64   flash-leds:
65     description: Flash LED phandles. See ../video-interfaces.txt for details.
66
67   lens-focus:
68     description: Lens focus controller phandles. See ../video-interfaces.txt
69       for details.
70
71   rotation:
72     description: Rotation of the sensor.  See ../video-interfaces.txt for
73       details.
74     enum: [ 0, 180 ]
75
76   port:
77     type: object
78     properties:
79       endpoint:
80         type: object
81         properties:
82           link-frequencies:
83             $ref: /schemas/types.yaml#/definitions/uint64-array
84             description: List of allowed data link frequencies.
85           data-lanes:
86             minItems: 1
87             maxItems: 8
88           bus-type:
89             description: The type of the data bus.
90             oneOf:
91               - const: 1 # CSI-2 C-PHY
92               - const: 3 # CCP2
93               - const: 4 # CSI-2 D-PHY
94
95         required:
96           - link-frequencies
97           - data-lanes
98           - bus-type
99
100 required:
101   - compatible
102   - reg
103   - clock-frequency
104   - clocks
105
106 additionalProperties: false
107
108 examples:
109   - |
110     #include <dt-bindings/gpio/gpio.h>
111
112     i2c2 {
113         #address-cells = <1>;
114         #size-cells = <0>;
115
116         clock-frequency = <400000>;
117
118         camera-sensor@10 {
119             compatible = "mipi-ccs-1.0", "mipi-ccs";
120             reg = <0x10>;
121             reset-gpios = <&gpio3 20 GPIO_ACTIVE_LOW>;
122             vana-supply = <&vaux3>;
123             clocks = <&omap3_isp 0>;
124             clock-frequency = <9600000>;
125             port {
126                 ccs_ep: endpoint {
127                     data-lanes = <1 2>;
128                     remote-endpoint = <&csi2a_ep>;
129                     link-frequencies = /bits/ 64 <199200000 210000000
130                                                   499200000>;
131                     bus-type = <4>;
132                 };
133             };
134         };
135     };
136 ...