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 /* Forward Declarations */ 36 union ccb; 37 struct cam_periph; 38 struct cam_sim; 39 40 /* 41 * Definition of a CAM path. Paths are created from bus, target, and lun ids 42 * via xpt_create_path and allow for reference to devices without recurring 43 * lookups in the edt. 44 */ 45 struct cam_path; 46 47 /* Path functions */ 48 49 #ifdef _KERNEL 50 51 /* 52 * Definition of an async handler callback block. These are used to add 53 * SIMs and peripherals to the async callback lists. 54 */ 55 struct async_node { 56 SLIST_ENTRY(async_node) links; 57 u_int32_t event_enable; /* Async Event enables */ 58 void (*callback)(void *arg, u_int32_t code, 59 struct cam_path *path, void *args); 60 void *callback_arg; 61 }; 62 63 SLIST_HEAD(async_list, async_node); 64 SLIST_HEAD(periph_list, cam_periph); 65 66 #if defined(CAM_DEBUG_FLAGS) && !defined(CAMDEBUG) 67 #error "You must have options CAMDEBUG to use options CAM_DEBUG_FLAGS" 68 #endif 69 70 /* 71 * In order to enable the CAM_DEBUG_* options, the user must have CAMDEBUG 72 * enabled. Also, the user must have either none, or all of CAM_DEBUG_BUS, 73 * CAM_DEBUG_TARGET, and CAM_DEBUG_LUN specified. 74 */ 75 #if defined(CAM_DEBUG_BUS) || defined(CAM_DEBUG_TARGET) \ 76 || defined(CAM_DEBUG_LUN) 77 #ifdef CAMDEBUG 78 #if !defined(CAM_DEBUG_BUS) || !defined(CAM_DEBUG_TARGET) \ 79 || !defined(CAM_DEBUG_LUN) 80 #error "You must define all or none of CAM_DEBUG_BUS, CAM_DEBUG_TARGET \ 81 and CAM_DEBUG_LUN" 82 #endif /* !CAM_DEBUG_BUS || !CAM_DEBUG_TARGET || !CAM_DEBUG_LUN */ 83 #else /* !CAMDEBUG */ 84 #error "You must use options CAMDEBUG if you use the CAM_DEBUG_* options" 85 #endif /* CAMDEBUG */ 86 #endif /* CAM_DEBUG_BUS || CAM_DEBUG_TARGET || CAM_DEBUG_LUN */ 87 88 void xpt_action(union ccb *new_ccb); 89 void xpt_action_default(union ccb *new_ccb); 90 union ccb *xpt_alloc_ccb(void); 91 union ccb *xpt_alloc_ccb_nowait(void); 92 void xpt_free_ccb(union ccb *free_ccb); 93 void xpt_setup_ccb(struct ccb_hdr *ccb_h, 94 struct cam_path *path, 95 u_int32_t priority); 96 void xpt_merge_ccb(union ccb *master_ccb, 97 union ccb *slave_ccb); 98 cam_status xpt_create_path(struct cam_path **new_path_ptr, 99 struct cam_periph *perph, 100 path_id_t path_id, 101 target_id_t target_id, lun_id_t lun_id); 102 cam_status xpt_create_path_unlocked(struct cam_path **new_path_ptr, 103 struct cam_periph *perph, 104 path_id_t path_id, 105 target_id_t target_id, lun_id_t lun_id); 106 void xpt_free_path(struct cam_path *path); 107 int xpt_path_comp(struct cam_path *path1, 108 struct cam_path *path2); 109 void xpt_print_path(struct cam_path *path); 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 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 cam_status xpt_register_async(int event, ac_callback_t *cbfunc, 126 void *cbarg, struct cam_path *path); 127 cam_status xpt_compile_path(struct cam_path *new_path, 128 struct cam_periph *perph, 129 path_id_t path_id, 130 target_id_t target_id, 131 lun_id_t lun_id); 132 133 void xpt_release_path(struct cam_path *path); 134 135 #endif /* _KERNEL */ 136 137 #endif /* _CAM_CAM_XPT_H */ 138 139