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

Cache object: eed1a473861f8394948e2dde1924a574

[ 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.

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

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