Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:8 as permitted sender) client-ip=2620:137:e000::3:8;
From:   =?iso-8859-1?Q?Jan_Kundr=E1t?= <jan.kundrat@cesnet.cz>
To:     Hugo Villeneuve <hugo@hugovil.com>
Cc:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Jiri Slaby <jirislaby@kernel.org>,
        Hugo Villeneuve <hvilleneuve@dimonoff.com>,
        <linux-kernel@vger.kernel.org>, <linux-serial@vger.kernel.org>
Subject: Re: [PATCH] serial: max310x: change confusing comment about Tx FIFO
Date:   Fri, 01 Dec 2023 17:04:15 +0100
MIME-Version: 1.0
Message-ID: <f6e44cd7-4b25-48de-a57c-96497bf9da6a@cesnet.cz>
In-Reply-To: <20231122175957.3875102-1-hugo@hugovil.com>
References: <20231122175957.3875102-1-hugo@hugovil.com>
Organization: CESNET
User-Agent: Trojita/unstable-2022-08-22; Qt/5.15.10; wayland; Linux; 
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

On st=C5=99eda 22. listopadu 2023 18:59:56 CET, Hugo Villeneuve wrote:
> From: Hugo Villeneuve <hvilleneuve@dimonoff.com>
>
> 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.

This (commit) message is confusing, too, IMHO, because `txlen` is the=20
number of bytes that are currently waiting in the TX FIFO. So that number=20
is "available" for the HW UART to pick up and send, but it's not a number=20
of bytes that's "available" in the FIFO for host to push more bytes to. I=20
guess you might want to tweak that description here.

Cheers,
Jan

>
> Change the comment so that it is unambiguous.
>
> Signed-off-by: Hugo Villeneuve <hvilleneuve@dimonoff.com>
> ---
>  drivers/tty/serial/max310x.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/tty/serial/max310x.c b/drivers/tty/serial/max310x.c
> index 97e4965b73d4..f3a99daebdaa 100644
> --- a/drivers/tty/serial/max310x.c
> +++ b/drivers/tty/serial/max310x.c
> @@ -780,7 +780,7 @@ static void max310x_handle_tx(struct uart_port *port)
>  =09to_send =3D uart_circ_chars_pending(xmit);
>  =09until_end =3D CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE);
>  =09if (likely(to_send)) {
> -=09=09/* Limit to size of TX FIFO */
> +=09=09/* Limit to space available in TX FIFO */
>  =09=09txlen =3D max310x_port_read(port, MAX310X_TXFIFOLVL_REG);
>  =09=09txlen =3D port->fifosize - txlen;
>  =09=09to_send =3D (to_send > txlen) ? txlen : to_send;
>
> base-commit: 98b1cc82c4affc16f5598d4fa14b1858671b2263