xref: /dragonfly/sys/dev/raid/twa/tw_cl_ioctl.h (revision 31524921)
1 /*
2  * Copyright (c) 2004-07 Applied Micro Circuits Corporation.
3  * Copyright (c) 2004-05 Vinod Kashyap
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  *	$FreeBSD: head/sys/dev/twa/tw_cl_ioctl.h 169400 2007-05-09 04:16:32Z scottl $
28  */
29 
30 /*
31  * AMCC'S 3ware driver for 9000 series storage controllers.
32  *
33  * Author: Vinod Kashyap
34  * Modifications by: Adam Radford
35  */
36 
37 
38 
39 #ifndef TW_CL_IOCTL_H
40 
41 #define TW_CL_IOCTL_H
42 
43 
44 /*
45  * Macros and structures for Common Layer handled ioctls.
46  */
47 
48 
49 #define TW_CL_AEN_NOT_RETRIEVED	0x1
50 #define TW_CL_AEN_RETRIEVED	0x2
51 
52 #define TW_CL_ERROR_AEN_NO_EVENTS	0x1003	/* No more events */
53 #define TW_CL_ERROR_AEN_OVERFLOW	0x1004	/* AEN overflow occurred */
54 
55 #define TW_CL_ERROR_IOCTL_LOCK_NOT_HELD		0x1001   /* Not locked */
56 #define TW_CL_ERROR_IOCTL_LOCK_ALREADY_HELD	0x1002   /* Already locked */
57 
58 
59 #pragma pack(1)
60 
61 /* Structure used to handle GET/RELEASE LOCK ioctls. */
62 struct tw_cl_lock_packet {
63 	TW_UINT32	timeout_msec;
64 	TW_UINT32	time_remaining_msec;
65 	TW_UINT32	force_flag;
66 };
67 
68 
69 /* Structure used to handle GET COMPATIBILITY INFO ioctl. */
70 struct tw_cl_compatibility_packet {
71 	TW_UINT8	driver_version[32];/* driver version */
72 	TW_UINT16	working_srl;	/* driver & firmware negotiated srl */
73 	TW_UINT16	working_branch;	/* branch # of the firmware that the
74 					driver is compatible with */
75 	TW_UINT16	working_build;	/* build # of the firmware that the
76 					driver is compatible with */
77 	TW_UINT16	driver_srl_high;/* highest driver supported srl */
78 	TW_UINT16	driver_branch_high;/* highest driver supported branch */
79 	TW_UINT16	driver_build_high;/* highest driver supported build */
80 	TW_UINT16	driver_srl_low;/* lowest driver supported srl */
81 	TW_UINT16	driver_branch_low;/* lowest driver supported branch */
82 	TW_UINT16	driver_build_low;/* lowest driver supported build */
83 	TW_UINT16	fw_on_ctlr_srl;	/* srl of running firmware */
84 	TW_UINT16	fw_on_ctlr_branch;/* branch # of running firmware */
85 	TW_UINT16	fw_on_ctlr_build;/* build # of running firmware */
86 };
87 
88 
89 /* Driver understandable part of the ioctl packet built by the API. */
90 struct tw_cl_driver_packet {
91 	TW_UINT32	control_code;
92 	TW_UINT32	status;
93 	TW_UINT32	unique_id;
94 	TW_UINT32	sequence_id;
95 	TW_UINT32	os_status;
96 	TW_UINT32	buffer_length;
97 };
98 
99 
100 /* ioctl packet built by the API. */
101 struct tw_cl_ioctl_packet {
102 	struct tw_cl_driver_packet	driver_pkt;
103 	TW_INT8				padding[488];
104 	struct tw_cl_command_packet	cmd_pkt;
105 	TW_INT8				data_buf[1];
106 };
107 
108 #pragma pack()
109 
110 
111 
112 #endif /* TW_CL_IOCTL_H */
113