master
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 <sys/cdefs.h>
37#include <cam/cam_ccb.h>
38#endif
39
40/* Forward Declarations */
41union ccb;
42struct cam_periph;
43struct cam_ed;
44struct cam_sim;
45struct 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 */
52struct cam_path;
53
54/* Path functions */
55
56#ifdef _KERNEL
57
58/*
59 * Definition of an async handler callback block. These are used to add
60 * SIMs and peripherals to the async callback lists.
61 */
62struct async_node {
63 SLIST_ENTRY(async_node) links;
64 uint32_t event_enable; /* Async Event enables */
65 uint32_t event_lock; /* Take SIM lock for handlers. */
66 void (*callback)(void *arg, uint32_t code,
67 struct cam_path *path, void *args);
68 void *callback_arg;
69};
70
71SLIST_HEAD(async_list, async_node);
72SLIST_HEAD(periph_list, cam_periph);
73
74void xpt_action(union ccb *new_ccb);
75void xpt_action_default(union ccb *new_ccb);
76union ccb *xpt_alloc_ccb(void);
77union ccb *xpt_alloc_ccb_nowait(void);
78void xpt_free_ccb(union ccb *free_ccb);
79void xpt_setup_ccb_flags(struct ccb_hdr *ccb_h,
80 struct cam_path *path,
81 uint32_t priority,
82 uint32_t flags);
83void xpt_setup_ccb(struct ccb_hdr *ccb_h,
84 struct cam_path *path,
85 uint32_t priority);
86void xpt_merge_ccb(union ccb *dst_ccb,
87 union ccb *src_ccb);
88cam_status xpt_create_path(struct cam_path **new_path_ptr,
89 struct cam_periph *perph,
90 path_id_t path_id,
91 target_id_t target_id, lun_id_t lun_id);
92cam_status xpt_create_path_unlocked(struct cam_path **new_path_ptr,
93 struct cam_periph *perph,
94 path_id_t path_id,
95 target_id_t target_id, lun_id_t lun_id);
96int xpt_getattr(char *buf, size_t len, const char *attr,
97 struct cam_path *path);
98void xpt_free_path(struct cam_path *path);
99void xpt_path_counts(struct cam_path *path, uint32_t *bus_ref,
100 uint32_t *periph_ref, uint32_t *target_ref,
101 uint32_t *device_ref);
102int xpt_path_comp(struct cam_path *path1,
103 struct cam_path *path2);
104int xpt_path_comp_dev(struct cam_path *path,
105 struct cam_ed *dev);
106char * xpt_path_string(struct cam_path *path, char *str,
107 size_t str_len);
108void xpt_path_sbuf(struct cam_path *path, struct sbuf *sb);
109path_id_t xpt_path_path_id(struct cam_path *path);
110target_id_t xpt_path_target_id(struct cam_path *path);
111lun_id_t xpt_path_lun_id(struct cam_path *path);
112struct cam_sim *xpt_path_sim(struct cam_path *path);
113struct cam_periph *xpt_path_periph(struct cam_path *path);
114device_t xpt_path_sim_device(const struct cam_path *path);
115void xpt_print_path(struct cam_path *path);
116void xpt_print_device(struct cam_ed *device);
117void xpt_print(struct cam_path *path, const char *fmt, ...);
118void xpt_async(uint32_t async_code, struct cam_path *path,
119 void *async_arg);
120void xpt_rescan(union ccb *ccb);
121void xpt_hold_boot(void);
122void xpt_release_boot(void);
123void xpt_lock_buses(void);
124void xpt_unlock_buses(void);
125struct 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))
132cam_status xpt_register_async(int event, ac_callback_t *cbfunc,
133 void *cbarg, struct cam_path *path);
134cam_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);
139int xpt_clone_path(struct cam_path **new_path,
140 struct cam_path *path);
141
142void xpt_release_path(struct cam_path *path);
143
144const char * xpt_action_name(uint32_t action);
145void xpt_pollwait(union ccb *start_ccb, uint32_t timeout);
146uint32_t xpt_poll_setup(union ccb *start_ccb);
147void xpt_sim_poll(struct cam_sim *sim);
148
149/*
150 * Perform a path inquiry at the request priority. The bzero may be
151 * unnecessary.
152 */
153static inline void
154xpt_path_inq(struct ccb_pathinq *cpi, struct cam_path *path)
155{
156
157 bzero(cpi, sizeof(*cpi));
158 xpt_setup_ccb(&cpi->ccb_h, path, CAM_PRIORITY_NORMAL);
159 cpi->ccb_h.func_code = XPT_PATH_INQ;
160 xpt_action((union ccb *)cpi);
161}
162
163#endif /* _KERNEL */
164
165#endif /* _CAM_CAM_XPT_H */