Skip to contentSkip to conversation

serial: 8250: add option to disable registration of legacy ISA ports

PATCH In review Mans Rullgard 3 participants 6 messages Jan 28, 2021 – Feb 18, 2021 4 messages not in the archive TTY layer and serial drivers

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 serial: 8250: add option to disable registration of legacy ISA ports

On systems that do not have the traditional PC ISA serial ports, the 8250 driver still creates non-functional device nodes. This change makes only ports that actually exist (PCI, DT, ...) get device nodes.

---
 drivers/tty/serial/8250/8250_core.c | 26 ++++++++++++++++++++------
 drivers/tty/serial/8250/Kconfig     |  5 +++++
 2 files changed, 25 insertions(+), 6 deletions(-)
drivers/tty/serial/8250/8250_core.c +20 -6
index cae61d1ebec5..49695dd3677c 100644
@@ -555,6 +555,7 @@ static void __init serial8250_isa_init_ports(void)
 	}
 }
 
+#ifdef CONFIG_SERIAL_8250_ISA
 static void __init
 serial8250_register_ports(struct uart_driver *drv, struct device *dev)
 {
@@ -575,6 +576,7 @@ serial8250_register_ports(struct uart_driver *drv, struct device *dev)
 		uart_add_one_port(drv, &up->port);
 	}
 }
+#endif
 
 #ifdef CONFIG_SERIAL_8250_CONSOLE
 
@@ -797,6 +799,7 @@ void serial8250_resume_port(int line)
 }
 EXPORT_SYMBOL(serial8250_resume_port);
 
+#ifdef CONFIG_SERIAL_8250_ISA
 /*
  * Register a set of serial devices attached to a platform device.  The
  * list is terminated with a zero flags entry, which means we expect
@@ -907,6 +910,7 @@ static struct platform_driver serial8250_isa_driver = {
  * in the table in include/asm/serial.h
  */
 static struct platform_device *serial8250_isa_devs;
