Re: [RFT PATCH v3 10/27] docs: driver-api: device-io: Document ioremap() variants & access funcs

From: Hector Martin
Date: Tue Mar 09 2021 - 15:31:08 EST


On 06/03/2021 00.51, Arnd Bergmann wrote:
On Fri, Mar 5, 2021 at 4:09 PM Andy Shevchenko
<andy.shevchenko@xxxxxxxxx> wrote:
On Fri, Mar 5, 2021 at 12:25 PM Linus Walleij <linus.walleij@xxxxxxxxxx> wrote:
On Thu, Mar 4, 2021 at 10:40 PM Hector Martin <marcan@xxxxxxxxx> wrote:

This documents the newly introduced ioremap_np() along with all the
other common ioremap() variants, and some higher-level abstractions
available.

Signed-off-by: Hector Martin <marcan@xxxxxxxxx>

I like this, I just want one change:

Put the common ioremap() on top in all paragraphs, so the norm
comes before the exceptions.

I.e. it is weird to mention ioremap_np() before mentioning ioremap().

+1 here. That is what I have stumbled upon reading carefully.

In that case, the order should probably be:

ioremap
ioremap_wc
ioremap_wt
ioremap_np
ioremap_uc
ioremap_cache

Going from most common to least common, rather than going from
strongest to weakest.

Yeah, I was dwelling on the issue of ioremap_np being first when I wrote that... this alternative works for me, I'll sort it like this then. It'll just need some re-wording to make it all flow properly.

--
Hector Martin (marcan@xxxxxxxxx)
Public Key: https://mrcn.st/pub