Merge tag 'berlin-dt-4.2-1' of git://git.infradead.org/users/hesselba/linux-berlin into next/dt

Marvell Berlin SoC Family Device Tree Bindings

---------------------------------------------------------------

Work in progress statement:

Device tree files and bindings applying to Marvell Berlin SoCs and boards are

considered "unstable". Any Marvell Berlin device tree binding may change at any

time. Be sure to use a device tree binary and a kernel image generated from the

same source tree.

Please refer to Documentation/devicetree/bindings/ABI.txt for a definition of a

stable binding/ABI.

---------------------------------------------------------------

Boards with a SoC of the Marvell Berlin family, e.g. Armada 1500

shall have the following properties:

different functions which are described below.

Required properties:

- compatible: shall be one of

	"marvell,berlin2-chip-ctrl" for BG2

	"marvell,berlin2cd-chip-ctrl" for BG2CD

	"marvell,berlin2q-chip-ctrl" for BG2Q

- compatible:

	* the first and second values must be:

		"simple-mfd", "syscon"

- reg: address and length of following register sets for

  BG2/BG2CD: chip control register set

  BG2Q: chip control register set and cpu pll registers

individual registers dealing with pinmux, padmux, and reset.

Required properties:

- compatible: should be one of

	"marvell,berlin2-system-ctrl" for BG2

	"marvell,berlin2cd-system-ctrl" for BG2CD

	"marvell,berlin2q-system-ctrl" for BG2Q

- compatible:

	* the first and second values must be:

		"simple-mfd", "syscon"

- reg: address and length of the system control register set

* Clock provider binding

As clock related registers are spread among the chip control registers, the

chip control node also provides the clocks. Marvell Berlin2 (BG2, BG2CD, BG2Q)

SoCs share the same IP for PLLs and clocks, with some minor differences in

features and register layout.

Required properties:

- #clock-cells: shall be set to 1

- clocks: clock specifiers referencing the core clock input clocks

- clock-names: array of strings describing the input clock specifiers above.

    Allowed clock-names for the reference clocks are

      "refclk" for the SoCs osciallator input on all SoCs,

    and SoC-specific input clocks for

      BG2/BG2CD: "video_ext0" for the external video clock input

Clocks provided by core clocks shall be referenced by a clock specifier

indexing one of the provided clocks. Refer to dt-bindings/clock/berlin<soc>.h

for the corresponding index mapping.

* Pin controller binding

Pin control registers are part of both register sets, chip control and system

control. The pins controlled are organized in groups, so no actual pin

information is needed.

A pin-controller node should contain subnodes representing the pin group

configurations, one per function. Each subnode has the group name and the muxing

function used.

Be aware the Marvell Berlin datasheets use the keyword 'mode' for what is called

a 'function' in the pin-controller subsystem.

Required subnode-properties:

- groups: a list of strings describing the group names.

- function: a string describing the function used to mux the groups.

* Reset controller binding

A reset controller is part of the chip control registers set. The chip control

node also provides the reset. The register set is not at the same offset between

Berlin SoCs.

Required property:

- #reset-cells: must be set to 2

Example:

chip: chip-control@ea0000 {

	compatible = "marvell,berlin2-chip-ctrl";

	#clock-cells = <1>;

	#reset-cells = <2>;

	compatible = "simple-mfd", "syscon";

	reg = <0xea0000 0x400>;

	clocks = <&refclk>, <&externaldev 0>;

	clock-names = "refclk", "video_ext0";

	spi1_pmux: spi1-pmux {

		groups = "G0";

		function = "spi1";

	};

	/* sub-device nodes */

};

sysctrl: system-controller@d000 {

	compatible = "marvell,berlin2-system-ctrl";

	compatible = "simple-mfd", "syscon";

	reg = <0xd000 0x100>;

	uart0_pmux: uart0-pmux {

		groups = "GSM4";

		function = "uart0";

	};

	uart1_pmux: uart1-pmux {

		groups = "GSM5";

		function = "uart1";

	};

	uart2_pmux: uart2-pmux {

		groups = "GSM3";

		function = "uart2";

	};

	/* sub-device nodes */

};

