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
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
32#ifndef _CAM_CAM_XPT_H
33#define _CAM_CAM_XPT_H 1
34
35#ifdef _KERNEL
36#include <cam/cam_ccb.h>
37#endif
38#include <sys/sbuf.h>
39
40/* Forward Declarations */
41union ccb;
42struct cam_periph;
43struct cam_ed;
44struct cam_sim;
45
46/*
47 * Definition of a CAM path. Paths are created from bus, target, and lun ids
48 * via xpt_create_path and allow for reference to devices without recurring
49 * lookups in the edt.
50 */
51struct cam_path;
52
53/* Path functions */
54
55#ifdef _KERNEL
56
57/*
58 * Definition of an async handler callback block. These are used to add
59 * SIMs and peripherals to the async callback lists.
60 */
61struct async_node {
62 SLIST_ENTRY(async_node) links;
63 uint32_t event_enable; /* Async Event enables */
64 uint32_t event_lock; /* Take SIM lock for handlers. */
65 void (*callback)(void *arg, uint32_t code,
66 struct cam_path *path, void *args);
67 void *callback_arg;
68};
69
70SLIST_HEAD(async_list, async_node);
71SLIST_HEAD(periph_list, cam_periph);
72
73void xpt_action(union ccb *new_ccb);
74void xpt_action_default(union ccb *new_ccb);
75union ccb *xpt_alloc_ccb(void);
76union ccb *xpt_alloc_ccb_nowait(void);
77void xpt_free_ccb(union ccb *free_ccb);
78void xpt_setup_ccb_flags(struct ccb_hdr *ccb_h,
79 struct cam_path *path,
80 uint32_t priority,
81 uint32_t flags);
82void xpt_setup_ccb(struct ccb_hdr *ccb_h,
83 struct cam_path *path,
84 uint32_t priority);
85void xpt_merge_ccb(union ccb *dst_ccb,
86 union ccb *src_ccb);
87cam_status xpt_create_path(struct cam_path **new_path_ptr,
88 struct cam_periph *perph,
89 path_id_t path_id,
90 target_id_t target_id, lun_id_t lun_id);
91cam_status xpt_create_path_unlocked(struct cam_path **new_path_ptr,
92 struct cam_periph *perph,
93 path_id_t path_id,
94 target_id_t target_id, lun_id_t lun_id);
95int xpt_getattr(char *buf, size_t len, const char *attr,
96 struct cam_path *path);
97void xpt_free_path(struct cam_path *path);
98void xpt_path_counts(struct cam_path *path, uint32_t *bus_ref,
99 uint32_t *periph_ref, uint32_t *target_ref,
100 uint32_t *device_ref);
101int xpt_path_comp(struct cam_path *path1,
102 struct cam_path *path2);
103int xpt_path_comp_dev(struct cam_path *path,
104 struct cam_ed *dev);
105char * xpt_path_string(struct cam_path *path, char *str,
106 size_t str_len);
107void xpt_path_sbuf(struct cam_path *path, struct sbuf *sb);
108path_id_t xpt_path_path_id(struct cam_path *path);
109target_id_t xpt_path_target_id(struct cam_path *path);
110lun_id_t xpt_path_lun_id(struct cam_path *path);
111struct cam_sim *xpt_path_sim(struct cam_path *path);
112struct cam_periph *xpt_path_periph(struct cam_path *path);
113device_t xpt_path_sim_device(const struct cam_path *path);
114void xpt_print_path(struct cam_path *path);
115void xpt_print(struct cam_path *path, const char *fmt, ...);
116void xpt_async(uint32_t async_code, struct cam_path *path,
117 void *async_arg);
118void xpt_rescan(union ccb *ccb);
119void xpt_hold_boot(void);
120void xpt_release_boot(void);
121void xpt_lock_buses(void);
122void xpt_unlock_buses(void);
123struct mtx * xpt_path_mtx(struct cam_path *path);
124#define xpt_path_lock(path) mtx_lock(xpt_path_mtx(path))
125#define xpt_path_unlock(path) mtx_unlock(xpt_path_mtx(path))
126#define xpt_path_assert(path, what) mtx_assert(xpt_path_mtx(path), (what))
127#define xpt_path_owned(path) mtx_owned(xpt_path_mtx(path))
128#define xpt_path_sleep(path, chan, priority, wmesg, timo) \
129 msleep((chan), xpt_path_mtx(path), (priority), (wmesg), (timo))
130cam_status xpt_register_async(int event, ac_callback_t *cbfunc,
131 void *cbarg, struct cam_path *path);
132cam_status xpt_compile_path(struct cam_path *new_path,
133 struct cam_periph *perph,
134 path_id_t path_id,
135 target_id_t target_id,
136 lun_id_t lun_id);
137int xpt_clone_path(struct cam_path **new_path,
138 struct cam_path *path);
139
140void xpt_release_path(struct cam_path *path);
141
142const char * xpt_action_name(uint32_t action);
143void xpt_pollwait(union ccb *start_ccb, uint32_t timeout);
144uint32_t xpt_poll_setup(union ccb *start_ccb);
145void xpt_sim_poll(struct cam_sim *sim);
146
147/*
148 * Perform a path inquiry. bzero may be redundant for allocated CCBs, but for
149 * the on-stack CCBs it's required.
150 */
151static inline void
152xpt_path_inq(struct ccb_pathinq *cpi, struct cam_path *path)
153{
154 bzero(cpi, sizeof(*cpi));
155 xpt_setup_ccb(&cpi->ccb_h, path, CAM_PRIORITY_NONE);
156 cpi->ccb_h.func_code = XPT_PATH_INQ;
157 xpt_action((union ccb *)cpi);
158}
159
160/*
161 * Perform get device type. bzero may be redundant for allocated CCBs, but for
162 * the on-stack CCBs it's required.
163 */
164static inline void
165xpt_gdev_type(struct ccb_getdev *cgd, struct cam_path *path)
166{
167 bzero(cgd, sizeof(*cgd));
168 xpt_setup_ccb(&cgd->ccb_h, path, CAM_PRIORITY_NONE);
169 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
170 xpt_action((union ccb *)cgd);
171}
172
173#endif /* _KERNEL */
174
175#endif /* _CAM_CAM_XPT_H */