sys/cam/cam_xpt.h

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