From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751393AbdA1Iiz (ORCPT ); Sat, 28 Jan 2017 03:38:55 -0500 Received: from mail-wm0-f66.google.com ([74.125.82.66]:34797 "EHLO mail-wm0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750800AbdA1Iiq (ORCPT ); Sat, 28 Jan 2017 03:38:46 -0500 Date: Sat, 28 Jan 2017 09:38:22 +0100 From: Ingo Molnar To: Jonathan Corbet Cc: LKML , Thomas Gleixner , Ingo Molnar , "H. Peter Anvin" Subject: Re: [PATCH] x86: Improve documentation for low-level device I/O functions Message-ID: <20170128083822.GA17814@gmail.com> References: <20170127161752.0b95e95b@lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20170127161752.0b95e95b@lwn.net> User-Agent: Mutt/1.5.24 (2015-08-30) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org * Jonathan Corbet wrote: > Add kerneldoc comments for memcpy_{to,from}io() and memset_io(). The > existing documentation for ioremap() was distant from the definition, > causing kernel-doc to miss it; move it appropriately. > > Signed-off-by: Jonathan Corbet > --- > arch/x86/include/asm/io.h | 47 ++++++++++++++++++++++++++++++++++++----------- > 1 file changed, 36 insertions(+), 11 deletions(-) > > diff --git a/arch/x86/include/asm/io.h b/arch/x86/include/asm/io.h > index d34bd370074b..a8a6c856a08f 100644 > --- a/arch/x86/include/asm/io.h > +++ b/arch/x86/include/asm/io.h > @@ -164,6 +164,18 @@ static inline unsigned int isa_virt_to_bus(volatile void *address) > #define virt_to_bus virt_to_phys > #define bus_to_virt phys_to_virt > > +/* > + * The default ioremap() behavior is non-cached; if you need something > + * else, you probably want one of the following. > + */ > +extern void __iomem *ioremap_nocache(resource_size_t offset, unsigned long size); > +extern void __iomem *ioremap_uc(resource_size_t offset, unsigned long size); > +#define ioremap_uc ioremap_uc > + > +extern void __iomem *ioremap_cache(resource_size_t offset, unsigned long size); > +extern void __iomem *ioremap_prot(resource_size_t offset, unsigned long size, > + unsigned long prot_val); > + > /** > * ioremap - map bus memory into CPU space > * @offset: bus address of the memory > @@ -178,17 +190,6 @@ static inline unsigned int isa_virt_to_bus(volatile void *address) > * If the area you are trying to map is a PCI BAR you should have a > * look at pci_iomap(). > */ > -extern void __iomem *ioremap_nocache(resource_size_t offset, unsigned long size); > -extern void __iomem *ioremap_uc(resource_size_t offset, unsigned long size); > -#define ioremap_uc ioremap_uc > - > -extern void __iomem *ioremap_cache(resource_size_t offset, unsigned long size); > -extern void __iomem *ioremap_prot(resource_size_t offset, unsigned long size, > - unsigned long prot_val); > - > -/* > - * The default ioremap() behavior is non-cached: > - */ > static inline void __iomem *ioremap(resource_size_t offset, unsigned long size) > { > return ioremap_nocache(offset, size); > @@ -207,18 +208,42 @@ extern void set_iounmap_nonlazy(void); > */ > #define xlate_dev_kmem_ptr(p) p > > +/** > + * memset_io Set a range of I/O memory to a constant value > + * @addr: The beginning of the I/O-memory range to set > + * @val: The value to set the memory to > + * @count: The number of bytest to set I fixed this 'bytest' typo and applied the patch, thanks Jon! Thanks, Ingo