xref: /freebsd/sys/dev/mrsas/mrsas_ioctl.h (revision e8e8c939350bdf3c228a411caa9660c607c27a11)
1 /*
2  * Copyright (c) 2015, AVAGO Tech. All rights reserved. Author: Marian Choy
3  * Copyright (c) 2014, LSI Corp. All rights reserved. Author: Marian Choy
4  * Support: freebsdraid@avagotech.com
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer. 2. Redistributions
12  * in binary form must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution. 3. Neither the name of the
15  * <ORGANIZATION> nor the names of its contributors may be used to endorse or
16  * promote products derived from this software without specific prior written
17  * permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  * The views and conclusions contained in the software and documentation are
32  * those of the authors and should not be interpreted as representing
33  * official policies,either expressed or implied, of the FreeBSD Project.
34  *
35  * Send feedback to: <megaraidfbsd@avagotech.com> Mail to: AVAGO TECHNOLOGIES, 1621
36  * Barber Lane, Milpitas, CA 95035 ATTN: MegaRaid FreeBSD
37  *
38  */
39 
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
42 
43 #ifndef MRSAS_IOCTL_H
44 #define	MRSAS_IOCTL_H
45 
46 #ifndef _IOWR
47 #include <sys/ioccom.h>
48 #endif					/* !_IOWR */
49 
50 #ifdef COMPAT_FREEBSD32
51 /* Compilation error FIX */
52 #if (__FreeBSD_version <= 900000)
53 #include <sys/socket.h>
54 #endif
55 #include <sys/mount.h>
56 #include <compat/freebsd32/freebsd32.h>
57 #endif
58 
59 /*
60  * We need to use the same values as the mfi driver until MegaCli adds
61  * support for this (mrsas) driver: M is for MegaRAID. (This is typically the
62  * vendor or product initial) 1 arbitrary. (This may be used to segment kinds
63  * of commands.  (1-9 status, 10-20 policy, etc.) struct mrsas_iocpacket
64  * (sizeof() this parameter will be used.) These three values are encoded
65  * into a somewhat unique, 32-bit value.
66  */
67 
68 #define	MRSAS_IOC_GET_PCI_INFO				_IOR('M', 7, MRSAS_DRV_PCI_INFORMATION)
69 #define	MRSAS_IOC_FIRMWARE_PASS_THROUGH64	_IOWR('M', 1, struct mrsas_iocpacket)
70 #ifdef COMPAT_FREEBSD32
71 #define	MRSAS_IOC_FIRMWARE_PASS_THROUGH32	_IOWR('M', 1, struct mrsas_iocpacket32)
72 #endif
73 
74 #define	MRSAS_IOC_SCAN_BUS		_IO('M',  10)
75 
76 #define	MRSAS_LINUX_CMD32		0xc1144d01
77 
78 #define	MAX_IOCTL_SGE			16
79 #define	MFI_FRAME_DIR_READ		0x0010
80 #define	MFI_CMD_LD_SCSI_IO		0x03
81 
82 #define	INQUIRY_CMD				0x12
83 #define	INQUIRY_CMDLEN			6
84 #define	INQUIRY_REPLY_LEN		96
85 #define	INQUIRY_VENDOR			8	/* Offset in reply data to
86 						 * vendor name */
87 #define	SCSI_SENSE_BUFFERSIZE	96
88 
89 #define	MEGAMFI_RAW_FRAME_SIZE	128
90 
91 
92 #pragma pack(1)
93 struct mrsas_iocpacket {
94 	u_int16_t host_no;
95 	u_int16_t __pad1;
96 	u_int32_t sgl_off;
97 	u_int32_t sge_count;
98 	u_int32_t sense_off;
99 	u_int32_t sense_len;
100 	union {
101 		u_int8_t raw[MEGAMFI_RAW_FRAME_SIZE];
102 		struct mrsas_header hdr;
103 	}	frame;
104 	struct iovec sgl[MAX_IOCTL_SGE];
105 };
106 
107 #pragma pack()
108 
109 #ifdef COMPAT_FREEBSD32
110 #pragma pack(1)
111 struct mrsas_iocpacket32 {
112 	u_int16_t host_no;
113 	u_int16_t __pad1;
114 	u_int32_t sgl_off;
115 	u_int32_t sge_count;
116 	u_int32_t sense_off;
117 	u_int32_t sense_len;
118 	union {
119 		u_int8_t raw[MEGAMFI_RAW_FRAME_SIZE];
120 		struct mrsas_header hdr;
121 	}	frame;
122 	struct iovec32 sgl[MAX_IOCTL_SGE];
123 };
124 
125 #pragma pack()
126 #endif					/* COMPAT_FREEBSD32 */
127 
128 #endif					/* MRSAS_IOCTL_H */
129