1/* $NetBSD: twaio.h,v 1.6 2015/09/06 06:01:00 dholland Exp $ */
2/* $wasabi: twaio.h,v 1.8 2006/04/27 17:12:39 wrstuden Exp $ */
3
4/*-
5 * Copyright (c) 2003-04 3ware, Inc.
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: src/sys/dev/twa/twa_ioctl.h,v 1.1 2004/03/30 03:45:59 vkashyap Exp $
30 */
31
32/*
33 * 3ware driver for 9000 series storage controllers.
34 *
35 * Author: Vinod Kashyap
36 */
37
38
39#ifndef _DEV_PCI_TWAIO_H_
40#define _DEV_PCI_TWAIO_H_
41
42#include <sys/ioccom.h>
43
44
45#define TWA_AEN_NOT_RETRIEVED 0x1
46#define TWA_AEN_RETRIEVED 0x2
47
48#define TWA_ERROR_AEN_NO_EVENTS 0x1003 /* No more events */
49#define TWA_ERROR_AEN_OVERFLOW 0x1004 /* AEN clobber occurred */
50
51#define TWA_ERROR_IOCTL_LOCK_NOT_HELD 0x1001 /* Not locked */
52#define TWA_ERROR_IOCTL_LOCK_ALREADY_HELD 0x1002 /* Already locked */
53
54
55struct twa_scan_bus_packet {
56 uint32_t unit;
57} __packed;
58
59struct tw_cl_event_packet {
60 uint32_t sequence_id;
61 uint32_t time_stamp_sec;
62 uint16_t aen_code;
63 uint8_t severity;
64 uint8_t retrieved;
65 uint8_t repeat_count;
66 uint8_t parameter_len;
67 uint8_t parameter_data[98];
68 uint32_t event_src;
69 uint8_t severity_str[20];
70} __packed;
71
72struct tw_cl_lock_packet {
73 uint32_t timeout_msec;
74 uint32_t time_remaining_msec;
75 uint32_t force_flag;
76} __packed;
77
78
79struct tw_cl_compatibility_packet {
80 uint8_t driver_version[32];/* driver version */
81 uint16_t working_srl; /* driver & firmware negotiated srl */
82 uint16_t working_branch; /* branch # of the firmware that the driver is compatible with */
83 uint16_t working_build; /* build # of the firmware that the driver is compatible with */
84} __packed;
85
86
87struct twa_driver_packet {
88 uint32_t control_code;
89 uint32_t status;
90 uint32_t unique_id;
91 uint32_t sequence_id;
92 uint32_t os_status;
93 uint32_t buffer_length;
94} __packed;
95
96/* Account for differences between 32/64 bit system. Offsets into memory
97 * are anticipated for driver/firmware command packets and having a
98 * variable sized pointer depending on architecture add 4 bytes to any offset
99 * after the pdata declaration
100 */
101#define TW_SIZEOF_VOIDPTR (sizeof(void *))
102
103struct twa_ioctl_9k {
104 struct twa_driver_packet twa_drvr_pkt;
105 void *pdata; /* points to data_buf */
106 int8_t padding[488 - TW_SIZEOF_VOIDPTR];
107 struct twa_command_packet twa_cmd_pkt;
108 int8_t data_buf[1];
109} __packed;
110
111typedef struct twa_ioctl_with_payload {
112 struct twa_driver_packet twa_drvr_pkt;
113 int8_t padding[488];
114 struct twa_command_packet twa_cmd_pkt;
115 union {
116 struct tw_cl_event_packet event_pkt;
117 struct tw_cl_lock_packet lock_pkt;
118 struct tw_cl_compatibility_packet compat_pkt;
119 int8_t data_buf[1];
120 } payload;
121} __packed TWA_IOCTL_WITH_PAYLOAD;
122
123/*
124 * We need the structure below to ensure that the first byte of
125 * data_buf is not overwritten by the kernel, after we return
126 * from the ioctl call. Note that twa_cmd_pkt has been reduced
127 * to an array of 1024 bytes even though it's actually 2048 bytes
128 * in size. This is because, we don't expect requests from user
129 * land requiring 2048 (273 sg elements) byte cmd pkts.
130 */
131typedef struct twa_ioctl_no_data_buf {
132 struct twa_driver_packet twa_drvr_pkt;
133 void *pdata; /* points to data_buf */
134 int8_t padding[488 - TW_SIZEOF_VOIDPTR];
135 struct twa_command_packet twa_cmd_pkt;
136} __packed TWA_IOCTL_NO_DATA_BUF;
137
138
139/*
140 * Get the device external name of the specified array unit.
141 */
142 /* WASABI */
143struct twa_unitname {
144 int tn_unit;
145 char tn_name[16]; /* XXX sizeof(dev->dv_xname) */
146};
147
148#define TW_OSL_IOCTL_SCAN_BUS _IO ('T', 200)
149
150#define TW_OSL_IOCTL_FIRMWARE_PASS_THROUGH \
151 _IOWR('T', 202, TWA_IOCTL_NO_DATA_BUF)
152
153#define TW_CL_IOCTL_GET_FIRST_EVENT _IOWR('T', 203, TWA_IOCTL_WITH_PAYLOAD)
154#define TW_CL_IOCTL_GET_LAST_EVENT _IOWR('T', 204, TWA_IOCTL_WITH_PAYLOAD)
155#define TW_CL_IOCTL_GET_NEXT_EVENT _IOWR('T', 205, TWA_IOCTL_WITH_PAYLOAD)
156#define TW_CL_IOCTL_GET_PREVIOUS_EVENT _IOWR('T', 206, TWA_IOCTL_WITH_PAYLOAD)
157#define TW_CL_IOCTL_GET_LOCK _IOWR('T', 207, TWA_IOCTL_WITH_PAYLOAD)
158#define TW_CL_IOCTL_RELEASE_LOCK _IOWR('T', 208, TWA_IOCTL_WITH_PAYLOAD)
159#define TW_CL_IOCTL_GET_COMPATIBILITY_INFO \
160 _IOWR('T', 209, TWA_IOCTL_WITH_PAYLOAD)
161/* WASABI */
162#define TWA_IOCTL_GET_UNITNAME _IOWR('T', 220, struct twa_unitname)
163
164#endif /* _DEV_PCI_TWAIO_H_ */
165