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_CL_IOCTL_H
40
41#define TW_CL_IOCTL_H
42
43/*
44 * Macros and structures for Common Layer handled ioctls.
45 */
46
47#define TW_CL_AEN_NOT_RETRIEVED	0x1
48#define TW_CL_AEN_RETRIEVED	0x2
49
50#define TW_CL_ERROR_AEN_NO_EVENTS	0x1003	/* No more events */
51#define TW_CL_ERROR_AEN_OVERFLOW	0x1004	/* AEN overflow occurred */
52
53#define TW_CL_ERROR_IOCTL_LOCK_NOT_HELD		0x1001   /* Not locked */
54#define TW_CL_ERROR_IOCTL_LOCK_ALREADY_HELD	0x1002   /* Already locked */
55
56#pragma pack(1)
57
58/* Structure used to handle GET/RELEASE LOCK ioctls. */
59struct tw_cl_lock_packet {
60	TW_UINT32	timeout_msec;
61	TW_UINT32	time_remaining_msec;
62	TW_UINT32	force_flag;
63};
64
65/* Structure used to handle GET COMPATIBILITY INFO ioctl. */
66struct tw_cl_compatibility_packet {
67	TW_UINT8	driver_version[32];/* driver version */
68	TW_UINT16	working_srl;	/* driver & firmware negotiated srl */
69	TW_UINT16	working_branch;	/* branch # of the firmware that the
70					driver is compatible with */
71	TW_UINT16	working_build;	/* build # of the firmware that the
72					driver is compatible with */
73	TW_UINT16	driver_srl_high;/* highest driver supported srl */
74	TW_UINT16	driver_branch_high;/* highest driver supported branch */
75	TW_UINT16	driver_build_high;/* highest driver supported build */
76	TW_UINT16	driver_srl_low;/* lowest driver supported srl */
77	TW_UINT16	driver_branch_low;/* lowest driver supported branch */
78	TW_UINT16	driver_build_low;/* lowest driver supported build */
79	TW_UINT16	fw_on_ctlr_srl;	/* srl of running firmware */
80	TW_UINT16	fw_on_ctlr_branch;/* branch # of running firmware */
81	TW_UINT16	fw_on_ctlr_build;/* build # of running firmware */
82};
83
84/* Driver understandable part of the ioctl packet built by the API. */
85struct tw_cl_driver_packet {
86	TW_UINT32	control_code;
87	TW_UINT32	status;
88	TW_UINT32	unique_id;
89	TW_UINT32	sequence_id;
90	TW_UINT32	os_status;
91	TW_UINT32	buffer_length;
92};
93
94/* ioctl packet built by the API. */
95struct tw_cl_ioctl_packet {
96	struct tw_cl_driver_packet	driver_pkt;
97	TW_INT8				padding[488];
98	struct tw_cl_command_packet	cmd_pkt;
99	TW_INT8				data_buf[1];
100};
101
102#pragma pack()
103
104#endif /* TW_CL_IOCTL_H */
105