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