Re: [PATCH -next v2 19/21] spi: dw: switch to use modern name

From: Serge Semin <fancer.lancer@gmail.com>
To: Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Yang Yingliang <yangyingliang@huawei.com>,
	linux-spi@vger.kernel.org, broonie@kernel.org, lukas@wunner.de
Subject: Re: [PATCH -next v2 19/21] spi: dw: switch to use modern name
Date: Wed, 16 Aug 2023 12:38:48 +0300	[thread overview]
Message-ID: <hq4k5y6el34vghqrfrg4sjgpvnw32fqyqlwfahypu4m4hoodfj@x4sprdm22b7s> (raw)
In-Reply-To: <CAMuHMdU0akTNec7z_aAw=i_NO8j-j0Q_XsRiYhnnPj53qLneug@mail.gmail.com>

Hi Geert

On Wed, Aug 16, 2023 at 09:17:52AM +0200, Geert Uytterhoeven wrote:
> Hi Yang,
> 
> On Wed, Aug 16, 2023 at 5:45 AM Yang Yingliang <yangyingliang@huawei.com> wrote:
> > On 2023/8/15 19:36, Geert Uytterhoeven wrote:
> > > On Mon, Aug 7, 2023 at 4:10 PM Yang Yingliang <yangyingliang@huawei.com> wrote:
> > >> Change legacy name master to modern name host or controller.
> > >>
> > >> No functional changed.
> > >>
> > >> Signed-off-by: Yang Yingliang <yangyingliang@huawei.com>
> > > Thanks for your patch, which is now commit eefc6c5c2451126c ("spi:
> > > dw: switch to use modern name") in spi/for-next.
> > >
> > >> --- a/drivers/spi/spi-dw-mmio.c
> > >> +++ b/drivers/spi/spi-dw-mmio.c
> > >> @@ -68,7 +68,7 @@ struct dw_spi_mscc {
> > >>                  ((((val) << 1) | BIT(0)) << ELBA_SPICS_OFFSET(cs))
> > >>
> > >>   /*
> > >> - * The Designware SPI controller (referred to as master in the documentation)
> > >> + * The Designware SPI controller (referred to as host in the documentation)
> > >>    * automatically deasserts chip select when the tx fifo is empty. The chip
> > >>    * selects then needs to be either driven as GPIOs or, for the first 4 using
> > >>    * the SPI boot controller registers. the final chip select is an OR gate
> > > Have you verified that Synopsys did update the documentation for the
> > > Designware SPI controller?  If not, I think it's prudent to keep the
> > > old name.
> >
> > I'm trying to rename the legacy name(master/slave) to modern
> > name(host/target) used in SPI drivers,
> > is it ok to change this comment master to host ?
> 

> That depends on the (external) documentation this comment refers
> to.  If that documentation refers to master, you must not change
> the comment.
> 
> https://www.synopsys.com/dw/ipdir.php?ds=amba_ssi offers a download
> link which is supposed to allow you to download this documentation
> after registration, but unfortunately that process doesn't seem to work
> (it just takes me back to the same page).

I don't think Synopsys will let anybody to freely download their IP-core
databook with no NDA signed. The only docs which can be relatively
simple reached is the brief IP-core datasheet. For instance the DW SSI
datasheet is available here:
https://www.synopsys.com/dw/doc.php/ds/c/amba_ssi.pdf
I had to provide my corporate private data to get that pdf-file
including the corporate email. That file doesn't use any master or
slave words but I doubt it used to have them anyway because
another modern datasheet still utilizes master/slave wording:
https://www.synopsys.com/dw/doc.php/ds/i/dw_amba_solutions.pdf

So as I already answered to Yang I doubt Synopsys has executed any
renaming. You are correct to note the questionable change in this
patch. Thanks.

-Serge(y)

> 
> > >> @@ -142,14 +142,14 @@ static int dw_spi_mscc_jaguar2_init(struct platform_device *pdev,
> > >>   }
> > >>
> > >>   /*
> > >> - * The Designware SPI controller (referred to as master in the
> > >> + * The Designware SPI controller (referred to as host in the
> > > Likewise.
> > >
> > >>    * documentation) automatically deasserts chip select when the tx fifo
> > >>    * is empty. The chip selects then needs to be driven by a CS override
> > >>    * register. enable is an active low signal.
> > >>    */
> > >>   static void dw_spi_sparx5_set_cs(struct spi_device *spi, bool enable)
> > >>   {
> 
> Gr{oetje,eeting}s,
> 
>                         Geert
> 
> -- 
> Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org
> 
> In personal conversations with technical people, I call myself a hacker. But
> when I'm talking to journalists I just say "programmer" or something like that.
>                                 -- Linus Torvalds