include/machine/_kernel_uio.h

0001 /*-
0002  * SPDX-License-Identifier: BSD-3-Clause
0003  *
0004  * Copyright (c) 1982, 1986, 1993, 1994
0005  *  The Regents of the University of California.  All rights reserved.
0006  *
0007  * Redistribution and use in source and binary forms, with or without
0008  * modification, are permitted provided that the following conditions
0009  * are met:
0010  * 1. Redistributions of source code must retain the above copyright
0011  *    notice, this list of conditions and the following disclaimer.
0012  * 2. Redistributions in binary form must reproduce the above copyright
0013  *    notice, this list of conditions and the following disclaimer in the
0014  *    documentation and/or other materials provided with the distribution.
0015  * 3. Neither the name of the University nor the names of its contributors
0016  *    may be used to endorse or promote products derived from this software
0017  *    without specific prior written permission.
0018  *
0019  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
0020  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0021  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0022  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
0023  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
0024  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
0025  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
0026  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
0027  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
0028  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
0029  * SUCH DAMAGE.
0030  *
0031  *  @(#)uio.h   8.5 (Berkeley) 2/22/94
0032  * $FreeBSD: head/sys/sys/uio.h 331621 2018-03-27 15:20:03Z brooks $
0033  */
0034
0035 /**
0036  * @file
0037  *
0038  * @ingroup RTEMSImplFreeBSDKernel
0039  *
0040  * @brief This header file provides device driver I/O definitions for the
0041  *   kernel space (_KERNEL is defined before including <sys/uio.h>).
0042  */
0043
0044 #if defined(_SYS_UIO_H_) && defined(_KERNEL)
0045
0046 struct uio {
0047     struct  iovec *uio_iov;     /* scatter/gather list */
0048     int uio_iovcnt;     /* length of scatter/gather list */
0049     off_t   uio_offset;     /* offset in target object */
0050     ssize_t uio_resid;      /* remaining bytes to process */
0051     enum    uio_seg uio_segflg; /* address space */
0052     enum    uio_rw uio_rw;      /* operation */
0053     struct  thread *uio_td;     /* owner */
0054 };
0055
0056 /*
0057  * Limits
0058  *
0059  * N.B.: UIO_MAXIOV must be no less than IOV_MAX from <sys/syslimits.h>
0060  * which in turn must be no less than _XOPEN_IOV_MAX from <limits.h>.  If
0061  * we ever make this tunable (probably pointless), then IOV_MAX should be
0062  * removed from <sys/syslimits.h> and applications would be expected to use
0063  * sysconf(3) to find out the correct value, or else assume the worst
0064  * (_XOPEN_IOV_MAX).  Perhaps UIO_MAXIOV should be simply defined as
0065  * IOV_MAX.
0066  */
0067 #define UIO_MAXIOV  1024        /* max 1K of iov's */
0068
0069 struct vm_object;
0070 struct vm_page;
0071 struct bus_dma_segment;
0072
0073 struct uio *cloneuio(struct uio *uiop);
0074 int copyiniov(const struct iovec *iovp, u_int iovcnt, struct iovec **iov,
0075         int error);
0076 int copyinuio(const struct iovec *iovp, u_int iovcnt, struct uio **uiop);
0077 int copyout_map(struct thread *td, vm_offset_t *addr, size_t sz);
0078 int copyout_unmap(struct thread *td, vm_offset_t addr, size_t sz);
0079 int physcopyin(void *src, vm_paddr_t dst, size_t len);
0080 int physcopyout(vm_paddr_t src, void *dst, size_t len);
0081 int physcopyin_vlist(struct bus_dma_segment *src, off_t offset,
0082         vm_paddr_t dst, size_t len);
0083 int physcopyout_vlist(vm_paddr_t src, struct bus_dma_segment *dst,
0084         off_t offset, size_t len);
0085 int uiomove(void *cp, int n, struct uio *uio);
0086 int uiomove_frombuf(void *buf, int buflen, struct uio *uio);
0087 int uiomove_fromphys(struct vm_page *ma[], vm_offset_t offset, int n,
0088         struct uio *uio);
0089 int uiomove_nofault(void *cp, int n, struct uio *uio);
0090 int uiomove_object(struct vm_object *obj, off_t obj_size, struct uio *uio);
0091
0092 #else /* !_SYS_UIO_H_ || !_KERNEL */
0093 #error "must be included via <sys/uio.h> in kernel space"
0094 #endif /* _SYS_UIO_H_ && _KERNEL */