sys/dev/twa/tw_osl_share.h

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