Add tws(4), a driver for the LSI 3ware 9750 series SATA/SAS RAID controllers.
[dragonfly.git] / sys / dev / raid / tws / tws_user.h
1 /*
2  * Copyright (c) 2010, LSI Corp.
3  * All rights reserved.
4  * Author : Manjunath Ranganathaiah
5  * Support: freebsdraid@lsi.com
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
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
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of the <ORGANIZATION> nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * $FreeBSD: src/sys/dev/tws/tws_user.h,v 1.3 2007/05/09 04:16:32 mrangana Exp $
35  */
36
37 #define TWS_AEN_NOT_RETRIEVED        0x1
38 #define TWS_AEN_RETRIEVED            0x2
39
40 #define TWS_AEN_NO_EVENTS            0x1003  /* No more events */
41 #define TWS_AEN_OVERFLOW             0x1004  /* AEN overflow occurred */
42
43 #define TWS_IOCTL_LOCK_NOT_HELD      0x1001   /* Not locked */
44 #define TWS_IOCTL_LOCK_ALREADY_HELD  0x1002   /* Already locked */
45
46 #define TWS_IOCTL_LOCK_HELD          0x1
47 #define TWS_IOCTL_LOCK_FREE          0x0
48
49 #pragma pack(1)
50
51 /* Structure used to handle GET/RELEASE LOCK ioctls. */
52 struct tws_lock_packet {
53     u_int32_t       timeout_msec;
54     u_int32_t       time_remaining_msec;
55     u_int32_t       force_flag;
56 };
57
58 /* Structure used to handle GET COMPATIBILITY INFO ioctl. */
59 struct tws_compatibility_packet {
60     u_int8_t    driver_version[32];/* driver version */
61     u_int16_t   working_srl;    /* driver & firmware negotiated srl */
62     u_int16_t   working_branch; /* branch # of the firmware that the
63                                     driver is compatible with */
64     u_int16_t   working_build;  /* build # of the firmware that the
65                                         driver is compatible with */
66     u_int16_t   driver_srl_high;/* highest driver supported srl */
67     u_int16_t   driver_branch_high;/* highest driver supported branch */
68     u_int16_t   driver_build_high;/* highest driver supported build */
69     u_int16_t   driver_srl_low;/* lowest driver supported srl */
70     u_int16_t   driver_branch_low;/* lowest driver supported branch */
71     u_int16_t   driver_build_low;/* lowest driver supported build */
72     u_int16_t   fw_on_ctlr_srl; /* srl of running firmware */
73     u_int16_t   fw_on_ctlr_branch;/* branch # of running firmware */
74     u_int16_t   fw_on_ctlr_build;/* build # of running firmware */
75 };
76
77
78 /* Driver understandable part of the ioctl packet built by the API. */
79 struct tws_driver_packet {
80     u_int32_t       control_code;
81     u_int32_t       status;
82     u_int32_t       unique_id;
83     u_int32_t       sequence_id;
84     u_int32_t       os_status;
85     u_int32_t       buffer_length;
86 };
87
88 /* ioctl packet built by the API. */
89 struct tws_ioctl_packet {
90     struct tws_driver_packet      driver_pkt;
91     char                          padding[488];
92     struct tws_command_packet     cmd_pkt;
93     char                          data_buf[1];
94 };
95
96 #pragma pack()
97
98
99 #pragma pack(1)
100 /*
101  * We need the structure below to ensure that the first byte of
102  * data_buf is not overwritten by the kernel, after we return
103  * from the ioctl call.  Note that cmd_pkt has been reduced
104  * to an array of 1024 bytes even though it's actually 2048 bytes
105  * in size.  This is because, we don't expect requests from user
106  * land requiring 2048 (273 sg elements) byte cmd pkts.
107  */
108 struct tws_ioctl_no_data_buf {
109     struct tws_driver_packet     driver_pkt;
110     void                         *pdata; /* points to data_buf */
111     char                         padding[488 - sizeof(void *)];
112     struct tws_command_packet    cmd_pkt;
113 };
114
115 #pragma pack()
116
117
118 #include <sys/ioccom.h>
119
120 #pragma pack(1)
121
122 struct tws_ioctl_with_payload {
123     struct tws_driver_packet     driver_pkt;
124     char                         padding[488];
125     struct tws_command_packet    cmd_pkt;
126     union {
127         struct tws_event_packet               event_pkt;
128         struct tws_lock_packet                lock_pkt;
129         struct tws_compatibility_packet       compat_pkt;
130         char                                  data_buf[1];
131     } payload;
132 };
133
134 #pragma pack()
135
136 /* ioctl cmds */
137
138 #define TWS_IOCTL_SCAN_BUS                            \
139         _IO('T', 200)
140 #define TWS_IOCTL_FIRMWARE_PASS_THROUGH               \
141         _IOWR('T', 202, struct tws_ioctl_no_data_buf)
142 #define TWS_IOCTL_GET_FIRST_EVENT                     \
143         _IOWR('T', 203, struct tws_ioctl_with_payload)
144 #define TWS_IOCTL_GET_LAST_EVENT                      \
145         _IOWR('T', 204, struct tws_ioctl_with_payload)
146 #define TWS_IOCTL_GET_NEXT_EVENT                      \
147         _IOWR('T', 205, struct tws_ioctl_with_payload)
148 #define TWS_IOCTL_GET_PREVIOUS_EVENT                  \
149         _IOWR('T', 206, struct tws_ioctl_with_payload)
150 #define TWS_IOCTL_GET_LOCK                            \
151         _IOWR('T', 207, struct tws_ioctl_with_payload)
152 #define TWS_IOCTL_RELEASE_LOCK                        \
153         _IOWR('T', 208, struct tws_ioctl_with_payload)
154 #define TWS_IOCTL_GET_COMPATIBILITY_INFO              \
155         _IOWR('T', 209, struct tws_ioctl_with_payload)