xref: /freebsd/sys/x86/include/busdma_impl.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2013 The FreeBSD Foundation
5  *
6  * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
7  * under sponsorship from the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef	__X86_BUSDMA_IMPL_H
34 #define	__X86_BUSDMA_IMPL_H
35 
36 struct bus_dma_tag_common {
37 	struct bus_dma_impl *impl;
38 	struct bus_dma_tag_common *parent;
39 	bus_size_t	  alignment;
40 	bus_addr_t	  boundary;
41 	bus_addr_t	  lowaddr;
42 	bus_addr_t	  highaddr;
43 	bus_dma_filter_t *filter;
44 	void		 *filterarg;
45 	bus_size_t	  maxsize;
46 	u_int		  nsegments;
47 	bus_size_t	  maxsegsz;
48 	int		  flags;
49 	bus_dma_lock_t	 *lockfunc;
50 	void		 *lockfuncarg;
51 	int		  ref_count;
52 	int		  domain;
53 };
54 
55 struct bus_dma_impl {
56 	int (*tag_create)(bus_dma_tag_t parent,
57 	    bus_size_t alignment, bus_addr_t boundary, bus_addr_t lowaddr,
58 	    bus_addr_t highaddr, bus_dma_filter_t *filter,
59 	    void *filterarg, bus_size_t maxsize, int nsegments,
60 	    bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
61 	    void *lockfuncarg, bus_dma_tag_t *dmat);
62 	int (*tag_destroy)(bus_dma_tag_t dmat);
63 	int (*tag_set_domain)(bus_dma_tag_t);
64 	bool (*id_mapped)(bus_dma_tag_t, vm_paddr_t, bus_size_t);
65 	int (*map_create)(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
66 	int (*map_destroy)(bus_dma_tag_t dmat, bus_dmamap_t map);
67 	int (*mem_alloc)(bus_dma_tag_t dmat, void** vaddr, int flags,
68 	    bus_dmamap_t *mapp);
69 	void (*mem_free)(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
70 	int (*load_ma)(bus_dma_tag_t dmat, bus_dmamap_t map,
71 	    struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
72 	    bus_dma_segment_t *segs, int *segp);
73 	int (*load_phys)(bus_dma_tag_t dmat, bus_dmamap_t map,
74 	    vm_paddr_t buf, bus_size_t buflen, int flags,
75 	    bus_dma_segment_t *segs, int *segp);
76 	int (*load_buffer)(bus_dma_tag_t dmat, bus_dmamap_t map,
77 	    void *buf, bus_size_t buflen, struct pmap *pmap, int flags,
78 	    bus_dma_segment_t *segs, int *segp);
79 	void (*map_waitok)(bus_dma_tag_t dmat, bus_dmamap_t map,
80 	    struct memdesc *mem, bus_dmamap_callback_t *callback,
81 	    void *callback_arg);
82 	bus_dma_segment_t *(*map_complete)(bus_dma_tag_t dmat, bus_dmamap_t map,
83 	    bus_dma_segment_t *segs, int nsegs, int error);
84 	void (*map_unload)(bus_dma_tag_t dmat, bus_dmamap_t map);
85 	void (*map_sync)(bus_dma_tag_t dmat, bus_dmamap_t map,
86 	    bus_dmasync_op_t op);
87 #ifdef KMSAN
88 	void (*load_kmsan)(bus_dmamap_t map, struct memdesc *mem);
89 #endif
90 };
91 
92 void bus_dma_dflt_lock(void *arg, bus_dma_lock_op_t op);
93 int bus_dma_run_filter(struct bus_dma_tag_common *dmat, vm_paddr_t paddr);
94 int common_bus_dma_tag_create(struct bus_dma_tag_common *parent,
95     bus_size_t alignment,
96     bus_addr_t boundary, bus_addr_t lowaddr, bus_addr_t highaddr,
97     bus_dma_filter_t *filter, void *filterarg, bus_size_t maxsize,
98     int nsegments, bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
99     void *lockfuncarg, size_t sz, void **dmat);
100 
101 extern struct bus_dma_impl bus_dma_bounce_impl;
102 
103 #endif
104