sys/sys/physmem.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2014 Ian Lepore <ian@freebsd.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _SYS_PHYSMEM_H_
  32 #define _SYS_PHYSMEM_H_
  33
  34 #ifndef _KERNEL
  35 #include <stdbool.h>
  36 #endif
  37
  38 /*
  39  * Routines to help configure physical ram.
  40  *
  41  * Multiple regions of contiguous physical ram can be added (in any order).
  42  *
  43  * Multiple regions of physical ram that should be excluded from crash dumps, or
  44  * memory allocation, or both, can be added (in any order).
  45  *
  46  * After all early kernel init is done and it's time to configure all
  47  * remainining non-excluded physical ram for use by other parts of the kernel,
  48  * physmem_init_kernel_globals() processes the hardware regions and
  49  * exclusion regions to generate the global dump_avail and phys_avail arrays
  50  * that communicate physical ram configuration to other parts of the kernel.
  51  */
  52
  53 #define EXFLAG_NODUMP   0x01
  54 #define EXFLAG_NOALLOC  0x02
  55
  56 void physmem_hardware_region(uint64_t pa, uint64_t sz);
  57 void physmem_exclude_region(vm_paddr_t pa, vm_size_t sz, uint32_t flags);
  58 size_t physmem_avail(vm_paddr_t *avail, size_t maxavail);
  59 void physmem_init_kernel_globals(void);
  60 void physmem_print_tables(void);
  61 bool physmem_excluded(vm_paddr_t pa, vm_size_t sz);
  62
  63 /*
  64  * Convenience routines for FDT.
  65  */
  66
  67 #ifdef FDT
  68
  69 #include <machine/ofw_machdep.h>
  70
  71 static inline void
  72 physmem_hardware_regions(struct mem_region * mrptr, int mrcount)
  73 {
  74         while (mrcount--) {
  75                 physmem_hardware_region(mrptr->mr_start, mrptr->mr_size);
  76                 ++mrptr;
  77         }
  78 }
  79
  80 static inline void
  81 physmem_exclude_regions(struct mem_region * mrptr, int mrcount,
  82     uint32_t exflags)
  83 {
  84         while (mrcount--) {
  85                 physmem_exclude_region(mrptr->mr_start, mrptr->mr_size,
  86                     exflags);
  87                 ++mrptr;
  88         }
  89 }
  90
  91 #endif /* FDT */
  92
  93 #endif /* !_SYS_PHYSMEM_H_ */