All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] asm-generic: Update kernel documentation in io.h
@ 2020-05-14 17:08 ` Miquel Raynal
  0 siblings, 0 replies; 3+ messages in thread
From: Miquel Raynal @ 2020-05-14 17:08 UTC (permalink / raw)
  To: Arnd Bergmann; +Cc: linux-arch, linux-kernel, Thomas Petazzoni, Miquel Raynal

The kernel documentation of:
* bus_to_virt()
* memcpy_fromio()
* memcpy_toio()
refers to older parameters.

Update it to fit the actual names.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 include/asm-generic/io.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
index d39ac997dda8..cb617baf8d47 100644
--- a/include/asm-generic/io.h
+++ b/include/asm-generic/io.h
@@ -1051,8 +1051,8 @@ static inline void *bus_to_virt(unsigned long address)
 /**
  * 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 bytes to set
+ * @value:	The value to set the memory to
+ * @size:	The number of bytes to set
  *
  * Set a range of I/O memory to a given value.
  */
@@ -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.20.1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH] asm-generic: Update kernel documentation in io.h
@ 2020-05-14 17:08 ` Miquel Raynal
  0 siblings, 0 replies; 3+ messages in thread
From: Miquel Raynal @ 2020-05-14 17:08 UTC (permalink / raw)
  To: Arnd Bergmann; +Cc: linux-arch, linux-kernel, Thomas Petazzoni, Miquel Raynal

The kernel documentation of:
* bus_to_virt()
* memcpy_fromio()
* memcpy_toio()
refers to older parameters.

Update it to fit the actual names.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 include/asm-generic/io.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
index d39ac997dda8..cb617baf8d47 100644
--- a/include/asm-generic/io.h
+++ b/include/asm-generic/io.h
@@ -1051,8 +1051,8 @@ static inline void *bus_to_virt(unsigned long address)
 /**
  * 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 bytes to set
+ * @value:	The value to set the memory to
+ * @size:	The number of bytes to set
  *
  * Set a range of I/O memory to a given value.
  */
@@ -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.20.1

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] asm-generic: Update kernel documentation in io.h
  2020-05-14 17:08 ` Miquel Raynal
  (?)
@ 2020-05-14 17:31 ` Randy Dunlap
  -1 siblings, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2020-05-14 17:31 UTC (permalink / raw)
  To: Miquel Raynal, Arnd Bergmann; +Cc: linux-arch, linux-kernel, Thomas Petazzoni

On 5/14/20 10:08 AM, Miquel Raynal wrote:
> The kernel documentation of:
> * bus_to_virt()
> * memcpy_fromio()
> * memcpy_toio()
> refers to older parameters.
> 
> Update it to fit the actual names.
> 
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> ---
>  include/asm-generic/io.h | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
> index d39ac997dda8..cb617baf8d47 100644
> --- a/include/asm-generic/io.h
> +++ b/include/asm-generic/io.h
> @@ -1051,8 +1051,8 @@ static inline void *bus_to_virt(unsigned long address)
>  /**
>   * 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 bytes to set
> + * @value:	The value to set the memory to
> + * @size:	The number of bytes to set
>   *
>   * Set a range of I/O memory to a given value.
>   */
> @@ -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.
>   */
> 

https://lore.kernel.org/lkml/20200424020831.30494-1-wenhu.wang@vivo.com/
is a better (more complete) patch IMO.

if Arnd would merge...

thanks.
-- 
~Randy


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-05-14 17:31 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-14 17:08 [PATCH] asm-generic: Update kernel documentation in io.h Miquel Raynal
2020-05-14 17:08 ` Miquel Raynal
2020-05-14 17:31 ` Randy Dunlap

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.