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