Skip to contentSkip to conversation

serial: sifive: lock port in startup()/shutdown() callbacks

PATCH Superseded Ryo Takakura 2 participants 3 messages Apr 5, 2025 – Apr 10, 2025

Subsystems (4)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 serial: sifive: lock port in startup()/shutdown() callbacks

startup()/shutdown() callbacks access SIFIVE_SERIAL_IE_OFFS. The register is also accessed from write() callback.

If console were printing and startup()/shutdown() callback gets called, its access to the register could be overwritten.

Add port->lock to startup()/shutdown() callbacks to make sure their access to SIFIVE_SERIAL_IE_OFFS is synchronized against write() callback.

Fixes 45c054d0815b ("tty: serial: add driver for the SiFive UART")

---

This patch used be part of a series for converting sifive driver to nbcon[0]. It's now sent seperatly as the rest of the series does not need be applied to the stable branch.

Sincerely,
Ryo Takakura

[0] https://lore.kernel.org/all/[email protected]/

---
 drivers/tty/serial/sifive.c | 6 ++++++
 1 file changed, 6 insertions(+)
drivers/tty/serial/sifive.c +6 -0
index 5904a2d4c..054a8e630 100644
@@ -563,8 +563,11 @@ static void sifive_serial_break_ctl(struct uart_port *port, int break_state)
 static int sifive_serial_startup(struct uart_port *port)
 {
 	struct sifive_serial_port *ssp = port_to_sifive_serial_port(port);
+	unsigned long flags;
 
+	uart_port_lock_irqsave(&ssp->port, &flags);
 	__ssp_enable_rxwm(ssp);
+	uart_port_unlock_irqrestore(&ssp->port, flags);
 
 	return 0;
 }
@@ -572,9 +575,12 @@ static int sifive_serial_startup(struct uart_port *port)
 static void sifive_serial_shutdown(struct uart_port *port)
 {
 	struct sifive_serial_port *ssp = port_to_sifive_serial_port(port);
+	unsigned long flags;
 
+	uart_port_lock_irqsave(&ssp->port, &flags);
 	__ssp_disable_rxwm(ssp);
 	__ssp_disable_txwm(ssp);
+	uart_port_unlock_irqrestore(&ssp->port, flags);
 }
 
 /**
Signature · 1 line
2.34.1
Reviewed-by on v2 1/1
#1 lore raw
Quoted 6 lines · Ryo Takakura

startup()/shutdown() callbacks access SIFIVE_SERIAL_IE_OFFS. The register is also accessed from write() callback.

If console were printing and startup()/shutdown() callback gets called, its access to the register could be overwritten.

Quoted 7 lines

Add port->lock to startup()/shutdown() callbacks to make sure their access to SIFIVE_SERIAL_IE_OFFS is synchronized against write() callback.

Fixes 45c054d0815b ("tty: serial: add driver for the SiFive UART")

I do not have the hardware around so I could not test it. But the change make sense. It fixes a real race. And the code looks reasonable:

Best Regards,
Petr

#2 lore raw
Quoted 15 lines · Petr Mladek
Quoted 6 lines · Ryo Takakura

startup()/shutdown() callbacks access SIFIVE_SERIAL_IE_OFFS. The register is also accessed from write() callback.

If console were printing and startup()/shutdown() callback gets called, its access to the register could be overwritten.

Quoted 7 lines

Add port->lock to startup()/shutdown() callbacks to make sure their access to SIFIVE_SERIAL_IE_OFFS is synchronized against write() callback.

Fixes 45c054d0815b ("tty: serial: add driver for the SiFive UART")
Quoted 5 lines

I do not have the hardware around so I could not test it. But the change make sense. It fixes a real race. And the code looks reasonable:

Thanks for reviewing this one as well!
I'll send v3 with your Reviewed-by.

Sincerely,
Ryo Takakura

Quoted 2 lines

Best Regards,
Petr