+Cc stable
Lukas Wunner wrote on Thu, Sep 22, 2022 at 06:27:33PM +0200:
When a UART port is newly registered, uart_configure_port() seeks to deassert RS485 Transmit Enable by setting the RTS bit in port->mctrl. However a number of UART drivers interpret a set RTS bit as *assertion* instead of deassertion: Affected drivers include those using serial8250_em485_config() (except 8250_bcm2835aux.c) and some using mctrl_gpio (e.g. imx.c).
Since the interpretation of the RTS bit is driver-specific, it is not suitable as a means to centrally deassert Transmit Enable in the serial core. Instead, the serial core must call on drivers to deassert it in their driver-specific way. One way to achieve that is to call ->rs485_config(). It implicitly deasserts Transmit Enable.
So amend uart_configure_port() and uart_resume_port() to invoke uart_rs485_config(). That allows removing calls to uart_rs485_config() from drivers' ->probe() hooks and declaring the function static.
Skip any invocation of ->set_mctrl() if RS485 is enabled. RS485 has no hardware flow control, so the modem control lines are irrelevant and need not be touched. When leaving RS485 mode, reset the modem control lines to the state stored in port->mctrl. That way, UARTs which are muxed between RS485 and RS232 transceivers drive the lines correctly when switched to RS232. (serial8250_do_startup() historically raises the OUT1 modem signal because otherwise interrupts are not signaled on ancient PC UARTs, but I believe that no longer applies to modern, RS485-capable UARTs and is thus safe to be skipped.)
imx.c modifies port->mctrl whenever Transmit Enable is asserted and deasserted. Stop it from doing that so port->mctrl reflects the RS232 line state.
8250_omap.c deasserts Transmit Enable on ->runtime_resume() by calling ->set_mctrl(). Because that is now a no-op in RS485 mode, amend the function to call serial8250_em485_stop_tx().
fsl_lpuart.c retrieves and applies the RS485 device tree properties after registering the UART port. Because applying now happens on registration in uart_configure_port(), move retrieval of the properties ahead of uart_add_one_port().
Fixes: d3b3404df318 ("serial: Fix incorrect rs485 polarity on uart open")
Thanks for this fix! We also noticed rs485 DE was initially wrong last week and I noticed this when I was about to send a patch that just inverted the SER_RS485_RTS_AFTER_SEND check in uart_configure_port, but after reading the commit message here it's a lot more complicated than that depending on the serial driver... (fixing commit 2dd8a74fddd2 ("serial: core: Initialize rs485 RTS polarity already on probe"), but it's actually the same problem in the opposite direction)
Unfortunately you've marked this for v4.14+ stable, but it doesn't even apply to 5.19.14 due to (at least) commit d8fcd9cfbde5 ("serial: core: move sanitizing of RS485 delays into own function"), so it hasn't been picked up yet; since quite a bit of code was cleaned up/moved one will need to pay a bit attention when doing that.
What would you like to do for stable branches? Would you be able to send a patch that applies on older 5.10 and 5.15 where commit d3b3404df318 ("serial: Fix incorrect rs485 polarity on uart open") has been backported?
If that sounds too complicated we could probably just revert a handful of serial_core/rs485 commits, but going forward sounds more future-proof to me.
Thanks! (nothing below, leaving quote for stable@)
Reported-by: Matthias Schiffer matthias.schiffer@ew.tq-group.com Tested-by: Matthias Schiffer matthias.schiffer@ew.tq-group.com Link: https://lore.kernel.org/all/20220329085050.311408-1-matthias.schiffer@ew.tq-... Reported-by: Roosen Henri Henri.Roosen@ginzinger.com Link: https://lore.kernel.org/all/8f538a8903795f22f9acc94a9a31b03c9c4ccacb.camel@g... Signed-off-by: Lukas Wunner lukas@wunner.de Cc: stable@vger.kernel.org # v4.14+
v1 -> v2: Deassert RTS in serial8250_em485_init() only if no transmission is currently ongoing (Ilpo)
v2 -> v3: Drop superfluous newline
v3 -> v4: Resend with changelog at maintainer's request
drivers/tty/serial/8250/8250_omap.c | 3 +++ drivers/tty/serial/8250/8250_pci.c | 9 +-------- drivers/tty/serial/8250/8250_port.c | 12 +++++++----- drivers/tty/serial/fsl_lpuart.c | 10 ++++------ drivers/tty/serial/imx.c | 8 ++------ drivers/tty/serial/serial_core.c | 36 ++++++++++++++++++++---------------- include/linux/serial_core.h | 1 - 7 files changed, 37 insertions(+), 42 deletions(-)
diff --git a/drivers/tty/serial/8250/8250_omap.c b/drivers/tty/serial/8250/8250_omap.c index b43894e..2e67754 100644 --- a/drivers/tty/serial/8250/8250_omap.c +++ b/drivers/tty/serial/8250/8250_omap.c @@ -342,6 +342,9 @@ static void omap8250_restore_regs(struct uart_8250_port *up) omap8250_update_mdr1(up, priv); up->port.ops->set_mctrl(&up->port, up->port.mctrl);
- if (up->port.rs485.flags & SER_RS485_ENABLED)
serial8250_em485_stop_tx(up);} /* diff --git a/drivers/tty/serial/8250/8250_pci.c b/drivers/tty/serial/8250/8250_pci.c index 6f66dc2..b260c55 100644 --- a/drivers/tty/serial/8250/8250_pci.c +++ b/drivers/tty/serial/8250/8250_pci.c @@ -1627,7 +1627,6 @@ static int pci_fintek_init(struct pci_dev *dev) resource_size_t bar_data[3]; u8 config_base; struct serial_private *priv = pci_get_drvdata(dev);
- struct uart_8250_port *port;
if (!(pci_resource_flags(dev, 5) & IORESOURCE_IO) || !(pci_resource_flags(dev, 4) & IORESOURCE_IO) || @@ -1674,13 +1673,7 @@ static int pci_fintek_init(struct pci_dev *dev) pci_write_config_byte(dev, config_base + 0x06, dev->irq);
if (priv) {/* re-apply RS232/485 mode when* pciserial_resume_ports()*/port = serial8250_get_port(priv->line[i]);uart_rs485_config(&port->port);} else {
if (!priv) { /* First init without port data * force init to RS232 Mode */diff --git a/drivers/tty/serial/8250/8250_port.c b/drivers/tty/serial/8250/8250_port.c index 907c5ff..b21550c 100644 --- a/drivers/tty/serial/8250/8250_port.c +++ b/drivers/tty/serial/8250/8250_port.c @@ -600,7 +600,7 @@ void serial8250_rpm_put(struct uart_8250_port *p) static int serial8250_em485_init(struct uart_8250_port *p) { if (p->em485)
return 0;
goto deassert_rts;p->em485 = kmalloc(sizeof(struct uart_8250_em485), GFP_ATOMIC); if (!p->em485) @@ -616,7 +616,9 @@ static int serial8250_em485_init(struct uart_8250_port *p) p->em485->active_timer = NULL; p->em485->tx_stopped = true;
- p->rs485_stop_tx(p);
+deassert_rts:
- if (p->em485->tx_stopped)
p->rs485_stop_tx(p);return 0; } @@ -2047,6 +2049,9 @@ void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl) static void serial8250_set_mctrl(struct uart_port *port, unsigned int mctrl) {
- if (port->rs485.flags & SER_RS485_ENABLED)
return;- if (port->set_mctrl) port->set_mctrl(port, mctrl); else
@@ -3189,9 +3194,6 @@ static void serial8250_config_port(struct uart_port *port, int flags) if (flags & UART_CONFIG_TYPE) autoconfig(up);
- if (port->rs485.flags & SER_RS485_ENABLED)
uart_rs485_config(port);- /* if access method is AU, it is a 16550 with a quirk */ if (port->type == PORT_16550A && port->iotype == UPIO_AU) up->bugs |= UART_BUG_NOMSR;
diff --git a/drivers/tty/serial/fsl_lpuart.c b/drivers/tty/serial/fsl_lpuart.c index e9d5b48..dfc73fe 100644 --- a/drivers/tty/serial/fsl_lpuart.c +++ b/drivers/tty/serial/fsl_lpuart.c @@ -2724,15 +2724,13 @@ static int lpuart_probe(struct platform_device *pdev) if (ret) goto failed_reset;
- ret = uart_add_one_port(&lpuart_reg, &sport->port);
- if (ret)
goto failed_attach_port;- ret = uart_get_rs485_mode(&sport->port); if (ret) goto failed_get_rs485;
- uart_rs485_config(&sport->port);
- ret = uart_add_one_port(&lpuart_reg, &sport->port);
- if (ret)
goto failed_attach_port;ret = devm_request_irq(&pdev->dev, sport->port.irq, handler, 0, DRIVER_NAME, sport); @@ -2742,9 +2740,9 @@ static int lpuart_probe(struct platform_device *pdev) return 0; failed_irq_request: -failed_get_rs485: uart_remove_one_port(&lpuart_reg, &sport->port); failed_attach_port: +failed_get_rs485: failed_reset: lpuart_disable_clks(sport); return ret; diff --git a/drivers/tty/serial/imx.c b/drivers/tty/serial/imx.c index 5875ee6..05b432d 100644 --- a/drivers/tty/serial/imx.c +++ b/drivers/tty/serial/imx.c @@ -380,8 +380,7 @@ static void imx_uart_rts_active(struct imx_port *sport, u32 *ucr2) { *ucr2 &= ~(UCR2_CTSC | UCR2_CTS);
- sport->port.mctrl |= TIOCM_RTS;
- mctrl_gpio_set(sport->gpios, sport->port.mctrl);
- mctrl_gpio_set(sport->gpios, sport->port.mctrl | TIOCM_RTS);
} /* called with port.lock taken and irqs caller dependent */ @@ -390,8 +389,7 @@ static void imx_uart_rts_inactive(struct imx_port *sport, u32 *ucr2) *ucr2 &= ~UCR2_CTSC; *ucr2 |= UCR2_CTS;
- sport->port.mctrl &= ~TIOCM_RTS;
- mctrl_gpio_set(sport->gpios, sport->port.mctrl);
- mctrl_gpio_set(sport->gpios, sport->port.mctrl & ~TIOCM_RTS);
} static void start_hrtimer_ms(struct hrtimer *hrt, unsigned long msec) @@ -2347,8 +2345,6 @@ static int imx_uart_probe(struct platform_device *pdev) dev_err(&pdev->dev, "low-active RTS not possible when receiver is off, enabling receiver\n");
- uart_rs485_config(&sport->port);
- /* Disable interrupts before requesting them */ ucr1 = imx_uart_readl(sport, UCR1); ucr1 &= ~(UCR1_ADEN | UCR1_TRDYEN | UCR1_IDEN | UCR1_RRDYEN | UCR1_RTSDEN);
diff --git a/drivers/tty/serial/serial_core.c b/drivers/tty/serial/serial_core.c index c711318..179ee19 100644 --- a/drivers/tty/serial/serial_core.c +++ b/drivers/tty/serial/serial_core.c @@ -158,15 +158,10 @@ static void uart_start(struct tty_struct *tty) unsigned long flags; unsigned int old;
- if (port->rs485.flags & SER_RS485_ENABLED) {
set &= ~TIOCM_RTS;clear &= ~TIOCM_RTS;- }
- spin_lock_irqsave(&port->lock, flags); old = port->mctrl; port->mctrl = (old & ~clear) | set;
- if (old != port->mctrl)
- if (old != port->mctrl && !(port->rs485.flags & SER_RS485_ENABLED)) port->ops->set_mctrl(port, port->mctrl); spin_unlock_irqrestore(&port->lock, flags);
} @@ -1391,7 +1386,7 @@ static void uart_set_rs485_termination(struct uart_port *port, !!(rs485->flags & SER_RS485_TERMINATE_BUS)); } -int uart_rs485_config(struct uart_port *port) +static int uart_rs485_config(struct uart_port *port) { struct serial_rs485 *rs485 = &port->rs485; int ret; @@ -1405,7 +1400,6 @@ int uart_rs485_config(struct uart_port *port) return ret; } -EXPORT_SYMBOL_GPL(uart_rs485_config); static int uart_get_rs485_config(struct uart_port *port, struct serial_rs485 __user *rs485) @@ -1444,8 +1438,13 @@ static int uart_set_rs485_config(struct tty_struct *tty, struct uart_port *port, spin_lock_irqsave(&port->lock, flags); ret = port->rs485_config(port, &tty->termios, &rs485);
- if (!ret)
- if (!ret) { port->rs485 = rs485;
/* Reset RTS and other mctrl lines when disabling RS485 */if (!(rs485.flags & SER_RS485_ENABLED))port->ops->set_mctrl(port, port->mctrl);- } spin_unlock_irqrestore(&port->lock, flags); if (ret) return ret;
@@ -2352,7 +2351,8 @@ int uart_suspend_port(struct uart_driver *drv, struct uart_port *uport) spin_lock_irq(&uport->lock); ops->stop_tx(uport);
ops->set_mctrl(uport, 0);
if (!(uport->rs485.flags & SER_RS485_ENABLED))ops->set_mctrl(uport, 0);@@ -2440,7 +2440,8 @@ int uart_resume_port(struct uart_driver *drv, struct uart_port *uport) uart_change_pm(state, UART_PM_STATE_ON); spin_lock_irq(&uport->lock);
ops->set_mctrl(uport, 0);
if (!(uport->rs485.flags & SER_RS485_ENABLED))ops->set_mctrl(uport, 0);@@ -2451,7 +2452,10 @@ int uart_resume_port(struct uart_driver *drv, struct uart_port *uport) if (tty) uart_change_speed(tty, state, NULL); spin_lock_irq(&uport->lock);
ops->set_mctrl(uport, uport->mctrl);
if (!(uport->rs485.flags & SER_RS485_ENABLED))ops->set_mctrl(uport, uport->mctrl);elseuart_rs485_config(uport); ops->start_tx(uport); spin_unlock_irq(&uport->lock); tty_port_set_initialized(port, 1);@@ -2558,10 +2562,10 @@ int uart_resume_port(struct uart_driver *drv, struct uart_port *uport) */ spin_lock_irqsave(&port->lock, flags); port->mctrl &= TIOCM_DTR;
if (port->rs485.flags & SER_RS485_ENABLED &&!(port->rs485.flags & SER_RS485_RTS_AFTER_SEND))port->mctrl |= TIOCM_RTS;port->ops->set_mctrl(port, port->mctrl);
if (!(port->rs485.flags & SER_RS485_ENABLED))port->ops->set_mctrl(port, port->mctrl);elseuart_rs485_config(port);/* diff --git a/include/linux/serial_core.h b/include/linux/serial_core.h index 02a4299..0354369 100644 --- a/include/linux/serial_core.h +++ b/include/linux/serial_core.h @@ -933,5 +933,4 @@ static inline int uart_handle_break(struct uart_port *port) !((cflag) & CLOCAL)) int uart_get_rs485_mode(struct uart_port *port); -int uart_rs485_config(struct uart_port *port); #endif /* LINUX_SERIAL_CORE_H */
On Mon, Oct 10, 2022 at 03:17:14PM +0900, Dominique MARTINET wrote:
+Cc stable
Lukas Wunner wrote on Thu, Sep 22, 2022 at 06:27:33PM +0200:
When a UART port is newly registered, uart_configure_port() seeks to deassert RS485 Transmit Enable by setting the RTS bit in port->mctrl. However a number of UART drivers interpret a set RTS bit as *assertion* instead of deassertion: Affected drivers include those using serial8250_em485_config() (except 8250_bcm2835aux.c) and some using mctrl_gpio (e.g. imx.c).
Since the interpretation of the RTS bit is driver-specific, it is not suitable as a means to centrally deassert Transmit Enable in the serial core. Instead, the serial core must call on drivers to deassert it in their driver-specific way. One way to achieve that is to call ->rs485_config(). It implicitly deasserts Transmit Enable.
So amend uart_configure_port() and uart_resume_port() to invoke uart_rs485_config(). That allows removing calls to uart_rs485_config() from drivers' ->probe() hooks and declaring the function static.
Skip any invocation of ->set_mctrl() if RS485 is enabled. RS485 has no hardware flow control, so the modem control lines are irrelevant and need not be touched. When leaving RS485 mode, reset the modem control lines to the state stored in port->mctrl. That way, UARTs which are muxed between RS485 and RS232 transceivers drive the lines correctly when switched to RS232. (serial8250_do_startup() historically raises the OUT1 modem signal because otherwise interrupts are not signaled on ancient PC UARTs, but I believe that no longer applies to modern, RS485-capable UARTs and is thus safe to be skipped.)
imx.c modifies port->mctrl whenever Transmit Enable is asserted and deasserted. Stop it from doing that so port->mctrl reflects the RS232 line state.
8250_omap.c deasserts Transmit Enable on ->runtime_resume() by calling ->set_mctrl(). Because that is now a no-op in RS485 mode, amend the function to call serial8250_em485_stop_tx().
fsl_lpuart.c retrieves and applies the RS485 device tree properties after registering the UART port. Because applying now happens on registration in uart_configure_port(), move retrieval of the properties ahead of uart_add_one_port().
Fixes: d3b3404df318 ("serial: Fix incorrect rs485 polarity on uart open")
Thanks for this fix! We also noticed rs485 DE was initially wrong last week and I noticed this when I was about to send a patch that just inverted the SER_RS485_RTS_AFTER_SEND check in uart_configure_port, but after reading the commit message here it's a lot more complicated than that depending on the serial driver... (fixing commit 2dd8a74fddd2 ("serial: core: Initialize rs485 RTS polarity already on probe"), but it's actually the same problem in the opposite direction)
Unfortunately you've marked this for v4.14+ stable, but it doesn't even apply to 5.19.14 due to (at least) commit d8fcd9cfbde5 ("serial: core: move sanitizing of RS485 delays into own function"), so it hasn't been picked up yet; since quite a bit of code was cleaned up/moved one will need to pay a bit attention when doing that.
What would you like to do for stable branches? Would you be able to send a patch that applies on older 5.10 and 5.15 where commit d3b3404df318 ("serial: Fix incorrect rs485 polarity on uart open") has been backported?
If that sounds too complicated we could probably just revert a handful of serial_core/rs485 commits, but going forward sounds more future-proof to me.
Thanks! (nothing below, leaving quote for stable@)
<formletter>
This is not the correct way to submit patches for inclusion in the stable kernel tree. Please read: https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html for how to do this properly.
</formletter>
Greg Kroah-Hartman wrote on Mon, Oct 10, 2022 at 08:38:07AM +0200:
Thanks for this fix! We also noticed rs485 DE was initially wrong last week and I noticed this when I was about to send a patch that just inverted the SER_RS485_RTS_AFTER_SEND check in uart_configure_port, but after reading the commit message here it's a lot more complicated than that depending on the serial driver... (fixing commit 2dd8a74fddd2 ("serial: core: Initialize rs485 RTS polarity already on probe"), but it's actually the same problem in the opposite direction)
Unfortunately you've marked this for v4.14+ stable, but it doesn't even apply to 5.19.14 due to (at least) commit d8fcd9cfbde5 ("serial: core: move sanitizing of RS485 delays into own function"), so it hasn't been picked up yet; since quite a bit of code was cleaned up/moved one will need to pay a bit attention when doing that.
What would you like to do for stable branches? Would you be able to send a patch that applies on older 5.10 and 5.15 where commit d3b3404df318 ("serial: Fix incorrect rs485 polarity on uart open") has been backported?
If that sounds too complicated we could probably just revert a handful of serial_core/rs485 commits, but going forward sounds more future-proof to me.
Thanks! (nothing below, leaving quote for stable@)
<formletter>
This is not the correct way to submit patches for inclusion in the stable kernel tree. Please read: https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html for how to do this properly.
</formletter>
Yes, it does not apply. I've just added stable@ in cc so you're aware that 5.10 and 5.15 still have a problem with the serial code (and in case you have an opinion between trying to backport this big patch or reverting a bunch of older ones)
The quote is just context.
I can try to backport it and send it properly if Lukas doesn't have time, but it doesn't hurt to discuss first.
Thanks,
On Mon, Oct 10, 2022 at 03:17:14PM +0900, Dominique MARTINET wrote:
Lukas Wunner wrote on Thu, Sep 22, 2022 at 06:27:33PM +0200:
When a UART port is newly registered, uart_configure_port() seeks to deassert RS485 Transmit Enable by setting the RTS bit in port->mctrl. However a number of UART drivers interpret a set RTS bit as *assertion* instead of deassertion: Affected drivers include those using serial8250_em485_config() (except 8250_bcm2835aux.c) and some using mctrl_gpio (e.g. imx.c).
Since the interpretation of the RTS bit is driver-specific, it is not suitable as a means to centrally deassert Transmit Enable in the serial core. Instead, the serial core must call on drivers to deassert it in their driver-specific way. One way to achieve that is to call ->rs485_config(). It implicitly deasserts Transmit Enable.
So amend uart_configure_port() and uart_resume_port() to invoke uart_rs485_config(). That allows removing calls to uart_rs485_config() from drivers' ->probe() hooks and declaring the function static.
[...]
We also noticed rs485 DE was initially wrong last week and I noticed this when I was about to send a patch that just inverted the SER_RS485_RTS_AFTER_SEND check in uart_configure_port, but after reading the commit message here it's a lot more complicated than that depending on the serial driver...
Yes, sorry for the breakage.
Unfortunately you've marked this for v4.14+ stable, but it doesn't even apply to 5.19.14
[...]
What would you like to do for stable branches? Would you be able to send a patch that applies on older 5.10 and 5.15 where commit d3b3404df318 ("serial: Fix incorrect rs485 polarity on uart open") has been backported?
Greg will try to apply it to stable kernels (probably after the merge window closes) and send an e-mail that it failed. I was going to wait for that to happen and then look into backporting the patch.
Basically what needs to be done is replace calls to uart_rs485_config() with a direct invocation of port->rs485_config(). Plus carefully checking that nothing is missing or breaks. That's probably simpler than just backporting additional patches or reverting stuff. If you want to take a stab at it, go ahead. :)
Thanks,
Lukas
Lukas Wunner wrote on Mon, Oct 10, 2022 at 10:53:05AM +0200:
Unfortunately you've marked this for v4.14+ stable, but it doesn't even apply to 5.19.14
[...]
What would you like to do for stable branches? Would you be able to send a patch that applies on older 5.10 and 5.15 where commit d3b3404df318 ("serial: Fix incorrect rs485 polarity on uart open") has been backported?
Greg will try to apply it to stable kernels (probably after the merge window closes) and send an e-mail that it failed. I was going to wait for that to happen and then look into backporting the patch.
Ah, sorry for rushing you here -- I got tricked by the git committer date but that doesn't mean the merge commit was that old, I hadn't noticed this just got in.
Basically what needs to be done is replace calls to uart_rs485_config() with a direct invocation of port->rs485_config(). Plus carefully checking that nothing is missing or breaks. That's probably simpler than just backporting additional patches or reverting stuff. If you want to take a stab at it, go ahead. :)
The only hardware I have is ims and your patch touches at quite a few of the drivers, I'm not really in a good position to check anything there but I can give it a stab tomorrow or Wed
By the way that just made me check the imx code, but if I am to trust that set_mctrl is never called with RS485 enabled and rs485_config is only called when it is enabled should the SER_RS485_ENABLED checks be removed there, or did I misunderstand something and it's still useful?
(I wouldn't know if the rs232 hardware flags have any impact on rs485 actual control but I'll trust you on this and that nothing ever calls set_mctrl when rs485 is enabled... I would actually have said that rts_active/inactive should keep setting port->mctrl precisely for the cases where both are muxed as you'll otherwise unreliably enable/disable RTS based on the state the last time was when get_mctrl was called; but I haven't seen this done so it doesn't really matter to me)
Thanks,
linux-stable-mirror@lists.linaro.org
-
Dominique MARTINET -
Greg Kroah-Hartman -
Lukas Wunner