kernel: demand_paging: fix arch_page_location_get() documentation

Symbols from enum arch_page_location are defined as
ARCH_PAGE_LOCATION_* and not ARCH_PAGE_FAULT_*.

Signed-off-by: Nicolas Pitre <npitre@baylibre.com>
This commit is contained in:
Nicolas Pitre 2024-05-21 21:47:52 -04:00 committed by Anas Nashif
commit b34e94f362

View file

@ -435,12 +435,12 @@ enum arch_page_location {
* in that. * in that.
* *
* @param addr Virtual data page address that took the page fault * @param addr Virtual data page address that took the page fault
* @param [out] location In the case of ARCH_PAGE_FAULT_PAGED_OUT, the backing * @param [out] location In the case of ARCH_PAGE_LOCATION_PAGED_OUT, the backing
* store location value used to retrieve the data page. In the case of * store location value used to retrieve the data page. In the case of
* ARCH_PAGE_FAULT_PAGED_IN, the physical address the page is mapped to. * ARCH_PAGE_LOCATION_PAGED_IN, the physical address the page is mapped to.
* @retval ARCH_PAGE_FAULT_PAGED_OUT The page was evicted to the backing store. * @retval ARCH_PAGE_LOCATION_PAGED_OUT The page was evicted to the backing store.
* @retval ARCH_PAGE_FAULT_PAGED_IN The data page is resident in memory. * @retval ARCH_PAGE_LOCATION_PAGED_IN The data page is resident in memory.
* @retval ARCH_PAGE_FAULT_BAD The page is un-mapped or otherwise has had * @retval ARCH_PAGE_LOCATION_BAD The page is un-mapped or otherwise has had
* invalid access * invalid access
*/ */
enum arch_page_location arch_page_location_get(void *addr, uintptr_t *location); enum arch_page_location arch_page_location_get(void *addr, uintptr_t *location);