[deliverable/linux.git] / Documentation / devicetree / bindings / memory-controllers / renesas-memory-controllers.txt

DT bindings for Renesas R-Mobile and SH-Mobile memory controllers
=================================================================

Renesas R-Mobile and SH-Mobile SoCs contain one or more memory controllers.
These memory controllers differ from one SoC variant to another, and are called
by different names ("DDR Bus Controller (DBSC)", "DDR3 Bus State Controller
(DBSC3)", "SDRAM Bus State Controller (SBSC)").

Currently memory controller device nodes are used only to reference PM
domains, and prevent these PM domains from being powered down, which would
crash the system.

As there exist no actual drivers for these controllers yet, these bindings
should be considered EXPERIMENTAL for now.

Required properties:
  - compatible: Must be one of the following SoC-specific values:
		  - "renesas,dbsc-r8a73a4" (R-Mobile APE6)
		  - "renesas,dbsc3-r8a7740" (R-Mobile A1)
		  - "renesas,sbsc-sh73a0" (SH-Mobile AG5)
  - reg: Must contain the base address and length of the memory controller's
	 registers.

Optional properties:
  - interrupts: Must contain a list of interrupt specifiers for memory
		controller interrupts, if available.
  - interrupt-names: Must contain a list of interrupt names corresponding to
		     the interrupts in the interrupts property, if available.
		     Valid interrupt names are:
			- "sec" (secure interrupt)
			- "temp" (normal (temperature) interrupt)
  - power-domains: Must contain a reference to the PM domain that the memory
		   controller belongs to, if available.

Example:

	sbsc1: memory-controller@fe400000 {
		compatible = "renesas,sbsc-sh73a0";
		reg = <0xfe400000 0x400>;
		interrupts = <0 35 IRQ_TYPE_LEVEL_HIGH>,
			     <0 36 IRQ_TYPE_LEVEL_HIGH>;
		interrupt-names = "sec", "temp";
		power-domains = <&pd_a4bc0>;
	};
Commit	Line	Data
753b9c9c GU	1	DT bindings for Renesas R-Mobile and SH-Mobile memory controllers
	2	=================================================================
	3
	4	Renesas R-Mobile and SH-Mobile SoCs contain one or more memory controllers.
	5	These memory controllers differ from one SoC variant to another, and are called
	6	by different names ("DDR Bus Controller (DBSC)", "DDR3 Bus State Controller
	7	(DBSC3)", "SDRAM Bus State Controller (SBSC)").
	8
	9	Currently memory controller device nodes are used only to reference PM
	10	domains, and prevent these PM domains from being powered down, which would
	11	crash the system.
	12
	13	As there exist no actual drivers for these controllers yet, these bindings
	14	should be considered EXPERIMENTAL for now.
	15
	16	Required properties:
	17	- compatible: Must be one of the following SoC-specific values:
	18	- "renesas,dbsc-r8a73a4" (R-Mobile APE6)
	19	- "renesas,dbsc3-r8a7740" (R-Mobile A1)
	20	- "renesas,sbsc-sh73a0" (SH-Mobile AG5)
	21	- reg: Must contain the base address and length of the memory controller's
	22	registers.
	23
	24	Optional properties:
	25	- interrupts: Must contain a list of interrupt specifiers for memory
	26	controller interrupts, if available.
e5cf79d9 LJ	27	- interrupt-names: Must contain a list of interrupt names corresponding to
	28	the interrupts in the interrupts property, if available.
	29	Valid interrupt names are:
753b9c9c GU	30	- "sec" (secure interrupt)
	31	- "temp" (normal (temperature) interrupt)
	32	- power-domains: Must contain a reference to the PM domain that the memory
	33	controller belongs to, if available.
	34
	35	Example:
	36
	37	sbsc1: memory-controller@fe400000 {
	38	compatible = "renesas,sbsc-sh73a0";
	39	reg = <0xfe400000 0x400>;
	40	interrupts = <0 35 IRQ_TYPE_LEVEL_HIGH>,
	41	<0 36 IRQ_TYPE_LEVEL_HIGH>;
	42	interrupt-names = "sec", "temp";
	43	power-domains = <&pd_a4bc0>;
	44	};