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