xref: /dragonfly/sys/dev/raid/twa/tw_osl_ioctl.h (revision 8edfbc5e)
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_osl_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_OSL_IOCTL_H
40 
41 #define TW_OSL_IOCTL_H
42 
43 
44 /*
45  * Macros and structures for OS Layer/Common Layer handled ioctls.
46  */
47 
48 
49 
50 #include <dev/raid/twa/tw_cl_fwif.h>
51 #include <dev/raid/twa/tw_cl_ioctl.h>
52 
53 
54 
55 #pragma pack(1)
56 /*
57  * We need the structure below to ensure that the first byte of
58  * data_buf is not overwritten by the kernel, after we return
59  * from the ioctl call.  Note that cmd_pkt has been reduced
60  * to an array of 1024 bytes even though it's actually 2048 bytes
61  * in size.  This is because, we don't expect requests from user
62  * land requiring 2048 (273 sg elements) byte cmd pkts.
63  */
64 typedef struct tw_osli_ioctl_no_data_buf {
65 	struct tw_cl_driver_packet	driver_pkt;
66 	TW_VOID				*pdata; /* points to data_buf */
67 	TW_INT8				padding[488 - sizeof(TW_VOID *)];
68 	struct tw_cl_command_packet	cmd_pkt;
69 } TW_OSLI_IOCTL_NO_DATA_BUF;
70 
71 #pragma pack()
72 
73 /* ioctl cmds handled by the OS Layer */
74 #define TW_OSL_IOCTL_SCAN_BUS				\
75 	_IO('T', 200)
76 #define TW_OSL_IOCTL_FIRMWARE_PASS_THROUGH		\
77 	_IOWR('T', 202, TW_OSLI_IOCTL_NO_DATA_BUF)
78 
79 
80 #include <sys/ioccom.h>
81 
82 #pragma pack(1)
83 
84 typedef struct tw_osli_ioctl_with_payload {
85 	struct tw_cl_driver_packet	driver_pkt;
86 	TW_INT8				padding[488];
87 	struct tw_cl_command_packet	cmd_pkt;
88 	union {
89 		struct tw_cl_event_packet		event_pkt;
90 		struct tw_cl_lock_packet		lock_pkt;
91 		struct tw_cl_compatibility_packet	compat_pkt;
92 		TW_INT8					data_buf[1];
93 	} payload;
94 } TW_OSLI_IOCTL_WITH_PAYLOAD;
95 
96 #pragma pack()
97 
98 /* ioctl cmds handled by the Common Layer */
99 #define TW_CL_IOCTL_GET_FIRST_EVENT			\
100 	_IOWR('T', 203, TW_OSLI_IOCTL_WITH_PAYLOAD)
101 #define TW_CL_IOCTL_GET_LAST_EVENT			\
102 	_IOWR('T', 204, TW_OSLI_IOCTL_WITH_PAYLOAD)
103 #define TW_CL_IOCTL_GET_NEXT_EVENT			\
104 	_IOWR('T', 205, TW_OSLI_IOCTL_WITH_PAYLOAD)
105 #define TW_CL_IOCTL_GET_PREVIOUS_EVENT			\
106 	_IOWR('T', 206, TW_OSLI_IOCTL_WITH_PAYLOAD)
107 #define TW_CL_IOCTL_GET_LOCK				\
108 	_IOWR('T', 207, TW_OSLI_IOCTL_WITH_PAYLOAD)
109 #define TW_CL_IOCTL_RELEASE_LOCK			\
110 	_IOWR('T', 208, TW_OSLI_IOCTL_WITH_PAYLOAD)
111 #define TW_CL_IOCTL_GET_COMPATIBILITY_INFO		\
112 	_IOWR('T', 209, TW_OSLI_IOCTL_WITH_PAYLOAD)
113 
114 
115 
116 #endif /* TW_OSL_IOCTL_H */
117