1 /*        $NetBSD: pmap_devmap.h,v 1.2 2024/11/25 22:03:44 skrll Exp $          */
2 
3 /*-
4  * Copyright (c) 2022 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Nick Hudson
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 
33 #ifndef   _UVM_PMAP_DEVMAP_H_
34 #define   _UVM_PMAP_DEVMAP_H_
35 
36 #ifdef _KERNEL
37 
38 typedef struct pmap_devmap {
39           vaddr_t             pd_va;              /* virtual address */
40           paddr_t             pd_pa;              /* physical address */
41           psize_t             pd_size;  /* size of region */
42           vm_prot_t pd_prot;  /* protection code */
43           u_int               pd_flags; /* flags for pmap_kenter_{pa,range} */
44 } pmap_devmap_t;
45 
46 
47 bool pmap_devmap_bootstrapped_p(void);
48 void pmap_devmap_register(const struct pmap_devmap *);
49 void pmap_devmap_bootstrap(vaddr_t, const struct pmap_devmap *);
50 vaddr_t pmap_devmap_root(void);
51 const struct pmap_devmap *pmap_devmap_find_pa(paddr_t, psize_t);
52 const struct pmap_devmap *pmap_devmap_find_va(vaddr_t, vsize_t);
53 
54 #define   DEVMAP_ENTRY_FLAGS(va, pa, sz, fl)                          \
55 {                                                                               \
56           .pd_va = DEVMAP_ALIGN(va),                                  \
57           .pd_pa = DEVMAP_ALIGN(pa),                                  \
58           .pd_size = DEVMAP_SIZE(sz),                                 \
59           .pd_prot = VM_PROT_READ | VM_PROT_WRITE,                    \
60           .pd_flags = (fl),                                           \
61 }
62 
63 #define   DEVMAP_ENTRY(va, pa, sz)                                    \
64           DEVMAP_ENTRY_FLAGS(va, pa, sz, DEVMAP_FLAGS)
65 
66 #define   DEVMAP_ENTRY_END    { 0 }
67 
68 #endif /* _KERNEL */
69 
70 #endif    /* _UVM_PMAP_DEVMAP_H_ */
71