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

   1 * Gated Clock bindings for Marvell EBU SoCs
   2
   3 Marvell Armada 370/XP, Dove and Kirkwood allow some peripheral clocks to be
   4 gated to save some power. The clock consumer should specify the desired clock
   5 by having the clock ID in its "clocks" phandle cell. The clock ID is directly
   6 mapped to the corresponding clock gating control bit in HW to ease manual clock
   7 lookup in datasheet.
   8
   9 The following is a list of provided IDs for Armada 370:
  10 ID      Clock   Peripheral
  11 -----------------------------------
  12 0       Audio   AC97 Cntrl
  13 1       pex0_en PCIe 0 Clock out
  14 2       pex1_en PCIe 1 Clock out
  15 3       ge1     Gigabit Ethernet 1
  16 4       ge0     Gigabit Ethernet 0
  17 5       pex0    PCIe Cntrl 0
  18 9       pex1    PCIe Cntrl 1
  19 15      sata0   SATA Host 0
  20 17      sdio    SDHCI Host
  21 25      tdm     Time Division Mplx
  22 28      ddr     DDR Cntrl
  23 30      sata1   SATA Host 0
  24
  25 The following is a list of provided IDs for Armada XP:
  26 ID      Clock   Peripheral
  27 -----------------------------------
  28 0       audio   Audio Cntrl
  29 1       ge3     Gigabit Ethernet 3
  30 2       ge2     Gigabit Ethernet 2
  31 3       ge1     Gigabit Ethernet 1
  32 4       ge0     Gigabit Ethernet 0
  33 5       pex0    PCIe Cntrl 0
  34 6       pex1    PCIe Cntrl 1
  35 7       pex2    PCIe Cntrl 2
  36 8       pex3    PCIe Cntrl 3
  37 13      bp
  38 14      sata0lnk
  39 15      sata0   SATA Host 0
  40 16      lcd     LCD Cntrl
  41 17      sdio    SDHCI Host
  42 18      usb0    USB Host 0
  43 19      usb1    USB Host 1
  44 20      usb2    USB Host 2
  45 22      xor0    XOR DMA 0
  46 23      crypto  CESA engine
  47 25      tdm     Time Division Mplx
  48 28      xor1    XOR DMA 1
  49 29      sata1lnk
  50 30      sata1   SATA Host 0
  51
  52 The following is a list of provided IDs for Dove:
  53 ID      Clock   Peripheral
  54 -----------------------------------
  55 0       usb0    USB Host 0
  56 1       usb1    USB Host 1
  57 2       ge      Gigabit Ethernet
  58 3       sata    SATA Host
  59 4       pex0    PCIe Cntrl 0
  60 5       pex1    PCIe Cntrl 1
  61 8       sdio0   SDHCI Host 0
  62 9       sdio1   SDHCI Host 1
  63 10      nand    NAND Cntrl
  64 11      camera  Camera Cntrl
  65 12      i2s0    I2S Cntrl 0
  66 13      i2s1    I2S Cntrl 1
  67 15      crypto  CESA engine
  68 21      ac97    AC97 Cntrl
  69 22      pdma    Peripheral DMA
  70 23      xor0    XOR DMA 0
  71 24      xor1    XOR DMA 1
  72 30      gephy   Gigabit Ethernel PHY
  73 Note: gephy(30) is implemented as a parent clock of ge(2)
  74
  75 The following is a list of provided IDs for Kirkwood:
  76 ID      Clock   Peripheral
  77 -----------------------------------
  78 0       ge0     Gigabit Ethernet 0
  79 2       pex0    PCIe Cntrl 0
  80 3       usb0    USB Host 0
  81 4       sdio    SDIO Cntrl
  82 5       tsu     Transp. Stream Unit
  83 6       dunit   SDRAM Cntrl
  84 7       runit   Runit
  85 8       xor0    XOR DMA 0
  86 9       audio   I2S Cntrl 0
  87 14      sata0   SATA Host 0
  88 15      sata1   SATA Host 1
  89 16      xor1    XOR DMA 1
  90 17      crypto  CESA engine
  91 18      pex1    PCIe Cntrl 1
  92 19      ge1     Gigabit Ethernet 1
  93 20      tdm     Time Division Mplx
  94
  95 Required properties:
  96 - compatible : shall be one of the following:
  97         "marvell,armada-370-gating-clock" - for Armada 370 SoC clock gating
  98         "marvell,armada-xp-gating-clock" - for Armada XP SoC clock gating
  99         "marvell,dove-gating-clock" - for Dove SoC clock gating
 100         "marvell,kirkwood-gating-clock" - for Kirkwood SoC clock gating
 101 - reg : shall be the register address of the Clock Gating Control register
 102 - #clock-cells : from common clock binding; shall be set to 1
 103
 104 Optional properties:
 105 - clocks : default parent clock phandle (e.g. tclk)
 106
 107 Example:
 108
 109 gate_clk: clock-gating-control@d0038 {
 110         compatible = "marvell,dove-gating-clock";
 111         reg = <0xd0038 0x4>;
 112         /* default parent clock is tclk */
 113         clocks = <&core_clk 0>;
 114         #clock-cells = <1>;
 115 };
 116
 117 sdio0: sdio@92000 {
 118         compatible = "marvell,dove-sdhci";
 119         /* get clk gate bit 8 (sdio0) */
 120         clocks = <&gate_clk 8>;
 121 };