Documentation/devicetree/bindings/clock/mvebu-gated-clock.txt

   1 * Gated Clock bindings for Marvell EBU SoCs
   2
   3 Marvell Armada 370/375/380/385/39x/XP, Dove and Kirkwood allow some
   4 peripheral clocks to be gated to save some power. The clock consumer
   5 should specify the desired clock by having the clock ID in its
   6 "clocks" phandle cell. The clock ID is directly mapped to the
   7 corresponding clock gating control bit in HW to ease manual clock
   8 lookup in datasheet.
   9
  10 The following is a list of provided IDs for Armada 370:
  11 ID      Clock   Peripheral
  12 -----------------------------------
  13 0       Audio   AC97 Cntrl
  14 1       pex0_en PCIe 0 Clock out
  15 2       pex1_en PCIe 1 Clock out
  16 3       ge1     Gigabit Ethernet 1
  17 4       ge0     Gigabit Ethernet 0
  18 5       pex0    PCIe Cntrl 0
  19 9       pex1    PCIe Cntrl 1
  20 15      sata0   SATA Host 0
  21 17      sdio    SDHCI Host
  22 23      crypto  CESA (crypto engine)
  23 25      tdm     Time Division Mplx
  24 28      ddr     DDR Cntrl
  25 30      sata1   SATA Host 0
  26
  27 The following is a list of provided IDs for Armada 375:
  28 ID      Clock           Peripheral
  29 -----------------------------------
  30 2       mu              Management Unit
  31 3       pp              Packet Processor
  32 4       ptp             PTP
  33 5       pex0            PCIe 0 Clock out
  34 6       pex1            PCIe 1 Clock out
  35 8       audio           Audio Cntrl
  36 11      nd_clk          Nand Flash Cntrl
  37 14      sata0_link      SATA 0 Link
  38 15      sata0_core      SATA 0 Core
  39 16      usb3            USB3 Host
  40 17      sdio            SDHCI Host
  41 18      usb             USB Host
  42 19      gop             Gigabit Ethernet MAC
  43 20      sata1_link      SATA 1 Link
  44 21      sata1_core      SATA 1 Core
  45 22      xor0            XOR DMA 0
  46 23      xor1            XOR DMA 0
  47 24      copro           Coprocessor
  48 25      tdm             Time Division Mplx
  49 28      crypto0_enc     Cryptographic Unit Port 0 Encryption
  50 29      crypto0_core    Cryptographic Unit Port 0 Core
  51 30      crypto1_enc     Cryptographic Unit Port 1 Encryption
  52 31      crypto1_core    Cryptographic Unit Port 1 Core
  53
  54 The following is a list of provided IDs for Armada 380/385:
  55 ID      Clock           Peripheral
  56 -----------------------------------
  57 0       audio           Audio
  58 2       ge2             Gigabit Ethernet 2
  59 3       ge1             Gigabit Ethernet 1
  60 4       ge0             Gigabit Ethernet 0
  61 5       pex1            PCIe 1
  62 6       pex2            PCIe 2
  63 7       pex3            PCIe 3
  64 8       pex0            PCIe 0
  65 9       usb3h0          USB3 Host 0
  66 10      usb3h1          USB3 Host 1
  67 11      usb3d           USB3 Device
  68 13      bm              Buffer Management
  69 14      crypto0z        Cryptographic 0 Z
  70 15      sata0           SATA 0
  71 16      crypto1z        Cryptographic 1 Z
  72 17      sdio            SDIO
  73 18      usb2            USB 2
  74 21      crypto1         Cryptographic 1
  75 22      xor0            XOR 0
  76 23      crypto0         Cryptographic 0
  77 25      tdm             Time Division Multiplexing
  78 28      xor1            XOR 1
  79 30      sata1           SATA 1
  80
  81 The following is a list of provided IDs for Armada 39x:
  82 ID      Clock           Peripheral
  83 -----------------------------------
  84 5       pex1            PCIe 1
  85 6       pex2            PCIe 2
  86 7       pex3            PCIe 3
  87 8       pex0            PCIe 0
  88 9       usb3h0          USB3 Host 0
  89 17      sdio            SDIO
  90 22      xor0            XOR 0
  91 28      xor1            XOR 1
  92
  93 The following is a list of provided IDs for Armada XP:
  94 ID      Clock   Peripheral
  95 -----------------------------------
  96 0       audio   Audio Cntrl
  97 1       ge3     Gigabit Ethernet 3
  98 2       ge2     Gigabit Ethernet 2
  99 3       ge1     Gigabit Ethernet 1
 100 4       ge0     Gigabit Ethernet 0
 101 5       pex0    PCIe Cntrl 0
 102 6       pex1    PCIe Cntrl 1
 103 7       pex2    PCIe Cntrl 2
 104 8       pex3    PCIe Cntrl 3
 105 13      bp
 106 14      sata0lnk
 107 15      sata0   SATA Host 0
 108 16      lcd     LCD Cntrl
 109 17      sdio    SDHCI Host
 110 18      usb0    USB Host 0
 111 19      usb1    USB Host 1
 112 20      usb2    USB Host 2
 113 22      xor0    XOR DMA 0
 114 23      crypto  CESA engine
 115 25      tdm     Time Division Mplx
 116 28      xor1    XOR DMA 1
 117 29      sata1lnk
 118 30      sata1   SATA Host 0
 119
 120 The following is a list of provided IDs for Dove:
 121 ID      Clock   Peripheral
 122 -----------------------------------
 123 0       usb0    USB Host 0
 124 1       usb1    USB Host 1
 125 2       ge      Gigabit Ethernet
 126 3       sata    SATA Host
 127 4       pex0    PCIe Cntrl 0
 128 5       pex1    PCIe Cntrl 1
 129 8       sdio0   SDHCI Host 0
 130 9       sdio1   SDHCI Host 1
 131 10      nand    NAND Cntrl
 132 11      camera  Camera Cntrl
 133 12      i2s0    I2S Cntrl 0
 134 13      i2s1    I2S Cntrl 1
 135 15      crypto  CESA engine
 136 21      ac97    AC97 Cntrl
 137 22      pdma    Peripheral DMA
 138 23      xor0    XOR DMA 0
 139 24      xor1    XOR DMA 1
 140 30      gephy   Gigabit Ethernel PHY
 141 Note: gephy(30) is implemented as a parent clock of ge(2)
 142
 143 The following is a list of provided IDs for Kirkwood:
 144 ID      Clock   Peripheral
 145 -----------------------------------
 146 0       ge0     Gigabit Ethernet 0
 147 2       pex0    PCIe Cntrl 0
 148 3       usb0    USB Host 0
 149 4       sdio    SDIO Cntrl
 150 5       tsu     Transp. Stream Unit
 151 6       dunit   SDRAM Cntrl
 152 7       runit   Runit
 153 8       xor0    XOR DMA 0
 154 9       audio   I2S Cntrl 0
 155 14      sata0   SATA Host 0
 156 15      sata1   SATA Host 1
 157 16      xor1    XOR DMA 1
 158 17      crypto  CESA engine
 159 18      pex1    PCIe Cntrl 1
 160 19      ge1     Gigabit Ethernet 1
 161 20      tdm     Time Division Mplx
 162
 163 Required properties:
 164 - compatible : shall be one of the following:
 165         "marvell,armada-370-gating-clock" - for Armada 370 SoC clock gating
 166         "marvell,armada-375-gating-clock" - for Armada 375 SoC clock gating
 167         "marvell,armada-380-gating-clock" - for Armada 380/385 SoC clock gating
 168         "marvell,armada-390-gating-clock" - for Armada 39x SoC clock gating
 169         "marvell,armada-xp-gating-clock" - for Armada XP SoC clock gating
 170         "marvell,dove-gating-clock" - for Dove SoC clock gating
 171         "marvell,kirkwood-gating-clock" - for Kirkwood SoC clock gating
 172 - reg : shall be the register address of the Clock Gating Control register
 173 - #clock-cells : from common clock binding; shall be set to 1
 174
 175 Optional properties:
 176 - clocks : default parent clock phandle (e.g. tclk)
 177
 178 Example:
 179
 180 gate_clk: clock-gating-control@d0038 {
 181         compatible = "marvell,dove-gating-clock";
 182         reg = <0xd0038 0x4>;
 183         /* default parent clock is tclk */
 184         clocks = <&core_clk 0>;
 185         #clock-cells = <1>;
 186 };
 187
 188 sdio0: sdio@92000 {
 189         compatible = "marvell,dove-sdhci";
 190         /* get clk gate bit 8 (sdio0) */
 191         clocks = <&gate_clk 8>;
 192 };