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.6 2007/06/14 01:09:30 dillon 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 struct cam_devq * cam_simq_alloc(u_int32_t max_sim_transactions);
  53 void              cam_simq_release(struct cam_devq *devq);
  54
  55 struct cam_sim *  cam_sim_alloc(sim_action_func sim_action,
  56                                 sim_poll_func sim_poll,
  57                                 const char *sim_name,
  58                                 void *softc,
  59                                 u_int32_t unit,
  60                                 int max_dev_transactions,
  61                                 int max_tagged_dev_transactions,
  62                                 struct cam_devq *queue);
  63 void              cam_sim_free(struct cam_sim *sim);
  64 void              cam_sim_release(struct cam_sim *sim, int flags);
  65
  66 #define CAM_SIM_SOFTC   0x0002
  67
  68 /* Optional sim attributes may be set with these. */
  69 void    cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id);
  70
  71
  72
  73 /* Convenience routines for accessing sim attributes. */
  74 static __inline u_int32_t cam_sim_path(struct cam_sim *sim);
  75 static __inline const char *cam_sim_name(struct cam_sim *sim);
  76 static __inline void *    cam_sim_softc(struct cam_sim *sim);
  77 static __inline u_int32_t cam_sim_unit(struct cam_sim *sim);
  78 static __inline u_int32_t cam_sim_bus(struct cam_sim *sim);
  79
  80
  81
  82 /* Generically useful offsets into the sim private area */
  83 #define spriv_ptr0 sim_priv.entries[0].ptr
  84 #define spriv_ptr1 sim_priv.entries[1].ptr
  85 #define spriv_field0 sim_priv.entries[0].field
  86 #define spriv_field1 sim_priv.entries[1].field
  87
  88 /*
  89  * The sim driver should not access anything directly from this
  90  * structure.
  91  */
  92 struct cam_sim {
  93         sim_action_func         sim_action;
  94         sim_poll_func           sim_poll;
  95         const char              *sim_name;
  96         void                    *softc;         /* might be NULL */
  97         u_int32_t               path_id;        /* bootdev may set this to 0? */
  98         u_int32_t               unit_number;
  99         u_int32_t               bus_id;
 100         int                     max_tagged_dev_openings;
 101         int                     max_dev_openings;
 102         u_int32_t               flags;
 103 #define         CAM_SIM_REL_TIMEOUT_PENDING     0x01
 104         struct callout          c_handle;
 105         struct cam_devq         *devq;  /* Device Queue to use for this SIM */
 106         int                     refcount;       /* References to the sim */
 107 };
 108
 109 static __inline u_int32_t
 110 cam_sim_path(struct cam_sim *sim)
 111 {
 112         return (sim->path_id);
 113 }
 114
 115 static __inline const char *
 116 cam_sim_name(struct cam_sim *sim)
 117 {
 118         return (sim->sim_name);
 119 }
 120
 121 static __inline void *
 122 cam_sim_softc(struct cam_sim *sim)
 123 {
 124         return (sim->softc);
 125 }
 126
 127 static __inline u_int32_t
 128 cam_sim_unit(struct cam_sim *sim)
 129 {
 130         return (sim->unit_number);
 131 }
 132
 133 static __inline u_int32_t
 134 cam_sim_bus(struct cam_sim *sim)
 135 {
 136         return (sim->bus_id);
 137 }
 138
 139 #endif /* _KERNEL */
 140 #endif /* _CAM_CAM_SIM_H */