xref: /freebsd-13-stable/sys/dev/twe/tweio.h (revision f8167e0404dab9ffeaca95853dd237ab7c587f82)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2000 Michael Smith
5  * Copyright (c) 2003 Paul Saab
6  * Copyright (c) 2003 Vinod Kashyap
7  * Copyright (c) 2000 BSDi
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * 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 AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 /*
33  * User-space command
34  *
35  * Note that the command's scatter/gather list will be computed by the
36  * driver, and cannot be filled in by the consumer.
37  */
38 struct twe_usercommand {
39     TWE_Command	tu_command;	/* command ready for the controller */
40     void	*tu_data;	/* pointer to data in userspace */
41     size_t	tu_size;	/* userspace data length */
42 };
43 
44 #define TWEIO_COMMAND		_IOWR('T', 100, struct twe_usercommand)
45 
46 /*
47  * Command queue statistics
48  */
49 #define TWEQ_FREE	0
50 #define TWEQ_BIO	1
51 #define TWEQ_READY	2
52 #define TWEQ_BUSY	3
53 #define TWEQ_COMPLETE	4
54 #define TWEQ_COUNT	5	/* total number of queues */
55 
56 struct twe_qstat {
57     u_int32_t	q_length;
58     u_int32_t	q_max;
59     u_int32_t	q_min;
60 };
61 
62 /*
63  * Statistics request
64  */
65 union twe_statrequest {
66     u_int32_t		ts_item;
67     struct twe_qstat	ts_qstat;
68 };
69 
70 #define TWEIO_STATS		_IOWR('T', 101, union twe_statrequest)
71 
72 /*
73  * AEN listen
74  */
75 #define TWEIO_AEN_POLL		_IOR('T', 102, u_int16_t)
76 #define TWEIO_AEN_WAIT		_IOR('T', 103, u_int16_t)
77 
78 /*
79  * Controller parameter access
80  */
81 struct twe_paramcommand {
82     u_int16_t	tp_table_id;
83     u_int8_t	tp_param_id;
84     void	*tp_data;
85     u_int8_t	tp_size;
86 };
87 
88 #define TWEIO_SET_PARAM		_IOW ('T', 104, struct twe_paramcommand)
89 #define TWEIO_GET_PARAM		_IOW ('T', 105, struct twe_paramcommand)
90 
91 /*
92  * Request a controller soft-reset
93  */
94 #define TWEIO_RESET		_IO  ('T', 106)
95 
96 /*
97  * Request a drive addition or deletion
98  */
99 struct twe_drivecommand {
100     int		td_unit;
101 };
102 
103 #define TWEIO_ADD_UNIT		_IOW ('U', 107, int)
104 #define TWEIO_DEL_UNIT		_IOW ('U', 108, int)
105