xref: /freebsd/sys/dev/proto/proto_busdma.h (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
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  * $FreeBSD$
27  */
28 
29 #ifndef _DEV_PROTO_BUSDMA_H_
30 #define _DEV_PROTO_BUSDMA_H_
31 
32 struct proto_md;
33 
34 struct proto_tag {
35 	LIST_ENTRY(proto_tag)	tags;
36 	struct proto_tag	*parent;
37 	LIST_ENTRY(proto_tag)	peers;
38 	LIST_HEAD(,proto_tag)	children;
39 	LIST_HEAD(,proto_md)	mds;
40 	bus_addr_t		align;
41 	bus_addr_t		bndry;
42 	bus_addr_t		maxaddr;
43 	bus_size_t		maxsz;
44 	bus_size_t		maxsegsz;
45 	u_int			nsegs;
46 	u_int			datarate;
47 };
48 
49 struct proto_md {
50 	LIST_ENTRY(proto_md)	mds;
51 	LIST_ENTRY(proto_md)	peers;
52 	struct proto_tag	*tag;
53 	void			*virtaddr;
54 	vm_paddr_t		physaddr;
55 	bus_dma_tag_t		bd_tag;
56 	bus_dmamap_t		bd_map;
57 };
58 
59 struct proto_busdma {
60 	LIST_HEAD(,proto_tag)	tags;
61 	LIST_HEAD(,proto_md)	mds;
62 	bus_dma_tag_t		bd_roottag;
63 	struct sx		sxlck;
64 };
65 
66 struct proto_busdma *proto_busdma_attach(struct proto_softc *);
67 int proto_busdma_detach(struct proto_softc *, struct proto_busdma *);
68 
69 int proto_busdma_cleanup(struct proto_softc *, struct proto_busdma *);
70 
71 int proto_busdma_ioctl(struct proto_softc *, struct proto_busdma *,
72     struct proto_ioc_busdma *, struct thread *);
73 
74 int proto_busdma_mmap_allowed(struct proto_busdma *, vm_paddr_t);
75 
76 #endif /* _DEV_PROTO_BUSDMA_H_ */
77