cam_xpt.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 dealing with the 
    3  * Common Access Method Transport (xpt) layer.
    4  *
    5  * Copyright (c) 1997 Justin T. Gibbs.
    6  * All rights reserved.
    7  *
    8  * Redistribution and use in source and binary forms, with or without
    9  * modification, are permitted provided that the following conditions
   10  * are met:
   11  * 1. Redistributions of source code must retain the above copyright
   12  *    notice, this list of conditions, and the following disclaimer,
   13  *    without modification, immediately at the beginning of the file.
   14  * 2. The name of the author may not be used to endorse or promote products
   15  *    derived from this software without specific prior written permission.
   16  *
   17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
   21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   27  * SUCH DAMAGE.
   28  *
   29  * $FreeBSD$
   30  */
   31 
   32 #ifndef _CAM_CAM_XPT_H
   33 #define _CAM_CAM_XPT_H 1
   34 
   35 #ifdef _KERNEL
   36 #include <sys/cdefs.h>
   37 #include <cam/cam_ccb.h>
   38 #endif
   39 
   40 
   41 /* Forward Declarations */
   42 union ccb;
   43 struct cam_periph;
   44 struct cam_ed;
   45 struct cam_sim;
   46 
   47 /*
   48  * Definition of a CAM path.  Paths are created from bus, target, and lun ids
   49  * via xpt_create_path and allow for reference to devices without recurring
   50  * lookups in the edt.
   51  */
   52 struct cam_path;
   53 
   54 /* Path functions */
   55 
   56 #ifdef _KERNEL
   57 
   58 /*
   59  * Definition of an async handler callback block.  These are used to add
   60  * SIMs and peripherals to the async callback lists.
   61  */
   62 struct async_node {
   63         SLIST_ENTRY(async_node) links;
   64         u_int32_t       event_enable;   /* Async Event enables */
   65         u_int32_t       event_lock;     /* Take SIM lock for handlers. */
   66         void            (*callback)(void *arg, u_int32_t code,
   67                                     struct cam_path *path, void *args);
   68         void            *callback_arg;
   69 };
   70 
   71 SLIST_HEAD(async_list, async_node);
   72 SLIST_HEAD(periph_list, cam_periph);
   73 
   74 void                    xpt_action(union ccb *new_ccb);
   75 void                    xpt_action_default(union ccb *new_ccb);
   76 union ccb               *xpt_alloc_ccb(void);
   77 union ccb               *xpt_alloc_ccb_nowait(void);
   78 void                    xpt_free_ccb(union ccb *free_ccb);
   79 void                    xpt_setup_ccb_flags(struct ccb_hdr *ccb_h,
   80                                             struct cam_path *path,
   81                                             u_int32_t priority,
   82                                             u_int32_t flags);
   83 void                    xpt_setup_ccb(struct ccb_hdr *ccb_h,
   84                                       struct cam_path *path,
   85                                       u_int32_t priority);
   86 void                    xpt_merge_ccb(union ccb *master_ccb,
   87                                       union ccb *slave_ccb);
   88 cam_status              xpt_create_path(struct cam_path **new_path_ptr,
   89                                         struct cam_periph *perph,
   90                                         path_id_t path_id,
   91                                         target_id_t target_id, lun_id_t lun_id);
   92 cam_status              xpt_create_path_unlocked(struct cam_path **new_path_ptr,
   93                                         struct cam_periph *perph,
   94                                         path_id_t path_id,
   95                                         target_id_t target_id, lun_id_t lun_id);
   96 int                     xpt_getattr(char *buf, size_t len, const char *attr,
   97                                     struct cam_path *path);
   98 void                    xpt_free_path(struct cam_path *path);
   99 void                    xpt_path_counts(struct cam_path *path, uint32_t *bus_ref,
  100                                         uint32_t *periph_ref, uint32_t *target_ref,
  101                                         uint32_t *device_ref);
  102 int                     xpt_path_comp(struct cam_path *path1,
  103                                       struct cam_path *path2);
  104 int                     xpt_path_comp_dev(struct cam_path *path,
  105                                           struct cam_ed *dev);
  106 void                    xpt_print_path(struct cam_path *path);
  107 void                    xpt_print_device(struct cam_ed *device);
  108 void                    xpt_print(struct cam_path *path, const char *fmt, ...);
  109 int                     xpt_path_string(struct cam_path *path, char *str,
  110                                         size_t str_len);
  111 path_id_t               xpt_path_path_id(struct cam_path *path);
  112 target_id_t             xpt_path_target_id(struct cam_path *path);
  113 lun_id_t                xpt_path_lun_id(struct cam_path *path);
  114 struct cam_sim          *xpt_path_sim(struct cam_path *path);
  115 struct cam_periph       *xpt_path_periph(struct cam_path *path);
  116 void                    xpt_async(u_int32_t async_code, struct cam_path *path,
  117                                   void *async_arg);
  118 void                    xpt_rescan(union ccb *ccb);
  119 void                    xpt_hold_boot(void);
  120 void                    xpt_release_boot(void);
  121 void                    xpt_lock_buses(void);
  122 void                    xpt_unlock_buses(void);
  123 struct mtx *            xpt_path_mtx(struct cam_path *path);
  124 #define xpt_path_lock(path)     mtx_lock(xpt_path_mtx(path))
  125 #define xpt_path_unlock(path)   mtx_unlock(xpt_path_mtx(path))
  126 #define xpt_path_assert(path, what)     mtx_assert(xpt_path_mtx(path), (what))
  127 #define xpt_path_owned(path)    mtx_owned(xpt_path_mtx(path))
  128 #define xpt_path_sleep(path, chan, priority, wmesg, timo)               \
  129     msleep((chan), xpt_path_mtx(path), (priority), (wmesg), (timo))
  130 cam_status              xpt_register_async(int event, ac_callback_t *cbfunc,
  131                                            void *cbarg, struct cam_path *path);
  132 cam_status              xpt_compile_path(struct cam_path *new_path,
  133                                          struct cam_periph *perph,
  134                                          path_id_t path_id,
  135                                          target_id_t target_id,
  136                                          lun_id_t lun_id);
  137 cam_status              xpt_clone_path(struct cam_path **new_path,
  138                                       struct cam_path *path);
  139 void                    xpt_copy_path(struct cam_path *new_path,
  140                                       struct cam_path *path);
  141 
  142 void                    xpt_release_path(struct cam_path *path);
  143 
  144 /*
  145  * Perform a path inquiry at the request priority. The bzero may be
  146  * unnecessary.
  147  */
  148 static inline void
  149 xpt_path_inq(struct ccb_pathinq *cpi, struct cam_path *path)
  150 {
  151 
  152         bzero(cpi, sizeof(*cpi));
  153         xpt_setup_ccb(&cpi->ccb_h, path, CAM_PRIORITY_NORMAL);
  154         cpi->ccb_h.func_code = XPT_PATH_INQ;
  155         xpt_action((union ccb *)cpi);
  156 }
  157 
  158 #endif /* _KERNEL */
  159 
  160 #endif /* _CAM_CAM_XPT_H */

Cache object: 6e5c64deafc4060947aad3f282d4f940

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

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