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 01/10] irqchip/ls-extirq: rename "interrupt-map" OF property to "fsl,extirq-map"
Date:   Tue, 14 Dec 2021 03:37:51 +0200
Message-Id: <20211214013800.2703568-2-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?aQjCepHuUl4F0i/q7xcBOrDq30bXvNWJQUBAFJlf4nIC9gFnq0vOXudDrf7g?=
 =?us-ascii?Q?XvvBUkrU7txUUEP7e/F9A+dlr7J9t5YamfXEM9srYIywuOop4o0dvd935z74?=
 =?us-ascii?Q?I4Y1KLkylz1DefTnQnYZvCE9MOWTuSDIK29Vtv+z4fv1/C1eT+wXvzg/qSvX?=
 =?us-ascii?Q?/Znhni6OR75xmLNxBhlWfgcaDxjISGALrcrWQ9tGL2/qmIAtTfaFxJWwZRuo?=
 =?us-ascii?Q?K8tOgoGOutzrS6WtIhR/3Rua5cPcEJR1wz60uDmP4bAi4a9Rhw+Um/Izi2Gx?=
 =?us-ascii?Q?hIR4LuLuOJ1DJ/Bs+iZCJK3pEXV0DIa/DYKibo6jK26HLYqQHwJ2xmhgx03O?=
 =?us-ascii?Q?CQdrnIVJu1XLxExUjupfL69HAcpQCE7ys2zzNgimLa+o8raIJ0WkNDhELZas?=
 =?us-ascii?Q?4ufZrKkCEr6M3UFyXsAsnSsKPPLyvCcn5Vf/X+vNd1w5TpMhqjABU53ImJ6W?=
 =?us-ascii?Q?daVUpprZWhdp77208T44r3hEtuK7Zm5FvczogW80Xpn+n0upBgEq//iCZ7K0?=
 =?us-ascii?Q?2nc86u+dBbNq+W6QNt58uZsWM29Z5kgM2Jx6GtOeMXyOhLuDAhcDFWsJQr9+?=
 =?us-ascii?Q?N0jCbes+afO7spNj9ARXgrvp2F9rdfZ5VbNgG7UsU+WnXkNsqQU8Ym3v3Zu4?=
 =?us-ascii?Q?QK6EZiMiUoAAOXYJFslBwznjd7V97Yx1nZkoWkeiWBfk82OSjjQcOFA4tdIh?=
 =?us-ascii?Q?k41LX5a/OD4Vw+RDeDTfJh7FdSjAc3I89QcxjAiN6RgOe1HIALPsypvrUUdr?=
 =?us-ascii?Q?OBkd/tTfxpSWkPe+WXRQKudoHMIcinn3bq4AyccEuj66JElE4GO8BBdvDrYk?=
 =?us-ascii?Q?b0DwjhP3gNUyDh8s+mCKVDRjpzenRdsPGiL3MoN+Tw4+KPB2AiB3jMvbIklZ?=
 =?us-ascii?Q?e5nBZB4fiSVm6my3fpDZnVLF1YhgsCxAf7qt6PSolHQBB6M2t8TURQccY+pP?=
 =?us-ascii?Q?1Y+5Zng3WSrW17NMZ1PEfw79ZBR3CdF/vhAjUgJmwHJue4ETdtpqzFSS/s/5?=
 =?us-ascii?Q?0a+vvhKZz04bMLM5Sk7tYCiKoHTvBzSbab8WqiokzPZelr4xeXufLHVL5Oao?=
 =?us-ascii?Q?QA6sLdEPn4UBkj+0kfchS6MiAPhNKUR3kwzUD+54vhmjQPoRA4GcBO3gGBFa?=
 =?us-ascii?Q?d8SSg29dugqH37DfhL28xxRgkUPgLytzv8PTjePzhoH3V1zlYCb5gIUKsFA5?=
 =?us-ascii?Q?M6S1WFwkMpn7oic/HAK7iasraYxQcycpL7POQpBEDTgkRcWkApP+q8rs9lza?=
 =?us-ascii?Q?i9eaSyeG5lAEzxdjd+xiC/G7viPPDY/CVPuuL1UaBUa2YPbPzBeucDusSva6?=
 =?us-ascii?Q?S9Vt4LX3hCVcsD9H/SYlH1iq+DCvnViZ7zHamk/FsjMSwlNBDFsC2sDRUX18?=
 =?us-ascii?Q?u3vZzx8hMaghcBB0TEz2TNragUtdkoZb1wgaF0T/3lBTUoaur9/4qiysgQOq?=
 =?us-ascii?Q?rwioPrUi7Td/kj/y7NCZQQi7zMLoSDPBjV6Q0WUqTXm1tDOixQwVUa2AbZ/X?=
 =?us-ascii?Q?Rkw7mgDzO16O2xPCZ1swwyxOIARPHvpPjqCmBa+jDNJD51t2GodOOen3ok4E?=
 =?us-ascii?Q?RnvVQMD3zMjBUV4NO1HDxIAtIURMSPQgdN0A8uHBpVXGWIPrXNFbcgDrqq/0?=
 =?us-ascii?Q?JcOtj5LVM7R5BrDIHfDhcLw=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 9fa852e5-b6dc-4a3c-58a5-08d9bea271fa
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:35.7253
 (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: QAqq15aCAutNIelQmQ+xlvXZ9fuwrpgKiLujDt67lRz6BoPtO568CY5Z3SNKA1cAA0AVkwT9ZAXV6RJQ/FvrLw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB6944
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

This OF property was supposed to be named "fsl,extirq-map" since the
first patch submissions, but at Rob Herring's suggestion it was named
"interrupt-map":
https://lore.kernel.org/lkml/20190927161118.GA19333@bogus/

At that time, the "interrupt-map" was ignored by the core for OF nodes
that also had an "interrupt-controller" property, but that changed with
commit 041284181226 ("of/irq: Allow matching of an interrupt-map local
to an interrupt controller"), which made the consumer drivers of the
ls-extirq break. To work around this breakage, the OF bindings for IRQs
have introduced a table of "OF IRQ interrupt-map abusers".
This can be seen in commit de4adddcbcc2 ("of/irq: Add a quirk for
controllers with their own definition of interrupt-map").

To stop being abusers, let's go back to the original form of these
bindings, before Rob's review. Compatibility will be kept with the
current abusive bindings for a few more kernel cycles, to give people
some time to update. But to also give them an incentive, print a warning
that the support for "interrupt-map" will be removed. This will be seen
when running a new kernel with an old device tree.

While the breakage was introduced relatively recently, the device tree
changes are intended to backport stable kernels for quicker conversion
to an acceptable set of bindings, and this driver will need to support
the updated stable bindings.

Fixes: 0dcd9f872769 ("irqchip: Add support for Layerscape external interrupt lines")
Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---
 drivers/irqchip/irq-ls-extirq.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/drivers/irqchip/irq-ls-extirq.c b/drivers/irqchip/irq-ls-extirq.c
index 853b3972dbe7..b6ecc5e3472f 100644
--- a/drivers/irqchip/irq-ls-extirq.c
+++ b/drivers/irqchip/irq-ls-extirq.c
@@ -101,9 +101,15 @@ ls_extirq_parse_map(struct ls_extirq_data *priv, struct device_node *node)
 	u32 mapsize;
 	int ret;
 
-	map = of_get_property(node, "interrupt-map", &mapsize);
-	if (!map)
-		return -ENOENT;
+	map = of_get_property(node, "fsl,extirq-map", &mapsize);
+	if (!map) {
+		map = of_get_property(node, "interrupt-map", &mapsize);
+		if (!map)
+			return -ENOENT;
+
+		pr_warn("\"interrupt-map\" is a reserved OF property, and support for it will be removed. Please use \"fsl,extirq-map\" instead.\n");
+	}
+
 	if (mapsize % sizeof(*map))
 		return -EINVAL;
 	mapsize /= sizeof(*map);
-- 
2.25.1