xref: /freebsd/sys/sys/_bus_dma.h (revision 95ee2897)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright 2006 John-Mark Gurney.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  */
29 
30 #ifndef _SYS__BUS_DMA_H_
31 #define _SYS__BUS_DMA_H_
32 
33 typedef int bus_dmasync_op_t;
34 
35 /*
36  *	bus_dma_tag_t
37  *
38  *	A machine-dependent opaque type describing the characteristics
39  *	of how to perform DMA mappings.  This structure encapsultes
40  *	information concerning address and alignment restrictions, number
41  *	of S/G segments, amount of data per S/G segment, etc.
42  */
43 typedef struct bus_dma_tag	*bus_dma_tag_t;
44 
45 /*
46  *	bus_dmamap_t
47  *
48  *	DMA mapping instance information.
49  */
50 typedef struct bus_dmamap	*bus_dmamap_t;
51 
52 /*
53  * A function that performs driver-specific synchronization on behalf of
54  * busdma.
55  */
56 typedef enum {
57 	BUS_DMA_LOCK	= 0x01,
58 	BUS_DMA_UNLOCK	= 0x02,
59 } bus_dma_lock_op_t;
60 
61 typedef void bus_dma_lock_t(void *, bus_dma_lock_op_t);
62 
63 #endif /* !_SYS__BUS_DMA_H_ */
64