sys/dev/twa/tw_osl_ioctl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2004-07 Applied Micro Circuits Corporation.
   5  * Copyright (c) 2004-05 Vinod Kashyap.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      $FreeBSD$
  30  */
  31
  32 /*
  33  * AMCC'S 3ware driver for 9000 series storage controllers.
  34  *
  35  * Author: Vinod Kashyap
  36  * Modifications by: Adam Radford
  37  */
  38
  39
  40
  41 #ifndef TW_OSL_IOCTL_H
  42
  43 #define TW_OSL_IOCTL_H
  44
  45
  46 /*
  47  * Macros and structures for OS Layer/Common Layer handled ioctls.
  48  */
  49
  50
  51
  52 #include <dev/twa/tw_cl_fwif.h>
  53 #include <dev/twa/tw_cl_ioctl.h>
  54
  55
  56
  57 #pragma pack(1)
  58 /*
  59  * We need the structure below to ensure that the first byte of
  60  * data_buf is not overwritten by the kernel, after we return
  61  * from the ioctl call.  Note that cmd_pkt has been reduced
  62  * to an array of 1024 bytes even though it's actually 2048 bytes
  63  * in size.  This is because, we don't expect requests from user
  64  * land requiring 2048 (273 sg elements) byte cmd pkts.
  65  */
  66 typedef struct tw_osli_ioctl_no_data_buf {
  67         struct tw_cl_driver_packet      driver_pkt;
  68         TW_VOID                         *pdata; /* points to data_buf */
  69         TW_INT8                         padding[488 - sizeof(TW_VOID *)];
  70         struct tw_cl_command_packet     cmd_pkt;
  71 } TW_OSLI_IOCTL_NO_DATA_BUF;
  72
  73 #pragma pack()
  74
  75 /* ioctl cmds handled by the OS Layer */
  76 #define TW_OSL_IOCTL_SCAN_BUS                           \
  77         _IO('T', 200)
  78 #define TW_OSL_IOCTL_FIRMWARE_PASS_THROUGH              \
  79         _IOWR('T', 202, TW_OSLI_IOCTL_NO_DATA_BUF)
  80
  81
  82 #include <sys/ioccom.h>
  83
  84 #pragma pack(1)
  85
  86 typedef struct tw_osli_ioctl_with_payload {
  87         struct tw_cl_driver_packet      driver_pkt;
  88         TW_INT8                         padding[488];
  89         struct tw_cl_command_packet     cmd_pkt;
  90         union {
  91                 struct tw_cl_event_packet               event_pkt;
  92                 struct tw_cl_lock_packet                lock_pkt;
  93                 struct tw_cl_compatibility_packet       compat_pkt;
  94                 TW_INT8                                 data_buf[1];
  95         } payload;
  96 } TW_OSLI_IOCTL_WITH_PAYLOAD;
  97
  98 #pragma pack()
  99
 100 /* ioctl cmds handled by the Common Layer */
 101 #define TW_CL_IOCTL_GET_FIRST_EVENT                     \
 102         _IOWR('T', 203, TW_OSLI_IOCTL_WITH_PAYLOAD)
 103 #define TW_CL_IOCTL_GET_LAST_EVENT                      \
 104         _IOWR('T', 204, TW_OSLI_IOCTL_WITH_PAYLOAD)
 105 #define TW_CL_IOCTL_GET_NEXT_EVENT                      \
 106         _IOWR('T', 205, TW_OSLI_IOCTL_WITH_PAYLOAD)
 107 #define TW_CL_IOCTL_GET_PREVIOUS_EVENT                  \
 108         _IOWR('T', 206, TW_OSLI_IOCTL_WITH_PAYLOAD)
 109 #define TW_CL_IOCTL_GET_LOCK                            \
 110         _IOWR('T', 207, TW_OSLI_IOCTL_WITH_PAYLOAD)
 111 #define TW_CL_IOCTL_RELEASE_LOCK                        \
 112         _IOWR('T', 208, TW_OSLI_IOCTL_WITH_PAYLOAD)
 113 #define TW_CL_IOCTL_GET_COMPATIBILITY_INFO              \
 114         _IOWR('T', 209, TW_OSLI_IOCTL_WITH_PAYLOAD)
 115
 116
 117
 118 #endif /* TW_OSL_IOCTL_H */