serial: max310x: change confusing comment about Tx FIFO
authorHugo Villeneuve <hvilleneuve@dimonoff.com>
Wed, 22 Nov 2023 17:59:56 +0000 (12:59 -0500)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Sat, 25 Nov 2023 07:23:16 +0000 (07:23 +0000)
The comment wording can be confusing, as txlen will return the number of
bytes available in the FIFO, which can be less than the maximum theoretical
Tx FIFO size.

Change the comment so that it is unambiguous.

Signed-off-by: Hugo Villeneuve <hvilleneuve@dimonoff.com>
Link: https://lore.kernel.org/r/20231122175957.3875102-1-hugo@hugovil.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/tty/serial/max310x.c

index 97e4965..f3a99da 100644 (file)
@@ -780,7 +780,7 @@ static void max310x_handle_tx(struct uart_port *port)
        to_send = uart_circ_chars_pending(xmit);
        until_end = CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE);
        if (likely(to_send)) {
-               /* Limit to size of TX FIFO */
+               /* Limit to space available in TX FIFO */
                txlen = max310x_port_read(port, MAX310X_TXFIFOLVL_REG);
                txlen = port->fifosize - txlen;
                to_send = (to_send > txlen) ? txlen : to_send;