kernel: mm: rename Z_MEM_VM_OFFSET to K_MEM_VIRT_OFFSET

This is part of a series to move memory management functions
away from the z_ namespace and into its own namespace. Also
make documentation available via doxygen.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>

arch/x86/core/x86_mmu.c

@@ -593,7 +593,7 @@ static void print_entries(pentry_t entries_array[], uint8_t *base, int level,
 				if (phys == virt) {
 					/* Identity mappings */
 					COLOR(YELLOW);
-				} else if (phys + Z_MEM_VM_OFFSET == virt) {
+				} else if (phys + K_MEM_VIRT_OFFSET == virt) {
 					/* Permanent RAM mappings */
 					COLOR(GREEN);
 				} else {

include/zephyr/kernel/internal/mm.h

@@ -16,11 +16,14 @@
  * @{
  */
 
-/*
+/**
+ * @def K_MEM_VIRT_OFFSET
+ * @brief Address offset of permanent virtual mapping from physical address.
+ *
  * This is the offset to subtract from a virtual address mapped in the
  * kernel's permanent mapping of RAM, to obtain its physical address.
  *
- *     virt_addr = phys_addr + Z_MEM_VM_OFFSET
+ *     virt_addr = phys_addr + K_MEM_VIRT_OFFSET
  *
  * This only works for virtual addresses within the interval
  * [CONFIG_KERNEL_VM_BASE, CONFIG_KERNEL_VM_BASE + (CONFIG_SRAM_SIZE * 1024)).
@@ -35,16 +38,16 @@
  * constraints defined.
  */
 #ifdef CONFIG_MMU
-#define Z_MEM_VM_OFFSET	((CONFIG_KERNEL_VM_BASE + CONFIG_KERNEL_VM_OFFSET) - \
-			 (CONFIG_SRAM_BASE_ADDRESS + CONFIG_SRAM_OFFSET))
+#define K_MEM_VIRT_OFFSET	((CONFIG_KERNEL_VM_BASE + CONFIG_KERNEL_VM_OFFSET) - \
+				 (CONFIG_SRAM_BASE_ADDRESS + CONFIG_SRAM_OFFSET))
 #else
-#define Z_MEM_VM_OFFSET	0
+#define K_MEM_VIRT_OFFSET	0
 #endif /* CONFIG_MMU */
 
-#define Z_MEM_PHYS_ADDR(virt)	((virt) - Z_MEM_VM_OFFSET)
-#define Z_MEM_VIRT_ADDR(phys)	((phys) + Z_MEM_VM_OFFSET)
+#define Z_MEM_PHYS_ADDR(virt)	((virt) - K_MEM_VIRT_OFFSET)
+#define Z_MEM_VIRT_ADDR(phys)	((phys) + K_MEM_VIRT_OFFSET)
 
-#if Z_MEM_VM_OFFSET != 0
+#if K_MEM_VIRT_OFFSET != 0
 #define Z_VM_KERNEL 1
 #ifdef CONFIG_XIP
 #error "XIP and a virtual memory kernel are not allowed"