cam_xpt.h revision 169605 
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: head/sys/cam/cam_xpt.h 169605 2007-05-16 16:54:23Z 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_sim;
39
40/*
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
43 * lookups in the edt.
44 */
45struct cam_path;
46
47/* Path functions */
48
49#ifdef _KERNEL
50
51void			xpt_action(union ccb *new_ccb);
52void			xpt_setup_ccb(struct ccb_hdr *ccb_h,
53				      struct cam_path *path,
54				      u_int32_t priority);
55void			xpt_merge_ccb(union ccb *master_ccb,
56				      union ccb *slave_ccb);
57cam_status		xpt_create_path(struct cam_path **new_path_ptr,
58					struct cam_periph *perph,
59					path_id_t path_id,
60					target_id_t target_id, lun_id_t lun_id);
61cam_status		xpt_create_path_unlocked(struct cam_path **new_path_ptr,
62					struct cam_periph *perph,
63					path_id_t path_id,
64					target_id_t target_id, lun_id_t lun_id);
65void			xpt_free_path(struct cam_path *path);
66int			xpt_path_comp(struct cam_path *path1,
67				      struct cam_path *path2);
68void			xpt_print_path(struct cam_path *path);
69void			xpt_print(struct cam_path *path, const char *fmt, ...);
70int			xpt_path_string(struct cam_path *path, char *str,
71					size_t str_len);
72path_id_t		xpt_path_path_id(struct cam_path *path);
73target_id_t		xpt_path_target_id(struct cam_path *path);
74lun_id_t		xpt_path_lun_id(struct cam_path *path);
75struct cam_sim		*xpt_path_sim(struct cam_path *path);
76struct cam_periph	*xpt_path_periph(struct cam_path *path);
77void			xpt_async(u_int32_t async_code, struct cam_path *path,
78				  void *async_arg);
79void			xpt_rescan(union ccb *ccb);
80void			xpt_lock_buses(void);
81void			xpt_unlock_buses(void);
82cam_status		xpt_register_async(int event, ac_callback_t *cbfunc,
83					   void *cbarg, struct cam_path *path);
84#endif /* _KERNEL */
85
86#endif /* _CAM_CAM_XPT_H */
87
88