locking/memory-barriers.txt: Improve documentation for writel() example
authorParav Pandit <parav@nvidia.com>
Thu, 27 Oct 2022 20:10:00 +0000 (23:10 +0300)
committerPaul E. McKenney <paulmck@kernel.org>
Wed, 4 Jan 2023 04:47:04 +0000 (20:47 -0800)
commit289e1c89217d42a18230ab45e75fd79c993671f3
treefc9a10cde7d91afb4add41d1c4c2e7ce797c9a5b
parent1b929c02afd37871d5afb9d498426f83432e71c2
locking/memory-barriers.txt: Improve documentation for writel() example

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

writeX() section of "KERNEL I/O BARRIER EFFECTS" already describes
ordering of I/O accessors with MMIO writes.

Hence add the comment for pseudo code of writel() and remove confusing
text around writel() and wmb().

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

Co-developed-by: Will Deacon <will@kernel.org>
Signed-off-by: Will Deacon <will@kernel.org>
Signed-off-by: Parav Pandit <parav@nvidia.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Documentation/memory-barriers.txt