xref: /freebsd/sys/cam/cam_xpt_periph.h (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1 /*-
2  * Data structures and definitions for dealing with the
3  * Common Access Method Transport (xpt) layer from peripheral
4  * drivers.
5  *
6  * SPDX-License-Identifier: BSD-2-Clause
7  *
8  * Copyright (c) 1997 Justin T. Gibbs.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification, immediately at the beginning of the file.
17  * 2. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
24  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef _CAM_CAM_XPT_PERIPH_H
34 #define _CAM_CAM_XPT_PERIPH_H 1
35 
36 #include <cam/cam_queue.h>
37 #include <cam/cam_xpt.h>
38 
39 /* Functions accessed by the peripheral drivers */
40 #ifdef _KERNEL
41 void		xpt_release_ccb(union ccb *released_ccb);
42 void		xpt_schedule(struct cam_periph *perph, uint32_t new_priority);
43 int32_t		xpt_add_periph(struct cam_periph *periph);
44 void		xpt_remove_periph(struct cam_periph *periph);
45 void		xpt_announce_periph(struct cam_periph *periph,
46 				    char *announce_string);
47 void		xpt_announce_periph_sbuf(struct cam_periph *periph,
48 					 struct sbuf *sb,
49 					 char *announce_string);
50 void		xpt_announce_quirks(struct cam_periph *periph,
51 				    int quirks, char *bit_string);
52 void		xpt_announce_quirks_sbuf(struct cam_periph *periph,
53 				    struct sbuf *sb,
54 				    int quirks, char *bit_string);
55 void		xpt_denounce_periph(struct cam_periph *periph);
56 void		xpt_denounce_periph_sbuf(struct cam_periph *periph, struct sbuf *sb);
57 #endif
58 
59 #endif /* _CAM_CAM_XPT_PERIPH_H */
60