2 * Data structures and definitions for dealing with the
3 * Common Access Method Transport (xpt) layer.
5 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
7 * Copyright (c) 1997 Justin T. Gibbs.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
34 #ifndef _CAM_CAM_XPT_H
35 #define _CAM_CAM_XPT_H 1
38 #include <sys/cdefs.h>
39 #include <cam/cam_ccb.h>
43 /* Forward Declarations */
51 * Definition of a CAM path. Paths are created from bus, target, and lun ids
52 * via xpt_create_path and allow for reference to devices without recurring
62 * Definition of an async handler callback block. These are used to add
63 * SIMs and peripherals to the async callback lists.
66 SLIST_ENTRY(async_node) links;
67 u_int32_t event_enable; /* Async Event enables */
68 u_int32_t event_lock; /* Take SIM lock for handlers. */
69 void (*callback)(void *arg, u_int32_t code,
70 struct cam_path *path, void *args);
74 SLIST_HEAD(async_list, async_node);
75 SLIST_HEAD(periph_list, cam_periph);
77 void xpt_action(union ccb *new_ccb);
78 void xpt_action_default(union ccb *new_ccb);
79 union ccb *xpt_alloc_ccb(void);
80 union ccb *xpt_alloc_ccb_nowait(void);
81 void xpt_free_ccb(union ccb *free_ccb);
82 void xpt_setup_ccb_flags(struct ccb_hdr *ccb_h,
83 struct cam_path *path,
86 void xpt_setup_ccb(struct ccb_hdr *ccb_h,
87 struct cam_path *path,
89 void xpt_merge_ccb(union ccb *master_ccb,
90 union ccb *slave_ccb);
91 cam_status xpt_create_path(struct cam_path **new_path_ptr,
92 struct cam_periph *perph,
94 target_id_t target_id, lun_id_t lun_id);
95 cam_status xpt_create_path_unlocked(struct cam_path **new_path_ptr,
96 struct cam_periph *perph,
98 target_id_t target_id, lun_id_t lun_id);
99 int xpt_getattr(char *buf, size_t len, const char *attr,
100 struct cam_path *path);
101 void xpt_free_path(struct cam_path *path);
102 void xpt_path_counts(struct cam_path *path, uint32_t *bus_ref,
103 uint32_t *periph_ref, uint32_t *target_ref,
104 uint32_t *device_ref);
105 int xpt_path_comp(struct cam_path *path1,
106 struct cam_path *path2);
107 int xpt_path_comp_dev(struct cam_path *path,
109 void xpt_print_path(struct cam_path *path);
110 void xpt_print_device(struct cam_ed *device);
111 void xpt_print(struct cam_path *path, const char *fmt, ...);
112 int xpt_path_string(struct cam_path *path, char *str,
114 int xpt_path_sbuf(struct cam_path *path, struct sbuf *sb);
115 path_id_t xpt_path_path_id(struct cam_path *path);
116 target_id_t xpt_path_target_id(struct cam_path *path);
117 lun_id_t xpt_path_lun_id(struct cam_path *path);
118 struct cam_sim *xpt_path_sim(struct cam_path *path);
119 struct cam_periph *xpt_path_periph(struct cam_path *path);
120 void xpt_async(u_int32_t async_code, struct cam_path *path,
122 void xpt_rescan(union ccb *ccb);
123 void xpt_hold_boot(void);
124 void xpt_release_boot(void);
125 void xpt_lock_buses(void);
126 void xpt_unlock_buses(void);
127 struct mtx * xpt_path_mtx(struct cam_path *path);
128 #define xpt_path_lock(path) mtx_lock(xpt_path_mtx(path))
129 #define xpt_path_unlock(path) mtx_unlock(xpt_path_mtx(path))
130 #define xpt_path_assert(path, what) mtx_assert(xpt_path_mtx(path), (what))
131 #define xpt_path_owned(path) mtx_owned(xpt_path_mtx(path))
132 #define xpt_path_sleep(path, chan, priority, wmesg, timo) \
133 msleep((chan), xpt_path_mtx(path), (priority), (wmesg), (timo))
134 cam_status xpt_register_async(int event, ac_callback_t *cbfunc,
135 void *cbarg, struct cam_path *path);
136 cam_status xpt_compile_path(struct cam_path *new_path,
137 struct cam_periph *perph,
139 target_id_t target_id,
141 cam_status xpt_clone_path(struct cam_path **new_path,
142 struct cam_path *path);
143 void xpt_copy_path(struct cam_path *new_path,
144 struct cam_path *path);
146 void xpt_release_path(struct cam_path *path);
148 const char * xpt_action_name(uint32_t action);
149 void xpt_pollwait(union ccb *start_ccb, uint32_t timeout);
150 uint32_t xpt_poll_setup(union ccb *start_ccb);
151 void xpt_sim_poll(struct cam_sim *sim);
154 * Perform a path inquiry at the request priority. The bzero may be
158 xpt_path_inq(struct ccb_pathinq *cpi, struct cam_path *path)
161 bzero(cpi, sizeof(*cpi));
162 xpt_setup_ccb(&cpi->ccb_h, path, CAM_PRIORITY_NORMAL);
163 cpi->ccb_h.func_code = XPT_PATH_INQ;
164 xpt_action((union ccb *)cpi);
169 #endif /* _CAM_CAM_XPT_H */