Skip to contentSkip to conversation

serial: core: Fix serial core port id to not use port->line

PATCH In review Tony Lindgren 3 participants 6 messages Jul 19, 2023 TTY layer and serial drivers

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 serial: core: Fix serial core port id to not use port->line

The serial core port id should be serial core controller specific port instance, which is not always the port->line index.

For example, 8250 driver maps a number of legacy ports, and when a hardware specific device driver takes over, we typically have one driver instance for each port. Let's instead add port->port_id to keep track serial ports mapped to each serial core controller instance.

Currently this is only a cosmetic issue for the serial core port device names. The issue can be noticed looking at /sys/bus/serial-base/devices for example though. Let's fix the issue to avoid port addressing issues later on.

Fixes 84a9582fd203 ("serial: core: Start managing serial controllers to enable runtime PM")
---
 drivers/tty/serial/8250/8250_core.c  | 2 ++
 drivers/tty/serial/serial_base_bus.c | 2 +-
 include/linux/serial_core.h          | 1 +
 3 files changed, 4 insertions(+), 1 deletion(-)
drivers/tty/serial/8250/8250_core.c +2 -0
@@ -497,6 +497,7 @@ static struct uart_8250_port *serial8250_setup_port(int index)
 
 	up = &serial8250_ports[index];
 	up->port.line = index;
+	up->port.port_id = index;
 
 	serial8250_init_port(up);
 	if (!base_ops)
@@ -1040,6 +1041,7 @@ int serial8250_register_8250_port(const struct uart_8250_port *up)
 			uart_remove_one_port(&serial8250_reg, &uart->port);
 
 		uart->port.ctrl_id	= up->port.ctrl_id;
+		uart->port.port_id	= up->port.port_id;
 		uart->port.iobase       = up->port.iobase;
 		uart->port.membase      = up->port.membase;
 		uart->port.irq          = up->port.irq;
drivers/tty/serial/serial_base_bus.c +1 -1
@@ -136,7 +136,7 @@ struct serial_port_device *serial_base_port_add(struct uart_port *port,
 	err = serial_base_device_init(port, &port_dev->dev,
 				      &ctrl_dev->dev, &serial_port_type,
 				      serial_base_port_release,
-				      port->line);
+				      port->port_id);
 	if (err)
 		goto err_put_device;
 
