dt-bindings: Add TI SCI PM Domains

Add a generic power domain implementation, TI SCI PM Domains, that
will hook into the genpd framework and allow the TI SCI protocol to
control device power states.

Also, provide macros representing each device index as understood
by TI SCI to be used in the device node power-domain references.
These are identifiers for the K2G devices managed by the PMMC.

Acked-by: Santosh Shilimkar <ssantosh@kernel.org>
Reviewed-by: Ulf Hansson <ulf.hansson@linaro.org>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Nishanth Menon <nm@ti.com>
Signed-off-by: Dave Gerlach <d-gerlach@ti.com>
Signed-off-by: Santosh Shilimkar <ssantosh@kernel.org>

3 files changed, 149 insertions, 0 deletions

diff --git a/Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt b/Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
new file mode 100644
index 000000000000..c705db07d820
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
@@ -0,0 +1,57 @@
+Texas Instruments TI-SCI Generic Power Domain
+---------------------------------------------
+
+Some TI SoCs contain a system controller (like the PMMC, etc...) that is
+responsible for controlling the state of the IPs that are present.
+Communication between the host processor running an OS and the system
+controller happens through a protocol known as TI-SCI [1].
+
+[1] Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
+
+PM Domain Node
+==============
+The PM domain node represents the global PM domain managed by the PMMC, which
+in this case is the implementation as documented by the generic PM domain
+bindings in Documentation/devicetree/bindings/power/power_domain.txt.  Because
+this relies on the TI SCI protocol to communicate with the PMMC it must be a
+child of the pmmc node.
+
+Required Properties:
+--------------------
+- compatible: should be "ti,sci-pm-domain"
+- #power-domain-cells: Must be 1 so that an id can be provided in each
+                       device node.
+
+Example (K2G):
+-------------
+        pmmc: pmmc {
+                compatible = "ti,k2g-sci";
+                ...
+
+                k2g_pds: power-controller {
+                        compatible = "ti,sci-pm-domain";
+                        #power-domain-cells = <1>;
+                };
+        };
+
+PM Domain Consumers
+===================
+Hardware blocks belonging to a PM domain should contain a "power-domains"
+property that is a phandle pointing to the corresponding PM domain node
+along with an index representing the device id to be passed to the PMMC
+for device control.
+
+Required Properties:
+--------------------
+- power-domains: phandle pointing to the corresponding PM domain node
+                 and an ID representing the device.
+
+See dt-bindings/genpd/k2g.h for the list of valid identifiers for k2g.
+
+Example (K2G):
+--------------------
+        uart0: serial@02530c00 {
+                compatible = "ns16550a";
+                ...
+                power-domains = <&k2g_pds K2G_DEV_UART0>;
+        };
diff --git a/MAINTAINERS b/MAINTAINERS
index c776906f67a9..9057479ee607 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12382,6 +12382,8 @@ S:	Maintained
 F:      Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
 F:      drivers/firmware/ti_sci*
 F:      include/linux/soc/ti/ti_sci_protocol.h
+F:      Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+F:      include/dt-bindings/genpd/k2g.h
 
 THANKO'S RAREMONO AM/FM/SW RADIO RECEIVER USB DRIVER
 M:      Hans Verkuil <hverkuil@xs4all.nl>
