xref: /freebsd/sys/cam/cam_xpt_sim.h (revision 95ee2897)
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_SIM_H
33 #define _CAM_CAM_XPT_SIM_H 1
34 
35 #include <cam/cam_xpt.h>
36 #include <cam/cam_queue.h>
37 
38 /* Functions accessed by SIM drivers */
39 #ifdef _KERNEL
40 int		xpt_bus_register(struct cam_sim *sim, device_t parent,
41 				 uint32_t bus);
42 int		xpt_bus_deregister(path_id_t path_id);
43 uint32_t	xpt_freeze_simq(struct cam_sim *sim, u_int count);
44 void		xpt_release_simq(struct cam_sim *sim, int run_queue);
45 uint32_t	xpt_freeze_devq(struct cam_path *path, u_int count);
46 void		xpt_release_devq(struct cam_path *path,
47 		    u_int count, int run_queue);
48 void		xpt_done(union ccb *done_ccb);
49 void		xpt_done_direct(union ccb *done_ccb);
50 #endif
51 
52 #endif /* _CAM_CAM_XPT_SIM_H */
53