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