xref: /freebsd/sys/dev/mfi/mfi_ioctl.h (revision 271c3a9060f2ee55607ebe146523f888e1db2654)
1 /*-
2  * Copyright (c) 2006 IronPort Systems
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 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #if defined(__amd64__) /* Assume amd64 wants 32 bit Linux */
31 struct iovec32 {
32 	u_int32_t	iov_base;
33 	int		iov_len;
34 };
35 #endif
36 
37 #define MFIQ_FREE	0
38 #define MFIQ_BIO	1
39 #define MFIQ_READY	2
40 #define MFIQ_BUSY	3
41 #define MFIQ_COUNT	4
42 
43 struct mfi_qstat {
44 	uint32_t	q_length;
45 	uint32_t	q_max;
46 };
47 
48 union mfi_statrequest {
49 	uint32_t		ms_item;
50 	struct mfi_qstat	ms_qstat;
51 };
52 
53 #define MAX_IOCTL_SGE	16
54 
55 struct mfi_ioc_packet {
56 	uint16_t	mfi_adapter_no;
57 	uint16_t	mfi_pad1;
58 	uint32_t	mfi_sgl_off;
59 	uint32_t	mfi_sge_count;
60 	uint32_t	mfi_sense_off;
61 	uint32_t	mfi_sense_len;
62 	union {
63 		uint8_t raw[128];
64 		struct mfi_frame_header hdr;
65 	} mfi_frame;
66 
67 	struct iovec mfi_sgl[MAX_IOCTL_SGE];
68 } __packed;
69 
70 #ifdef __amd64__
71 struct mfi_ioc_packet32 {
72 	uint16_t	mfi_adapter_no;
73 	uint16_t	mfi_pad1;
74 	uint32_t	mfi_sgl_off;
75 	uint32_t	mfi_sge_count;
76 	uint32_t	mfi_sense_off;
77 	uint32_t	mfi_sense_len;
78 	union {
79 		uint8_t raw[128];
80 		struct mfi_frame_header hdr;
81 	} mfi_frame;
82 
83 	struct iovec32 mfi_sgl[MAX_IOCTL_SGE];
84 } __packed;
85 #endif
86 
87 struct mfi_ioc_aen {
88 	uint16_t	aen_adapter_no;
89 	uint16_t	aen_pad1;
90 	uint32_t	aen_seq_num;
91 	uint32_t	aen_class_locale;
92 } __packed;
93 
94 #define MFI_CMD		_IOWR('M', 1, struct mfi_ioc_packet)
95 #ifdef __amd64__
96 #define MFI_CMD32	_IOWR('M', 1, struct mfi_ioc_packet32)
97 #endif
98 #define MFI_SET_AEN	_IOW('M', 3, struct mfi_ioc_aen)
99 
100 #define MAX_LINUX_IOCTL_SGE	16
101 
102 struct mfi_linux_ioc_packet {
103 	uint16_t	lioc_adapter_no;
104 	uint16_t	lioc_pad1;
105 	uint32_t	lioc_sgl_off;
106 	uint32_t	lioc_sge_count;
107 	uint32_t	lioc_sense_off;
108 	uint32_t	lioc_sense_len;
109 	union {
110 		uint8_t raw[128];
111 		struct mfi_frame_header hdr;
112 	} lioc_frame;
113 
114 #if defined(__amd64__) /* Assume amd64 wants 32 bit Linux */
115 	struct iovec32 lioc_sgl[MAX_LINUX_IOCTL_SGE];
116 #else
117 	struct iovec lioc_sgl[MAX_LINUX_IOCTL_SGE];
118 #endif
119 } __packed;
120 
121 struct mfi_ioc_passthru {
122 	struct mfi_dcmd_frame	ioc_frame;
123 	uint32_t		buf_size;
124 	uint8_t			*buf;
125 } __packed;
126 
127 #ifdef __amd64__
128 struct mfi_ioc_passthru32 {
129 	struct mfi_dcmd_frame	ioc_frame;
130 	uint32_t		buf_size;
131 	uint32_t		buf;
132 } __packed;
133 #endif
134 
135 #define MFIIO_STATS	_IOWR('Q', 101, union mfi_statrequest)
136 #define MFIIO_PASSTHRU	_IOWR('C', 102, struct mfi_ioc_passthru)
137 #ifdef __amd64__
138 #define MFIIO_PASSTHRU32	_IOWR('C', 102, struct mfi_ioc_passthru32)
139 #endif
140 
141 struct mfi_linux_ioc_aen {
142 	uint16_t	laen_adapter_no;
143 	uint16_t	laen_pad1;
144 	uint32_t	laen_seq_num;
145 	uint32_t	laen_class_locale;
146 } __packed;
147 
148 struct mfi_query_disk {
149 	uint8_t	array_id;
150 	uint8_t	present;
151 	uint8_t	open;
152 	uint8_t reserved;	/* reserved for future use */
153 	char	devname[SPECNAMELEN + 1];
154 } __packed;
155 
156 #define MFIIO_QUERY_DISK	_IOWR('Q', 102, struct mfi_query_disk)
157 
158 /*
159  * Create a second set so the FreeBSD native ioctl doesn't
160  * conflict in FreeBSD ioctl handler.  Translate in mfi_linux.c.
161  */
162 #define MFI_LINUX_CMD		0xc1144d01
163 #define MFI_LINUX_SET_AEN	0x400c4d03
164 #define MFI_LINUX_CMD_2		0xc1144d02
165 #define MFI_LINUX_SET_AEN_2	0x400c4d04
166