Received-SPF: pass (google.com: domain of linux-kernel+bounces-195208-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: CrescentCY Hsieh <crescentcy.hsieh@moxa.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jiri Slaby <jirislaby@kernel.org>
Cc: linux-kernel@vger.kernel.org,
	linux-serial@vger.kernel.org,
	CrescentCY Hsieh <crescentcy.hsieh@moxa.com>
Subject: [PATCH] tty: serial: 8250: Passing attr_group to universal driver
Date: Thu, 30 May 2024 17:44:57 +0800
Message-Id: <20240530094457.1974-1-crescentcy.hsieh@moxa.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?3f25Z9L2mZLaQpmjaexMkXZz8HXJnp4gVYqITVMkcQ/MR4WcvyeCuJp95Cd/?=
 =?us-ascii?Q?97dA1JBdyN3JQscZWNsOMO525OX5RcPz3fh8ASj2Fg53ur7ywbsLy2uh2GHw?=
 =?us-ascii?Q?YhE0dMLKChTBVzevvfQAVLEzYjGRp3HuWgpDtTzKOZUJAbWjFuI2jcEHwTw6?=
 =?us-ascii?Q?V4qYTizO/ePrYE8PwnNDizTdA1XJjF0Dhfz5kbaoHkXdEpy1B10UmLV4nVpl?=
 =?us-ascii?Q?SS8r0BhTjoaR/QiCf/MKxPoFCUyWvl2+Jjt9FDYJ7CGNWAmLQ72DCStLExVT?=
 =?us-ascii?Q?oz4OCAmn3B5FuVmyIlPPDPVPp2VfwvVtlYUpPJkiMNxBiGbjqG4h1F8RNfr2?=
 =?us-ascii?Q?L+GxxuMCEi4y4W7FBgZFCLEDZQRUY1BTyF51FxTSPqjMytnF8CC+0LsZQEcb?=
 =?us-ascii?Q?PjQE5DQ87BEzIDhQe+wwT5TkmFy/6SxzbL1mVOITpooFsIxdXUqfjPT4HF35?=
 =?us-ascii?Q?Ebs9PcWIFK/ipmZgEEREHepEkeDWB0C8aOOXRT+9aOp6jvoh8jhIJjxIUqFa?=
 =?us-ascii?Q?yRUaHHAwWooFEF1zIP0C0NxkJ6U6l4G8GTHZAeoHgX1TRZsa1awVjCg87gP/?=
 =?us-ascii?Q?jPPNOD4KHY4vSgkOhBm07/UyQByOBpqCuCzwzkn+bFz2cjqJtReccTjH1UhI?=
 =?us-ascii?Q?pP76a5/i+dRxnJnlykBFNjp/eTPfl18PNh4r5Wi3gxDS5rhCY5EyAZlhnwZw?=
 =?us-ascii?Q?fo2Daabn2U9niR14IE2aRH0gZWKQEtvPQDbODiKPBhi8iu7PF67Gk/TmHq7g?=
 =?us-ascii?Q?JjhYt3dQ1F5gzRzvXgVvfTkPVoL3YQW76YHa8S3he8IjmyKz0eTrUgXLPTAb?=
 =?us-ascii?Q?cNmCFOEoUtprbrWcGRSshNhQYUyDl+ft0d6q36kOXlgVzBaXT+O+8o/bAmHB?=
 =?us-ascii?Q?1u/T0dYMBTaTbYM8dRDVs6o1TqYls+6x6s96d40ZFdmzSZfgJYO+dv9LNjki?=
 =?us-ascii?Q?YMp/w+8dRjbuWGO+rHFs3HkEx+qs1vBJ+BMmd3cPgTDfSF3jOcb5mRyh1S/T?=
 =?us-ascii?Q?LxCHfTa5CTqpRUiEqgEMMOGDjKbCWbyYTRT8n8zzWKFgPGDio4y1EWmvU4D/?=
 =?us-ascii?Q?HoDyqpHFiDTMhobs1NNK0tUKaWN1P9pIWTYaIdqvUiWWxwZG4NaBASlfeBQo?=
 =?us-ascii?Q?ybaAd42cp8RBQWeRbXz111PcuQxADlSlIfmZ7EDLGeRhRZV2aDJDCYSVbqWG?=
 =?us-ascii?Q?lW1p7wXq5HlZRLmoo6aerD1h7W5NzMf/8Hq60IfIWI8UQwNuGfJzP+EUXQLh?=
 =?us-ascii?Q?Mo7ezlL0yw5jDEhzPx8Q7DhIpdK56TjcBaU2VQ8VqnLfSx+qcgly9iNMw/nT?=
 =?us-ascii?Q?RIey7c6sq4dARJHZZzPnULcMNRxAQtpeNrySYFCzUVN5RK28VxVZ+HxRYjn1?=
 =?us-ascii?Q?VqF41h10u9d/lM262zQrwOA9FXwaxjqDT153GOjJGqKB2hB2xJBPyUs3ba4R?=
 =?us-ascii?Q?e2oVfEhh6y5eQe5YqKJnPJ/gLvv1R6U+YTB3hsEeogIsiu8FTRwHw9ZCvnhe?=
 =?us-ascii?Q?UhdKaFmMo4IgLl/oOpdvJIUX/iJ4JIM5cWDvQjZjmW8Y6a4hi0+0WpA3GClS?=
 =?us-ascii?Q?q6LvPmrrTSn+GNBQ5D8L2UShg5ScMEmEpVGvydwSzyBa56vuabPR3bkue6fE?=
 =?us-ascii?Q?XA=3D=3D?=
X-OriginatorOrg: moxa.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 18e9ac29-9b27-418b-1d03-08dc808d30fe
X-MS-Exchange-CrossTenant-AuthSource: PUZPR01MB5405.apcprd01.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 May 2024 09:45:08.2096
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 5571c7d4-286b-47f6-9dd5-0aa688773c8e
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: hvRc8TQ2oA/7Rnf2yhShAluBXbKlwK/jSSULDukdUL4W7eslaIld9Tg6soLBFA1oQDPvG0FuvoCzAVGtTQx5MLV+lI6fGhDTh6Q/8XzUSHE=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: TY0PR0101MB4938

Many low-level drivers in Linux kernel register their serial ports with
the help of universal driver (8250_core, 8250_port).

There is an attribute group called `serial8250_dev_attr_group` within
`8250_port.c` to handle the `rx_trig_bytes` attribute:
https://lore.kernel.org/all/20140716011931.31474.68825.stgit@yuno-kbuild.novalocal/

However, if a low-level driver has some HW specifications that need to
be set or retrieved using an attr_group, the universal driver
(8250_port) would overwrite the low-level driver's attr_group.

This patch allows the low-level driver's attr_group to be passed to the
universal driver (8250_port) and combines the two attr_groups. This
ensures that the corresponding system file will only be created if the
device is registered by such a low-level driver.

Signed-off-by: CrescentCY Hsieh <crescentcy.hsieh@moxa.com>
---
 drivers/tty/serial/8250/8250_core.c |  9 +++++++++
 drivers/tty/serial/8250/8250_port.c | 26 ++++++++++++++++++++++++--
 include/linux/serial_core.h         |  1 +
 3 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/drivers/tty/serial/8250/8250_core.c b/drivers/tty/serial/8250/8250_core.c
index 43824a174a51..01d04f9d5192 100644
--- a/drivers/tty/serial/8250/8250_core.c
+++ b/drivers/tty/serial/8250/8250_core.c
@@ -1130,6 +1130,8 @@ int serial8250_register_8250_port(const struct uart_8250_port *up)
 			uart->port.pm = up->port.pm;
 		if (up->port.handle_break)
 			uart->port.handle_break = up->port.handle_break;
+		if (up->port.attr_group)
+			uart->port.attr_group = up->port.attr_group;
 		if (up->dl_read)
 			uart->dl_read = up->dl_read;
 		if (up->dl_write)
@@ -1210,6 +1212,13 @@ void serial8250_unregister_port(int line)
 		uart->port.type = PORT_UNKNOWN;
 		uart->port.dev = &serial8250_isa_devs->dev;
 		uart->port.port_id = line;
+
+		if (uart->port.attr_group_allocated) {
+			kfree(uart->port.attr_group->attrs);
+			kfree(uart->port.attr_group);
+			uart->port.attr_group_allocated = false;
+		}
+		uart->port.attr_group = NULL;
 		uart->capabilities = 0;
 		serial8250_init_port(uart);
 		serial8250_apply_quirks(uart);
diff --git a/drivers/tty/serial/8250/8250_port.c b/drivers/tty/serial/8250/8250_port.c
index 893bc493f662..ddfa8b59e562 100644
--- a/drivers/tty/serial/8250/8250_port.c
+++ b/drivers/tty/serial/8250/8250_port.c
@@ -3135,9 +3135,31 @@ static struct attribute_group serial8250_dev_attr_group = {
 static void register_dev_spec_attr_grp(struct uart_8250_port *up)
 {
 	const struct serial8250_config *conf_type = &uart_config[up->port.type];
+	struct attribute **upp_attrs = NULL;
+	int upp_attrs_num = 0, i;
 
-	if (conf_type->rxtrig_bytes[0])
-		up->port.attr_group = &serial8250_dev_attr_group;
+	up->port.attr_group_allocated = false;
+
+	if (up->port.attr_group) {
+		upp_attrs = up->port.attr_group->attrs;
+
+		while (upp_attrs[upp_attrs_num])
+			upp_attrs_num++;
+
+		up->port.attr_group = kcalloc(1, sizeof(struct attribute_group), GFP_KERNEL);
+		up->port.attr_group->attrs = kcalloc(upp_attrs_num + 2, sizeof(struct attribute *), GFP_KERNEL);
+
+		for (i = 0; i < upp_attrs_num; ++i)
+			up->port.attr_group->attrs[i] = upp_attrs[i];
+
+		if (conf_type->rxtrig_bytes[0])
+			up->port.attr_group->attrs[upp_attrs_num] = &dev_attr_rx_trig_bytes.attr;
+
+		up->port.attr_group_allocated = true;
+	} else {
+		if (conf_type->rxtrig_bytes[0])
+			up->port.attr_group = &serial8250_dev_attr_group;
+	}
 }
 
 static void serial8250_config_port(struct uart_port *port, int flags)
diff --git a/include/linux/serial_core.h b/include/linux/serial_core.h
index 8cb65f50e830..3212d64c32c6 100644
--- a/include/linux/serial_core.h
+++ b/include/linux/serial_core.h
@@ -581,6 +581,7 @@ struct uart_port {
 	unsigned char		console_reinit;
 	const char		*name;			/* port name */
 	struct attribute_group	*attr_group;		/* port specific attributes */
+	bool			attr_group_allocated;	/* whether attr_group is dynamic allocated */
 	const struct attribute_group **tty_groups;	/* all attributes (serial core use only) */
 	struct serial_rs485     rs485;
 	struct serial_rs485	rs485_supported;	/* Supported mask for serial_rs485 */
-- 
2.34.1