xref: /freebsd/sys/contrib/device-tree/Bindings/media/i2c/ovti,og01a1b.yaml (revision b2d2a78ad80ec68d4a17f5aef97d21686cb1e29b)

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
# Copyright (c) 2023-2024 Linaro Ltd.
%YAML 1.2
---
$id: http://devicetree.org/schemas/media/i2c/ovti,og01a1b.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: OmniVision OG01A1B Image Sensor

maintainers:
  - Vladimir Zapolskiy <vladimir.zapolskiy@linaro.org>

description:
  The OmniVision OG01A1B is black and white CMOS 1.3 Megapixel (1280x1024)
  image sensor controlled over an I2C-compatible SCCB bus.
  The sensor transmits images on a MIPI CSI-2 output interface with one or
  two data lanes.

allOf:
  - $ref: /schemas/media/video-interface-devices.yaml#

properties:
  compatible:
    const: ovti,og01a1b

  reg:
    maxItems: 1

  clocks:
    maxItems: 1

  reset-gpios:
    description: Active low GPIO connected to XSHUTDOWN pad of the sensor.
    maxItems: 1

  strobe-gpios:
    description: Input GPIO connected to strobe pad of the sensor.
    maxItems: 1

  avdd-supply:
    description: Analogue circuit voltage supply.

  dovdd-supply:
    description: I/O circuit voltage supply.

  dvdd-supply:
    description: Digital circuit voltage supply.

  port:
    $ref: /schemas/graph.yaml#/$defs/port-base
    additionalProperties: false
    description:
      Output port node, single endpoint describing the CSI-2 transmitter.

    properties:
      endpoint:
        $ref: /schemas/media/video-interfaces.yaml#
        unevaluatedProperties: false

        properties:
          data-lanes:
            minItems: 1
            maxItems: 2
            items:
              enum: [1, 2]

          link-frequencies: true

        required:
          - data-lanes
          - link-frequencies

required:
  - compatible
  - reg
  - clocks
  - port

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>

    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        sensor@60 {
            compatible = "ovti,og01a1b";
            reg = <0x60>;
            clocks = <&clk 0>;
            reset-gpios = <&gpio 117 GPIO_ACTIVE_LOW>;
            avdd-supply = <&vreg_3v3>;
            dovdd-supply = <&vreg_1p8>;
            dvdd-supply = <&vreg_1p2>;

            port {
                og01a1b_ep: endpoint {
                    remote-endpoint = <&csiphy_ep>;
                    data-lanes = <1 2>;
                    link-frequencies = /bits/ 64 <500000000>;
                };
            };
        };
    };
...