system_mm.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_SYSTEM_MM_H_
#define ZEPHYR_INCLUDE_DRIVERS_SYSTEM_MM_H_
 
#include <zephyr/types.h>
 
#ifndef _ASMLANGUAGE
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * Caching mode definitions. These are mutually exclusive.
 */
 
#define SYS_MM_MEM_CACHE_NONE           2
 
#define SYS_MM_MEM_CACHE_WT             1
 
#define SYS_MM_MEM_CACHE_WB             0
 
#define SYS_MM_MEM_CACHE_MASK           (BIT(3) - 1)
 
/*
 * Region permission attributes.
 * Default should be read-only, no user, no exec.
 */
 
#define SYS_MM_MEM_PERM_RW              BIT(3)
 
#define SYS_MM_MEM_PERM_EXEC            BIT(4)
 
#define SYS_MM_MEM_PERM_USER            BIT(5)
 
int sys_mm_drv_map_page(void *virt, uintptr_t phys, uint32_t flags);
 
int sys_mm_drv_map_region(void *virt, uintptr_t phys,
                          size_t size, uint32_t flags);
 
int sys_mm_drv_map_array(void *virt, uintptr_t *phys,
                         size_t cnt, uint32_t flags);
 
int sys_mm_drv_unmap_page(void *virt);
 
int sys_mm_drv_unmap_region(void *virt, size_t size);
 
int sys_mm_drv_page_phys_get(void *virt, uintptr_t *phys);
 
int sys_mm_drv_remap_region(void *virt_old, size_t size, void *virt_new);
 
int sys_mm_drv_move_region(void *virt_old, size_t size, void *virt_new,
                           uintptr_t phys_new);
 
int sys_mm_drv_move_array(void *virt_old, size_t size, void *virt_new,
                          uintptr_t *phys_new, size_t phys_cnt);
 
 
int sys_mm_drv_update_page_flags(void *virt, uint32_t flags);
 
int sys_mm_drv_update_region_flags(void *virt, size_t size, uint32_t flags);
 
struct sys_mm_drv_region {
        void *addr; 
        size_t size; 
        uint32_t attr; 
};
 
/* TODO is it safe to assume no valid region has size == 0? */
#define SYS_MM_DRV_MEMORY_REGION_FOREACH(regions, iter) \
        for (iter = regions; iter->size; iter++)
 
const struct sys_mm_drv_region *sys_mm_drv_query_memory_regions(void);
 
void sys_mm_drv_query_memory_regions_free(const struct sys_mm_drv_region *regions);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _ASMLANGUAGE */
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_SYSTEM_MM_H_ */