Message-ID: <70b1de02-b674-ca17-9219-61fa8e1c00db@axentia.se>
Date:   Thu, 9 Dec 2021 12:32:29 +0100
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101
 Thunderbird/91.3.2
Content-Language: en-US
To:     "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Cc:     Linus Walleij <linus.walleij@linaro.org>,
        Bartosz Golaszewski <brgl@bgdev.pl>,
        "linux-gpio@vger.kernel.org" <linux-gpio@vger.kernel.org>,
        Andy Shevchenko <andy.shevchenko@gmail.com>,
        Alexander Dahl <ada@thorsis.com>,
        Ludovic Desroches <ludovic.desroches@microchip.com>,
        Nicolas Ferre <nicolas.ferre@microchip.com>,
        Alexandre Belloni <alexandre.belloni@bootlin.com>
From:   Peter Rosin <peda@axentia.se>
Subject: [PATCH] gpiolib: allow line names from device props to override
 driver names
Organization: Axentia Technologies AB
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?WVRqd2xWZUlYczJIQktnSVZ4VmgrUThOWlF5clpTdkttZ2pXd3BudFljSUVX?=
 =?utf-8?B?SW1yOHBrZUpUbVFGam9zcmFmNC9mdERiUlUyV2ZzbjU3VE9YYkJXZWorTy9L?=
 =?utf-8?B?MTIvb2VJTjR0SkhIc09kYnJBWTZPNCtXTm1BSGwrZ1RzUGhSOWZZUU5PVXg2?=
 =?utf-8?B?VlRrVXI4ek1OQnMxRk04VXB2K1NnbW9iR2UwdGlwL29KWjBVNjJNSWZidmxo?=
 =?utf-8?B?UGEvQVMvUjBvY3dLVWVVRkNNcEZvRWJQM21aWEdRakhhUWJ5NmtFWEptMGg3?=
 =?utf-8?B?bkxMZnVSQzg4ZmtaVUVjK2lwRW1PS2hHTFIrc2lqVkVnSzZFTWRxSUtXV1VY?=
 =?utf-8?B?L2VaOXBpUkUrQXl4QmMrUDBySVNvS1RUeSsrQ1lwUzltemwxbzV6V3IwNzFr?=
 =?utf-8?B?ME8xaGJVTHVubkNZeURLR1FoZnlnaEhGSDFKdjlkRXQyWDQ5Qy96cEVCL3hm?=
 =?utf-8?B?dUpvZmdQMStWVndIZFdCSDFWZmlTcVJhVnRaeEp6VU1DWkJUVXliajV2UHdz?=
 =?utf-8?B?WGd3Njh6MEhNVFI3QnZBRzc3VmZKejdtL0VXZXBDQ2lDR2Z4c3JsNVppUHlm?=
 =?utf-8?B?N2dvR01Fd1hZelBJVHMwNWQzckZtZjNhR0R0VW1NUUZGNE9iV1B5aFBla1N0?=
 =?utf-8?B?bnFTSnU0TmRoYlNhWHdVYVlEdFlnSURvd0xtYUNSYkRXNFZJM3lLNGp1a1NV?=
 =?utf-8?B?M3hscUM1TWM1a2JNdlVVSjRQWWliaStoZ296VDVuOEUvTVBuQXdhNWNTL2dW?=
 =?utf-8?B?YmY2Y0dqbUVWZWxwU1o2Y0VQcnRCVTBNajhpbkxsNzRPTjRaY2VMR2JPd255?=
 =?utf-8?B?RHJFaVQ0TDJBOVJiQzlReEZZRzFTWTNRQlYzalhBSWpvSGdvQkVJZmFlUFVp?=
 =?utf-8?B?WTFYOGtaY3Z0WEJiNkZNcTZFOWlzQ2pCYnlLcjJ0bnFxbCtyUDFsUFVkSUJp?=
 =?utf-8?B?WlRuTGwvb055QTZPUjJpVjJXN3RKeEtzVDlJV1d6dlVUajNScmRaeGt3Tk5U?=
 =?utf-8?B?VGl0R1FUQ1R4TUJSQk5tWHZDZ3l2aDdBMWZGTGZoaFVnR3hscTk1REk0eE54?=
 =?utf-8?B?VmtZeWlxd2YwT09meXVyc2hkUWtibmErQmNFN3NFS2pBMlBzMHp3STlSZWth?=
 =?utf-8?B?ZkhjTHhrUDlPeEFmeERBQU9GKzRUZmVlKzJaVHArMWVuTDZpNUdKT1p4dDZj?=
 =?utf-8?B?VUFOaHdIakQ4cWhWbldRaGtsUEdvcUQ0NUtUUStySE5NOUVmTnRqUFlwSkJw?=
 =?utf-8?B?NC9MQXRiMnYvV09FRXRPYktub0RuMi93bWJsVW5xZG1raUJjcUtpWm5ERmtW?=
 =?utf-8?B?aUpCU2x2SVdpbnA2Z0JIQ1VBMnBNRzVkelRHL2lUR3JGekJvMFFwS2ttazdF?=
 =?utf-8?B?UGxsWWJRc0U5RnBhNkt6ZHVaY1ZwQnRxTHQ0SFNsNW5VODRlTlhLWjQ4OFdp?=
 =?utf-8?B?MnhzbytLeFhjcFE0Y3hWWEowdlg4SnRzUzd5eHlqUTRCbkpFdFVhbGNGS2Js?=
 =?utf-8?B?L3NxTmg5WVV1ZEZUMDhzQzNhZ3BlNGZkS0tmTG0vK2Y2LytQeUVsMmYwRDcy?=
 =?utf-8?B?N0FhUC9ENGx6UmsrdlpBZDd3SjR2TGpvelZXckFtMTNzWHhvTWI5TTR1RXVT?=
 =?utf-8?B?dFBWVUlaSXNDT0hBTlpPbFJ0U29BdXJHNDl6MU5nVFl4M2hBaFA5RmJBbHJp?=
 =?utf-8?B?cm1vSzdaaGJrL2k0ZW9PNVJDNG1rb1lxMFpBK3cycWZZa2luOXpqQlBIc081?=
 =?utf-8?B?RlF6NldZWFlBV01STHo0dUIvNVIvbmV3eVYzRktiNjNGbTJWWERtMUh6UmFq?=
 =?utf-8?B?aU9tZkFWMm9JL0c5YjlFZVpzQ2ExQk8wTGVZVllaVUdSTFJDbnU0ejJTZFho?=
 =?utf-8?B?SEFqYVZ3eDNMd095RFNYeUJMWFBnclBZYWRURjdodmpxSVFDWjBNaTRFdHBn?=
 =?utf-8?B?VHVPWUppV0N0ZnpQL1d4UXVoMUJSaUhKNFdXckRYa2xlSDlTMGFVVlpHZEZh?=
 =?utf-8?B?OEYwUHlzY08xbDcwUkdCOEs5T1NwT3pZSll6RS9oTU1PYnZHQ1ZiT2Z6b2dp?=
 =?utf-8?B?bjFjeTA1RTB5VWQ3SitIZzROQm0wSWtiZFFudks5eS9LM3dyc1IzZmVnb2Jv?=
 =?utf-8?Q?pANc=3D?=