include/linux/serial_core.h +1 -0
@@ -460,6 +460,7 @@ struct uart_port {
 	int			(*iso7816_config)(struct uart_port *,
 						  struct serial_iso7816 *iso7816);
 	int			ctrl_id;		/* optional serial core controller id */
+	int			port_id;		/* optional serial core port id */
 	unsigned int		irq;			/* irq number */
 	unsigned long		irqflags;		/* irq flags  */
 	unsigned int		uartclk;		/* base uart clock */
Signature · 1 line
2.41.0
maintainer
#1 lore raw
Quoted 12 lines · Tony Lindgren

The serial core port id should be serial core controller specific port instance, which is not always the port->line index.

For example, 8250 driver maps a number of legacy ports, and when a hardware specific device driver takes over, we typically have one driver instance for each port. Let's instead add port->port_id to keep track serial ports mapped to each serial core controller instance.

Currently this is only a cosmetic issue for the serial core port device names. The issue can be noticed looking at /sys/bus/serial-base/devices for example though. Let's fix the issue to avoid port addressing issues later on.

...

include/linux/serial_core.h struct uart_port { · line 463

Quoted 7 lines
include/linux/serial_core.h +1 -0
@@ -460,6 +460,7 @@ struct uart_port {
  	int			(*iso7816_config)(struct uart_port *,
  						  struct serial_iso7816 *iso7816);
  	int			ctrl_id;		/* optional serial core controller id */
+	int			port_id;		/* optional serial core port id */

Can the id be negative? If not, please use uint.

thanks,

Signature · 2 lines
js
suse labs
#2 lore raw
Quoted 1 line · Jiri Slaby

On 19. 07. 23, 7:12, Tony Lindgren wrote:

...

Quoted 4 lines

include/linux/serial_core.h struct uart_port { · line 463

Quoted 2 lines

int ctrl_id; /* optional serial core controller id */

include/linux/serial_core.h +1 -0
+	int			port_id;		/* optional serial core port id */

Can the id be negative? If not, please use uint.

Does this suggestion apply to ctrl_id as well?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#3 lore raw
Quoted 11 lines · Andy Shevchenko
Quoted 1 line · Jiri Slaby

On 19. 07. 23, 7:12, Tony Lindgren wrote:

...

Quoted 4 lines

include/linux/serial_core.h struct uart_port { · line 463

Quoted 2 lines

int ctrl_id; /* optional serial core controller id */

include/linux/serial_core.h +1 -0
+	int			port_id;		/* optional serial core port id */

Can the id be negative? If not, please use uint.

Does this suggestion apply to ctrl_id as well?

Sure, but he hasn't added it in this series ;). So it should go to someone's todo :P.

Signature · 2 lines
js
suse labs
#4 lore raw
Quoted 11 lines · Jiri Slaby
Quoted 10 lines · Andy Shevchenko
Quoted 1 line · Jiri Slaby

On 19. 07. 23, 7:12, Tony Lindgren wrote:

...

Quoted 4 lines

include/linux/serial_core.h struct uart_port { · line 463

Quoted 2 lines

int ctrl_id; /* optional serial core controller id */

include/linux/serial_core.h +1 -0
+	int			port_id;		/* optional serial core port id */

Can the id be negative? If not, please use uint.

Quoted 4 lines
Quoted 1 line

Does this suggestion apply to ctrl_id as well?

Sure, but he hasn't added it in this series ;). So it should go to someone's todo :P.

Yes it can be uint, that's left over from some earlier revision where -ENODEV was used, will fix that too.

Regards,

Tony

Reviewed-by on v1 1/1
#5 lore raw
In reply to Tony Lindgren
Quoted 8 lines · Tony Lindgren

The serial core port id should be serial core controller specific port instance, which is not always the port->line index.

For example, 8250 driver maps a number of legacy ports, and when a hardware specific device driver takes over, we typically have one driver instance for each port. Let's instead add port->port_id to keep track serial ports mapped to each serial core controller instance.

Quoted 4 lines

Currently this is only a cosmetic issue for the serial core port device names. The issue can be noticed looking at /sys/bus/serial-base/devices for example though. Let's fix the issue to avoid port addressing issues later on.

Good catch!

Quoted 52 lines
Fixes 84a9582fd203 ("serial: core: Start managing serial controllers to enable runtime PM")
---
 drivers/tty/serial/8250/8250_core.c  | 2 ++
 drivers/tty/serial/serial_base_bus.c | 2 +-
 include/linux/serial_core.h          | 1 +
 3 files changed, 4 insertions(+), 1 deletion(-)
drivers/tty/serial/8250/8250_core.c +2 -0
@@ -497,6 +497,7 @@ static struct uart_8250_port *serial8250_setup_port(int index)
 
 	up = &serial8250_ports[index];
 	up->port.line = index;
+	up->port.port_id = index;
 
 	serial8250_init_port(up);
 	if (!base_ops)
@@ -1040,6 +1041,7 @@ int serial8250_register_8250_port(const struct uart_8250_port *up)
 			uart_remove_one_port(&serial8250_reg, &uart->port);
 
 		uart->port.ctrl_id	= up->port.ctrl_id;
+		uart->port.port_id	= up->port.port_id;
 		uart->port.iobase       = up->port.iobase;
 		uart->port.membase      = up->port.membase;
 		uart->port.irq          = up->port.irq;
drivers/tty/serial/serial_base_bus.c +1 -1
@@ -136,7 +136,7 @@ struct serial_port_device *serial_base_port_add(struct uart_port *port,
 	err = serial_base_device_init(port, &port_dev->dev,
 				      &ctrl_dev->dev, &serial_port_type,
 				      serial_base_port_release,
-				      port->line);
+				      port->port_id);
 	if (err)
 		goto err_put_device;
 
include/linux/serial_core.h +1 -0
@@ -460,6 +460,7 @@ struct uart_port {
 	int			(*iso7816_config)(struct uart_port *,
 						  struct serial_iso7816 *iso7816);
 	int			ctrl_id;		/* optional serial core controller id */
+	int			port_id;		/* optional serial core port id */
 	unsigned int		irq;			/* irq number */
 	unsigned long		irqflags;		/* irq flags  */
 	unsigned int		uartclk;		/* base uart clock */
Signature · 1 line
2.41.0
Signature · 2 lines
With Best Regards,
Andy Shevchenko