From 79886caeb4bf17b01fcc42c0891a61bcd5863a75 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Mon, 8 Apr 2024 17:41:48 +0200 Subject: Kernel: Thoroughly document code. --- Private/KernelKit/KernelHeap.hpp | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'Private/KernelKit') diff --git a/Private/KernelKit/KernelHeap.hpp b/Private/KernelKit/KernelHeap.hpp index 69c84b7f..5358236e 100644 --- a/Private/KernelKit/KernelHeap.hpp +++ b/Private/KernelKit/KernelHeap.hpp @@ -13,8 +13,26 @@ #include namespace NewOS { + +/// @brief Declare pointer as free. +/// @param heapPtr the pointer. +/// @return Int32 ke_delete_ke_heap(voidPtr allocatedPtr); + +/// @brief Check if pointer is a valid kernel pointer. +/// @param heapPtr the pointer +/// @return if it exists. Boolean ke_is_valid_heap(VoidPtr ptr); + +/// @brief allocate chunk of memory. +/// @param sz size of pointer +/// @param rw read write (true to enable it) +/// @param user is it accesible by user processes? +/// @return the pointer voidPtr ke_new_ke_heap(SizeT sz, const bool rw, const bool user); + +/// @brief Protect the heap pointer with a CRC32. +/// @param heapPtr HIB pointer. +/// @return if it valid: point has crc now., otherwise fail. Boolean ke_protect_ke_heap(VoidPtr heapPtr); } // namespace NewOS -- cgit v1.2.3