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 */
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
52 * Definition of an async handler callback block. These are used to add
53 * SIMs and peripherals to the async callback lists.
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);
63 SLIST_HEAD(async_list, async_node);
64 SLIST_HEAD(periph_list, cam_periph);
66 void xpt_action(union ccb *new_ccb);
67 void xpt_action_default(union ccb *new_ccb);
68 union ccb *xpt_alloc_ccb(void);
69 union ccb *xpt_alloc_ccb_nowait(void);
70 void xpt_free_ccb(union ccb *free_ccb);
71 void xpt_setup_ccb(struct ccb_hdr *ccb_h,
72 struct cam_path *path,
74 void xpt_merge_ccb(union ccb *master_ccb,
75 union ccb *slave_ccb);
76 cam_status xpt_create_path(struct cam_path **new_path_ptr,
77 struct cam_periph *perph,
79 target_id_t target_id, lun_id_t lun_id);
80 cam_status xpt_create_path_unlocked(struct cam_path **new_path_ptr,
81 struct cam_periph *perph,
83 target_id_t target_id, lun_id_t lun_id);
84 int xpt_getattr(char *buf, size_t len, const char *attr,
85 struct cam_path *path);
86 void xpt_free_path(struct cam_path *path);
87 void xpt_path_counts(struct cam_path *path, uint32_t *bus_ref,
88 uint32_t *periph_ref, uint32_t *target_ref,
89 uint32_t *device_ref);
90 int xpt_path_comp(struct cam_path *path1,
91 struct cam_path *path2);
92 void xpt_print_path(struct cam_path *path);
93 void xpt_print(struct cam_path *path, const char *fmt, ...);
94 int xpt_path_string(struct cam_path *path, char *str,
96 path_id_t xpt_path_path_id(struct cam_path *path);
97 target_id_t xpt_path_target_id(struct cam_path *path);
98 lun_id_t xpt_path_lun_id(struct cam_path *path);
99 int xpt_path_legacy_ata_id(struct cam_path *path);
100 struct cam_sim *xpt_path_sim(struct cam_path *path);
101 struct cam_periph *xpt_path_periph(struct cam_path *path);
102 void xpt_async(u_int32_t async_code, struct cam_path *path,
104 void xpt_rescan(union ccb *ccb);
105 void xpt_hold_boot(void);
106 void xpt_release_boot(void);
107 void xpt_lock_buses(void);
108 void xpt_unlock_buses(void);
109 cam_status xpt_register_async(int event, ac_callback_t *cbfunc,
110 void *cbarg, struct cam_path *path);
111 cam_status xpt_compile_path(struct cam_path *new_path,
112 struct cam_periph *perph,
114 target_id_t target_id,
117 void xpt_release_path(struct cam_path *path);
121 #endif /* _CAM_CAM_XPT_H */