[PATCH v4 7/8] mtd: spi-nor: Enhance locking to support reads while writes

[Miquel Raynal]

Hi Tudor,

tudor.ambarus at linaro.org wrote on Fri, 17 Mar 2023 05:59:08 +0000:

> Hi, Miquel,
> 
> I find the overall idea good.

Thanks a lot for the detailed review!

> On 2/1/23 11:36, Miquel Raynal wrote:
> > On devices featuring several banks, the Read While Write (RWW) feature
> > is here to improve the overall performance when performing parallel
> > reads and writes at different locations (different banks). The following
> > constraints have to be taken into account:
> > 1#: A single operation can be performed in a given bank.
> > 2#: Only a single program or erase operation can happen on the entire
> >     chip (common hardware limitation to limit costs)
> > 3#: Reads must remain serialized even though reads on different banks
> >     might occur at the same time.  
> 
> 3# is unclear if one limits just at reading the commit message. Are the
> reads serialized per bank or per flash?

Per flash.

> After reading the code, it looks like all the reads are serialized per
> flash regardless if it reads registers or memory. I assume you meant
> that crossing a bank boundary with a single read is fine.

Yes, I will update that item to clarify.

> But can you
> really read from bank 1 and bank 3 at the same time? The code doesn't
> take this into consideration.

Yes this is taken into account and supported, a read can cross a bank
boundary.

