2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2010, LSI Corp.
6 * Author : Manjunath Ranganathaiah
7 * Support: freebsdraid@lsi.com
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
19 * 3. Neither the name of the <ORGANIZATION> nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
37 #define TWS_AEN_NOT_RETRIEVED 0x1
38 #define TWS_AEN_RETRIEVED 0x2
40 #define TWS_AEN_NO_EVENTS 0x1003 /* No more events */
41 #define TWS_AEN_OVERFLOW 0x1004 /* AEN overflow occurred */
43 #define TWS_IOCTL_LOCK_NOT_HELD 0x1001 /* Not locked */
44 #define TWS_IOCTL_LOCK_ALREADY_HELD 0x1002 /* Already locked */
46 #define TWS_IOCTL_LOCK_HELD 0x1
47 #define TWS_IOCTL_LOCK_FREE 0x0
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;
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 */
77 /* Driver understandable part of the ioctl packet built by the API. */
78 struct tws_driver_packet {
79 u_int32_t control_code;
82 u_int32_t sequence_id;
84 u_int32_t buffer_length;
87 /* ioctl packet built by the API. */
88 struct tws_ioctl_packet {
89 struct tws_driver_packet driver_pkt;
91 struct tws_command_packet cmd_pkt;
99 * We need the structure below to ensure that the first byte of
100 * data_buf is not overwritten by the kernel, after we return
101 * from the ioctl call. Note that cmd_pkt has been reduced
102 * to an array of 1024 bytes even though it's actually 2048 bytes
103 * in size. This is because, we don't expect requests from user
104 * land requiring 2048 (273 sg elements) byte cmd pkts.
106 struct tws_ioctl_no_data_buf {
107 struct tws_driver_packet driver_pkt;
108 void *pdata; /* points to data_buf */
109 char padding[488 - sizeof(void *)];
110 struct tws_command_packet cmd_pkt;
115 #include <sys/ioccom.h>
119 struct tws_ioctl_with_payload {
120 struct tws_driver_packet driver_pkt;
122 struct tws_command_packet cmd_pkt;
124 struct tws_event_packet event_pkt;
125 struct tws_lock_packet lock_pkt;
126 struct tws_compatibility_packet compat_pkt;
135 #define TWS_IOCTL_SCAN_BUS \
137 #define TWS_IOCTL_FIRMWARE_PASS_THROUGH \
138 _IOWR('T', 202, struct tws_ioctl_no_data_buf)
139 #define TWS_IOCTL_GET_FIRST_EVENT \
140 _IOWR('T', 203, struct tws_ioctl_with_payload)
141 #define TWS_IOCTL_GET_LAST_EVENT \
142 _IOWR('T', 204, struct tws_ioctl_with_payload)
143 #define TWS_IOCTL_GET_NEXT_EVENT \
144 _IOWR('T', 205, struct tws_ioctl_with_payload)
145 #define TWS_IOCTL_GET_PREVIOUS_EVENT \
146 _IOWR('T', 206, struct tws_ioctl_with_payload)
147 #define TWS_IOCTL_GET_LOCK \
148 _IOWR('T', 207, struct tws_ioctl_with_payload)
149 #define TWS_IOCTL_RELEASE_LOCK \
150 _IOWR('T', 208, struct tws_ioctl_with_payload)
151 #define TWS_IOCTL_GET_COMPATIBILITY_INFO \
152 _IOWR('T', 209, struct tws_ioctl_with_payload)