xref: /freebsd-13-stable/sys/dev/amr/amrio.h (revision f8167e0404dab9ffeaca95853dd237ab7c587f82)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause AND BSD-3-Clause
3  *
4  * Copyright (c) 1999 Michael Smith
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * Copyright (c) 2002 Eric Moore
29  * Copyright (c) 2002 LSI Logic Corporation
30  * All rights reserved.
31  *
32  * Redistribution and use in source and binary forms, with or without
33  * modification, are permitted provided that the following conditions
34  * are met:
35  * 1. Redistributions of source code must retain the above copyright
36  *    notice, this list of conditions and the following disclaimer.
37  * 2. Redistributions in binary form must reproduce the above copyright
38  *    notice, this list of conditions and the following disclaimer in the
39  *    documentation and/or other materials provided with the distribution.
40  * 3. The party using or redistributing the source code and binary forms
41  *    agrees to the disclaimer below and the terms and conditions set forth
42  *    herein.
43  *
44  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
45  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
48  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54  * SUCH DAMAGE.
55  *
56  */
57 
58 /*
59  * ioctl interface
60  */
61 
62 #include <sys/ioccom.h>
63 #include <sys/param.h>
64 
65 /*
66  * Fetch the driver's interface version.
67  */
68 #define AMR_IO_VERSION_NUMBER	153
69 #define AMR_IO_VERSION	_IOR('A', 0x200, int)
70 
71 /*
72  * Pass a command from userspace through to the adapter.
73  *
74  * Note that in order to be code-compatible with the Linux
75  * interface where possible, the formatting of the au_cmd field is
76  * somewhat Interesting.
77  *
78  * For normal commands, the layout is (fields from struct amr_mailbox_ioctl):
79  *
80  * 0		mb_command
81  * 1		mb_channel
82  * 2		mb_param
83  * 3		mb_pad[0]
84  * 4		mb_drive
85  *
86  * For SCSI passthrough commands, the layout is:
87  *
88  * 0		AMR_CMD_PASS	(0x3)
89  * 1		reserved, 0
90  * 2		cdb length
91  * 3		cdb data
92  * 3+cdb_len	passthrough control byte (timeout, ars, islogical)
93  * 4+cdb_len	reserved, 0
94  * 5+cdb_len	channel
95  * 6+cdb_len	target
96  */
97 
98 struct amr_user_ioctl {
99     unsigned char	au_cmd[32];	/* command text from userspace */
100     void		*au_buffer;	/* data buffer in userspace */
101     unsigned long	au_length;	/* data buffer size (0 == no data) */
102     int			au_direction;	/* data transfer direction */
103 #define AMR_IO_NODATA	0
104 #define AMR_IO_READ	1
105 #define AMR_IO_WRITE	2
106     int			au_status;	/* command status returned by adapter */
107 };
108 
109 #define AMR_IO_COMMAND	_IOWR('A', 0x201, struct amr_user_ioctl)
110 
111 #if defined(__amd64__)
112 
113 struct amr_user_ioctl32 {
114     unsigned char	au_cmd[32];	/* command text from userspace */
115     u_int32_t		au_buffer;	/* 32-bit pointer to uspace buf */
116     u_int32_t		au_length;	/* length of the uspace buffer */
117     int32_t		au_direction;	/* data transfer direction */
118     int32_t		au_status;	/* command status returned by adapter */
119 };
120 
121 #	define AMR_IO_COMMAND32	_IOWR('A', 0x201, struct amr_user_ioctl32)
122 #endif
123