mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Ahmad Fatoum <a.fatoum@pengutronix.de>
To: barebox@lists.infradead.org
Cc: Ahmad Fatoum <a.fatoum@pengutronix.de>
Subject: [PATCH 1/3] Documentation: devel: background-execution: update section on I2C slices
Date: Fri,  9 Aug 2024 16:24:42 +0200	[thread overview]
Message-ID: <20240809142444.316021-1-a.fatoum@pengutronix.de> (raw)

When the documentation was written, there were no I2C slices yet.
The example is still useful to explain why slices need to be used, so
we'll leave it in, but update the documentation to reflect that slices
are indeed used now in I2C code.

Fixes: 51ae3151381b ("i2c: Add slices for I2C adapters")
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/devel/background-execution.rst | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/Documentation/devel/background-execution.rst b/Documentation/devel/background-execution.rst
index d379593efb23..cf8675b9aa0e 100644
--- a/Documentation/devel/background-execution.rst
+++ b/Documentation/devel/background-execution.rst
@@ -131,12 +131,14 @@ executed nothing else happens. This means that when fastboot flashes an image
 in a workqueue then barebox won't react to any key presses on the command line.
 The usage of the interfaces described in this document is not yet very
 widespread in barebox. The interfaces are used in the places where we need
-them, but there are other places which do not use them but should. For example
-using a LED driven by a I2C GPIO exander used as hearbeat LED won't work
-properly currently. Consider the I2C driver accesses an unrelated I2C device,
+them, but there are other places which do not use them but should.
+
+For example using a LED driven by a I2C GPIO expander used as hearbeat LED
+used to not work properly before addition of slices.
+Consider the I2C driver accesses an unrelated I2C device,
 like an EEPROM. After having initiated the transfer the driver polls for the
 transfer being completed using a ``is_timeout()`` loop. The call to
 ``is_timeout()`` then calls into the registered pollers from which one accesses
 the same I2C bus whose driver is just polling for completion of another
-transfer. With this the I2C driver is in an undefined state and will likely not
-work anymore.
+transfer. Without slices, this left the I2C driver in an undefined state,
+where it would likely not work anymore.
-- 
2.39.2




             reply	other threads:[~2024-08-09 14:25 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-09 14:24 Ahmad Fatoum [this message]
2024-08-09 14:24 ` [PATCH 2/3] Documentation: user: intro: add more info about mailing list Ahmad Fatoum
2024-08-09 14:24 ` [PATCH 3/3] README: bring it up to date Ahmad Fatoum
2024-08-14  8:06   ` Sascha Hauer
2024-08-14  8:04 ` [PATCH 1/3] Documentation: devel: background-execution: update section on I2C slices Sascha Hauer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240809142444.316021-1-a.fatoum@pengutronix.de \
    --to=a.fatoum@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox