From:   Vladimir Oltean <vladimir.oltean@nxp.com>
To:     devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org
Cc:     Marc Zyngier <maz@kernel.org>, Rob Herring <robh+dt@kernel.org>,
        Shawn Guo <shawnguo@kernel.org>, Li Yang <leoyang.li@nxp.com>,
        Biwen Li <biwen.li@nxp.com>,
        Zhiqiang Hou <Zhiqiang.Hou@nxp.com>,
        Kurt Kanzenbach <kurt@linutronix.de>,
        Rasmus Villemoes <linux@rasmusvillemoes.dk>
Subject: [RFC PATCH devicetree 03/10] dt-bindings: ls-extirq: replace "interrupt-map" documentation with "fsl,extirq-map"
Date:   Tue, 14 Dec 2021 03:37:53 +0200
Message-Id: <20211214013800.2703568-4-vladimir.oltean@nxp.com>
In-Reply-To: <20211214013800.2703568-1-vladimir.oltean@nxp.com>
References: <20211214013800.2703568-1-vladimir.oltean@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?1FnIGeNuh6/Myrd3e5VkJxY/dv2YvQ+veP6lU4xTPw1XYRXwi8xJf8rxA2+s?=
 =?us-ascii?Q?M5jfvdqi1hi2hZIiBl8lSBMOGqKBkgStoK+LjEwSyVYfiiQ1NEYeNac6vVFk?=
 =?us-ascii?Q?MRsGsS0MQsa3iopHOXg6RzqJD7X6QFP/JwsrWAALQBcXc/NjIJU9rFnWzVen?=
 =?us-ascii?Q?/l/2Wduhp8HzY8LBLuCDRHEhjlGKC+TxGcC9+iT9L9nCf3H8DO2ePhjb7+Kk?=
 =?us-ascii?Q?kzaWMa26Uzghrw1azLfUSYDVO8nwVrRj1axlEkj4mbT5DkS1pc9byzPmoT/+?=
 =?us-ascii?Q?BPBc0WCqmb3VQHTz0TtRUt9PWxbCDjeQ+5OJb2H2QU0+KVbMVqov4SJ63SmY?=
 =?us-ascii?Q?k8u8eKkGVWITbVndPu7iU9Q2llk4DT+NipBGFIybIU/Typ6/dgq1cqU5mqFV?=
 =?us-ascii?Q?nlPQ1OwOVKKEOqP+2y1zAWz4HQet3fHU5duyC+fwY8iPPHiY3g87W0jzMNpd?=
 =?us-ascii?Q?SB7B+MXqFeU3OJ/jmeAGZhUjx8yRk+0VTzj/0g5JxYopWZ50GI6hiBWf5bBi?=
 =?us-ascii?Q?VCwIs9PdEbVawVnewJXSa7SG47F00vlngog8AKeslPZsd7rWIwkmQmx6Unng?=
 =?us-ascii?Q?fxgETbaLrsugWIcz/7hS2BxvsnRIZKNYm5w0tXnsfIoWcVldXEfQxMjdbLJt?=
 =?us-ascii?Q?alKZB6/QaCihzNijHeH1D/9gHYUhbr0/d/zyXLUaueUch/duF68Fx8K8gYPn?=
 =?us-ascii?Q?wTy2P47CS3j/k351ilpJ6nIGr/PYuFaN1jKuJRuEi7/6WRPFBEIvUs5pKROb?=
 =?us-ascii?Q?QK617p+roEfRgPDf977L8G5YhqITo1+dULbwZOixvVLLjm/dPd4XtO2jYPAQ?=
 =?us-ascii?Q?H5jhm34t936n496BC2gnVa8sEXi/+CSHoOiyb5Q57esm15pgUa4Vltmgklv/?=
 =?us-ascii?Q?ZmBC5l0EqJ+XO6fKOqwMN9x6D5ZDqp3sRH85l/JHGtERZsSRuQ4QYLe8TtP8?=
 =?us-ascii?Q?WU0as7hlAAKzO0c1dxY5GONs6CddiBbmCtfxrSROYQMqB5vD1Tx2mbXOlIjT?=
 =?us-ascii?Q?yCbNvHufQ8/V4iqhksMTKpl4vavwqhz0a0d9vjJ6YRp/ISjM1tviLgT2hmtm?=
 =?us-ascii?Q?lON/BMS3WOX+xi8m51NVdRiJbNfTNR7L6SSV+irVNbquX7dYnia9yyqB4jtR?=
 =?us-ascii?Q?nVLPVeOnn4rqhr1D+fewCHL+cP58jlCNvMwgTr/hFx/AzEmZJZaDyDIdXxhv?=
 =?us-ascii?Q?ev+DE2XMG6K4eLLmfXpCJu5tLQFMmle/j47PYeWdSB89RchtpZ5yLSsWprC5?=
 =?us-ascii?Q?eAR7zCBEAfMugW01ZvVyLxwMBT/9Ad/GePwwUx/E8iTNeDhXL9tCOZJxpSIg?=
 =?us-ascii?Q?p/AfvQdWNPEJomrIdaI8ATg5d2/M0wnDLzewlpGbZZmvebtvwZCvCmFGmAmB?=
 =?us-ascii?Q?tMamWEQg/lasoi/+gIMQt6Y8+MV4QJbfdKvTskUjQJ0QLyMKqy8y6I68x7ix?=
 =?us-ascii?Q?0T+Unj1SyS31OUXn1dUkmfFlIaIg4a7qo4gdfkidtQXuGsybqhBlHwYE6ONV?=
 =?us-ascii?Q?SwgdRCaH/maXdmo4XaOnTQRMDwZO5stwQ7mSMC+5vbpbK9gKs2WAwYcpo5Z4?=
 =?us-ascii?Q?FweZ2cV2zrF1NjCrRF2EC4sI/aSRiR/7oi4Jb63+J15qWuH80xgudMNRQKij?=
 =?us-ascii?Q?nE1lZ3Q2o+M998dVs254Kuo=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 003cbb92-386e-4486-f2fd-08d9bea2735f
