highmem: document kunmap_local()
authorIra Weiny <ira.weiny@intel.com>
Wed, 16 Feb 2022 04:31:34 +0000 (15:31 +1100)
committerStephen Rothwell <sfr@canb.auug.org.au>
Thu, 17 Feb 2022 03:46:38 +0000 (14:46 +1100)
commita0b8dfeb52577c3c5bab27bb4e9622fd31acf084
tree7997623a980edf8261f08ba6e78df5a8e7362fdd
parent94ceef3bc9d0b5b4d2ed625868ea76bcc642d277
highmem: document kunmap_local()

Some users of kmap() add an offset to the kmap() address to be used
during the mapping.

When converting to kmap_local_page() the base address does not
need to be stored because any address within the page can be used in
kunmap_local().  However, this was not clear from the documentation and
cause some questions.[1]

Document that any address in the page can be used in kunmap_local() to
clarify this for future users.

[1] https://lore.kernel.org/lkml/20211213154543.GM3538886@iweiny-DESK2.sc.intel.com/

Link: https://lkml.kernel.org/r/20220124013045.806718-1-ira.weiny@intel.com
Signed-off-by: Ira Weiny <ira.weiny@intel.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au>
include/linux/highmem-internal.h