X-OriginatorOrg: axentia.se
X-MS-Exchange-CrossTenant-Network-Message-Id: d93edb5f-adfb-4c97-74e5-08d9bb079705
X-MS-Exchange-CrossTenant-AuthSource: DB8PR02MB5482.eurprd02.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Dec 2021 11:32:32.3967
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4ee68585-03e1-4785-942a-df9c1871a234
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: hBt/fZnyhutmuXox0Vp/ulxfZCSCnGT2bVM1QOPzC7q5nwFjv5+prQgPuMqlpyQg
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB3PR0202MB3402
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Some gpio providers set names for gpio lines that match the names of
the pins on the SoC, or variations on that theme. These names are
generally generic, such as pioC12 in the at91 case. These generic names
block the possibility to name gpio lines with in device properties
(i.e. gpio-line-names).

Allow overriding a generic name given by the gpio driver if there is
a name given to the gpio line using device properties, but leave the
generic name alone if no better name is available.

However, there is a risk. If user space is depending on the above
mentioned fixed gpio names, AND there are device properties that
previously did not reach the surface, the name change might cause
regressions. But hopefully this stays below the radar...

Signed-off-by: Peter Rosin <peda@axentia.se>
---
 drivers/gpio/gpiolib.c | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

Instead of doing this only for pinctrl-at91.c as in my recent patch [1], do
it for everyone.

Cheers,
Peter

[1] https://lore.kernel.org/lkml/4d17866a-d9a4-a3d7-189a-781d18dbea00@axentia.se/

diff --git a/drivers/gpio/gpiolib.c b/drivers/gpio/gpiolib.c
index abfbf546d159..00a2a689c202 100644
--- a/drivers/gpio/gpiolib.c
+++ b/drivers/gpio/gpiolib.c
@@ -422,8 +422,15 @@ static int devprop_gpiochip_set_names(struct gpio_chip *chip)
 	if (count > chip->ngpio)
 		count = chip->ngpio;
 
-	for (i = 0; i < count; i++)
-		gdev->descs[i].name = names[chip->offset + i];
+	for (i = 0; i < count; i++) {
+		/*
+		 * Allow overriding "fixed" names provided by the gpio
+		 * provider, the "fixed" names are generally generic and less
+		 * informative than the names given in device properties.
+		 */
+		if (names[chip->offset + i] && names[chip->offset + i][0])
+			gdev->descs[i].name = names[chip->offset + i];
+	}
 
 	kfree(names);
 
@@ -708,10 +715,12 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 	INIT_LIST_HEAD(&gdev->pin_ranges);
 #endif
 
-	if (gc->names)
+	if (gc->names) {
 		ret = gpiochip_set_desc_names(gc);
-	else
-		ret = devprop_gpiochip_set_names(gc);
+		if (ret)
+			goto err_remove_from_list;
+	}
+	ret = devprop_gpiochip_set_names(gc);
 	if (ret)
 		goto err_remove_from_list;
 
-- 
2.20.1