From d7cb08134102b7a2410c48d2a1802193f9031e00 Mon Sep 17 00:00:00 2001 From: Kimplul Date: Sun, 29 May 2022 16:23:41 +0300 Subject: continue documentation efforts --- include/apos/mem_nodes.h | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) (limited to 'include/apos/mem_nodes.h') diff --git a/include/apos/mem_nodes.h b/include/apos/mem_nodes.h index f0d1361..866915d 100644 --- a/include/apos/mem_nodes.h +++ b/include/apos/mem_nodes.h @@ -9,10 +9,31 @@ #include #include -void init_mem_blocks(); -void destroy_mem_blocks(); +/** + * Initialize memory node subsystem. + * + * @pre Physical memory subsystem has been initialized. + */ +void init_mem_nodes(); + +/** + * Destroy memory node subsystem. + * Free all associated allocations. + */ +void destroy_mem_nodes(); +/** + * Fetch a new memory node. + * + * @return Pointer to \ref mem_region node on success, \c NULL otherwise. + */ struct mem_region *get_mem_node(); + +/** + * Free a memory node. + * + * @param m Pointer to \ref mem_region node to free. + */ void free_mem_node(struct mem_region *m); #endif /* APOS_MM_NODES_H */ -- cgit v1.3