Re: [PATCH 2/6] spi: spi-fsl-dspi: Fix little endian access to PUSHR CMD and TXDATA

[Michael Walle]

Am 2020-03-09 19:07, schrieb Vladimir Oltean:
> Hi Michael,
>
> On Mon, 9 Mar 2020 at 19:59, Michael Walle <michael@xxxxxxxx> wrote:
> > Am 2020-03-09 15:56, schrieb Vladimir Oltean:
> > > From: Vladimir Oltean <vladimir.oltean@xxxxxxx>
> > >
> > > In XSPI mode, the 32-bit PUSHR register can be written to separately:
> > > the higher 16 bits are for commands and the lower 16 bits are for data.
> > >
> > > This has nicely been hacked around, by defining a second regmap with a
> > > width of 16 bits, and effectively splitting a 32-bit register into 2
> > > 16-bit ones, from the perspective of this regmap_pushr.
> > >
> > > The problem is the assumption about the controller's endianness. If the
> > > controller is little endian (such as anything post-LS1046A), then the
> > > first 2 bytes, in the order imposed by memory layout, will actually
> > > hold
> > > the TXDATA, and the last 2 bytes will hold the CMD.
> > >
> > > So take the controller's endianness into account when performing split
> > > writes to PUSHR. The obvious and simple solution would have been to
> > > call
> > > regmap_get_val_endian(), but that is an internal regmap function and we
> > > don't want to change regmap just for this. Therefore, we define the
> > > offsets per-instantiation, in the devtype_data structure. This means
> > > that we have to know from the driver which controllers are big- and
> > > which are little-endian (which is fine, we do, but it makes the device
> > > tree binding itself a little redundant except for regmap_config).
> > >
> > > This patch does not apply cleanly to stable trees, and a punctual fix
> > > to
> > > the commit cannot be provided given this constraint of lack of access
> > > to
> > > regmap_get_val_endian(). The per-SoC devtype_data structures (and
> > > therefore the premises to fix this bug) have been introduced only a few
> > > commits ago, in commit d35054010b57 ("spi: spi-fsl-dspi: Use specific
> > > compatible strings for all SoC instantiations")
> > >
> > > Fixes: 58ba07ec79e6 ("spi: spi-fsl-dspi: Add support for XSPI mode
> > > registers")
> > > Signed-off-by: Vladimir Oltean <vladimir.oltean@xxxxxxx>
> > > ---
> > >  drivers/spi/spi-fsl-dspi.c | 28 ++++++++++++++++++++++------
> > >  1 file changed, 22 insertions(+), 6 deletions(-)
> > >
> > > diff --git a/drivers/spi/spi-fsl-dspi.c b/drivers/spi/spi-fsl-dspi.c
> > > index 0ce26c1cbf62..a8e56abe20ac 100644
> > > --- a/drivers/spi/spi-fsl-dspi.c
> > > +++ b/drivers/spi/spi-fsl-dspi.c
> > > @@ -103,10 +103,6 @@
> > >  #define SPI_FRAME_BITS(bits)         SPI_CTAR_FMSZ((bits) - 1)
> > >  #define SPI_FRAME_EBITS(bits)                SPI_CTARE_FMSZE(((bits) - 1) >> 4)
> > >
> > > -/* Register offsets for regmap_pushr */
> > > -#define PUSHR_CMD                    0x0
> > > -#define PUSHR_TX                     0x2
> > > -
> > >  #define DMA_COMPLETION_TIMEOUT               msecs_to_jiffies(3000)
> > >
> > >  struct chip_data {
> > > @@ -124,6 +120,12 @@ struct fsl_dspi_devtype_data {
> > >       u8                      max_clock_factor;
> > >       int                     fifo_size;
> > >       int                     dma_bufsize;
> > > +     /*
> > > +      * Offsets for CMD and TXDATA within SPI_PUSHR when accessed
> > > +      * individually (in XSPI mode)
> > > +      */
> > > +     int                     pushr_cmd;
> > > +     int                     pushr_tx;
> > >  };
> >
> > Shouldn't this just read the "little-endian" property of the
> > device tree node?
>
> This is exactly what the driver did prior to this commit from 2014:
> https://patchwork.kernel.org/patch/4732711/
> Since then, "little-endian" and "big-endian" became generic regmap 
> properties.
>
> > Like it worked before with regmap, which takes
> > the little-endian/big-endian property into account.
>
> So XSPI mode allows you, among other things, to send 32 bits words at a 
> time.
> In my opinion this was tested only the big-endian DSPI controllers
> (LS1021A, LS1043A etc).
> On the little-endian controllers (LS2, LX2, LS1028A) I suspect this
> was actually never tested.
> The reason why we see it now is because we're "accelerating" even
> 8-bit words to 32-bit.
> So it is incorrect to say "like it worked before": it never worked 
> before.

I just meant how the endianess is figured out ;) Like by using the
endianess property in the device tree. Not by also taking the compatible
string into account.


> > If I understand this correctly, this solution would mix the methods
> > how the IP endianess is determined. Eg. regmap_xx uses the
> > little-endian property and this driver then also uses the compatible
> > string to also distinguish between the endianess.
>
> Yup. Otherwise we effectively have to duplicate the logic from the
> internal regmap_get_val_endian function. I found no other way to
> figure out what endianness the regmap_config has. Suggestions welcome.

If there is no way in determining that, you could just use the
of_property_read_bool(). there is also of_device_is_big_endian()
although I don't know if this is consistent with how the regmap uses it.
Eg. is it big-endian or little-endian if there is no property at all?

I mean something like:

if (little_endian)
    regmap_write(regmap, PUSHR_CMD_LE, cmd)
else
    regmap_write(regmap, PUSHR_CMD_BE, cmd)

Eg. if one would add another SoC to the DSPI driver, you would also need
to specify the cmd/tx offset. But actually its already known because it
just depend on the endianess which is already specified in the device 
tree.

-michael