> 
> > 4#: The I/O bus is unique and thus is the most constrained resource, all
> >     spi-nor operations requiring access to the spi bus (through the spi
> >     controller) must be serialized until the bus exchanges are over. So
> >     we must ensure a single operation can be "sent" at a time.
> > 5#: Any other operation that would not be either a read or a write or an
> >     erase is considered requiring access to the full chip and cannot be
> >     parallelized, we then need to ensure the full chip is in the idle
> >     state when this occurs.
> > 
> > All these constraints can easily be managed with a proper locking model:
> > 1#: Is enforced by a bitfield of the in-use banks, so that only a single
> >     operation can happen in a specific bank at any time.
> > 2#: Is handled by the ongoing_pe boolean which is set before any write
> >     or erase, and is released only at the very end of the
> >     operation. This way, no other destructive operation on the chip can
> >     start during this time frame.
> > 3#: An ongoing_rd boolean allows to track the ongoing reads, so that
> >     only one can be performed at a time.
> > 4#: An ongoing_io boolean is introduced in order to capture and serialize
> >     bus accessed. This is the one being released "sooner" than before,
> >     because we only need to protect the chip against other SPI accesses
> >     during the I/O phase, which for the destructive operations is the
> >     beginning of the operation (when we send the command cycles and
> >     possibly the data), while the second part of the operation (the
> >     erase delay or the programmation delay) is when we can do something
> >     else in another bank.
> > 5#: Is handled by the three booleans presented above, if any of them is
> >     set, the chip is not yet ready for the operation and must wait.
> > 
> > All these internal variables are protected by the existing lock, so that
> > changes in this structure are atomic. The serialization is handled with
> > a wait queue.
> > 
> > Signed-off-by: Miquel Raynal <miquel.raynal at bootlin.com>
> > ---
> >  drivers/mtd/spi-nor/core.c  | 319 ++++++++++++++++++++++++++++++++++--
> >  include/linux/mtd/spi-nor.h |  13 ++
> >  2 files changed, 317 insertions(+), 15 deletions(-)
> > 
> > diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c
> > index ac4627e0d6c2..ad2436e3688f 100644
> > --- a/drivers/mtd/spi-nor/core.c
> > +++ b/drivers/mtd/spi-nor/core.c
> > @@ -589,6 +589,66 @@ int spi_nor_sr_ready(struct spi_nor *nor)
> >  	return !(nor->bouncebuf[0] & SR_WIP);
> >  }
> >  
> > +/**
> > + * spi_nor_parallel_locking() - Checks if the RWW locking scheme shall be used
> > + * @nor:	pointer to 'struct spi_nor'.
> > + *
> > + * Return: true if parallel locking is enabled, false otherwise.
> > + */
> > +static bool spi_nor_parallel_locking(struct spi_nor *nor)
> > +{
> > +	if (nor->controller_ops &&
> > +	    (nor->controller_ops->prepare || nor->controller_ops->unprepare))
> > +		return false;  
> 
> We won't allow controller drivers in spi-nor/controllers to benefit of
> this feature, just do:
> 	if (nor->controller_ops)
> 		return false;

That is also checked in the spi-nor init helper, where SNOR_F_RWW is
now set, so no need to check it again and again.

> > +	return nor->info->n_banks > 1 && nor->info->no_sfdp_flags & SPI_NOR_RWW;  
> 
> we don't play with flash info flags throughout the core. Introduce a
> SNOR_F equivalent flag, see how they're used. You'll be able to get rid
> of the n_banks check as well.

Thanks for the clear pointers, looks much nicer now!

> > +}
> > +
> > +/* Locking helpers for status read operations */
> > +static int spi_nor_rww_start_rdst(struct spi_nor *nor)
> > +{
> > +	int ret = -EAGAIN;  
> 
> you can have a pointer to rww here, you'll avoid all those dereferences
> from nor. I would add such a pointer wherever there is more than one
> dereference, so the comment is for the entire patch.

haha, I guess this is a matter of taste, I'm not bothered by those, but
ok, I'll make the change here and after :-)

> > +
> > +	mutex_lock(&nor->lock);
> > +
> > +	if (nor->rww.ongoing_io || nor->rww.ongoing_rd)
> > +		goto busy;
> > +
> > +	nor->rww.ongoing_io = true;
> > +	nor->rww.ongoing_rd = true;
> > +	ret = 0;
> > +
> > +busy:
> > +	mutex_unlock(&nor->lock);
> > +	return ret;
> > +}
> > +
> > +static void spi_nor_rww_end_rdst(struct spi_nor *nor)
> > +{
> > +	mutex_lock(&nor->lock);
> > +
> > +	nor->rww.ongoing_io = false;
> > +	nor->rww.ongoing_rd = false;
> > +
> > +	mutex_unlock(&nor->lock);
> > +}
> > +
> > +static int spi_nor_lock_rdst(struct spi_nor *nor)
> > +{
> > +	if (spi_nor_parallel_locking(nor))
> > +		return spi_nor_rww_start_rdst(nor);
> > +
> > +	return 0;
> > +}
> > +
> > +static void spi_nor_unlock_rdst(struct spi_nor *nor)
> > +{
> > +	if (spi_nor_parallel_locking(nor)) {
> > +		spi_nor_rww_end_rdst(nor);
> > +		wake_up(&nor->rww.wait);
> > +	}
> > +}
> > +
> >  /**
> >   * spi_nor_ready() - Query the flash to see if it is ready for new commands.
> >   * @nor:	pointer to 'struct spi_nor'.
> > @@ -597,11 +657,21 @@ int spi_nor_sr_ready(struct spi_nor *nor)
> >   */
> >  static int spi_nor_ready(struct spi_nor *nor)
> >  {
> > +	int ret;
> > +
> > +	ret = spi_nor_lock_rdst(nor);
> > +	if (ret)
> > +		return 0;
> > +
> >  	/* Flashes might override the standard routine. */
> >  	if (nor->params->ready)
> > -		return nor->params->ready(nor);
> > +		ret = nor->params->ready(nor);
> > +	else
> > +		ret = spi_nor_sr_ready(nor);
> >  
> > -	return spi_nor_sr_ready(nor);
> > +	spi_nor_unlock_rdst(nor);
> > +
> > +	return ret;
> >  }
> >  
> >  /**
> > @@ -1087,7 +1157,81 @@ static void spi_nor_unprep(struct spi_nor *nor)
> >  		nor->controller_ops->unprepare(nor);
> >  }
> >  
> > +static void spi_nor_offset_to_banks(struct spi_nor *nor, loff_t start, size_t len,  
> 
> pass directly the bank_size instead of the pointer to nor, you'll avoid
> the double dereference.

Done

> 
> > +				    unsigned int *first, unsigned int *last)  
> 
> unsigned long long *first, *last ?

Actually I want these to remain unsigned int, the ULL suffix just mean
the input might be a 64-bit value, but it is quite common to treat the
output as 32-bit. Here we do not expect values greater than 4.

> > +{
> > +	*first = DIV_ROUND_DOWN_ULL(start, nor->params->bank_size);
> > +	*last = DIV_ROUND_DOWN_ULL(start + len - 1, nor->params->bank_size);
> > +}
> > +
> >  /* Generic helpers for internal locking and serialization */
> > +static bool spi_nor_rww_start_io(struct spi_nor *nor)
> > +{
> > +	bool start = false;
> > +
> > +	mutex_lock(&nor->lock);
> > +
> > +	if (nor->rww.ongoing_io)
> > +		goto busy;
> > +
> > +	nor->rww.ongoing_io = true;
> > +	start = true;
> > +
> > +busy:
> > +	mutex_unlock(&nor->lock);
> > +	return start;
> > +}
> > +
> > +static void spi_nor_rww_end_io(struct spi_nor *nor)
> > +{
> > +	mutex_lock(&nor->lock);
> > +	nor->rww.ongoing_io = false;
> > +	mutex_unlock(&nor->lock);
> > +}
> > +
> > +static int spi_nor_lock_device(struct spi_nor *nor)
> > +{
> > +	if (!spi_nor_parallel_locking(nor))
> > +		return 0;
> > +
> > +	return wait_event_killable(nor->rww.wait, spi_nor_rww_start_io(nor));
> > +}
> > +
> > +static void spi_nor_unlock_device(struct spi_nor *nor)
> > +{
> > +	if (spi_nor_parallel_locking(nor))
> > +		spi_nor_rww_end_io(nor);  
> 
> shall we wake_up here too?

True

> 
> > +}
> > +
> > +/* Generic helpers for internal locking and serialization */
> > +static bool spi_nor_rww_start_exclusive(struct spi_nor *nor)
> > +{
> > +	bool start = false;
> > +
> > +	mutex_lock(&nor->lock);
> > +
> > +	if (nor->rww.ongoing_io || nor->rww.ongoing_rd || nor->rww.ongoing_pe)
> > +		goto busy;
> > +
> > +	nor->rww.ongoing_io = true;
> > +	nor->rww.ongoing_rd = true;
> > +	nor->rww.ongoing_pe = true;
> > +	start = true;
> > +
> > +busy:
> > +	mutex_unlock(&nor->lock);
> > +	return start;
> > +}
> > +
> > +static void spi_nor_rww_end_exclusive(struct spi_nor *nor)
> > +{
> > +	mutex_lock(&nor->lock);
> > +	nor->rww.ongoing_io = false;
> > +	nor->rww.ongoing_rd = false;
> > +	nor->rww.ongoing_pe = false;
> > +	mutex_unlock(&nor->lock);
> > +}
> > +
> >  int spi_nor_prep_and_lock(struct spi_nor *nor)
> >  {
> >  	int ret;
> > @@ -1096,19 +1240,71 @@ int spi_nor_prep_and_lock(struct spi_nor *nor)
> >  	if (ret)
> >  		return ret;
> >  
> > -	mutex_lock(&nor->lock);
> > +	if (!spi_nor_parallel_locking(nor))
> > +		mutex_lock(&nor->lock);
> > +	else
> > +		ret = wait_event_killable(nor->rww.wait,
> > +					  spi_nor_rww_start_exclusive(nor));
> >  
> 
> No, don't touch spi_nor_prep_and_lock() and spi_nor_unlock_and_unprep(),
> you're giving the impresion that users of it (OTP, SWP) are safe to use
> them while reads or PE are in progress, which is not the case, because
> you don't guard the ops that they're using. You'll also have to document
> the flash info RWW flag ands say it is mutual exclusive with SWP and OTP
> features.

Actually I'm not getting what you mean here. Any access that is not
a pure read, write or erase (like register accesses, otp and swp
accesses) are automatically treated as needing full and exclusive
access to the chip. So everything works as before with these, even
if RWW is enabled, because that's not where we want performance
improvements. So I need to implement a dedicated "parallel_locking"
path inside these helpers to clearly enforcing an exclusive access to
the chip.

> > -	return 0;
> > +	return ret;
> >  }
> >  
> >  void spi_nor_unlock_and_unprep(struct spi_nor *nor)
> >  {
> > -	mutex_unlock(&nor->lock);
> > +	if (!spi_nor_parallel_locking(nor)) {
> > +		mutex_unlock(&nor->lock);
> > +	} else {
> > +		spi_nor_rww_end_exclusive(nor);
> > +		wake_up(&nor->rww.wait);
> > +	}
> >  
> >  	spi_nor_unprep(nor);
> >  }
> >  
> >  /* Internal locking helpers for program and erase operations */
> > +static bool spi_nor_rww_start_pe(struct spi_nor *nor, loff_t start, size_t len)
> > +{
> > +	unsigned int first, last;
> > +	bool started = false;
> > +	int bank;
> > +
> > +	mutex_lock(&nor->lock);
> > +
> > +	if (nor->rww.ongoing_io || nor->rww.ongoing_rd || nor->rww.ongoing_pe)
> > +		goto busy;
> > +
> > +	spi_nor_offset_to_banks(nor, start, len, &first, &last);
> > +	for (bank = first; bank <= last; bank++)
> > +		if (nor->rww.used_banks & BIT(bank))
> > +			goto busy;
> > +
> > +	for (bank = first; bank <= last; bank++)  
> you can avoid this second look by introducing a local used_banks
> variable and have the mask set in the previous loop. Then you'll just do
> an init at this point.

Done.

> 
> > +		nor->rww.used_banks |= BIT(bank);
> > +
> > +	nor->rww.ongoing_pe = true;
> > +	started = true;
> > +
> > +busy:
> > +	mutex_unlock(&nor->lock);
> > +	return started;
> > +}
> > +
> > +static void spi_nor_rww_end_pe(struct spi_nor *nor, loff_t start, size_t len)
> > +{
> > +	unsigned int first, last;
> > +	int bank;
> > +
> > +	mutex_lock(&nor->lock);
> > +
> > +	spi_nor_offset_to_banks(nor, start, len, &first, &last);
> > +	for (bank = first; bank <= last; bank++)
> > +		nor->rww.used_banks &= ~BIT(bank);
> > +
> > +	nor->rww.ongoing_pe = false;
> > +
> > +	mutex_unlock(&nor->lock);
> > +}
> > +
> >  static int spi_nor_prep_and_lock_pe(struct spi_nor *nor, loff_t start, size_t len)
> >  {
> >  	int ret;
> > @@ -1117,19 +1313,73 @@ static int spi_nor_prep_and_lock_pe(struct spi_nor *nor, loff_t start, size_t le
> >  	if (ret)
> >  		return ret;
> >  
> > -	mutex_lock(&nor->lock);
> > +	if (!spi_nor_parallel_locking(nor))
> > +		mutex_lock(&nor->lock);
> > +	else
> > +		ret = wait_event_killable(nor->rww.wait,
> > +					  spi_nor_rww_start_pe(nor, start, len));
> >  
> > -	return 0;
> > +	return ret;
> >  }
> >  
> >  static void spi_nor_unlock_and_unprep_pe(struct spi_nor *nor, loff_t start, size_t len)
> >  {
> > -	mutex_unlock(&nor->lock);
> > +	if (!spi_nor_parallel_locking(nor)) {
> > +		mutex_unlock(&nor->lock);
> > +	} else {
> > +		spi_nor_rww_end_pe(nor, start, len);
> > +		wake_up(&nor->rww.wait);
> > +	}
> >  
> >  	spi_nor_unprep(nor);
> >  }
> >  
> >  /* Internal locking helpers for read operations */
> > +static bool spi_nor_rww_start_rd(struct spi_nor *nor, loff_t start, size_t len)
> > +{
> > +	unsigned int first, last;
> > +	bool started = false;
> > +	int bank;
> > +
> > +	mutex_lock(&nor->lock);
> > +
> > +	if (nor->rww.ongoing_io || nor->rww.ongoing_rd)
> > +		goto busy;
> > +
> > +	spi_nor_offset_to_banks(nor, start, len, &first, &last);
> > +	for (bank = first; bank <= last; bank++)
> > +		if (nor->rww.used_banks & BIT(bank))
> > +			goto busy;
> > +
> > +	for (bank = first; bank <= last; bank++)  
> 
> mask to avoid 2nd loop

Done as well.

Thanks a lot!
Miquèl