The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/cam/cam_periph.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: c6f9058495539eeeb7c26a2f9dcb9317


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.