Merge branch 'pm-cpufreq'
[cascardo/linux.git] / Documentation / devicetree / bindings / media / renesas,fcp.txt
1 Renesas R-Car Frame Compression Processor (FCP)
2 -----------------------------------------------
3
4 The FCP is a companion module of video processing modules in the Renesas R-Car
5 Gen3 SoCs. It provides data compression and decompression, data caching, and
6 conversion of AXI transactions in order to reduce the memory bandwidth.
7
8 There are three types of FCP: FCP for Codec (FCPC), FCP for VSP (FCPV) and FCP
9 for FDP (FCPF). Their configuration and behaviour depend on the module they
10 are paired with. These DT bindings currently support the FCPV and FCPF.
11
12  - compatible: Must be one or more of the following
13
14    - "renesas,r8a7795-fcpv" for R8A7795 (R-Car H3) compatible 'FCP for VSP'
15    - "renesas,r8a7795-fcpf" for R8A7795 (R-Car H3) compatible 'FCP for FDP'
16    - "renesas,fcpv" for generic compatible 'FCP for VSP'
17    - "renesas,fcpf" for generic compatible 'FCP for FDP'
18
19    When compatible with the generic version, nodes must list the
20    SoC-specific version corresponding to the platform first, followed by the
21    family-specific and/or generic versions.
22
23  - reg: the register base and size for the device registers
24  - clocks: Reference to the functional clock
25
26 Optional properties:
27  - power-domains : power-domain property defined with a power domain specifier
28                    to respective power domain.
29
30
31 Device node example
32 -------------------
33
34         fcpvd1: fcp@fea2f000 {
35                 compatible = "renesas,r8a7795-fcpv", "renesas,fcpv";
36                 reg = <0 0xfea2f000 0 0x200>;
37                 clocks = <&cpg CPG_MOD 602>;
38                 power-domains = <&sysc R8A7795_PD_A3VP>;
39         };