xref: /freebsd-13.1/sys/dev/mly/mlyio.h (revision 718cf2cc)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2001 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  *	$FreeBSD$
29  */
30 
31 /********************************************************************************
32  * Control structures exchanged through the GAM interface with userland
33  * management tools.
34  *
35  * The member naming here is consistent with the Linux driver, with which this
36  * interface is basically compatible.
37  */
38 struct mly_user_command
39 {
40     unsigned char		ControllerNumber;
41     union mly_command_packet	CommandMailbox;
42     int				DataTransferLength;
43     int				RequestSenseLength;
44     void			*DataTransferBuffer;
45     void			*RequestSenseBuffer;
46     int				CommandStatus;		/* not in the Linux structure */
47 };
48 
49 #define MLYIO_COMMAND	_IOWR('M', 200, struct mly_user_command)
50 
51 struct mly_user_health
52 {
53     unsigned char	ControllerNumber;
54     void		*HealthStatusBuffer;
55 };
56 
57 #define MLYIO_HEALTH	_IOW('M', 201, struct mly_user_health)
58 
59 /*
60  * Command queue statistics
61  */
62 
63 #define MLYQ_FREE	0
64 #define MLYQ_BUSY	1
65 #define MLYQ_COMPLETE	2
66 #define MLYQ_COUNT	3
67 
68 struct mly_qstat
69 {
70     u_int32_t	q_length;
71     u_int32_t	q_max;
72 };
73