frame.h

Go to the documentation of this file.

#ifndef FRAME_H
#define FRAME_H
 
#include <stddef.h>
#include <stdint.h>
 
/**
 * @brief Metadata for a physical frame.
 */
struct frame;
 
/**
 * @brief Allocates a frame and returns a pointer to it.
 * The allocated frame will be zeroed out.
 * 
 * @param identifier A string identifier for the frame (for debugging purposes).
 * @return A pointer to the allocated frame.
 */
struct frame *alloc_frame(const char *identifier);
/**
 * @brief Frees a frame.
 * 
 * @param frame A pointer to the frame to free.
 * @note The frame will only be truly freed if its reference count drops to 0.
 */
void free_frame(struct frame *frame);
 
/**
 * @brief Returns the PFN of a frame.
 * 
 * @param frame A pointer to the frame.
 * @return The PFN of the frame.
 */
size_t frame_to_pfn(struct frame *frame);
/**
 * @brief Converts a PFN to a physical address.
 * 
 * @param pfn The PFN to convert.
 * @return The physical address.
 */
size_t pfn_to_phys(size_t pfn);
 
/**
 * @brief Initializes the frame allocator and memory map.
 */
void frame_init();
 
#endif