Device Tree Clock bindings for Marvell Berlin

This binding uses the common clock binding[1].

[1] Documentation/devicetree/bindings/clock/clock-bindings.txt

Clock related registers are spread among the chip control registers. Berlin

clock node should be a sub-node of the chip controller node. Marvell Berlin2

(BG2, BG2CD, BG2Q) SoCs share the same IP for PLLs and clocks, with some

minor differences in features and register layout.

Required properties:

- compatible: must be "marvell,berlin2-clk" or "marvell,berlin2q-clk"

- #clock-cells: must be 1

- clocks: must be the input parent clock phandle

- clock-names: name of the input parent clock

	Allowed clock-names for the reference clocks are

	"refclk" for the SoCs oscillator input on all SoCs,

	and SoC-specific input clocks for

	BG2/BG2CD: "video_ext0" for the external video clock input

Example:

chip_clk: clock {

	compatible = "marvell,berlin2q-clk";

	#clock-cells = <1>;

	clocks = <&refclk>;

	clock-names = "refclk";

};

* Pin-controller driver for the Marvell Berlin SoCs

Pin control registers are part of both chip controller and system

controller register sets. Pin controller nodes should be a sub-node of

either the chip controller or system controller node. The pins

controlled are organized in groups, so no actual pin information is

needed.

A pin-controller node should contain subnodes representing the pin group

configurations, one per function. Each subnode has the group name and

the muxing function used.

Be aware the Marvell Berlin datasheets use the keyword 'mode' for what

is called a 'function' in the pin-controller subsystem.

Required properties:

- compatible: should be one of:

	"marvell,berlin2-soc-pinctrl",

	"marvell,berlin2-system-pinctrl",

	"marvell,berlin2cd-soc-pinctrl",

	"marvell,berlin2cd-system-pinctrl",

	"marvell,berlin2q-soc-pinctrl",

	"marvell,berlin2q-system-pinctrl"

Required subnode-properties:

- groups: a list of strings describing the group names.

- function: a string describing the function used to mux the groups.

Example:

sys_pinctrl: pin-controller {

	compatible = "marvell,berlin2q-system-pinctrl";

	uart0_pmux: uart0-pmux {

		groups = "GSM12";

		function = "uart0";

	};

};

&uart0 {

	pinctrl-0 = <&uart0_pmux>;

	pinctrl-names = "default";

};

Marvell Berlin reset controller

===============================

Please also refer to reset.txt in this directory for common reset

controller binding usage.

The reset controller node must be a sub-node of the chip controller

node on Berlin SoCs.

Required properties:

- compatible: should be "marvell,berlin2-reset"

- #reset-cells: must be set to 2

Example:

chip_rst: reset {

	compatible = "marvell,berlin2-reset";

	#reset-cells = <2>;

};

&usb_phy0 {

	resets = <&chip_rst 0x104 12>;

};

 *

 * Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com>

 *

 * This file is licensed under the terms of the GNU General Public

 * This file is dual-licensed: you can use it either under the terms

 * of the GPL or the X11 license, at your option. Note that this dual

 * licensing only applies to this file, and not this project as a

 * whole.

 *

 *  a) This file is licensed under the terms of the GNU General Public

 *     License version 2. This program is licensed "as is" without any

 *     warranty of any kind, whether express or implied.

 *

 * Or, alternatively,

 *

 *  b) Permission is hereby granted, free of charge, to any person

 *     obtaining a copy of this software and associated documentation

 *     files (the "Software"), to deal in the Software without

 *     restriction, including without limitation the rights to use,

 *     copy, modify, merge, publish, distribute, sublicense, and/or

 *     sell copies of the Software, and to permit persons to whom the

 *     Software is furnished to do so, subject to the following

 *     conditions:

 *

 *     The above copyright notice and this permission notice shall be

 *     included in all copies or substantial portions of the Software.

 *

 *     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 *     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 *     OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 *     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 *     HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 *     WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 *     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 *     OTHER DEALINGS IN THE SOFTWARE.

 */

/dts-v1/;