lkml.org 
[lkml]   [2017]   [Jan]   [28]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] x86: Improve documentation for low-level device I/O functions

* Jonathan Corbet <corbet@lwn.net> 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 <corbet@lwn.net>
> ---
> 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

\
 
 \ /
  Last update: 2017-01-28 09:38    [W:0.118 / U:0.160 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site