diff --git a/include/dt-bindings/genpd/k2g.h b/include/dt-bindings/genpd/k2g.h
new file mode 100644
index 000000000000..fffdb604fc7d
--- /dev/null
+++ b/include/dt-bindings/genpd/k2g.h
@@ -0,0 +1,90 @@
+/*
+ * TI K2G SoC Device definitions
+ *
+ * Copyright (C) 2015-2017 Texas Instruments Incorporated - https://urldefense.proofpoint.com/v2/url?u=http-3A__www.ti.com_&d=DwIBAg&c=RoP1YumCXCgaWHvlZYR8PQcxBKCX5YTpkKY057SbK10&r=XBn1JQGPwR8CsE7xpP3wPlG6DQU7qw8ym65xieNZ4hY&m=K-anSnBVCpVU_mSaI7FWz6dwIAPBePhk6w9rCref6SI&s=UvxGRJAJRKjDVjwUuXloC2gH4uWNkMelLuW2oG01DPM&e=
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#ifndef _DT_BINDINGS_GENPD_K2G_H
+#define _DT_BINDINGS_GENPD_K2G_H
+
+/* Documented in https://urldefense.proofpoint.com/v2/url?u=http-3A__processors.wiki.ti.com_index.php_TISCI&d=DwIBAg&c=RoP1YumCXCgaWHvlZYR8PQcxBKCX5YTpkKY057SbK10&r=XBn1JQGPwR8CsE7xpP3wPlG6DQU7qw8ym65xieNZ4hY&m=K-anSnBVCpVU_mSaI7FWz6dwIAPBePhk6w9rCref6SI&s=OUR-PBKiUWN0Bhs-J9hzlER8kpqh_V70s09xc8Zo1iA&e=  */
+
+#define K2G_DEV_PMMC0                   0x0000
+#define K2G_DEV_MLB0                    0x0001
+#define K2G_DEV_DSS0                    0x0002
+#define K2G_DEV_MCBSP0                  0x0003
+#define K2G_DEV_MCASP0                  0x0004
+#define K2G_DEV_MCASP1                  0x0005
+#define K2G_DEV_MCASP2                  0x0006
+#define K2G_DEV_DCAN0                   0x0008
+#define K2G_DEV_DCAN1                   0x0009
+#define K2G_DEV_EMIF0                   0x000a
+#define K2G_DEV_MMCHS0                  0x000b
+#define K2G_DEV_MMCHS1                  0x000c
+#define K2G_DEV_GPMC0                   0x000d
+#define K2G_DEV_ELM0                    0x000e
+#define K2G_DEV_SPI0                    0x0010
+#define K2G_DEV_SPI1                    0x0011
+#define K2G_DEV_SPI2                    0x0012
+#define K2G_DEV_SPI3                    0x0013
+#define K2G_DEV_ICSS0                   0x0014
+#define K2G_DEV_ICSS1                   0x0015
+#define K2G_DEV_USB0                    0x0016
+#define K2G_DEV_USB1                    0x0017
+#define K2G_DEV_NSS0                    0x0018
+#define K2G_DEV_PCIE0                   0x0019
+#define K2G_DEV_GPIO0                   0x001b
+#define K2G_DEV_GPIO1                   0x001c
+#define K2G_DEV_TIMER64_0               0x001d
+#define K2G_DEV_TIMER64_1               0x001e
+#define K2G_DEV_TIMER64_2               0x001f
+#define K2G_DEV_TIMER64_3               0x0020
+#define K2G_DEV_TIMER64_4               0x0021
+#define K2G_DEV_TIMER64_5               0x0022
+#define K2G_DEV_TIMER64_6               0x0023
+#define K2G_DEV_MSGMGR0                 0x0025
+#define K2G_DEV_BOOTCFG0                0x0026
+#define K2G_DEV_ARM_BOOTROM0            0x0027
+#define K2G_DEV_DSP_BOOTROM0            0x0029
+#define K2G_DEV_DEBUGSS0                0x002b
+#define K2G_DEV_UART0                   0x002c
+#define K2G_DEV_UART1                   0x002d
+#define K2G_DEV_UART2                   0x002e
+#define K2G_DEV_EHRPWM0                 0x002f
+#define K2G_DEV_EHRPWM1                 0x0030
+#define K2G_DEV_EHRPWM2                 0x0031
+#define K2G_DEV_EHRPWM3                 0x0032
+#define K2G_DEV_EHRPWM4                 0x0033
+#define K2G_DEV_EHRPWM5                 0x0034
+#define K2G_DEV_EQEP0                   0x0035
+#define K2G_DEV_EQEP1                   0x0036
+#define K2G_DEV_EQEP2                   0x0037
+#define K2G_DEV_ECAP0                   0x0038
+#define K2G_DEV_ECAP1                   0x0039
+#define K2G_DEV_I2C0                    0x003a
+#define K2G_DEV_I2C1                    0x003b
+#define K2G_DEV_I2C2                    0x003c
+#define K2G_DEV_EDMA0                   0x003f
+#define K2G_DEV_SEMAPHORE0              0x0040
+#define K2G_DEV_INTC0                   0x0041
+#define K2G_DEV_GIC0                    0x0042
+#define K2G_DEV_QSPI0                   0x0043
+#define K2G_DEV_ARM_64B_COUNTER0        0x0044
+#define K2G_DEV_TETRIS0                 0x0045
+#define K2G_DEV_CGEM0                   0x0046
+#define K2G_DEV_MSMC0                   0x0047
+#define K2G_DEV_CBASS0                  0x0049
+#define K2G_DEV_BOARD0                  0x004c
+#define K2G_DEV_EDMA1                   0x004f
+
+#endif