diff mbox series

[08/14] serial: sh-sci: Fix a comment about SCIFA

Message ID 20250129165122.2980-9-thierry.bultel.yh@bp.renesas.com
State New
Headers show
Series None | expand

Commit Message

Thierry Bultel Jan. 29, 2025, 4:37 p.m. UTC
RZ/T1 has SCIFA, 'T' is not relevant.

Signed-off-by: Thierry Bultel <thierry.bultel.yh@bp.renesas.com>
---
 drivers/tty/serial/sh-sci.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Geert Uytterhoeven Jan. 30, 2025, 8:38 a.m. UTC | #1
CC linux-renesas-soc

On Wed, 29 Jan 2025 at 17:54, Thierry Bultel
<thierry.bultel.yh@bp.renesas.com> wrote:
>
> RZ/T1 has SCIFA, 'T' is not relevant.
>
> Signed-off-by: Thierry Bultel <thierry.bultel.yh@bp.renesas.com>
> ---
>  drivers/tty/serial/sh-sci.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/tty/serial/sh-sci.c b/drivers/tty/serial/sh-sci.c
> index 924b803af440..5ba25a6a5432 100644
> --- a/drivers/tty/serial/sh-sci.c
> +++ b/drivers/tty/serial/sh-sci.c
> @@ -291,7 +291,7 @@ static const struct sci_port_params sci_port_params[SCIx_NR_REGTYPES] = {
>         },
>
>         /*
> -        * The "SCIFA" that is in RZ/A2, RZ/G2L and RZ/T.
> +        * The "SCIFA" that is in RZ/A2, RZ/G2L and RZ/T1
>          * It looks like a normal SCIF with FIFO data, but with a
>          * compressed address space. Also, the break out of interrupts
>          * are different: ERI/BRI, RXI, TXI, TEI, DRI.
> --
> 2.43.0
Paul Barker Feb. 4, 2025, 4:51 p.m. UTC | #2
On 29/01/2025 16:37, Thierry Bultel wrote:
> RZ/T1 has SCIFA, 'T' is not relevant.
> 
> Signed-off-by: Thierry Bultel <thierry.bultel.yh@bp.renesas.com>

It'd be good to explain this better in the commit message, something like:

    The comment was correct when it was added, at that time RZ/T1 was
    the only SoC in the RZ/T line. Since then, further SoCs have been
    added with RZ/T names which do not use the same SCIFA register
    layout and so the comment is now misleading.

    So we update the comment to explicitly reference only RZ/T1 SoCs.

> ---
>  drivers/tty/serial/sh-sci.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/tty/serial/sh-sci.c b/drivers/tty/serial/sh-sci.c
> index 924b803af440..5ba25a6a5432 100644
> --- a/drivers/tty/serial/sh-sci.c
> +++ b/drivers/tty/serial/sh-sci.c
> @@ -291,7 +291,7 @@ static const struct sci_port_params sci_port_params[SCIx_NR_REGTYPES] = {
>  	},
>  
>  	/*
> -	 * The "SCIFA" that is in RZ/A2, RZ/G2L and RZ/T.
> +	 * The "SCIFA" that is in RZ/A2, RZ/G2L and RZ/T1

Please keep the full stop at the end of the sentence for consistency.

>  	 * It looks like a normal SCIF with FIFO data, but with a
>  	 * compressed address space. Also, the break out of interrupts
>  	 * are different: ERI/BRI, RXI, TXI, TEI, DRI.

Thanks,
diff mbox series

Patch

diff --git a/drivers/tty/serial/sh-sci.c b/drivers/tty/serial/sh-sci.c
index 924b803af440..5ba25a6a5432 100644
--- a/drivers/tty/serial/sh-sci.c
+++ b/drivers/tty/serial/sh-sci.c
@@ -291,7 +291,7 @@  static const struct sci_port_params sci_port_params[SCIx_NR_REGTYPES] = {
 	},
 
 	/*
-	 * The "SCIFA" that is in RZ/A2, RZ/G2L and RZ/T.
+	 * The "SCIFA" that is in RZ/A2, RZ/G2L and RZ/T1
 	 * It looks like a normal SCIF with FIFO data, but with a
 	 * compressed address space. Also, the break out of interrupts
 	 * are different: ERI/BRI, RXI, TXI, TEI, DRI.