Linux 6.7-rc7
[linux-modified.git] / Documentation / devicetree / bindings / media / i2c / st,st-vgxy61.yaml
1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2 # Copyright (c) 2022 STMicroelectronics SA.
3 %YAML 1.2
4 ---
5 $id: http://devicetree.org/schemas/media/i2c/st,st-vgxy61.yaml#
6 $schema: http://devicetree.org/meta-schemas/core.yaml#
7
8 title: STMicroelectronics VGxy61 HDR Global Shutter Sensor Family
9
10 maintainers:
11   - Benjamin Mugnier <benjamin.mugnier@foss.st.com>
12   - Sylvain Petinot <sylvain.petinot@foss.st.com>
13
14 description: |-
15   STMicroelectronics VGxy61 family has a CSI-2 output port. CSI-2 output is a
16   quad lanes 800Mbps per lane.
17   Supported formats are RAW8, RAW10, RAW12, RAW14 and RAW16.
18   Following part number are supported
19   - VG5661 and VG6661 are 1.6 Mpx (1464 x 1104) monochrome and color sensors.
20   Maximum frame rate is 75 fps.
21   - VG5761 and VG6761 are 2.3 Mpx (1944 x 1204) monochrome and color sensors.
22   Maximum frame rate is 60 fps.
23
24 properties:
25   compatible:
26     const: st,st-vgxy61
27
28   reg:
29     maxItems: 1
30
31   clocks:
32     maxItems: 1
33
34   VCORE-supply:
35     description:
36       Sensor digital core supply. Must be 1.2 volts.
37
38   VDDIO-supply:
39     description:
40       Sensor digital IO supply. Must be 1.8 volts.
41
42   VANA-supply:
43     description:
44       Sensor analog supply. Must be 2.8 volts.
45
46   reset-gpios:
47     description:
48       Reference to the GPIO connected to the reset pin, if any.
49       This is an active low signal to the vgxy61.
50
51   st,strobe-gpios-polarity:
52     description:
53       Invert polarity of illuminator's lights strobe GPIOs.
54       These GPIOs directly drive the illuminator LEDs.
55     type: boolean
56
57   port:
58     $ref: /schemas/graph.yaml#/$defs/port-base
59     additionalProperties: false
60
61     properties:
62       endpoint:
63         $ref: /schemas/media/video-interfaces.yaml#
64         unevaluatedProperties: false
65
66         properties:
67           data-lanes:
68             description:
69               CSI lanes to use
70             items:
71               - const: 1
72               - const: 2
73               - const: 3
74               - const: 4
75
76           remote-endpoint: true
77
78         required:
79           - data-lanes
80
81 required:
82   - compatible
83   - clocks
84   - VCORE-supply
85   - VDDIO-supply
86   - VANA-supply
87   - port
88
89 additionalProperties: false
90
91 examples:
92   - |
93     #include <dt-bindings/gpio/gpio.h>
94     i2c {
95         #address-cells = <1>;
96         #size-cells = <0>;
97         vgxy61: csi2tx@10 {
98             compatible = "st,st-vgxy61";
99             reg = <0x10>;
100             clocks = <&clk_ext_camera>;
101             VCORE-supply = <&v1v2>;
102             VDDIO-supply = <&v1v8>;
103             VANA-supply = <&v2v8>;
104             reset-gpios = <&mfxgpio 18 GPIO_ACTIVE_LOW>;
105             port {
106                 ep0: endpoint {
107                     data-lanes = <1 2 3 4>;
108                     remote-endpoint = <&mipi_csi2_out>;
109                 };
110             };
111         };
112     };
113 ...