xref: /freebsd/sys/contrib/device-tree/Bindings/media/xilinx/video.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1*c66ec88fSEmmanuel VadotDT bindings for Xilinx video IP cores
2*c66ec88fSEmmanuel Vadot-------------------------------------
3*c66ec88fSEmmanuel Vadot
4*c66ec88fSEmmanuel VadotXilinx video IP cores process video streams by acting as video sinks and/or
5*c66ec88fSEmmanuel Vadotsources. They are connected by links through their input and output ports,
6*c66ec88fSEmmanuel Vadotcreating a video pipeline.
7*c66ec88fSEmmanuel Vadot
8*c66ec88fSEmmanuel VadotEach video IP core is represented by an AMBA bus child node in the device
9*c66ec88fSEmmanuel Vadottree using bindings documented in this directory. Connections between the IP
10*c66ec88fSEmmanuel Vadotcores are represented as defined in ../video-interfaces.txt.
11*c66ec88fSEmmanuel Vadot
12*c66ec88fSEmmanuel VadotThe whole  pipeline is represented by an AMBA bus child node in the device
13*c66ec88fSEmmanuel Vadottree using bindings documented in ./xlnx,video.txt.
14*c66ec88fSEmmanuel Vadot
15*c66ec88fSEmmanuel VadotCommon properties
16*c66ec88fSEmmanuel Vadot-----------------
17*c66ec88fSEmmanuel Vadot
18*c66ec88fSEmmanuel VadotThe following properties are common to all Xilinx video IP cores.
19*c66ec88fSEmmanuel Vadot
20*c66ec88fSEmmanuel Vadot- xlnx,video-format: This property represents a video format transmitted on an
21*c66ec88fSEmmanuel Vadot  AXI bus between video IP cores, using its VF code as defined in "AXI4-Stream
22*c66ec88fSEmmanuel Vadot  Video IP and System Design Guide" [UG934]. How the format relates to the IP
23*c66ec88fSEmmanuel Vadot  core is described in the IP core bindings documentation.
24*c66ec88fSEmmanuel Vadot
25*c66ec88fSEmmanuel Vadot- xlnx,video-width: This property qualifies the video format with the sample
26*c66ec88fSEmmanuel Vadot  width expressed as a number of bits per pixel component. All components must
27*c66ec88fSEmmanuel Vadot  use the same width.
28*c66ec88fSEmmanuel Vadot
29*c66ec88fSEmmanuel Vadot- xlnx,cfa-pattern: When the video format is set to Mono/Sensor, this property
30*c66ec88fSEmmanuel Vadot  describes the sensor's color filter array pattern. Supported values are
31*c66ec88fSEmmanuel Vadot  "bggr", "gbrg", "grbg", "rggb" and "mono". If not specified, the pattern
32*c66ec88fSEmmanuel Vadot  defaults to "mono".
33*c66ec88fSEmmanuel Vadot
34*c66ec88fSEmmanuel Vadot
35*c66ec88fSEmmanuel Vadot[UG934] https://www.xilinx.com/support/documentation/ip_documentation/axi_videoip/v1_0/ug934_axi_videoIP.pdf
36