From: Pragat Pandya <pragat.pandya@gmail.com>
To: corbet@lwn.net
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-kernel-mentees@lists.linuxfoundation.org,
skhan@linuxfoundation.org,
Pragat Pandya <pragat.pandya@gmail.com>
Subject: [PATCH v2 2/2] Documentation: Add io_ordering.rst to driver-api manual
Date: Tue, 3 Mar 2020 00:01:05 +0530 [thread overview]
Message-ID: <20200302183105.27628-3-pragat.pandya@gmail.com> (raw)
In-Reply-To: <20200302183105.27628-1-pragat.pandya@gmail.com>
Add io_ordering.rst under Documentation/driver-api and reference it from
Sphinx TOC Tree present in Documentation/driver-api/index.rst
Signed-off-by: Pragat Pandya <pragat.pandya@gmail.com>
---
Documentation/driver-api/index.rst | 1 +
Documentation/driver-api/io_ordering.rst | 51 ++++++++++++++++++++++++
2 files changed, 52 insertions(+)
create mode 100644 Documentation/driver-api/io_ordering.rst
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index e9da95004632..9335412e3832 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -80,6 +80,7 @@ available subsections can be seen below.
isa
isapnp
io-mapping
+ io_ordering
generic-counter
lightnvm-pblk
memory-devices/index
diff --git a/Documentation/driver-api/io_ordering.rst b/Documentation/driver-api/io_ordering.rst
new file mode 100644
index 000000000000..2ab303ce9a0d
--- /dev/null
+++ b/Documentation/driver-api/io_ordering.rst
@@ -0,0 +1,51 @@
+==============================================
+Ordering I/O writes to memory-mapped addresses
+==============================================
+
+On some platforms, so-called memory-mapped I/O is weakly ordered. On such
+platforms, driver writers are responsible for ensuring that I/O writes to
+memory-mapped addresses on their device arrive in the order intended. This is
+typically done by reading a 'safe' device or bridge register, causing the I/O
+chipset to flush pending writes to the device before any reads are posted. A
+driver would usually use this technique immediately prior to the exit of a
+critical section of code protected by spinlocks. This would ensure that
+subsequent writes to I/O space arrived only after all prior writes (much like a
+memory barrier op, mb(), only with respect to I/O).
+
+A more concrete example from a hypothetical device driver::
+
+ ...
+ CPU A: spin_lock_irqsave(&dev_lock, flags)
+ CPU A: val = readl(my_status);
+ CPU A: ...
+ CPU A: writel(newval, ring_ptr);
+ CPU A: spin_unlock_irqrestore(&dev_lock, flags)
+ ...
+ CPU B: spin_lock_irqsave(&dev_lock, flags)
+ CPU B: val = readl(my_status);
+ CPU B: ...
+ CPU B: writel(newval2, ring_ptr);
+ CPU B: spin_unlock_irqrestore(&dev_lock, flags)
+ ...
+
+In the case above, the device may receive newval2 before it receives newval,
+which could cause problems. Fixing it is easy enough though::
+
+ ...
+ CPU A: spin_lock_irqsave(&dev_lock, flags)
+ CPU A: val = readl(my_status);
+ CPU A: ...
+ CPU A: writel(newval, ring_ptr);
+ CPU A: (void)readl(safe_register); /* maybe a config register? */
+ CPU A: spin_unlock_irqrestore(&dev_lock, flags)
+ ...
+ CPU B: spin_lock_irqsave(&dev_lock, flags)
+ CPU B: val = readl(my_status);
+ CPU B: ...
+ CPU B: writel(newval2, ring_ptr);
+ CPU B: (void)readl(safe_register); /* maybe a config register? */
+ CPU B: spin_unlock_irqrestore(&dev_lock, flags)
+
+Here, the reads from safe_register will cause the I/O chipset to flush any
+pending writes before actually posting the read to the chipset, preventing
+possible data corruption.
--
2.17.1
next prev parent reply other threads:[~2020-03-02 18:32 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-02 17:39 [PATCH 0/2] Documentation: Add two new rst files Pragat Pandya
2020-03-02 17:39 ` [PATCH 1/2] Documentation: Add a new .rst file under Documentation Pragat Pandya
2020-03-02 17:45 ` Jonathan Corbet
2020-03-02 18:31 ` [PATCH v2 0/2] Documentation: Add files to driver-api manual Pragat Pandya
2020-03-02 18:31 ` [PATCH v2 1/2] Documentation: Add io-mapping.rst " Pragat Pandya
2020-03-02 18:31 ` Pragat Pandya [this message]
2020-03-02 18:43 ` [PATCH v2 0/2] Documentation: Add files " Jonathan Corbet
2020-03-03 5:02 ` [PATCH v3 0/2] Documentation: Rename two txt files to rst Pragat Pandya
2020-03-03 5:03 ` [PATCH v3 1/2] Documentation: Add io-mapping.rst to driver-api manual Pragat Pandya
2020-03-03 5:03 ` [PATCH v3 2/2] Documentation: Add io_ordering.rst " Pragat Pandya
2020-03-10 17:34 ` [PATCH v3 0/2] Documentation: Rename two txt files to rst Jonathan Corbet
2020-03-02 17:39 ` [PATCH 2/2] Documentation: Add a new .rst file under Documentation Pragat Pandya
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=20200302183105.27628-3-pragat.pandya@gmail.com \
--to=pragat.pandya@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.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;
as well as URLs for NNTP newsgroup(s).