1 /*        $NetBSD: dmover_io.h,v 1.4 2017/10/28 06:27:32 riastradh Exp $        */
2 
3 /*
4  * Copyright (c) 2002, 2003 Wasabi Systems, Inc.
5  * All rights reserved.
6  *
7  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *        This product includes software developed for the NetBSD Project by
20  *        Wasabi Systems, Inc.
21  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22  *    or promote products derived from this software without specific prior
23  *    written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef _DMOVER_DMOVER_IO_H_
39 #define _DMOVER_DMOVER_IO_H_
40 
41 #include <sys/types.h>
42 #include <sys/ioccom.h>
43 #include <sys/uio.h>
44 
45 typedef struct {
46           struct iovec *dmbuf_iov;
47           u_int dmbuf_iovcnt;
48 } dmio_buffer;
49 
50 /*
51  * dmio_usrreq:
52  *
53  *        Request structure passed from user-space.
54  */
55 struct dmio_usrreq {
56           /* Output buffer. */
57           dmio_buffer req_outbuf;
58 
59           /*
60            * General purpose immediate value.  Can be used as an
61            * input, output, or both, depending on the function.
62            * The output is transmitted via the usrresp structure.
63            */
64           uint8_t req_immediate[8];
65 
66           /* Input buffer. */
67           dmio_buffer *req_inbuf;
68 
69           uint32_t req_id;    /* request ID; passed in response */
70 };
71 
72 /*
73  * dmio_usrresp:
74  *
75  *        Response structure passed to user-space.
76  */
77 struct dmio_usrresp {
78           uint32_t resp_id;   /* request ID */
79           int resp_error;               /* error, 0 if success */
80           uint8_t resp_immediate[8];
81 };
82 
83 /*
84  * DMIO_SETFUNC:
85  *
86  *        Ioctl to set the function type for the session.
87  */
88 #define   DMIO_SETFUNC                   _IOW('D', 0, struct dmio_setfunc)
89 
90 #define   DMIO_MAX_FUNCNAME   64
91 struct dmio_setfunc {
92           char dsf_name[DMIO_MAX_FUNCNAME];
93 };
94 
95 #endif /* _DMOVER_DMOVER_IO_H_ */
96