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 #endif
  40
  41 /* Forward Declarations */
  42 union ccb;
  43 struct cam_periph;
  44 struct cam_ed;
  45 struct cam_sim;
  46 struct sbuf;
  47
  48 /*
  49  * Definition of a CAM path.  Paths are created from bus, target, and lun ids
  50  * via xpt_create_path and allow for reference to devices without recurring
  51  * lookups in the edt.
  52  */
  53 struct cam_path;
  54
  55 /* Path functions */
  56
  57 #ifdef _KERNEL
  58
  59 /*
  60  * Definition of an async handler callback block.  These are used to add
  61  * SIMs and peripherals to the async callback lists.
  62  */
  63 struct async_node {
  64         SLIST_ENTRY(async_node) links;
  65         u_int32_t       event_enable;   /* Async Event enables */
  66         u_int32_t       event_lock;     /* Take SIM lock for handlers. */
  67         void            (*callback)(void *arg, u_int32_t code,
  68                                     struct cam_path *path, void *args);
  69         void            *callback_arg;
  70 };
  71
  72 SLIST_HEAD(async_list, async_node);
  73 SLIST_HEAD(periph_list, cam_periph);
  74
  75 void                    xpt_action(union ccb *new_ccb);
  76 void                    xpt_action_default(union ccb *new_ccb);
  77 union ccb               *xpt_alloc_ccb(void);
  78 union ccb               *xpt_alloc_ccb_nowait(void);
  79 void                    xpt_free_ccb(union ccb *free_ccb);
  80 void                    xpt_setup_ccb_flags(struct ccb_hdr *ccb_h,
  81                                             struct cam_path *path,
  82                                             u_int32_t priority,
  83                                             u_int32_t flags);
  84 void                    xpt_setup_ccb(struct ccb_hdr *ccb_h,
  85                                       struct cam_path *path,
  86                                       u_int32_t priority);
  87 void                    xpt_merge_ccb(union ccb *master_ccb,
  88                                       union ccb *slave_ccb);
  89 cam_status              xpt_create_path(struct cam_path **new_path_ptr,
  90                                         struct cam_periph *perph,
  91                                         path_id_t path_id,
  92                                         target_id_t target_id, lun_id_t lun_id);
  93 cam_status              xpt_create_path_unlocked(struct cam_path **new_path_ptr,
  94                                         struct cam_periph *perph,
  95                                         path_id_t path_id,
  96                                         target_id_t target_id, lun_id_t lun_id);
  97 int                     xpt_getattr(char *buf, size_t len, const char *attr,
  98                                     struct cam_path *path);
  99 void                    xpt_free_path(struct cam_path *path);
 100 void                    xpt_path_counts(struct cam_path *path, uint32_t *bus_ref,
 101                                         uint32_t *periph_ref, uint32_t *target_ref,
 102                                         uint32_t *device_ref);
 103 int                     xpt_path_comp(struct cam_path *path1,
 104                                       struct cam_path *path2);
 105 int                     xpt_path_comp_dev(struct cam_path *path,
 106                                           struct cam_ed *dev);
 107 void                    xpt_print_path(struct cam_path *path);
 108 void                    xpt_print_device(struct cam_ed *device);
 109 void                    xpt_print(struct cam_path *path, const char *fmt, ...);
 110 int                     xpt_path_string(struct cam_path *path, char *str,
 111                                         size_t str_len);
 112 int                     xpt_path_sbuf(struct cam_path *path, struct sbuf *sb);
 113 path_id_t               xpt_path_path_id(struct cam_path *path);
 114 target_id_t             xpt_path_target_id(struct cam_path *path);
 115 lun_id_t                xpt_path_lun_id(struct cam_path *path);
 116 struct cam_sim          *xpt_path_sim(struct cam_path *path);
 117 struct cam_periph       *xpt_path_periph(struct cam_path *path);
 118 void                    xpt_async(u_int32_t async_code, struct cam_path *path,
 119                                   void *async_arg);
 120 void                    xpt_rescan(union ccb *ccb);
 121 void                    xpt_hold_boot(void);
 122 void                    xpt_release_boot(void);
 123 void                    xpt_lock_buses(void);
 124 void                    xpt_unlock_buses(void);
 125 struct mtx *            xpt_path_mtx(struct cam_path *path);
 126 #define xpt_path_lock(path)     mtx_lock(xpt_path_mtx(path))
 127 #define xpt_path_unlock(path)   mtx_unlock(xpt_path_mtx(path))
 128 #define xpt_path_assert(path, what)     mtx_assert(xpt_path_mtx(path), (what))
 129 #define xpt_path_owned(path)    mtx_owned(xpt_path_mtx(path))
 130 #define xpt_path_sleep(path, chan, priority, wmesg, timo)               \
 131     msleep((chan), xpt_path_mtx(path), (priority), (wmesg), (timo))
 132 cam_status              xpt_register_async(int event, ac_callback_t *cbfunc,
 133                                            void *cbarg, struct cam_path *path);
 134 cam_status              xpt_compile_path(struct cam_path *new_path,
 135                                          struct cam_periph *perph,
 136                                          path_id_t path_id,
 137                                          target_id_t target_id,
 138                                          lun_id_t lun_id);
 139 cam_status              xpt_clone_path(struct cam_path **new_path,
 140                                       struct cam_path *path);
 141 void                    xpt_copy_path(struct cam_path *new_path,
 142                                       struct cam_path *path);
 143
 144 void                    xpt_release_path(struct cam_path *path);
 145
 146 const char *            xpt_action_name(uint32_t action);
 147
 148 #endif /* _KERNEL */
 149
 150 #endif /* _CAM_CAM_XPT_H */