adi-linux/Documentation/devicetree/bindings/media/adi,adi-axi-fb.yaml at bafbc8934f798fbbd13250fcbb1e49884bd88389 · dlech/adi-linux · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# SPDX-License-Identifier: GPL-2.0
# Copyright 2019 Analog Devices Inc.
%YAML 1.2
---
$id: http://devicetree.org/schemas/media/adi,adi-axi-fb.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Analog Devices AXI Frame Buffer

maintainers:
  - Bogdan Togorean <bogdan.togorean@analog.com>

description: |
  Bindings for the Analog Devices Frame Buffer core. Spefications of the
  core can be found in:
  https://wiki.analog.com/resources/fpga/docs/axi_dmac
  First example is used when FB is stored in PS RAM and second for PL RAM.

additionalProperties: false

properties:
  compatible:
    enum:
      - adi,axi-framebuffer-1.00.a

  memory-region:
    description:
      Phandle to a node used to specify reserved memory for video frame buffers.
      If not used, frame buffer address and size should be specified using reg
      property.

  reg:
    minItems: 2
    maxItems: 3

  reg-names:
    oneOf:
      - items:
          - const: tx_dma
          - const: rx_dma
      - items:
          - const: fb_mem
          - const: tx_dma
          - const: rx_dma

  adi,flock-resolution:
    description:
      (u32, u32) tuple setting resolution of input/output image in pixels.
      <horizontal> <vertical>
    $ref: /schemas/types.yaml#/definitions/uint32-array
    minItems: 2
    maxItems: 2

  adi,flock-mode:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      Select operating mode of the framebuffer.
      0 -> Frame rate conversion mode
      1 -> Output delay mode
    enum: [ 0, 1 ]

  adi,flock-frm-buf-nr:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      The total number of video frame buffers.
      Related to NUM_BUF synthesys parameter.
    minimum: 3

  adi,flock-distance:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      Applicable only in output delay mode. Set the output delay in frames.
      Should be set in interval 0 to flock,frm-buf-nr - 2
    minimum: 0

  adi,flock-line-stride:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      The number of bytes between the start of one row and the next row.
      Needs to be aligned to the bus width.

  adi,flock-frm-stride:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      Stride of consecutive frames in memory in bytes. Should be at least the
      size of one frame.

  adi,flock-dwidth:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      Represent the number of bytes per pixel according to used color space.
    enum: [ 1, 2, 4 ]

required:
  - compatible
  - reg
  - reg-names

examples:
  - |
    framebuffer@43000000 {
            compatible = "adi,axi-framebuffer-1.00.a";
            memory-region = <&reserved>;
            reg = <0x43000000 0x1000>, <0x43c20000 0x1000>;
            reg-names = "tx_dma", "rx_dma";
            adi,flock-resolution = <1920>, <1080>;
            adi,flock-distance = <0>;
            adi,flock-mode = <0>;
            adi,flock-dwidth = <4>;
            adi,flock-frm-buf-nr = <3>;
    };

    reserved-memory {
            #address-cells = <1>;
            #size-cells = <1>;
            ranges;

            reserved: buffer@0 {
                    no-map;
                    reg = <0x1C000000 0x2000000>;
            };
    };

  - |
    framebuffer@1c000000 {
            compatible = "adi,axi-framebuffer-1.00.a";
            reg = <0x1C000000 0x2000>, <0x43000000 0x1000>, <0x43c20000 0x1000>;
            reg-names = "fb_mem", "tx_dma", "rx_dma";
            adi,flock-resolution = <1920>, <1080>;
            adi,flock-distance = <0>;
            adi,flock-mode = <0>;
            adi,flock-dwidth = <4>;
            adi,flock-frm-buf-nr = <3>;
    };