linux/sound/core/memory.c
Takashi Iwai 1b2ff639ff ALSA: Align the syntax of iov_iter helpers with standard ones
We introduced a couple of helpers for copying iomem over iov_iter, and
the functions were formed like the former copy_from/to_user(), and the
return value was adjusted to 0/-EFAULT, which made the code transition
a bit easier at that time.

OTOH, the standard copy_from/to_iter() functions have different
argument orders and the return value, and this difference can be
confusing.  It's not only confusing but dangerous; actually I did
write a wrong code due to that once :-<

For reducing the confusion, this patch changes the syntax of those
helpers to align with the standard copy_from/to_iter().  The argument
order is changed and the return value is the size of copied bytes.
The callers of those functions are updated accordingly, too.

Link: https://patch.msgid.link/20241230114903.4959-1-tiwai@suse.de
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2024-12-30 12:50:04 +01:00

127 lines
3.1 KiB
C

// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Copyright (c) by Jaroslav Kysela <perex@perex.cz>
*
* Misc memory accessors
*/
#include <linux/export.h>
#include <linux/io.h>
#include <linux/uaccess.h>
#include <sound/core.h>
#include <sound/pcm.h>
/**
* copy_to_user_fromio - copy data from mmio-space to user-space
* @dst: the destination pointer on user-space
* @src: the source pointer on mmio
* @count: the data size to copy in bytes
*
* Copies the data from mmio-space to user-space.
*
* Return: Zero if successful, or non-zero on failure.
*/
int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count)
{
struct iov_iter iter;
if (import_ubuf(ITER_DEST, dst, count, &iter))
return -EFAULT;
if (copy_to_iter_fromio((const void __iomem *)src, count, &iter) != count)
return -EFAULT;
return 0;
}
EXPORT_SYMBOL(copy_to_user_fromio);
/**
* copy_to_iter_fromio - copy data from mmio-space to iov_iter
* @src: the source pointer on mmio
* @count: the data size to copy in bytes
* @dst: the destination iov_iter
*
* Copies the data from mmio-space to iov_iter.
*
* Return: number of bytes to be copied
*/
size_t copy_to_iter_fromio(const void __iomem *src, size_t count,
struct iov_iter *dst)
{
#if defined(__i386__) || defined(CONFIG_SPARC32)
return copy_to_iter((const void __force *)src, count, dst);
#else
char buf[256];
size_t res = 0;
while (count) {
size_t c = count;
if (c > sizeof(buf))
c = sizeof(buf);
memcpy_fromio(buf, (void __iomem *)src, c);
if (copy_to_iter(buf, c, dst) != c)
return res;
count -= c;
src += c;
res += c;
}
return res;
#endif
}
EXPORT_SYMBOL(copy_to_iter_fromio);
/**
* copy_from_user_toio - copy data from user-space to mmio-space
* @dst: the destination pointer on mmio-space
* @src: the source pointer on user-space
* @count: the data size to copy in bytes
*
* Copies the data from user-space to mmio-space.
*
* Return: Zero if successful, or non-zero on failure.
*/
int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count)
{
struct iov_iter iter;
if (import_ubuf(ITER_SOURCE, (void __user *)src, count, &iter))
return -EFAULT;
if (copy_from_iter_toio((void __iomem *)dst, count, &iter) != count)
return -EFAULT;
return 0;
}
EXPORT_SYMBOL(copy_from_user_toio);
/**
* copy_from_iter_toio - copy data from iov_iter to mmio-space
* @dst: the destination pointer on mmio-space
* @count: the data size to copy in bytes
* @src: the source iov_iter
*
* Copies the data from iov_iter to mmio-space.
*
* Return: number of bytes to be copied
*/
size_t copy_from_iter_toio(void __iomem *dst, size_t count,
struct iov_iter *src)
{
#if defined(__i386__) || defined(CONFIG_SPARC32)
return copy_from_iter((void __force *)dst, count, src);
#else
char buf[256];
size_t res = 0;
while (count) {
size_t c = count;
if (c > sizeof(buf))
c = sizeof(buf);
if (copy_from_iter(buf, c, src) != c)
return res;
memcpy_toio(dst, buf, c);
count -= c;
dst += c;
res += c;
}
return res;
#endif
}
EXPORT_SYMBOL(copy_from_iter_toio);