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