xref: /linux/Documentation/devicetree/bindings/soc/amlogic/amlogic,canvas.yaml (revision 7f464532b05dadc8f96acdda7093334c863e7a06)
12ff0b450SNeil Armstrong# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
22ff0b450SNeil Armstrong# Copyright 2019 BayLibre, SAS
32ff0b450SNeil Armstrong%YAML 1.2
42ff0b450SNeil Armstrong---
52ff0b450SNeil Armstrong$id: "http://devicetree.org/schemas/soc/amlogic/amlogic,canvas.yaml#"
62ff0b450SNeil Armstrong$schema: "http://devicetree.org/meta-schemas/core.yaml#"
72ff0b450SNeil Armstrong
82ff0b450SNeil Armstrongtitle: Amlogic Canvas Video Lookup Table
92ff0b450SNeil Armstrong
102ff0b450SNeil Armstrongmaintainers:
112ff0b450SNeil Armstrong  - Neil Armstrong <narmstrong@baylibre.com>
122ff0b450SNeil Armstrong  - Maxime Jourdan <mjourdan@baylibre.com>
132ff0b450SNeil Armstrong
142ff0b450SNeil Armstrongdescription: |
152ff0b450SNeil Armstrong  A canvas is a collection of metadata that describes a pixel buffer.
162ff0b450SNeil Armstrong  Those metadata include: width, height, phyaddr, wrapping and block mode.
172ff0b450SNeil Armstrong  Starting with GXBB the endianness can also be described.
182ff0b450SNeil Armstrong
192ff0b450SNeil Armstrong  Many IPs within Amlogic SoCs rely on canvas indexes to read/write pixel data
202ff0b450SNeil Armstrong  rather than use the phy addresses directly. For instance, this is the case for
212ff0b450SNeil Armstrong  the video decoders and the display.
222ff0b450SNeil Armstrong
232ff0b450SNeil Armstrong  Amlogic SoCs have 256 canvas.
242ff0b450SNeil Armstrong
252ff0b450SNeil Armstrongproperties:
262ff0b450SNeil Armstrong  compatible:
272ff0b450SNeil Armstrong    oneOf:
282ff0b450SNeil Armstrong      - items:
292ff0b450SNeil Armstrong        - enum:
302ff0b450SNeil Armstrong          - amlogic,meson8-canvas
312ff0b450SNeil Armstrong          - amlogic,meson8b-canvas
322ff0b450SNeil Armstrong          - amlogic,meson8m2-canvas
332ff0b450SNeil Armstrong        - const: amlogic,canvas
342ff0b450SNeil Armstrong      - const: amlogic,canvas # GXBB and newer SoCs
352ff0b450SNeil Armstrong
362ff0b450SNeil Armstrong  reg:
372ff0b450SNeil Armstrong    maxItems: 1
382ff0b450SNeil Armstrong
392ff0b450SNeil Armstrongrequired:
402ff0b450SNeil Armstrong  - compatible
412ff0b450SNeil Armstrong  - reg
422ff0b450SNeil Armstrong
43*7f464532SRob HerringadditionalProperties: false
44*7f464532SRob Herring
452ff0b450SNeil Armstrongexamples:
462ff0b450SNeil Armstrong  - |
472ff0b450SNeil Armstrong    canvas: video-lut@48 {
482ff0b450SNeil Armstrong        compatible = "amlogic,canvas";
492ff0b450SNeil Armstrong        reg = <0x48 0x14>;
502ff0b450SNeil Armstrong    };
512ff0b450SNeil Armstrong
52