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
40
41#ifndef TW_OSL_SHARE_H
42
43#define TW_OSL_SHARE_H
44
45
46/*
47 * Macros, structures and functions shared between OSL and CL,
48 * and defined by OSL.
49 */
50
51
52#include <sys/param.h>
53#include <sys/systm.h>
54#include <sys/kernel.h>
55#include <sys/clock.h>
56#include <sys/lock.h>
57#include <sys/mutex.h>
58#include <sys/sysctl.h>
59#include <sys/bus.h>
60#include <sys/taskqueue.h>
61
62#include <machine/bus.h>
63#include <machine/endian.h>
64#include <machine/stdarg.h>
65
66#include <dev/pci/pcivar.h>
67
68#include <dev/twa/tw_osl_types.h>
69#include "opt_twa.h"
70
71
72#ifdef TWA_DEBUG
73#define TW_OSL_DEBUG	TWA_DEBUG
74#endif
75
76#ifdef TWA_ENCLOSURE_SUPPORT
77#define TW_OSL_ENCLOSURE_SUPPORT
78#endif
79
80#define TW_OSL_DRIVER_VERSION_STRING	"3.80.06.003"
81
82#define	TW_OSL_CAN_SLEEP
83
84#ifdef TW_OSL_CAN_SLEEP
85typedef TW_VOID			*TW_SLEEP_HANDLE;
86#endif /* TW_OSL_CAN_SLEEP */
87
88#define TW_OSL_PCI_CONFIG_ACCESSIBLE
89
90#if _BYTE_ORDER == _BIG_ENDIAN
91#define TW_OSL_BIG_ENDIAN
92#else
93#define TW_OSL_LITTLE_ENDIAN
94#endif
95
96#ifdef TW_OSL_DEBUG
97extern TW_INT32		TW_OSL_DEBUG_LEVEL_FOR_CL;
98#endif /* TW_OSL_DEBUG */
99
100
101/* Possible return codes from/to Common Layer functions. */
102#define TW_OSL_ESUCCESS		0		/* success */
103#define TW_OSL_EGENFAILURE	1		/* general failure */
104#define TW_OSL_ENOMEM		ENOMEM		/* insufficient memory */
105#define TW_OSL_EIO		EIO		/* I/O error */
106#define TW_OSL_ETIMEDOUT	ETIMEDOUT	/* time out */
107#define TW_OSL_ENOTTY		ENOTTY		/* invalid command */
108#define TW_OSL_EBUSY		EBUSY		/* busy -- try later */
109#define TW_OSL_EBIG		EFBIG		/* request too big */
110#define TW_OSL_EWOULDBLOCK	EWOULDBLOCK	/* sleep timed out */
111#define TW_OSL_ERESTART		ERESTART /* sleep terminated by a signal */
112
113
114
115#endif /* TW_OSL_SHARE_H */
116