Documentation/devicetree/bindings/clock/renesas,cpg-mssr.txt

   1 * Renesas Clock Pulse Generator / Module Standby and Software Reset
   2
   3 On Renesas ARM SoCs (SH/R-Mobile, R-Car, RZ), the CPG (Clock Pulse Generator)
   4 and MSSR (Module Standby and Software Reset) blocks are intimately connected,
   5 and share the same register block.
   6
   7 They provide the following functionalities:
   8   - The CPG block generates various core clocks,
   9   - The MSSR block provides two functions:
  10       1. Module Standby, providing a Clock Domain to control the clock supply
  11          to individual SoC devices,
  12       2. Reset Control, to perform a software reset of individual SoC devices.
  13
  14 Required Properties:
  15   - compatible: Must be one of:
  16       - "renesas,r7s9210-cpg-mssr" for the r7s9210 SoC (RZ/A2)
  17       - "renesas,r8a7743-cpg-mssr" for the r8a7743 SoC (RZ/G1M)
  18       - "renesas,r8a7744-cpg-mssr" for the r8a7744 SoC (RZ/G1N)
  19       - "renesas,r8a7745-cpg-mssr" for the r8a7745 SoC (RZ/G1E)
  20       - "renesas,r8a77470-cpg-mssr" for the r8a77470 SoC (RZ/G1C)
  21       - "renesas,r8a774a1-cpg-mssr" for the r8a774a1 SoC (RZ/G2M)
  22       - "renesas,r8a774b1-cpg-mssr" for the r8a774b1 SoC (RZ/G2N)
  23       - "renesas,r8a774c0-cpg-mssr" for the r8a774c0 SoC (RZ/G2E)
  24       - "renesas,r8a7790-cpg-mssr" for the r8a7790 SoC (R-Car H2)
  25       - "renesas,r8a7791-cpg-mssr" for the r8a7791 SoC (R-Car M2-W)
  26       - "renesas,r8a7792-cpg-mssr" for the r8a7792 SoC (R-Car V2H)
  27       - "renesas,r8a7793-cpg-mssr" for the r8a7793 SoC (R-Car M2-N)
  28       - "renesas,r8a7794-cpg-mssr" for the r8a7794 SoC (R-Car E2)
  29       - "renesas,r8a7795-cpg-mssr" for the r8a7795 SoC (R-Car H3)
  30       - "renesas,r8a7796-cpg-mssr" for the r8a77960 SoC (R-Car M3-W)
  31       - "renesas,r8a77961-cpg-mssr" for the r8a77961 SoC (R-Car M3-W+)
  32       - "renesas,r8a77965-cpg-mssr" for the r8a77965 SoC (R-Car M3-N)
  33       - "renesas,r8a77970-cpg-mssr" for the r8a77970 SoC (R-Car V3M)
  34       - "renesas,r8a77980-cpg-mssr" for the r8a77980 SoC (R-Car V3H)
  35       - "renesas,r8a77990-cpg-mssr" for the r8a77990 SoC (R-Car E3)
  36       - "renesas,r8a77995-cpg-mssr" for the r8a77995 SoC (R-Car D3)
  37
  38   - reg: Base address and length of the memory resource used by the CPG/MSSR
  39     block
  40
  41   - clocks: References to external parent clocks, one entry for each entry in
  42     clock-names
  43   - clock-names: List of external parent clock names. Valid names are:
  44       - "extal" (r7s9210, r8a7743, r8a7744, r8a7745, r8a77470, r8a774a1,
  45                  r8a774b1, r8a774c0, r8a7790, r8a7791, r8a7792, r8a7793,
  46                  r8a7794, r8a7795, r8a77960, r8a77961, r8a77965, r8a77970,
  47                  r8a77980, r8a77990, r8a77995)
  48       - "extalr" (r8a774a1, r8a774b1, r8a7795, r8a77960, r8a77961, r8a77965,
  49                   r8a77970, r8a77980)
  50       - "usb_extal" (r8a7743, r8a7744, r8a7745, r8a77470, r8a7790, r8a7791,
  51                      r8a7793, r8a7794)
  52
  53   - #clock-cells: Must be 2
  54       - For CPG core clocks, the two clock specifier cells must be "CPG_CORE"
  55         and a core clock reference, as defined in
  56         <dt-bindings/clock/*-cpg-mssr.h>.
  57       - For module clocks, the two clock specifier cells must be "CPG_MOD" and
  58         a module number, as defined in the datasheet.
  59
  60   - #power-domain-cells: Must be 0
  61       - SoC devices that are part of the CPG/MSSR Clock Domain and can be
  62         power-managed through Module Standby should refer to the CPG device
  63         node in their "power-domains" property, as documented by the generic PM
  64         Domain bindings in
  65         Documentation/devicetree/bindings/power/power-domain.yaml.
  66
  67   - #reset-cells: Must be 1
  68       - The single reset specifier cell must be the module number, as defined
  69         in the datasheet.
  70
  71
  72 Examples
  73 --------
  74
  75   - CPG device node:
  76
  77         cpg: clock-controller@e6150000 {
  78                 compatible = "renesas,r8a7795-cpg-mssr";
  79                 reg = <0 0xe6150000 0 0x1000>;
  80                 clocks = <&extal_clk>, <&extalr_clk>;
  81                 clock-names = "extal", "extalr";
  82                 #clock-cells = <2>;
  83                 #power-domain-cells = <0>;
  84                 #reset-cells = <1>;
  85         };
  86
  87
  88   - CPG/MSSR Clock Domain member device node:
  89
  90         scif2: serial@e6e88000 {
  91                 compatible = "renesas,scif-r8a7795", "renesas,scif";
  92                 reg = <0 0xe6e88000 0 64>;
  93                 interrupts = <GIC_SPI 164 IRQ_TYPE_LEVEL_HIGH>;
  94                 clocks = <&cpg CPG_MOD 310>;
  95                 clock-names = "fck";
  96                 dmas = <&dmac1 0x13>, <&dmac1 0x12>;
  97                 dma-names = "tx", "rx";
  98                 power-domains = <&cpg>;
  99                 resets = <&cpg 310>;
 100         };