2020-04-22 09:42:28

by 王文虎

Subject: [PATCH] io: correct documentation mismatches for io memcpy

Minor mismatches exist between funtion documentations and parameter
definitions.

Function definition lines are as following:
static inline void memcpy_fromio(void *buffer,
const volatile void __iomem *addr,
size_t size)

static inline void memcpy_toio(volatile void __iomem *addr, const void *buffer,
size_t size)

Signed-off-by: Wang Wenhu <[email protected]>
---
include/asm-generic/io.h | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
index d39ac997dda8..63131ec4857f 100644
--- a/include/asm-generic/io.h
+++ b/include/asm-generic/io.h
@@ -1067,9 +1067,9 @@ static inline void memset_io(volatile void __iomem *addr, int value,
#define memcpy_fromio memcpy_fromio
/**
* memcpy_fromio Copy a block of data from I/O memory
- * @dst: The (RAM) destination for the copy
- * @src: The (I/O memory) source for the data
- * @count: The number of bytes to copy
+ * @buffer: The (RAM) destination for the copy
+ * @addr: The (I/O memory) source for the data
+ * @size: The number of bytes to copy
*
* Copy a block of data from I/O memory.
*/
@@ -1085,9 +1085,9 @@ static inline void memcpy_fromio(void *buffer,
#define memcpy_toio memcpy_toio
/**
* memcpy_toio Copy a block of data into I/O memory
- * @dst: The (I/O memory) destination for the copy
- * @src: The (RAM) source for the data
- * @count: The number of bytes to copy
+ * @addr: The (I/O memory) destination for the copy
+ * @buffer: The (RAM) source for the data
+ * @size: The number of bytes to copy
*
* Copy a block of data to I/O memory.
*/
--
2.17.1

2020-04-22 16:46:47

by Randy Dunlap

Subject: Re: [PATCH] io: correct documentation mismatches for io memcpy

Hi--

2 small nits: please see below.

On 4/22/20 2:29 AM, Wang Wenhu wrote:
> Minor mismatches exist between funtion documentations and parameter
> definitions.
>
> Function definition lines are as following:
> static inline void memcpy_fromio(void *buffer,
> const volatile void __iomem *addr,
> size_t size)
>
> static inline void memcpy_toio(volatile void __iomem *addr, const void *buffer,
> size_t size)
>
> Signed-off-by: Wang Wenhu <[email protected]>
> ---
> include/asm-generic/io.h | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
> index d39ac997dda8..63131ec4857f 100644
> --- a/include/asm-generic/io.h
> +++ b/include/asm-generic/io.h
> @@ -1067,9 +1067,9 @@ static inline void memset_io(volatile void __iomem *addr, int value,
> #define memcpy_fromio memcpy_fromio
> /**
> * memcpy_fromio Copy a block of data from I/O memory

This needs a dash ('-') between the function name & its description.

> - * @dst: The (RAM) destination for the copy
> - * @src: The (I/O memory) source for the data
> - * @count: The number of bytes to copy
> + * @buffer: The (RAM) destination for the copy
> + * @addr: The (I/O memory) source for the data
> + * @size: The number of bytes to copy
> *
> * Copy a block of data from I/O memory.
> */
> @@ -1085,9 +1085,9 @@ static inline void memcpy_fromio(void *buffer,
> #define memcpy_toio memcpy_toio
> /**
> * memcpy_toio Copy a block of data into I/O memory

Same here.

> - * @dst: The (I/O memory) destination for the copy
> - * @src: The (RAM) source for the data
> - * @count: The number of bytes to copy
> + * @addr: The (I/O memory) destination for the copy
> + * @buffer: The (RAM) source for the data
> + * @size: The number of bytes to copy
> *
> * Copy a block of data to I/O memory.
> */
>

If you would fix the above, you can also add:
Reviewed-by: Randy Dunlap <[email protected]>

thanks.
--
~Randy