xref: /netbsd-src/sys/dev/scsipi/scsipi_base.h (revision 32f35bc7ad70f823cd1ac35ddffb01738112e9a7)
1 /*	$NetBSD: scsipi_base.h,v 1.24 2017/02/26 10:58:47 maya Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 2004 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum.
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  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _DEV_SCSIPI_SCSIPI_BASE_H_
33 #define _DEV_SCSIPI_SCSIPI_BASE_H_
34 
35 struct scsipi_xfer *scsipi_get_xs(struct scsipi_periph *, int);
36 void	scsipi_put_xs(struct scsipi_xfer *);
37 
38 static __inline struct scsipi_xfer *scsipi_make_xs_internal(struct scsipi_periph *,
39 	    struct scsipi_generic *, int cmdlen, u_char *data_addr,
40 	    int datalen, int retries, int timeout, struct buf *,
41 	    int flags) __unused;
42 
43 static __inline struct scsipi_xfer *scsipi_make_xs_unlocked(struct scsipi_periph *,
44 	    struct scsipi_generic *, int cmdlen, u_char *data_addr,
45 	    int datalen, int retries, int timeout, struct buf *,
46 	    int flags) __unused;
47 
48 static __inline struct scsipi_xfer *scsipi_make_xs_locked(struct scsipi_periph *,
49 	    struct scsipi_generic *, int cmdlen, u_char *data_addr,
50 	    int datalen, int retries, int timeout, struct buf *,
51 	    int flags) __unused;
52 
53 /*
54  * Make a scsipi_xfer, and return a pointer to it.
55  */
56 
57 static __inline struct scsipi_xfer *
scsipi_make_xs_internal(struct scsipi_periph * periph,struct scsipi_generic * cmd,int cmdlen,u_char * data_addr,int datalen,int retries,int timeout,struct buf * bp,int flags)58 scsipi_make_xs_internal(struct scsipi_periph *periph, struct scsipi_generic *cmd,
59     int cmdlen, u_char *data_addr, int datalen, int retries, int timeout,
60     struct buf *bp, int flags)
61 {
62 	struct scsipi_xfer *xs;
63 
64 	if ((xs = scsipi_get_xs(periph, flags)) == NULL)
65 		return (NULL);
66 
67 	/*
68 	 * Fill out the scsipi_xfer structure.  We don't know whose context
69 	 * the cmd is in, so copy it.
70 	 */
71 	memcpy(&xs->cmdstore, cmd, cmdlen);
72 	xs->cmd = &xs->cmdstore;
73 	xs->cmdlen = cmdlen;
74 	xs->data = data_addr;
75 	xs->datalen = datalen;
76 	xs->xs_retries = retries;
77 	xs->timeout = timeout;
78 	xs->bp = bp;
79 
80 	return (xs);
81 }
82 
83 static __inline struct scsipi_xfer *
scsipi_make_xs_unlocked(struct scsipi_periph * periph,struct scsipi_generic * cmd,int cmdlen,u_char * data_addr,int datalen,int retries,int timeout,struct buf * bp,int flags)84 scsipi_make_xs_unlocked(struct scsipi_periph *periph, struct scsipi_generic *cmd,
85     int cmdlen, u_char *data_addr, int datalen, int retries, int timeout,
86     struct buf *bp, int flags)
87 {
88 
89 	return scsipi_make_xs_internal(periph, cmd, cmdlen, data_addr,
90 	    datalen, retries, timeout, bp, flags & ~XS_CTL_NOSLEEP);
91 }
92 
93 static __inline struct scsipi_xfer *
scsipi_make_xs_locked(struct scsipi_periph * periph,struct scsipi_generic * cmd,int cmdlen,u_char * data_addr,int datalen,int retries,int timeout,struct buf * bp,int flags)94 scsipi_make_xs_locked(struct scsipi_periph *periph, struct scsipi_generic *cmd,
95     int cmdlen, u_char *data_addr, int datalen, int retries, int timeout,
96     struct buf *bp, int flags)
97 {
98 
99 	KDASSERT(mutex_owned(chan_mtx(periph->periph_channel)));
100 	return scsipi_make_xs_internal(periph, cmd, cmdlen, data_addr,
101 	    datalen, retries, timeout, bp, flags | XS_CTL_NOSLEEP);
102 }
103 
104 #endif /* _DEV_SCSIPI_SCSIPI_BASE_H_ */
105