sys/dev/disk/mpt/mpt_cam.h

   1 /* $FreeBSD: head/sys/dev/mpt/mpt_cam.h 203108 2010-01-28 08:41:30Z mav $ */
   2 /*-
   3  * LSI MPT Host Adapter FreeBSD Wrapper Definitions (CAM version)
   4  *
   5  * Copyright (c) 2000, 2001 by Greg Ansley, Adam Prewett
   6  *
   7  * Partially derived from Matty Jacobs ISP driver.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice immediately at the beginning of the file, without modification,
  14  *    this list of conditions, and the following disclaimer.
  15  * 2. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  */
  28 /*-
  29  * Copyright (c) 2002, 2006 by Matthew Jacob
  30  * All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions are
  34  * met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  38  *    substantially similar to the "NO WARRANTY" disclaimer below
  39  *    ("Disclaimer") and any redistribution must be conditioned upon including
  40  *    a substantially similar Disclaimer requirement for further binary
  41  *    redistribution.
  42  * 3. Neither the names of the above listed copyright holders nor the names
  43  *    of any contributors may be used to endorse or promote products derived
  44  *    from this software without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  47  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  50  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  51  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  52  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  53  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  54  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  55  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
  56  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  57  *
  58  * Support from Chris Ellsworth in order to make SAS adapters work
  59  * is gratefully acknowledged.
  60  *
  61  * Support from LSI-Logic has also gone a great deal toward making this a
  62  * workable subsystem and is gratefully acknowledged.
  63  */
  64 /*-
  65  * Copyright (c) 2004, Avid Technology, Inc. and its contributors.
  66  * Copyright (c) 2005, WHEEL Sp. z o.o.
  67  * Copyright (c) 2004, 2005 Justin T. Gibbs
  68  * All rights reserved.
  69  *
  70  * Redistribution and use in source and binary forms, with or without
  71  * modification, are permitted provided that the following conditions are
  72  * met:
  73  * 1. Redistributions of source code must retain the above copyright
  74  *    notice, this list of conditions and the following disclaimer.
  75  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  76  *    substantially similar to the "NO WARRANTY" disclaimer below
  77  *    ("Disclaimer") and any redistribution must be conditioned upon including
  78  *    a substantially similar Disclaimer requirement for further binary
  79  *    redistribution.
  80  * 3. Neither the names of the above listed copyright holders nor the names
  81  *    of any contributors may be used to endorse or promote products derived
  82  *    from this software without specific prior written permission.
  83  *
  84  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  85  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  86  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  87  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  88  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  89  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  90  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  91  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  92  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  93  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
  94  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  95  */
  96 #ifndef  _MPT_CAM_H_
  97 #define  _MPT_CAM_H_
  98
  99 #include <bus/cam/cam.h>
 100 #include <bus/cam/cam_debug.h>
 101 #include <bus/cam/cam_ccb.h>
 102 #include <bus/cam/cam_sim.h>
 103 #include <bus/cam/cam_xpt.h>
 104 #include <bus/cam/cam_periph.h>
 105 #include <bus/cam/cam_xpt_sim.h>
 106 #include <bus/cam/scsi/scsi_all.h>
 107 #include <bus/cam/scsi/scsi_message.h>
 108
 109 #define ccb_mpt_ptr sim_priv.entries[0].ptr
 110 #define ccb_req_ptr sim_priv.entries[1].ptr
 111
 112 /************************** CCB Manipulation Routines *************************/
 113 static __inline void mpt_freeze_ccb(union ccb *ccb);
 114 static __inline void mpt_set_ccb_status(union ccb *ccb, cam_status status);
 115
 116 static __inline void
 117 mpt_freeze_ccb(union ccb *ccb)
 118 {
 119         if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
 120                 ccb->ccb_h.status |= CAM_DEV_QFRZN;
 121                 xpt_freeze_devq(ccb->ccb_h.path, /*count*/1);
 122         }
 123 }
 124
 125 static __inline void
 126 mpt_set_ccb_status(union ccb *ccb, cam_status status)
 127 {
 128         ccb->ccb_h.status &= ~CAM_STATUS_MASK;
 129         ccb->ccb_h.status |= status;
 130 }
 131
 132 /****************************** Timeout Recovery ******************************/
 133 /*
 134  * The longest timeout specified for a Task Managent command.
 135  */
 136 #define MPT_TMF_MAX_TIMEOUT     (20000)
 137
 138 static __inline void
 139 mpt_wakeup_recovery_thread(struct mpt_softc *mpt)
 140 {
 141         wakeup(mpt);
 142 }
 143
 144 /************************** Version Compatibility *************************/
 145 #define mpt_sim_alloc(a, b, c, mpt, e, f, g)    \
 146         cam_sim_alloc(a, b, c, mpt, (mpt)->unit, &(mpt)->mpt_lock, e, f, g)
 147 #endif /*_MPT_CAM_H_ */