sys/dev/amr/amrio.h

   1 /*-
   2  * Copyright (c) 1999 Michael Smith
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  *      $FreeBSD$
  27  */
  28
  29 /*
  30  * ioctl interface
  31  */
  32
  33 #include <sys/ioccom.h>
  34
  35 /*
  36  * Fetch the driver's interface version.
  37  */
  38 #define AMR_IO_VERSION_NUMBER   0x01
  39 #define AMR_IO_VERSION  _IOR('A', 0x200, int)
  40
  41 /*
  42  * Pass a command from userspace through to the adapter.
  43  *
  44  * Note that in order to be code-compatible with the Linux
  45  * interface where possible, the formatting of the au_cmd field is
  46  * somewhat Interesting.
  47  *
  48  * For normal commands, the layout is (fields from struct amr_mailbox_ioctl):
  49  *
  50  * 0            mb_command
  51  * 1            mb_channel
  52  * 2            mb_param
  53  * 3            mb_pad[0]
  54  * 4            mb_drive
  55  *
  56  * For SCSI passthrough commands, the layout is:
  57  *
  58  * 0            AMR_CMD_PASS    (0x3)
  59  * 1            reserved, 0
  60  * 2            cdb length
  61  * 3            cdb data
  62  * 3+cdb_len    passthrough control byte (timeout, ars, islogical)
  63  * 4+cdb_len    reserved, 0
  64  * 5+cdb_len    channel
  65  * 6+cdb_len    target
  66  */
  67
  68 struct amr_user_ioctl {
  69     unsigned char       au_cmd[32];     /* command text from userspace */
  70     void                *au_buffer;     /* data buffer in userspace */
  71     unsigned long       au_length;      /* data buffer size (0 == no data) */
  72     int                 au_direction;   /* data transfer direction */
  73 #define AMR_IO_NODATA   0
  74 #define AMR_IO_READ     1
  75 #define AMR_IO_WRITE    2
  76     int                 au_status;      /* command status returned by adapter */
  77 };
  78
  79 #define AMR_IO_COMMAND  _IOWR('A', 0x201, struct amr_user_ioctl)
  80