serial: sifive: Convert sifive console to nbcon
Subsystems (4)
v2 cover serial: sifive: Convert sifive console to nbcon
Hi!
This series convert sifive console to nbcon.
The first patch fixes the issue which was pointed out by John [0] that the driver has been accessing SIFIVE_SERIAL_IE_OFFS register on its ->startup() and ->shutdown() without port lock synchronization against ->write().
The fix on the first patch still applies to the second patch which converts the console to nbcon as ->write_thread() holds port lock and ->write_atomic() checks for the console ownership.
Sincerely,
Ryo Takakura
[0] https://lore.kernel.org/lkml/[email protected]/
---
Changes since v1:
[1] https://lore.kernel.org/lkml/[email protected]/
- Thank you John for the feedback!
- Add a patch for synchronizing startup()/shutdown() vs write().
- Add <Reviewed-by> by John.
---
Ryo Takakura (2):
serial: sifive: lock port in startup()/shutdown() callbacks
serial: sifive: Switch to nbcon console
drivers/tty/serial/sifive.c | 93 +++++++++++++++++++++++++++++++------ 1 file changed, 80 insertions(+), 13 deletions(-)
Signature · 1 line
2.34.1
PATCH v2 1/2 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.
--- drivers/tty/serial/sifive.c | 6 ++++++ 1 file changed, 6 insertions(+)
drivers/tty/serial/sifive.c +6 -0
@@ -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
kernel test robot
build botRe: [PATCH v2 1/2] serial: sifive: lock port in startup()/shutdown() callbacks
FYI: kernel test robot notices the stable kernel rule is not satisfied.
Hi,
Thanks for your patch.
FYI: kernel test robot notices the stable kernel rule is not satisfied.
The check is based on https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html#option-1
Rule: add the tag "Cc: [email protected]" in the sign-off area to have the patch automatically included in the stable tree.
Subject: [PATCH v2 1/2] serial: sifive: lock port in startup()/shutdown() callbacks
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
Re: [PATCH v2 1/2] 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.
---
Hi,
I'm sorry that I wasn't aware of how Cc stable should be done.
I added Cc for stable but please tell me if this patch should be resent or if there is any that is missing.
Sincerely,
Ryo Takakura
--- drivers/tty/serial/sifive.c | 6 ++++++ 1 file changed, 6 insertions(+)
drivers/tty/serial/sifive.c +6 -0
@@ -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
Greg KH
maintainerRe: [PATCH v2 1/2] serial: sifive: lock port in startup()/shutdown() callbacks
Quoted 12 lines · Ryo Takakura
startup()/shutdown() callbacks access
SIFIVE_SERIAL_IE_OFFS. The register is also accessed fromwrite()callback.If console were printing and startup()/shutdown() callback gets called, its access to the register could be overwritten.
Add
port->lockto startup()/shutdown() callbacks to make sure their access toSIFIVE_SERIAL_IE_OFFSis synchronized againstwrite()callback.Signed-off-by Ryo Takakura <[email protected]>
Quoted 8 lines
---
Hi,
I'm sorry that I wasn't aware of how Cc stable should be done.
I added Cc for stable but please tell me if this patch should be resent or if there is any that is missing.
Please resend a v3.
thanks,
greg k-h
Re: [PATCH v2 1/2] serial: sifive: lock port in startup()/shutdown() callbacks
Hi Greg,
Quoted 15 lines · Greg KH
Quoted 14 lines · Ryo Takakura
startup()/shutdown() callbacks access
SIFIVE_SERIAL_IE_OFFS. The register is also accessed fromwrite()callback.If console were printing and startup()/shutdown() callback gets called, its access to the register could be overwritten.
Add
port->lockto startup()/shutdown() callbacks to make sure their access toSIFIVE_SERIAL_IE_OFFSis synchronized againstwrite()callback.Signed-off-by Ryo Takakura <[email protected]>---
Quoted 8 lines
Quoted 6 lines
Hi,
I'm sorry that I wasn't aware of how Cc stable should be done.
I added Cc for stable but please tell me if this patch should be resent or if there is any that is missing.
Please resend a v3.
Ok. I'll send v3 shortly ;)
Sincerely,
Ryo Takakura
Quoted 3 lines
thanks,
greg k-h
PATCH v2 2/2 serial: sifive: Switch to nbcon console
In reply to Ryo TakakuraAdd the necessary callbacks(write_atomic, write_thread, device_lock and device_unlock) and CON_NBCON flag to switch the sifive console driver to perform as nbcon console.
Both ->write_atomic() and ->write_thread() will check for console ownership whenever they are accessing registers.
The ->device_lock()/unlock() will provide the additional serilization necessary for ->write_thread() which is called from dedicated printing thread.
--- drivers/tty/serial/sifive.c | 87 +++++++++++++++++++++++++++++++------ 1 file changed, 74 insertions(+), 13 deletions(-)
drivers/tty/serial/sifive.c +74 -13
@@ -151,6 +151,7 @@ struct sifive_serial_port {unsigned long baud_rate;struct clk *clk;struct notifier_block clk_notifier; +bool console_line_ended; };/*
@@ -785,33 +786,88 @@ static void sifive_serial_console_putchar(struct uart_port *port, unsigned char__ssp_wait_for_xmitr (ssp);__ssp_transmit_char (ssp, ch); + + ssp->console_line_ended = (ch =='\n' ); +} + +static void sifive_serial_device_lock (struct console *co,unsigned long *flags) +{ +struct uart_port *up = &sifive_serial_console_ports[co->index]->port; + +return __uart_port_lock_irqsave (up, flags); +} + +static void sifive_serial_device_unlock (struct console *co,unsigned long flags) +{ +struct uart_port *up = &sifive_serial_console_ports[co->index]->port; + +return __uart_port_unlock_irqrestore (up, flags); } -static void sifive_serial_console_write (struct console *co,const char *s, -unsigned int count) +static void sifive_serial_console_write_atomic (struct console *co, +struct nbcon_write_context *wctxt) {struct sifive_serial_port *ssp = sifive_serial_console_ports[co->index]; -unsigned long flags; +struct uart_port *port = &ssp->port;unsigned int ier; -int locked =1 ;if (!ssp)return ; -if (oops_in_progress) - locked =uart_port_trylock_irqsave (&ssp->port, &flags); -else -uart_port_lock_irqsave (&ssp->port, &flags); +if (!nbcon_enter_unsafe (wctxt)) +return ; ier =__ssp_readl (ssp,SIFIVE_SERIAL_IE_OFFS );__ssp_writel (0 ,SIFIVE_SERIAL_IE_OFFS , ssp); -uart_console_write (&ssp->port, s, count, sifive_serial_console_putchar); +if (!ssp->console_line_ended) +uart_console_write (port,"\n" ,1 , sifive_serial_console_putchar); +uart_console_write (port, wctxt->outbuf, wctxt->len, + sifive_serial_console_putchar);__ssp_writel (ier,SIFIVE_SERIAL_IE_OFFS , ssp); -if (locked) -uart_port_unlock_irqrestore (&ssp->port, flags); +nbcon_exit_unsafe (wctxt); +} + +static void sifive_serial_console_write_thread (struct console *co, +struct nbcon_write_context *wctxt) +{ +struct sifive_serial_port *ssp = sifive_serial_console_ports[co->index]; +struct uart_port *port = &ssp->port; +unsigned int ier; + +if (!ssp) +return ; + +if (!nbcon_enter_unsafe (wctxt)) +return ; + + ier =__ssp_readl (ssp,SIFIVE_SERIAL_IE_OFFS ); +__ssp_writel (0 ,SIFIVE_SERIAL_IE_OFFS , ssp); + +if (nbcon_exit_unsafe (wctxt)) { +int len =READ_ONCE (wctxt->len); +int i; + +for (i =0 ; i < len; i++) { +if (!nbcon_enter_unsafe (wctxt)) +break ; + +uart_console_write (port, wctxt->outbuf + i,1 , + sifive_serial_console_putchar); + +if (!nbcon_exit_unsafe (wctxt)) +break ; + } + } + +while (!nbcon_enter_unsafe (wctxt)) +nbcon_reacquire_nobuf (wctxt); + +__ssp_writel (ier,SIFIVE_SERIAL_IE_OFFS , ssp); + +nbcon_exit_unsafe (wctxt); }static int sifive_serial_console_setup (struct console *co,char *options)
@@ -829,6 +885,8 @@ static int sifive_serial_console_setup(struct console *co, char *options)if (!ssp)return -ENODEV ; + ssp->console_line_ended = true; +if (options)uart_parse_options (options, &baud, &parity, &bits, &flow);
@@ -839,10 +897,13 @@ static struct uart_driver sifive_serial_uart_driver;static struct console sifive_serial_console = { .name =SIFIVE_TTY_PREFIX , - .write = sifive_serial_console_write, + .write_atomic = sifive_serial_console_write_atomic, + .write_thread = sifive_serial_console_write_thread, + .device_lock = sifive_serial_device_lock, + .device_unlock = sifive_serial_device_unlock, .device = uart_console_device, .setup = sifive_serial_console_setup, - .flags =CON_PRINTBUFFER , + .flags =CON_PRINTBUFFER |CON_NBCON , .index =-1 , .data = &sifive_serial_uart_driver, };
Signature · 1 line
2.34.1