Received-SPF: pass (google.com: domain of linux-kernel+bounces-160125-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Precedence: bulk
MIME-Version: 1.0
References: <20240426135937.3810959-1-hugo@hugovil.com>
In-Reply-To: <20240426135937.3810959-1-hugo@hugovil.com>
From: "Konstantin P." <ria.freelander@gmail.com>
Date: Fri, 26 Apr 2024 17:10:29 +0300
Message-ID: <CAF1WSuy60hWPX5gnhg+uWYu6E=i6=Gn-wFcYKNrXKSqCZ54LAg@mail.gmail.com>
Subject: Re: [PATCH] serial: sc16is7xx: fix bug in sc16is7xx_set_baud() when
 using prescaler
To: Hugo Villeneuve <hugo@hugovil.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Jiri Slaby <jirislaby@kernel.org>, 
	Jon Ringle <jringle@gridpoint.com>, Hugo Villeneuve <hvilleneuve@dimonoff.com>, stable@vger.kernel.org, 
	linux-kernel@vger.kernel.org, linux-serial@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Fri, Apr 26, 2024 at 4:59=E2=80=AFPM Hugo Villeneuve <hugo@hugovil.com> =
wrote:
>
> From: Hugo Villeneuve <hvilleneuve@dimonoff.com>
>
> When using a high speed clock with a low baud rate, the 4x prescaler is
> automatically selected if required. In that case, sc16is7xx_set_baud()
> properly configures the chip registers, but returns an incorrect baud
> rate by not taking into account the prescaler value. This incorrect baud
> rate is then fed to uart_update_timeout().
>
> For example, with an input clock of 80MHz, and a selected baud rate of 50=
,
> sc16is7xx_set_baud() will return 200 instead of 50.
>
> Fix this by first changing the prescaler variable to hold the selected
> prescaler value instead of the MCR bitfield. Then properly take into
> account the selected prescaler value in the return value computation.
>
> Also add better documentation about the divisor value computation.
>
> Fixes: dfeae619d781 ("serial: sc16is7xx")
> Cc: stable@vger.kernel.org
> Signed-off-by: Hugo Villeneuve <hvilleneuve@dimonoff.com>
> ---
>  drivers/tty/serial/sc16is7xx.c | 23 ++++++++++++++++++-----
>  1 file changed, 18 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/tty/serial/sc16is7xx.c b/drivers/tty/serial/sc16is7x=
x.c
> index 03cf30e20b75..dcd6c5615401 100644
> --- a/drivers/tty/serial/sc16is7xx.c
> +++ b/drivers/tty/serial/sc16is7xx.c
> @@ -555,16 +555,28 @@ static bool sc16is7xx_regmap_noinc(struct device *d=
ev, unsigned int reg)
>         return reg =3D=3D SC16IS7XX_RHR_REG;
>  }
>
> +/*
> + * Configure programmable baud rate generator (divisor) according to the
> + * desired baud rate.
> + *
> + * From the datasheet, the divisor is computed according to:
> + *
> + *              XTAL1 input frequency
> + *             -----------------------
> + *                    prescaler
> + * divisor =3D ---------------------------
> + *            baud-rate x sampling-rate
> + */
>  static int sc16is7xx_set_baud(struct uart_port *port, int baud)
>  {
>         struct sc16is7xx_one *one =3D to_sc16is7xx_one(port, port);
>         u8 lcr;
> -       u8 prescaler =3D 0;
> +       int prescaler =3D 1;
>         unsigned long clk =3D port->uartclk, div =3D clk / 16 / baud;
>
>         if (div >=3D BIT(16)) {
> -               prescaler =3D SC16IS7XX_MCR_CLKSEL_BIT;
> -               div /=3D 4;
> +               prescaler =3D 4;
> +               div /=3D prescaler;
>         }
>
>         /* Enable enhanced features */
> @@ -574,9 +586,10 @@ static int sc16is7xx_set_baud(struct uart_port *port=
, int baud)
>                               SC16IS7XX_EFR_ENABLE_BIT);
>         sc16is7xx_efr_unlock(port);
>
> +       /* If bit MCR_CLKSEL is set, the divide by 4 prescaler is activat=
ed. */
>         sc16is7xx_port_update(port, SC16IS7XX_MCR_REG,
>                               SC16IS7XX_MCR_CLKSEL_BIT,
> -                             prescaler);
> +                             prescaler =3D=3D 1 ? 0 : SC16IS7XX_MCR_CLKS=
EL_BIT);
>
>         /* Backup LCR and access special register set (DLL/DLH) */
>         lcr =3D sc16is7xx_port_read(port, SC16IS7XX_LCR_REG);
> @@ -592,7 +605,7 @@ static int sc16is7xx_set_baud(struct uart_port *port,=
 int baud)
>         /* Restore LCR and access to general register set */
>         sc16is7xx_port_write(port, SC16IS7XX_LCR_REG, lcr);
>
> -       return DIV_ROUND_CLOSEST(clk / 16, div);
> +       return DIV_ROUND_CLOSEST((clk / prescaler) / 16, div);
>  }
>
>  static void sc16is7xx_handle_rx(struct uart_port *port, unsigned int rxl=
en,
>
> base-commit: 660a708098569a66a47d0abdad998e29e1259de6
> --
> 2.39.2
>

For me, looks normal. Does not cause problems on my vendored kernel
with my XR20M1172 patches. Do I need to integrate those inside my
patch? Or how should I do?