xref: /freebsd/sys/sys/mpt_ioctl.h (revision c697fb7f)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2008 Yahoo!, Inc.
5  * All rights reserved.
6  * Written by: John Baldwin <jhb@FreeBSD.org>
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  * 3. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * LSI MPT-Fusion Host Adapter FreeBSD userland interface
33  *
34  * $FreeBSD$
35  */
36 
37 #ifndef _MPT_IOCTL_H_
38 #define	_MPT_IOCTL_H_
39 
40 #include <dev/mpt/mpilib/mpi_type.h>
41 #include <dev/mpt/mpilib/mpi.h>
42 #include <dev/mpt/mpilib/mpi_cnfg.h>
43 
44 /*
45  * For the read header requests, the header should include the page
46  * type or extended page type, page number, and page version.  The
47  * buffer and length are unused.  The completed header is returned in
48  * the 'header' member.
49  *
50  * For the read page and write page requests, 'buf' should point to a
51  * buffer of 'len' bytes which holds the entire page (including the
52  * header).
53  *
54  * All requests specify the page address in 'page_address'.
55  */
56 struct mpt_cfg_page_req {
57 	CONFIG_PAGE_HEADER header;
58 	uint32_t page_address;
59 	void	*buf;
60 	int	len;
61 	uint16_t ioc_status;
62 };
63 
64 struct mpt_ext_cfg_page_req {
65 	CONFIG_EXTENDED_PAGE_HEADER header;
66 	uint32_t page_address;
67 	void	*buf;
68 	int	len;
69 	uint16_t ioc_status;
70 };
71 
72 struct mpt_raid_action {
73 	uint8_t action;
74 	uint8_t volume_bus;
75 	uint8_t volume_id;
76 	uint8_t phys_disk_num;
77 	uint32_t action_data_word;
78 	void *buf;
79 	int len;
80 	uint32_t volume_status;
81 	uint32_t action_data[4];
82 	uint16_t action_status;
83 	uint16_t ioc_status;
84 	uint8_t write;
85 };
86 
87 #define	MPTIO_READ_CFG_HEADER	_IOWR('M', 100, struct mpt_cfg_page_req)
88 #define	MPTIO_READ_CFG_PAGE	_IOWR('M', 101, struct mpt_cfg_page_req)
89 #define	MPTIO_READ_EXT_CFG_HEADER _IOWR('M', 102, struct mpt_ext_cfg_page_req)
90 #define	MPTIO_READ_EXT_CFG_PAGE	_IOWR('M', 103, struct mpt_ext_cfg_page_req)
91 #define	MPTIO_WRITE_CFG_PAGE	_IOWR('M', 104, struct mpt_cfg_page_req)
92 #define	MPTIO_RAID_ACTION	_IOWR('M', 105, struct mpt_raid_action)
93 
94 #if defined(__amd64__)
95 struct mpt_cfg_page_req32 {
96 	CONFIG_PAGE_HEADER header;
97 	uint32_t page_address;
98 	uint32_t buf;
99 	int	len;
100 	uint16_t ioc_status;
101 };
102 
103 struct mpt_ext_cfg_page_req32 {
104 	CONFIG_EXTENDED_PAGE_HEADER header;
105 	uint32_t page_address;
106 	uint32_t buf;
107 	int	len;
108 	uint16_t ioc_status;
109 };
110 
111 struct mpt_raid_action32 {
112 	uint8_t action;
113 	uint8_t volume_bus;
114 	uint8_t volume_id;
115 	uint8_t phys_disk_num;
116 	uint32_t action_data_word;
117 	uint32_t buf;
118 	int len;
119 	uint32_t volume_status;
120 	uint32_t action_data[4];
121 	uint16_t action_status;
122 	uint16_t ioc_status;
123 	uint8_t write;
124 };
125 
126 #define	MPTIO_READ_CFG_HEADER32	_IOWR('M', 100, struct mpt_cfg_page_req32)
127 #define	MPTIO_READ_CFG_PAGE32	_IOWR('M', 101, struct mpt_cfg_page_req32)
128 #define	MPTIO_READ_EXT_CFG_HEADER32 _IOWR('M', 102, struct mpt_ext_cfg_page_req32)
129 #define	MPTIO_READ_EXT_CFG_PAGE32 _IOWR('M', 103, struct mpt_ext_cfg_page_req32)
130 #define	MPTIO_WRITE_CFG_PAGE32	_IOWR('M', 104, struct mpt_cfg_page_req32)
131 #define	MPTIO_RAID_ACTION32	_IOWR('M', 105, struct mpt_raid_action32)
132 #endif
133 
134 #endif /* !_MPT_IOCTL_H_ */
135