sys/bus/cam/cam_sim.h

   1 /*
   2  * Data structures and definitions for SCSI Interface Modules (SIMs).
   3  *
   4  * Copyright (c) 1997 Justin T. Gibbs.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions, and the following disclaimer,
  12  *    without modification, immediately at the beginning of the file.
  13  * 2. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/sys/cam/cam_sim.h,v 1.4 1999/12/29 04:54:27 peter Exp $
  29  * $DragonFly: src/sys/bus/cam/cam_sim.h,v 1.7 2008/05/18 20:30:19 pavalos Exp $
  30  */
  31
  32 #ifndef _CAM_CAM_SIM_H
  33 #define _CAM_CAM_SIM_H 1
  34
  35 #ifdef _KERNEL
  36
  37 /*
  38  * The sim driver creates a sim for each controller.  The sim device
  39  * queue is separately created in order to allow resource sharing between
  40  * sims.  For instance, a driver may create one sim for each channel of
  41  * a multi-channel controller and use the same queue for each channel.
  42  * In this way, the queue resources are shared across all the channels
  43  * of the multi-channel controller.
  44  */
  45
  46 struct cam_sim;
  47 struct cam_devq;
  48
  49 typedef void (*sim_action_func)(struct cam_sim *sim, union ccb *ccb);
  50 typedef void (*sim_poll_func)(struct cam_sim *sim);
  51
  52 typedef struct lock     sim_lock;
  53 extern  sim_lock        sim_mplock;
  54
  55 void              cam_sim_lock(sim_lock *lock);
  56 void              cam_sim_unlock(sim_lock *lock);
  57 void              sim_lock_assert_owned(sim_lock *lock);
  58 int               sim_lock_sleep(void *ident, int flags, const char *wmesg,
  59                                  int timo, sim_lock *lock);
  60 struct cam_devq * cam_simq_alloc(u_int32_t max_sim_transactions);
  61 void              cam_simq_release(struct cam_devq *devq);
  62
  63 struct cam_sim *  cam_sim_alloc(sim_action_func sim_action,
  64                                 sim_poll_func sim_poll,
  65                                 const char *sim_name,
  66                                 void *softc,
  67                                 u_int32_t unit,
  68                                 sim_lock *lock,
  69                                 int max_dev_transactions,
  70                                 int max_tagged_dev_transactions,
  71                                 struct cam_devq *queue);
  72 void              cam_sim_free(struct cam_sim *sim);
  73 void              cam_sim_release(struct cam_sim *sim, int flags);
  74
  75 #define CAM_SIM_SOFTC   0x0002
  76
  77 /* Optional sim attributes may be set with these. */
  78 void    cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id);
  79
  80
  81
  82 /* Convenience routines for accessing sim attributes. */
  83 static __inline u_int32_t cam_sim_path(struct cam_sim *sim);
  84 static __inline const char *cam_sim_name(struct cam_sim *sim);
  85 static __inline void *    cam_sim_softc(struct cam_sim *sim);
  86 static __inline u_int32_t cam_sim_unit(struct cam_sim *sim);
  87 static __inline u_int32_t cam_sim_bus(struct cam_sim *sim);
  88
  89
  90
  91 /* Generically useful offsets into the sim private area */
  92 #define spriv_ptr0 sim_priv.entries[0].ptr
  93 #define spriv_ptr1 sim_priv.entries[1].ptr
  94 #define spriv_field0 sim_priv.entries[0].field
  95 #define spriv_field1 sim_priv.entries[1].field
  96
  97 /*
  98  * The sim driver should not access anything directly from this
  99  * structure.
 100  */
 101 struct cam_sim {
 102         sim_action_func         sim_action;
 103         sim_poll_func           sim_poll;
 104         const char              *sim_name;
 105         void                    *softc;         /* might be NULL */
 106         sim_lock                *lock;
 107         TAILQ_HEAD(, ccb_hdr)   sim_doneq;
 108         TAILQ_ENTRY(cam_sim)    links;
 109         u_int32_t               path_id;        /* bootdev may set this to 0? */
 110         u_int32_t               unit_number;
 111         u_int32_t               bus_id;
 112         int                     max_tagged_dev_openings;
 113         int                     max_dev_openings;
 114         u_int32_t               flags;
 115 #define CAM_SIM_REL_TIMEOUT_PENDING     0x01
 116 #define CAM_SIM_MPSAFE                  0x02
 117 #define CAM_SIM_ON_DONEQ                0x04
 118         struct callout          callout;
 119         struct cam_devq         *devq;  /* Device Queue to use for this SIM */
 120         int                     refcount;       /* References to the sim */
 121
 122         /* "Pool" of inactive ccbs managed by xpt_alloc_ccb and xpt_free_ccb */
 123         SLIST_HEAD(,ccb_hdr)    ccb_freeq;
 124         /*
 125          * Maximum size of ccb pool.  Modified as devices are added/removed
 126          * or have their * opening counts changed.
 127          */
 128         u_int                   max_ccbs;
 129         /* Current count of allocated ccbs */
 130         u_int                   ccb_count;
 131
 132 };
 133
 134 #define CAM_SIM_LOCK(sim)       cam_sim_lock((sim)->lock);
 135 #define CAM_SIM_UNLOCK(sim)     cam_sim_unlock((sim)->lock);
 136
 137 static __inline u_int32_t
 138 cam_sim_path(struct cam_sim *sim)
 139 {
 140         return (sim->path_id);
 141 }
 142
 143 static __inline const char *
 144 cam_sim_name(struct cam_sim *sim)
 145 {
 146         return (sim->sim_name);
 147 }
 148
 149 static __inline void *
 150 cam_sim_softc(struct cam_sim *sim)
 151 {
 152         return (sim->softc);
 153 }
 154
 155 static __inline u_int32_t
 156 cam_sim_unit(struct cam_sim *sim)
 157 {
 158         return (sim->unit_number);
 159 }
 160
 161 static __inline u_int32_t
 162 cam_sim_bus(struct cam_sim *sim)
 163 {
 164         return (sim->bus_id);
 165 }
 166
 167 #endif /* _KERNEL */
 168 #endif /* _CAM_CAM_SIM_H */