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