Documentation/devicetree/bindings/arm/marvell/ap806-system-controller.txt

   1 Marvell Armada AP806 System Controller
   2 ======================================
   3
   4 The AP806 is one of the two core HW blocks of the Marvell Armada 7K/8K
   5 SoCs. It contains system controllers, which provide several registers
   6 giving access to numerous features: clocks, pin-muxing and many other
   7 SoC configuration items. This DT binding allows to describe these
   8 system controllers.
   9
  10 For the top level node:
  11  - compatible: must be: "syscon", "simple-mfd";
  12  - reg: register area of the AP806 system controller
  13
  14 SYSTEM CONTROLLER 0
  15 ===================
  16
  17 Clocks:
  18 -------
  19
  20
  21 The Device Tree node representing the AP806 system controller provides
  22 a number of clocks:
  23
  24  - 0: reference clock of CPU cluster 0
  25  - 1: reference clock of CPU cluster 1
  26  - 2: fixed PLL at 1200 Mhz
  27  - 3: MSS clock, derived from the fixed PLL
  28
  29 Required properties:
  30
  31  - compatible: must be: "marvell,ap806-clock"
  32  - #clock-cells: must be set to 1
  33
  34 Pinctrl:
  35 --------
  36
  37 For common binding part and usage, refer to
  38 Documentation/devicetree/bindings/pinctrl/marvell,mvebu-pinctrl.txt.
  39
  40 Required properties:
  41 - compatible must be "marvell,ap806-pinctrl",
  42
  43 Available mpp pins/groups and functions:
  44 Note: brackets (x) are not part of the mpp name for marvell,function and given
  45 only for more detailed description in this document.
  46
  47 name    pins    functions
  48 ================================================================================
  49 mpp0    0       gpio, sdio(clk), spi0(clk)
  50 mpp1    1       gpio, sdio(cmd), spi0(miso)
  51 mpp2    2       gpio, sdio(d0), spi0(mosi)
  52 mpp3    3       gpio, sdio(d1), spi0(cs0n)
  53 mpp4    4       gpio, sdio(d2), i2c0(sda)
  54 mpp5    5       gpio, sdio(d3), i2c0(sdk)
  55 mpp6    6       gpio, sdio(ds)
  56 mpp7    7       gpio, sdio(d4), uart1(rxd)
  57 mpp8    8       gpio, sdio(d5), uart1(txd)
  58 mpp9    9       gpio, sdio(d6), spi0(cs1n)
  59 mpp10   10      gpio, sdio(d7)
  60 mpp11   11      gpio, uart0(txd)
  61 mpp12   12      gpio, sdio(pw_off), sdio(hw_rst)
  62 mpp13   13      gpio
  63 mpp14   14      gpio
  64 mpp15   15      gpio
  65 mpp16   16      gpio
  66 mpp17   17      gpio
  67 mpp18   18      gpio
  68 mpp19   19      gpio, uart0(rxd), sdio(pw_off)
  69
  70 GPIO:
  71 -----
  72 For common binding part and usage, refer to
  73 Documentation/devicetree/bindings/gpio/gpio-mvebu.txt.
  74
  75 Required properties:
  76
  77 - compatible: "marvell,armada-8k-gpio"
  78
  79 - offset: offset address inside the syscon block
  80
  81 Example:
  82 ap_syscon: system-controller@6f4000 {
  83         compatible = "syscon", "simple-mfd";
  84         reg = <0x6f4000 0x1000>;
  85
  86         ap_clk: clock {
  87                 compatible = "marvell,ap806-clock";
  88                 #clock-cells = <1>;
  89         };
  90
  91         ap_pinctrl: pinctrl {
  92                 compatible = "marvell,ap806-pinctrl";
  93         };
  94
  95         ap_gpio: gpio {
  96                 compatible = "marvell,armada-8k-gpio";
  97                 offset = <0x1040>;
  98                 ngpios = <19>;
  99                 gpio-controller;
 100                 #gpio-cells = <2>;
 101                 gpio-ranges = <&ap_pinctrl 0 0 19>;
 102         };
 103 };
 104
 105 SYSTEM CONTROLLER 1
 106 ===================
 107
 108 Thermal:
 109 --------
 110
 111 For common binding part and usage, refer to
 112 Documentation/devicetree/bindings/thermal/thermal.txt
 113
 114 The thermal IP can probe the temperature all around the processor. It
 115 may feature several channels, each of them wired to one sensor.
 116
 117 It is possible to setup an overheat interrupt by giving at least one
 118 critical point to any subnode of the thermal-zone node.
 119
 120 Required properties:
 121 - compatible: must be one of:
 122   * marvell,armada-ap806-thermal
 123 - reg: register range associated with the thermal functions.
 124
 125 Optional properties:
 126 - interrupts: overheat interrupt handle. Should point to line 18 of the
 127   SEI irqchip. See interrupt-controller/interrupts.txt
 128 - #thermal-sensor-cells: shall be <1> when thermal-zones subnodes refer
 129   to this IP and represents the channel ID. There is one sensor per
 130   channel. O refers to the thermal IP internal channel, while positive
 131   IDs refer to each CPU.
 132
 133 Example:
 134 ap_syscon1: system-controller@6f8000 {
 135         compatible = "syscon", "simple-mfd";
 136         reg = <0x6f8000 0x1000>;
 137
 138         ap_thermal: thermal-sensor@80 {
 139                 compatible = "marvell,armada-ap806-thermal";
 140                 reg = <0x80 0x10>;
 141                 interrupt-parent = <&sei>;
 142                 interrupts = <18>;
 143                 #thermal-sensor-cells = <1>;
 144         };
 145 };
 146
 147 Cluster clocks:
 148 ---------------
 149
 150 Device Tree Clock bindings for cluster clock of Marvell
 151 AP806/AP807. Each cluster contain up to 2 CPUs running at the same
 152 frequency.
 153
 154 Required properties:
 155  - compatible: must be one of:
 156    * "marvell,ap806-cpu-clock"
 157    * "marvell,ap807-cpu-clock"
 158 - #clock-cells : should be set to 1.
 159
 160 - clocks : shall be the input parent clock(s) phandle for the clock
 161            (one per cluster)
 162
 163 - reg: register range associated with the cluster clocks
 164
 165 ap_syscon1: system-controller@6f8000 {
 166         compatible = "marvell,armada-ap806-syscon1", "syscon", "simple-mfd";
 167         reg = <0x6f8000 0x1000>;
 168
 169         cpu_clk: clock-cpu@278 {
 170                 compatible = "marvell,ap806-cpu-clock";
 171                 clocks = <&ap_clk 0>, <&ap_clk 1>;
 172                 #clock-cells = <1>;
 173                 reg = <0x278 0xa30>;
 174         };
 175 };