+#endif
 
 /*
  * serial8250_register_8250_port and serial8250_unregister_port allows for
@@ -1149,6 +1153,8 @@ void serial8250_unregister_port(int line)
 	}
 
 	uart_remove_one_port(&serial8250_reg, &uart->port);
+	uart->port.dev = NULL;
+#ifdef CONFIG_SERIAL_8250_ISA
 	if (serial8250_isa_devs) {
 		uart->port.flags &= ~UPF_BOOT_AUTOCONF;
 		uart->port.type = PORT_UNKNOWN;
@@ -1156,9 +1162,8 @@ void serial8250_unregister_port(int line)
 		uart->capabilities = 0;
 		serial8250_apply_quirks(uart);
 		uart_add_one_port(&serial8250_reg, &uart->port);
-	} else {
-		uart->port.dev = NULL;
 	}
+#endif
 	mutex_unlock(&serial_mutex);
 }
 EXPORT_SYMBOL(serial8250_unregister_port);
@@ -1188,6 +1193,7 @@ static int __init serial8250_init(void)
 	if (ret)
 		goto unreg_uart_drv;
 
+#ifdef CONFIG_SERIAL_8250_ISA
 	serial8250_isa_devs = platform_device_alloc("serial8250",
 						    PLAT8250_DEV_LEGACY);
 	if (!serial8250_isa_devs) {
@@ -1202,26 +1208,33 @@ static int __init serial8250_init(void)
 	serial8250_register_ports(&serial8250_reg, &serial8250_isa_devs->dev);
 
 	ret = platform_driver_register(&serial8250_isa_driver);
-	if (ret == 0)
-		goto out;
+	if (ret)
+		goto del_dev;
+#endif
 
+out:
+	return ret;
+
+#ifdef CONFIG_SERIAL_8250_ISA
+del_dev:
 	platform_device_del(serial8250_isa_devs);
 put_dev:
 	platform_device_put(serial8250_isa_devs);
 unreg_pnp:
 	serial8250_pnp_exit();
+#endif
 unreg_uart_drv:
 #ifdef CONFIG_SPARC
 	sunserial_unregister_minors(&serial8250_reg, UART_NR);
 #else
 	uart_unregister_driver(&serial8250_reg);
 #endif
-out:
-	return ret;
+	goto out;
 }
 
 static void __exit serial8250_exit(void)
 {
+#ifdef CONFIG_SERIAL_8250_ISA
 	struct platform_device *isa_dev = serial8250_isa_devs;
 
 	/*
@@ -1233,6 +1246,7 @@ static void __exit serial8250_exit(void)
 
 	platform_driver_unregister(&serial8250_isa_driver);
 	platform_device_unregister(isa_dev);
+#endif
 
 	serial8250_pnp_exit();
 
drivers/tty/serial/8250/Kconfig +5 -0
index 603137da4736..683f81675a77 100644
@@ -52,6 +52,11 @@ config SERIAL_8250_DEPRECATED_OPTIONS
 	  If you did not notice yet and/or you have userspace from pre-3.7, it
 	  is safe (and recommended) to say N here.
 
+config SERIAL_8250_ISA
+	bool "8250/16550 ISA device support" if EXPERT
+	depends on SERIAL_8250
+	default y
+
 config SERIAL_8250_PNP
 	bool "8250/16550 PNP device support" if EXPERT
 	depends on SERIAL_8250 && PNP
Signature · 1 line
2.30.0

A message that is not in the archive (sent off-list or not yet received): [email protected]

A message that is not in the archive (sent off-list or not yet received): [email protected]

A message that is not in the archive (sent off-list or not yet received): YBa0J82FrD6mdP/[email protected]

#4 lore raw
Quoted 52 lines · Greg Kroah-Hartman
Quoted 21 lines · Måns Rullgård
Quoted 19 lines · Greg Kroah-Hartman
Quoted 18 lines · Mans Rullgard

On systems that do not have the traditional PC ISA serial ports, the 8250 driver still creates non-functional device nodes. This change makes only ports that actually exist (PCI, DT, ...) get device nodes.

---
 drivers/tty/serial/8250/8250_core.c | 26 ++++++++++++++++++++------
 drivers/tty/serial/8250/Kconfig     |  5 +++++
 2 files changed, 25 insertions(+), 6 deletions(-)
drivers/tty/serial/8250/8250_core.c +0 -0
index cae61d1ebec5..49695dd3677c 100644
@@ -555,6 +555,7 @@ static void __init serial8250_isa_init_ports(void)
 	}
 }
 
Quoted 5 lines
Quoted 3 lines

drivers/tty/serial/8250/8250_core.c static void __init serial8250_isa_init_ports(void) · line 558

Quoted 1 line
drivers/tty/serial/8250/8250_core.c +1 -0
+#ifdef CONFIG_SERIAL_8250_ISA

This is just making a mess of the code.

It was already a mess.

True, but don't make it a worse one please.

Quoted 10 lines
Quoted 5 lines

To do this right, pull the isa code out into a separate file and put the #ifdef in a .h file, so we can properly maintain and support this code over time. This change as-is is not going to make that any easier :(

I might put in that effort if there's a reasonable chance this change will be accepted. If it's going to be rejected regardless, I'd rather not waste my time.

Quoted 7 lines
Quoted 4 lines

drivers/tty/serial/8250/8250_core.c static void __init serial8250_isa_init_ports(void) · line 560

Quoted 2 lines
drivers/tty/serial/8250/8250_core.c +2 -0
+config SERIAL_8250_ISA
+	bool "8250/16550 ISA device support" if EXPERT

So, no one will set this?

I followed the pattern of the existing SERIAL_8250_PNP option. Was that a mistake? How would you prefer it?

I don't know, I'm just asking.

Quoted 2 lines
Quoted 1 line

What userspace visable change will be caused by this?

Quoted 7 lines
Quoted 5 lines

There won't be /dev/ttyS devices for ports that don't exist.

Quoted 1 line

Will ports get renumbered?

Not if they had predictable numbers to begin with.

So that would be "yes"? If so, obviously we couldn't take this, right?

On a Beaglebone Black based system with some of the UARTs enabled, those keep their numbers such that e.g. ttyS0, ttyS1, and ttyS4 show up in /dev while ttyS2 and ttyS3 do not since they don't correspond to any (enabled) ports.

If any of the very many variants of this driver do not assign fixed numbers, those would possibly be renumbered. Should that be the case, the numbering was never guaranteed to begin with, so I fail to see any problem.

Signature · 1 line
Måns Rullgård
#5 lore raw
Quoted 67 lines · Måns Rullgård
Quoted 52 lines · Greg Kroah-Hartman
Quoted 21 lines · Måns Rullgård
Quoted 19 lines · Greg Kroah-Hartman
Quoted 18 lines · Mans Rullgard

On systems that do not have the traditional PC ISA serial ports, the 8250 driver still creates non-functional device nodes. This change makes only ports that actually exist (PCI, DT, ...) get device nodes.

---
 drivers/tty/serial/8250/8250_core.c | 26 ++++++++++++++++++++------
 drivers/tty/serial/8250/Kconfig     |  5 +++++
 2 files changed, 25 insertions(+), 6 deletions(-)
drivers/tty/serial/8250/8250_core.c +0 -0
index cae61d1ebec5..49695dd3677c 100644
@@ -555,6 +555,7 @@ static void __init serial8250_isa_init_ports(void)
 	}
 }
 
Quoted 5 lines
Quoted 3 lines

drivers/tty/serial/8250/8250_core.c static void __init serial8250_isa_init_ports(void) · line 558

Quoted 1 line
drivers/tty/serial/8250/8250_core.c +1 -0
+#ifdef CONFIG_SERIAL_8250_ISA

This is just making a mess of the code.

It was already a mess.

True, but don't make it a worse one please.

Quoted 10 lines
Quoted 5 lines

To do this right, pull the isa code out into a separate file and put the #ifdef in a .h file, so we can properly maintain and support this code over time. This change as-is is not going to make that any easier :(

I might put in that effort if there's a reasonable chance this change will be accepted. If it's going to be rejected regardless, I'd rather not waste my time.

Quoted 7 lines
Quoted 4 lines

drivers/tty/serial/8250/8250_core.c static void __init serial8250_isa_init_ports(void) · line 560

Quoted 2 lines
drivers/tty/serial/8250/8250_core.c +2 -0
+config SERIAL_8250_ISA
+	bool "8250/16550 ISA device support" if EXPERT

So, no one will set this?

I followed the pattern of the existing SERIAL_8250_PNP option. Was that a mistake? How would you prefer it?

I don't know, I'm just asking.

Quoted 2 lines
Quoted 1 line

What userspace visable change will be caused by this?

Quoted 7 lines
Quoted 5 lines

There won't be /dev/ttyS devices for ports that don't exist.

Quoted 1 line

Will ports get renumbered?

Not if they had predictable numbers to begin with.

So that would be "yes"? If so, obviously we couldn't take this, right?

On a Beaglebone Black based system with some of the UARTs enabled, those keep their numbers such that e.g. ttyS0, ttyS1, and ttyS4 show up in /dev while ttyS2 and ttyS3 do not since they don't correspond to any (enabled) ports.

Quoted 4 lines

If any of the very many variants of this driver do not assign fixed numbers, those would possibly be renumbered. Should that be the case, the numbering was never guaranteed to begin with, so I fail to see any problem.

Ok, if that's the case, then yes, a cleaned up version of this patch would be nice, thanks!

greg k-h

#6 lore raw
In reply to a message not in the archive
Quoted 3 lines · Måns Rullgård
Quoted 1 line

What userspace visable change will be caused by this?

There won't be /dev/ttyS devices for ports that don't exist.

Oh yes, please!

That would mean I can create ttyS2 and upward while keeping ttyPS0 and ttyPS1 (which invaded the serial<N> alias namespace) at the lower numbers.

Quoted 3 lines
Quoted 1 line

Will ports get renumbered?

Not if they had predictable numbers to begin with.

It is hard to make predictable numbers with the backward operating serial<N> aliases in the device tree. It makes relations in the wrong direction.

If a system has two ttyPS<N> uarts (xilinx_uartps) and needs them at ttyPS0 and ttyPS1 (or at least <=ttyPS9, due to another bug in start_getty) and 10 ttyS<N> (8250) you can configure the kernel for 10 8250 devices and give 8 of them the predictable ttyS2 to ttyS9. The last two will get the remaining ttyS0 and ttyS1. You cannot assign them their number, because the serial0 and serial1 alias are required for the ttyPS0 and ttyPS1.

However with this option it would be possible to configure for 12 8250 devices and not use nor see ttyS0 and ttyS1.

The best option would of course be to not even instantiate kernel drivers for non-existing devices.

Maarten

A message that is not in the archive (sent off-list or not yet received): CAHp75VenDC0R3uX4_=Yzii-q5Z-YWcfT2_OO0yJkYehYAHDCew@mail.gmail.com

#8 lore raw
Quoted 8 lines · Andy Shevchenko
Quoted 5 lines · Mans Rullgard

On systems that do not have the traditional PC ISA serial ports, the 8250 driver still creates non-functional device nodes. This change makes only ports that actually exist (PCI, DT, ...) get device nodes.

Quoted 5 lines

This is kinda ABI breakage. At least this will break x86 platforms with HSUARTs (all modern ones) that are used in embedded systems.

I think you would rather need an option to disable this and select it by the platforms where it is known not to break anything.

What exactly breaks? The new option is enabled by default, just like the one right beside it (SERIAL_8250_PNP), so nothing at all changes unless this is actively disabled. On a system that doesn't have those ports, any attempt to access the device nodes produces some kind of error. How is it breaking anything to not create device nodes for hardware that doesn't exist?

Signature · 1 line
Måns Rullgård
#9 lore raw
In reply to a message not in the archive
Quoted 8 lines · Andy Shevchenko
Quoted 5 lines · Mans Rullgard

On systems that do not have the traditional PC ISA serial ports, the 8250 driver still creates non-functional device nodes. This change makes only ports that actually exist (PCI, DT, ...) get device nodes.

Quoted 5 lines

This is kinda ABI breakage. At least this will break x86 platforms with HSUARTs (all modern ones) that are used in embedded systems.

I think you would rather need an option to disable this and select it by the platforms where it is known not to break anything.

This option is behind CONFIG_EXPERT, if you set it, you know what you are doing, so that's fine.

thanks,

greg k-h