sys/dev/dmover/dmover_io.h

   1 /*      $NetBSD: dmover_io.h,v 1.1.12.3 2004/09/21 13:27:36 skrll 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/ioccom.h>
  42 #include <sys/uio.h>
  43
  44 typedef struct {
  45         struct iovec *dmbuf_iov;
  46         u_int dmbuf_iovcnt;
  47 } dmio_buffer;
  48
  49 /*
  50  * dmio_usrreq:
  51  *
  52  *      Request structure passed from user-space.
  53  */
  54 struct dmio_usrreq {
  55         /* Output buffer. */
  56         dmio_buffer req_outbuf;
  57
  58         /*
  59          * General purpose immediate value.  Can be used as an
  60          * input, output, or both, depending on the function.
  61          * The output is transmitted via the usrresp structure.
  62          */
  63         uint8_t req_immediate[8];
  64
  65         /* Input buffer. */
  66         dmio_buffer *req_inbuf;
  67
  68         uint32_t req_id;        /* request ID; passed in response */
  69 };
  70
  71 /*
  72  * dmio_usrresp:
  73  *
  74  *      Response structure passed to user-space.
  75  */
  76 struct dmio_usrresp {
  77         uint32_t resp_id;       /* request ID */
  78         int resp_error;         /* error, 0 if success */
  79         uint8_t resp_immediate[8];
  80 };
  81
  82 /*
  83  * DMIO_SETFUNC:
  84  *
  85  *      Ioctl to set the function type for the session.
  86  */
  87 #define DMIO_SETFUNC             _IOW('D', 0, struct dmio_setfunc)
  88
  89 #define DMIO_MAX_FUNCNAME       64
  90 struct dmio_setfunc {
  91         char dsf_name[DMIO_MAX_FUNCNAME];
  92 };
  93
  94 #endif /* _DMOVER_DMOVER_IO_H_ */