sys/cam/cam_periph.h

   1 /*-
   2  * Data structures and definitions for CAM peripheral ("type") drivers.
   3  *
   4  * Copyright (c) 1997, 1998 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$
  29  */
  30
  31 #ifndef _CAM_CAM_PERIPH_H
  32 #define _CAM_CAM_PERIPH_H 1
  33
  34 #include <sys/queue.h>
  35 #include <cam/cam_sim.h>
  36
  37 #ifdef _KERNEL
  38
  39 struct devstat;
  40
  41 extern struct cam_periph *xpt_periph;
  42
  43 extern struct periph_driver **periph_drivers;
  44 void periphdriver_register(void *);
  45 void periphdriver_init(int level);
  46
  47 #include <sys/module.h>
  48 #define PERIPHDRIVER_DECLARE(name, driver) \
  49         static int name ## _modevent(module_t mod, int type, void *data) \
  50         { \
  51                 switch (type) { \
  52                 case MOD_LOAD: \
  53                         periphdriver_register(data); \
  54                         break; \
  55                 case MOD_UNLOAD: \
  56                         printf(#name " module unload - not possible for this module type\n"); \
  57                         return EINVAL; \
  58                 default: \
  59                         return EOPNOTSUPP; \
  60                 } \
  61                 return 0; \
  62         } \
  63         static moduledata_t name ## _mod = { \
  64                 #name, \
  65                 name ## _modevent, \
  66                 (void *)&driver \
  67         }; \
  68         DECLARE_MODULE(name, name ## _mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
  69         MODULE_DEPEND(name, cam, 1, 1, 1)
  70
  71 typedef void (periph_init_t)(void); /*
  72                                      * Callback informing the peripheral driver
  73                                      * it can perform it's initialization since
  74                                      * the XPT is now fully initialized.
  75                                      */
  76 typedef periph_init_t *periph_init_func_t;
  77
  78 struct periph_driver {
  79         periph_init_func_t       init;
  80         char                     *driver_name;
  81         TAILQ_HEAD(,cam_periph)  units;
  82         u_int                    generation;
  83         u_int                    flags;
  84 #define CAM_PERIPH_DRV_EARLY            0x01
  85 };
  86
  87 typedef enum {
  88         CAM_PERIPH_BIO
  89 } cam_periph_type;
  90
  91 /* Generically usefull offsets into the peripheral private area */
  92 #define ppriv_ptr0 periph_priv.entries[0].ptr
  93 #define ppriv_ptr1 periph_priv.entries[1].ptr
  94 #define ppriv_field0 periph_priv.entries[0].field
  95 #define ppriv_field1 periph_priv.entries[1].field
  96
  97 typedef void            periph_start_t (struct cam_periph *periph,
  98                                         union ccb *start_ccb);
  99 typedef cam_status      periph_ctor_t (struct cam_periph *periph,
 100                                        void *arg);
 101 typedef void            periph_oninv_t (struct cam_periph *periph);
 102 typedef void            periph_dtor_t (struct cam_periph *periph);
 103 struct cam_periph {
 104         cam_pinfo                pinfo;
 105         periph_start_t          *periph_start;
 106         periph_oninv_t          *periph_oninval;
 107         periph_dtor_t           *periph_dtor;
 108         char                    *periph_name;
 109         struct cam_path         *path;  /* Compiled path to device */
 110         void                    *softc;
 111         struct cam_sim          *sim;
 112         u_int32_t                unit_number;
 113         cam_periph_type          type;
 114         u_int32_t                flags;
 115 #define CAM_PERIPH_RUNNING              0x01
 116 #define CAM_PERIPH_LOCKED               0x02
 117 #define CAM_PERIPH_LOCK_WANTED          0x04
 118 #define CAM_PERIPH_INVALID              0x08
 119 #define CAM_PERIPH_NEW_DEV_FOUND        0x10
 120 #define CAM_PERIPH_RECOVERY_INPROG      0x20
 121 #define CAM_PERIPH_SENSE_INPROG         0x40
 122         u_int32_t                immediate_priority;
 123         u_int32_t                refcount;
 124         SLIST_HEAD(, ccb_hdr)    ccb_list;      /* For "immediate" requests */
 125         SLIST_ENTRY(cam_periph)  periph_links;
 126         TAILQ_ENTRY(cam_periph)  unit_links;
 127         ac_callback_t           *deferred_callback;
 128         ac_code                  deferred_ac;
 129 };
 130
 131 #define CAM_PERIPH_MAXMAPS      2
 132
 133 struct cam_periph_map_info {
 134         int             num_bufs_used;
 135         struct buf      *bp[CAM_PERIPH_MAXMAPS];
 136 };
 137
 138 cam_status cam_periph_alloc(periph_ctor_t *periph_ctor,
 139                             periph_oninv_t *periph_oninvalidate,
 140                             periph_dtor_t *periph_dtor,
 141                             periph_start_t *periph_start,
 142                             char *name, cam_periph_type type, struct cam_path *,
 143                             ac_callback_t *, ac_code, void *arg);
 144 struct cam_periph *cam_periph_find(struct cam_path *path, char *name);
 145 int             cam_periph_list(struct cam_path *, struct sbuf *);
 146 cam_status      cam_periph_acquire(struct cam_periph *periph);
 147 void            cam_periph_release(struct cam_periph *periph);
 148 void            cam_periph_release_locked(struct cam_periph *periph);
 149 int             cam_periph_hold(struct cam_periph *periph, int priority);
 150 void            cam_periph_unhold(struct cam_periph *periph);
 151 void            cam_periph_invalidate(struct cam_periph *periph);
 152 int             cam_periph_mapmem(union ccb *ccb,
 153                                   struct cam_periph_map_info *mapinfo);
 154 void            cam_periph_unmapmem(union ccb *ccb,
 155                                     struct cam_periph_map_info *mapinfo);
 156 union ccb       *cam_periph_getccb(struct cam_periph *periph,
 157                                    u_int32_t priority);
 158 void            cam_periph_ccbwait(union ccb *ccb);
 159 int             cam_periph_runccb(union ccb *ccb,
 160                                   int (*error_routine)(union ccb *ccb,
 161                                                        cam_flags camflags,
 162                                                        u_int32_t sense_flags),
 163                                   cam_flags camflags, u_int32_t sense_flags,
 164                                   struct devstat *ds);
 165 int             cam_periph_ioctl(struct cam_periph *periph, u_long cmd,
 166                                  caddr_t addr,
 167                                  int (*error_routine)(union ccb *ccb,
 168                                                       cam_flags camflags,
 169                                                       u_int32_t sense_flags));
 170 void            cam_freeze_devq(struct cam_path *path);
 171 void            cam_freeze_devq_arg(struct cam_path *path, u_int32_t flags,
 172                     uint32_t arg);
 173 u_int32_t       cam_release_devq(struct cam_path *path, u_int32_t relsim_flags,
 174                                  u_int32_t opening_reduction, u_int32_t arg,
 175                                  int getcount_only);
 176 void            cam_periph_async(struct cam_periph *periph, u_int32_t code,
 177                                  struct cam_path *path, void *arg);
 178 void            cam_periph_bus_settle(struct cam_periph *periph,
 179                                       u_int bus_settle_ms);
 180 void            cam_periph_freeze_after_event(struct cam_periph *periph,
 181                                               struct timeval* event_time,
 182                                               u_int duration_ms);
 183 int             cam_periph_error(union ccb *ccb, cam_flags camflags,
 184                                  u_int32_t sense_flags, union ccb *save_ccb);
 185
 186 static __inline void
 187 cam_periph_lock(struct cam_periph *periph)
 188 {
 189         mtx_lock(periph->sim->mtx);
 190 }
 191
 192 static __inline void
 193 cam_periph_unlock(struct cam_periph *periph)
 194 {
 195         mtx_unlock(periph->sim->mtx);
 196 }
 197
 198 static __inline int
 199 cam_periph_owned(struct cam_periph *periph)
 200 {
 201         return (mtx_owned(periph->sim->mtx));
 202 }
 203
 204 static __inline int
 205 cam_periph_sleep(struct cam_periph *periph, void *chan, int priority,
 206                  const char *wmesg, int timo)
 207 {
 208         return (msleep(chan, periph->sim->mtx, priority, wmesg, timo));
 209 }
 210
 211 #endif /* _KERNEL */
 212 #endif /* _CAM_CAM_PERIPH_H */