public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Parav Pandit <parav@nvidia.com>
To: <bagasdotme@gmail.com>, <arnd@arndb.de>,
	<stern@rowland.harvard.edu>, <parri.andrea@gmail.com>,
	<will@kernel.org>, <peterz@infradead.org>, <boqun.feng@gmail.com>,
	<npiggin@gmail.com>, <dhowells@redhat.com>, <j.alglave@ucl.ac.uk>,
	<luc.maranget@inria.fr>, <paulmck@kernel.org>, <akiyks@gmail.com>,
	<dlustig@nvidia.com>, <joel@joelfernandes.org>, <corbet@lwn.net>,
	<linux-kernel@vger.kernel.org>, <linux-arch@vger.kernel.org>,
	<linux-doc@vger.kernel.org>
Cc: Parav Pandit <parav@nvidia.com>
Subject: [PATCH v4] locking/memory-barriers.txt: Improve documentation for writel() example
Date: Mon, 10 Oct 2022 13:13:31 +0300	[thread overview]
Message-ID: <20221010101331.29942-1-parav@nvidia.com> (raw)

The cited commit describes that when using writel(), explcit wmb()
is not needed. wmb() is an expensive barrier. writel() uses the needed
platform specific barrier instead of expensive wmb().

Hence update the example to be more accurate that matches the current
implementation.

commit 5846581e3563 ("locking/memory-barriers.txt: Fix broken DMA vs. MMIO ordering example")

Signed-off-by: Parav Pandit <parav@nvidia.com>

---
changelog:
v3->v4:
- further trimmed the documentation for redundant description
v2->v3:
- removed redundant description for writeX()
- updated text for alignment and smaller change lines
- updated commit log with blank line before signed-off-by line
v1->v2:
- Further improved description of writel() example
- changed commit subject from 'usage' to 'example'
v0->v1:
- Corrected to mention I/O barrier instead of dma_wmb().
- removed numbered references in commit log
- corrected typo 'explcit' to 'explicit' in commit log
---
 Documentation/memory-barriers.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt
index 832b5d36e279..4d24d39f5e42 100644
--- a/Documentation/memory-barriers.txt
+++ b/Documentation/memory-barriers.txt
@@ -1927,7 +1927,7 @@ There are some more advanced barrier functions:
      before we read the data from the descriptor, and the dma_wmb() allows
      us to guarantee the data is written to the descriptor before the device
      can see it now has ownership.  The dma_mb() implies both a dma_rmb() and
-     a dma_wmb().  Note that, when using writel(), a prior wmb() is not needed
+     a dma_wmb().  Note that, when using writel(), a prior barrier is not needed
      to guarantee that the cache coherent memory writes have completed before
      writing to the MMIO region.  The cheaper writel_relaxed() does not provide
      this guarantee and must not be used here.
-- 
2.26.2


             reply	other threads:[~2022-10-10 10:14 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-10 10:13 Parav Pandit [this message]
2022-10-17 20:55 ` [PATCH v4] locking/memory-barriers.txt: Improve documentation for writel() example Arnd Bergmann
2022-10-18  1:37   ` Akira Yokosawa
2022-10-18  6:44     ` Arnd Bergmann
2022-10-18  7:40       ` Akira Yokosawa
2022-10-18  7:49         ` Arnd Bergmann
2022-10-18  9:23           ` Akira Yokosawa
2022-10-18 10:05   ` Will Deacon
2022-10-18 17:49     ` Paul E. McKenney
2022-10-18 20:33       ` Parav Pandit
2022-10-27 18:15         ` Paul E. McKenney
2022-10-27 18:24           ` Parav Pandit

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=20221010101331.29942-1-parav@nvidia.com \
    --to=parav@nvidia.com \
    --cc=akiyks@gmail.com \
    --cc=arnd@arndb.de \
    --cc=bagasdotme@gmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=corbet@lwn.net \
    --cc=dhowells@redhat.com \
    --cc=dlustig@nvidia.com \
    --cc=j.alglave@ucl.ac.uk \
    --cc=joel@joelfernandes.org \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luc.maranget@inria.fr \
    --cc=npiggin@gmail.com \
    --cc=parri.andrea@gmail.com \
    --cc=paulmck@kernel.org \
    --cc=peterz@infradead.org \
    --cc=stern@rowland.harvard.edu \
    --cc=will@kernel.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