X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB5136.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Dec 2021 01:38:38.1001
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 0yajUmPwI9+JV+WOHUNP40nh3ys9nxZGMY//cA2ckq9JWhMj0HVnOPUbOHd/vFO7EwVc9b4PSxrER5zU1BXRgA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB6944
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

This change does 3 things at once:
- documents the recently added "fsl,extirq-map" property, which replaces
  "interrupt-map"
- clarifies the format of the property whose name is changing
- hides the "interrupt-map" property, that the driver still supports for
  backwards compatibility reasons, although not for long.

Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---
 .../bindings/interrupt-controller/fsl,ls-extirq.txt | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/Documentation/devicetree/bindings/interrupt-controller/fsl,ls-extirq.txt b/Documentation/devicetree/bindings/interrupt-controller/fsl,ls-extirq.txt
index 4d47df1a5c91..cddf1aa032be 100644
--- a/Documentation/devicetree/bindings/interrupt-controller/fsl,ls-extirq.txt
+++ b/Documentation/devicetree/bindings/interrupt-controller/fsl,ls-extirq.txt
@@ -18,9 +18,13 @@ Required properties:
 - reg: Specifies the Interrupt Polarity Control Register (INTPCR) in
   the SCFG or the External Interrupt Control Register (IRQCR) in
   the ISC.
-- interrupt-map: Specifies the mapping from external interrupts to GIC
-  interrupts.
-- interrupt-map-mask: Must be <0xffffffff 0>.
+- fsl,extirq-map: An array of elements through which the mapping between
+  external interrupts and GIC interrupts is specified. The first member of each
+  array element is the index of the extirq line. The second member must be
+  zero. The third member must be a phandle to the interrupt parent (the GIC).
+  The remaining number of members in an array element depends on the
+  #interrupt-cells property of the interrupt parent, and are used to specify
+  the parent interrupt.
 
 Example:
 	scfg: scfg@1570000 {
@@ -37,14 +41,13 @@ Example:
 			#address-cells = <0>;
 			interrupt-controller;
 			reg = <0x1ac 4>;
-			interrupt-map =
+			fsl,extirq-map =
 				<0 0 &gic GIC_SPI 163 IRQ_TYPE_LEVEL_HIGH>,
 				<1 0 &gic GIC_SPI 164 IRQ_TYPE_LEVEL_HIGH>,
 				<2 0 &gic GIC_SPI 165 IRQ_TYPE_LEVEL_HIGH>,
 				<3 0 &gic GIC_SPI 167 IRQ_TYPE_LEVEL_HIGH>,
 				<4 0 &gic GIC_SPI 168 IRQ_TYPE_LEVEL_HIGH>,
 				<5 0 &gic GIC_SPI 169 IRQ_TYPE_LEVEL_HIGH>;
-			interrupt-map-mask = <0xffffffff 0x0>;
 		};
 	};
 
-- 
2.25.1