s390_pci_mmio_write.2: Tweaks to Alexey Ishchuk's page

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2015-01-19 16:09:04 +01:00
parent c1eb8ec5f5
commit 18eff6b944
1 changed files with 33 additions and 26 deletions

View File

@ -31,41 +31,40 @@ MMIO memory page
.B #include <asm/unistd.h>
.BI "int s390_pci_mmio_write(unsigned long " mmio_addr ",
.BI " void *" user_buffer ",
.BI " size_t " length ");
.BI " void *" user_buffer ", size_t " length ");
.br
.BI "int s390_pci_mmio_read(unsigned long " mmio_addr ",
.BI " void *" user_buffer ",
.BI " size_t " length ");
.BI " void *" user_buffer ", size_t " length ");
.fi
.SH DESCRIPTION
The
.BR s390_pci_mmio_write ()
system call writes data of length
system call writes
.IR length
from the user space buffer
bytes of data from the user-space buffer
.IR user_buffer
to a PCI MMIO memory location.
to the PCI MMIO memory location specified by
.IR mmio_addr .
The
.BR s390_pci_mmio_read ()
system call reads data from a PCI MMIO memory location
to the user space buffer
.IR user_buffer
of
.IR length
bytes size.
system call reads
.I length
bytes of
data from the PCI MMIO memory location specified by
.IR mmio_addr
to the user-space buffer
.IR user_buffer .
These system calls must be used instead of the simple assignment
or data transfer operations that are used to access the PCI MMIO
memory areas mapped to the user space on the Linux on System z platform.
The address specified by the
or data-transfer operations that are used to access the PCI MMIO
memory areas mapped to user space on the Linux System z platform.
The address specified by
.IR mmio_addr
parameter must belong to a PCI MMIO memory page mapping in the user
address space, and the data being written or read must not cross a
page boundary.
must belong to a PCI MMIO memory page mapping in the caller's address space,
and the data being written or read must not cross a page boundary.
The
.IR length
parameter value cannot be greater than the page size.
value cannot be greater than the system page size.
.SH RETURN VALUE
On success,
.BR s390_pci_mmio_write ()
@ -77,17 +76,25 @@ On error, \-1 is returned and
is set to one of the error codes listed below.
.SH ERRORS
.TP
.B EFAULT
The address in
.I mmio_addr
is invalid.
.TP
.B EFAULT
.IR user_buffer
does not point to a valid location in the caller's address space.
.TP
.B EINVAL
Invalid
.I length
argument.
.TP
.B ENODEV
PCI support is not enabled.
.TP
.B ENOMEM
Insufficient memory.
.TP
.B EFAULT
Invalid address was specified.
.TP
.B EINVAL
Invalid parameter value.
.SH VERSIONS
These system calls are available since Linux 3.19.
.SH CONFORMING TO