cam_xpt.h revision 260387 
1/*-
2 * Data structures and definitions for dealing with the
3 * Common Access Method Transport (xpt) layer.
4 *
5 * Copyright (c) 1997 Justin T. Gibbs.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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.
16 *
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
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: stable/10/sys/cam/cam_xpt.h 260387 2014-01-07 01:51:48Z scottl $
30 */
31
32#ifndef _CAM_CAM_XPT_H
33#define _CAM_CAM_XPT_H 1
34
35/* Forward Declarations */
36union ccb;
37struct cam_periph;
38struct cam_ed;
39struct cam_sim;
40
41/*
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
44 * lookups in the edt.
45 */
46struct cam_path;
47
48/* Path functions */
49
50#ifdef _KERNEL
51
52/*
53 * Definition of an async handler callback block.  These are used to add
54 * SIMs and peripherals to the async callback lists.
55 */
56struct async_node {
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);
62	void		*callback_arg;
63};
64
65SLIST_HEAD(async_list, async_node);
66SLIST_HEAD(periph_list, cam_periph);
67
68void			xpt_action(union ccb *new_ccb);
69void			xpt_action_default(union ccb *new_ccb);
70union ccb		*xpt_alloc_ccb(void);
71union ccb		*xpt_alloc_ccb_nowait(void);
72void			xpt_free_ccb(union ccb *free_ccb);
73void			xpt_setup_ccb(struct ccb_hdr *ccb_h,
74				      struct cam_path *path,
75				      u_int32_t priority);
76void			xpt_merge_ccb(union ccb *master_ccb,
77				      union ccb *slave_ccb);
78cam_status		xpt_create_path(struct cam_path **new_path_ptr,
79					struct cam_periph *perph,
80					path_id_t path_id,
81					target_id_t target_id, lun_id_t lun_id);
82cam_status		xpt_create_path_unlocked(struct cam_path **new_path_ptr,
83					struct cam_periph *perph,
84					path_id_t path_id,
85					target_id_t target_id, lun_id_t lun_id);
86int			xpt_getattr(char *buf, size_t len, const char *attr,
87				    struct cam_path *path);
88void			xpt_free_path(struct cam_path *path);
89void			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);
92int			xpt_path_comp(struct cam_path *path1,
93				      struct cam_path *path2);
94int			xpt_path_comp_dev(struct cam_path *path,
95					  struct cam_ed *dev);
96void			xpt_print_path(struct cam_path *path);
97void			xpt_print_device(struct cam_ed *device);
98void			xpt_print(struct cam_path *path, const char *fmt, ...);
99int			xpt_path_string(struct cam_path *path, char *str,
100					size_t str_len);
101path_id_t		xpt_path_path_id(struct cam_path *path);
102target_id_t		xpt_path_target_id(struct cam_path *path);
103lun_id_t		xpt_path_lun_id(struct cam_path *path);
104int			xpt_path_legacy_ata_id(struct cam_path *path);
105struct cam_sim		*xpt_path_sim(struct cam_path *path);
106struct cam_periph	*xpt_path_periph(struct cam_path *path);
107void			xpt_async(u_int32_t async_code, struct cam_path *path,
108				  void *async_arg);
109void			xpt_rescan(union ccb *ccb);
110void			xpt_hold_boot(void);
111void			xpt_release_boot(void);
112void			xpt_lock_buses(void);
113void			xpt_unlock_buses(void);
114struct 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))
121cam_status		xpt_register_async(int event, ac_callback_t *cbfunc,
122					   void *cbarg, struct cam_path *path);
123cam_status		xpt_compile_path(struct cam_path *new_path,
124					 struct cam_periph *perph,
125					 path_id_t path_id,
126					 target_id_t target_id,
127					 lun_id_t lun_id);
128cam_status		xpt_clone_path(struct cam_path **new_path,
129				      struct cam_path *path);
130void			xpt_copy_path(struct cam_path *new_path,
131				      struct cam_path *path);
132
133void			xpt_release_path(struct cam_path *path);
134
135#endif /* _KERNEL */
136
137#endif /* _CAM_CAM_XPT_H */
138