xref: /freebsd/sys/dev/proto/proto_busdma.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * Copyright (c) 2015, 2019 Marcel Moolenaar
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef _DEV_PROTO_BUSDMA_H_
28 #define _DEV_PROTO_BUSDMA_H_
29 
30 struct proto_md;
31 
32 struct proto_tag {
33 	LIST_ENTRY(proto_tag)	tags;
34 	struct proto_tag	*parent;
35 	LIST_ENTRY(proto_tag)	peers;
36 	LIST_HEAD(,proto_tag)	children;
37 	LIST_HEAD(,proto_md)	mds;
38 	bus_addr_t		align;
39 	bus_addr_t		bndry;
40 	bus_addr_t		maxaddr;
41 	bus_size_t		maxsz;
42 	bus_size_t		maxsegsz;
43 	u_int			nsegs;
44 	u_int			datarate;
45 };
46 
47 struct proto_md {
48 	LIST_ENTRY(proto_md)	mds;
49 	LIST_ENTRY(proto_md)	peers;
50 	struct proto_tag	*tag;
51 	void			*virtaddr;
52 	vm_paddr_t		physaddr;
53 	bus_dma_tag_t		bd_tag;
54 	bus_dmamap_t		bd_map;
55 };
56 
57 struct proto_busdma {
58 	LIST_HEAD(,proto_tag)	tags;
59 	LIST_HEAD(,proto_md)	mds;
60 	bus_dma_tag_t		bd_roottag;
61 	struct sx		sxlck;
62 };
63 
64 struct proto_busdma *proto_busdma_attach(struct proto_softc *);
65 int proto_busdma_detach(struct proto_softc *, struct proto_busdma *);
66 
67 int proto_busdma_cleanup(struct proto_softc *, struct proto_busdma *);
68 
69 int proto_busdma_ioctl(struct proto_softc *, struct proto_busdma *,
70     struct proto_ioc_busdma *, struct thread *);
71 
72 int proto_busdma_mmap_allowed(struct proto_busdma *, vm_paddr_t);
73 
74 #endif /* _DEV_PROTO_BUSDMA_H_ */
75