2 * Data structures and definitions for dealing with the
3 * Common Access Method Transport (xpt) layer.
5 * Copyright (c) 1997 Justin T. Gibbs.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 #ifndef _CAM_CAM_XPT_H
33 #define _CAM_CAM_XPT_H 1
35 /* Forward Declarations */
42 * Definition of a CAM path. Paths are created from bus, target, and lun ids
43 * via xpt_create_path and allow for reference to devices without recurring
53 * Definition of an async handler callback block. These are used to add
54 * SIMs and peripherals to the async callback lists.
57 SLIST_ENTRY(async_node) links;
58 u_int32_t event_enable; /* Async Event enables */
59 u_int32_t event_lock; /* Take SIM lock for handlers. */
60 void (*callback)(void *arg, u_int32_t code,
61 struct cam_path *path, void *args);
65 SLIST_HEAD(async_list, async_node);
66 SLIST_HEAD(periph_list, cam_periph);
68 void xpt_action(union ccb *new_ccb);
69 void xpt_action_default(union ccb *new_ccb);
70 union ccb *xpt_alloc_ccb(void);
71 union ccb *xpt_alloc_ccb_nowait(void);
72 void xpt_free_ccb(union ccb *free_ccb);
73 void xpt_setup_ccb(struct ccb_hdr *ccb_h,
74 struct cam_path *path,
76 void xpt_merge_ccb(union ccb *master_ccb,
77 union ccb *slave_ccb);
78 cam_status xpt_create_path(struct cam_path **new_path_ptr,
79 struct cam_periph *perph,
81 target_id_t target_id, lun_id_t lun_id);
82 cam_status xpt_create_path_unlocked(struct cam_path **new_path_ptr,
83 struct cam_periph *perph,
85 target_id_t target_id, lun_id_t lun_id);
86 int xpt_getattr(char *buf, size_t len, const char *attr,
87 struct cam_path *path);
88 void xpt_free_path(struct cam_path *path);
89 void xpt_path_counts(struct cam_path *path, uint32_t *bus_ref,
90 uint32_t *periph_ref, uint32_t *target_ref,
91 uint32_t *device_ref);
92 int xpt_path_comp(struct cam_path *path1,
93 struct cam_path *path2);
94 int xpt_path_comp_dev(struct cam_path *path,
96 void xpt_print_path(struct cam_path *path);
97 void xpt_print_device(struct cam_ed *device);
98 void xpt_print(struct cam_path *path, const char *fmt, ...);
99 int xpt_path_string(struct cam_path *path, char *str,
101 path_id_t xpt_path_path_id(struct cam_path *path);
102 target_id_t xpt_path_target_id(struct cam_path *path);
103 lun_id_t xpt_path_lun_id(struct cam_path *path);
104 int xpt_path_legacy_ata_id(struct cam_path *path);
105 struct cam_sim *xpt_path_sim(struct cam_path *path);
106 struct cam_periph *xpt_path_periph(struct cam_path *path);
107 void xpt_async(u_int32_t async_code, struct cam_path *path,
109 void xpt_rescan(union ccb *ccb);
110 void xpt_hold_boot(void);
111 void xpt_release_boot(void);
112 void xpt_lock_buses(void);
113 void xpt_unlock_buses(void);
114 struct mtx * xpt_path_mtx(struct cam_path *path);
115 #define xpt_path_lock(path) mtx_lock(xpt_path_mtx(path))
116 #define xpt_path_unlock(path) mtx_unlock(xpt_path_mtx(path))
117 #define xpt_path_assert(path, what) mtx_assert(xpt_path_mtx(path), (what))
118 #define xpt_path_owned(path) mtx_owned(xpt_path_mtx(path))
119 #define xpt_path_sleep(path, chan, priority, wmesg, timo) \
120 msleep((chan), xpt_path_mtx(path), (priority), (wmesg), (timo))
121 cam_status xpt_register_async(int event, ac_callback_t *cbfunc,
122 void *cbarg, struct cam_path *path);
123 cam_status xpt_compile_path(struct cam_path *new_path,
124 struct cam_periph *perph,
126 target_id_t target_id,
128 cam_status xpt_clone_path(struct cam_path **new_path,
129 struct cam_path *path);
130 void xpt_copy_path(struct cam_path *new_path,
131 struct cam_path *path);
133 void xpt_release_path(struct cam_path *path);
137 #endif /* _CAM_CAM_XPT_H */