Zephyr Project API  3.2.0
A Scalable Open Source RTOS
system_mm.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2021 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
15#ifndef ZEPHYR_INCLUDE_DRIVERS_SYSTEM_MM_H_
16#define ZEPHYR_INCLUDE_DRIVERS_SYSTEM_MM_H_
17
18#include <zephyr/kernel.h>
19
20#ifndef _ASMLANGUAGE
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
33/*
34 * Caching mode definitions. These are mutually exclusive.
35 */
36
38#define SYS_MM_MEM_CACHE_NONE 2
39
41#define SYS_MM_MEM_CACHE_WT 1
42
44#define SYS_MM_MEM_CACHE_WB 0
45
47#define SYS_MM_MEM_CACHE_MASK (BIT(3) - 1)
48
49/*
50 * Region permission attributes.
51 * Default should be read-only, no user, no exec.
52 */
53
55#define SYS_MM_MEM_PERM_RW BIT(3)
56
58#define SYS_MM_MEM_PERM_EXEC BIT(4)
59
61#define SYS_MM_MEM_PERM_USER BIT(5)
62
84
106int sys_mm_drv_map_region(void *virt, uintptr_t phys,
107 size_t size, uint32_t flags);
108
130int sys_mm_drv_map_array(void *virt, uintptr_t *phys,
131 size_t cnt, uint32_t flags);
132
154int sys_mm_drv_unmap_page(void *virt);
155
178int sys_mm_drv_unmap_region(void *virt, size_t size);
179
197int sys_mm_drv_page_phys_get(void *virt, uintptr_t *phys);
198
226int sys_mm_drv_remap_region(void *virt_old, size_t size, void *virt_new);
227
259int sys_mm_drv_move_region(void *virt_old, size_t size, void *virt_new,
260 uintptr_t phys_new);
261
294int sys_mm_drv_move_array(void *virt_old, size_t size, void *virt_new,
295 uintptr_t *phys_new, size_t phys_cnt);
296
297
319
341int sys_mm_drv_update_region_flags(void *virt, size_t size, uint32_t flags);
342
347#ifdef __cplusplus
348}
349#endif
350
351#endif /* _ASMLANGUAGE */
352
353#endif /* ZEPHYR_INCLUDE_DRIVERS_SYSTEM_MM_H_ */
int sys_mm_drv_map_region(void *virt, uintptr_t phys, size_t size, uint32_t flags)
Map a region of physical memory into the virtual address space.
int sys_mm_drv_update_page_flags(void *virt, uint32_t flags)
Update memory page flags.
int sys_mm_drv_move_region(void *virt_old, size_t size, void *virt_new, uintptr_t phys_new)
Physically move memory, with copy.
int sys_mm_drv_update_region_flags(void *virt, size_t size, uint32_t flags)
Update memory region flags.
int sys_mm_drv_map_page(void *virt, uintptr_t phys, uint32_t flags)
Map one physical page into the virtual address space.
int sys_mm_drv_page_phys_get(void *virt, uintptr_t *phys)
Get the mapped physical memory address from virtual address.
int sys_mm_drv_move_array(void *virt_old, size_t size, void *virt_new, uintptr_t *phys_new, size_t phys_cnt)
Physically move memory, with copy.
int sys_mm_drv_map_array(void *virt, uintptr_t *phys, size_t cnt, uint32_t flags)
Map an array of physical memory into the virtual address space.
int sys_mm_drv_unmap_page(void *virt)
Remove mapping for one page of the provided virtual address.
int sys_mm_drv_unmap_region(void *virt, size_t size)
Remove mappings for a provided virtual address range.
int sys_mm_drv_remap_region(void *virt_old, size_t size, void *virt_new)
Remap virtual pages into new address.
flags
Definition: http_parser.h:131
Public kernel APIs.
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINTPTR_TYPE__ uintptr_t
Definition: stdint.h:105