Improved souce ig?

Author: pradosh-arduino

source/includes/drivers/rtl8139.h

@@ -8,7 +8,9 @@
  * @copyright Copyright (c) Pradosh 2023
  * 
  */
-#pragma once
+#ifndef rtl8139_h
+#define rtl8139_h
+ 
 #include <stdint.h>
 #include <stdbool.h>
 #include <basics.h>
@@ -44,6 +46,10 @@ struct rtl8139 {
     int8 mac_address[6];
 };
 
+/**
+ * @brief Global pointer for the RTL card.
+ * 
+ */
 extern struct rtl8139* RTL8139;
 
 /**
@@ -78,4 +84,6 @@ bool rtl8139_send_packet(const int8* data, int16 length);
  * @return [true] Return yes if a packet was received
  * @return [false] Return false if a packet was not received
  */
-bool rtl8139_receive_packet(int8* buffer, int16* length);
+bool rtl8139_receive_packet(int8* buffer, int16* length);
+
+#endif

source/includes/heap.h

@@ -21,14 +21,69 @@ typedef struct {
 
 #define MAX_PAGE_ALIGNED_ALLOCS 32
 
+/**
+ * @brief Function to initlialize heap.
+ * 
+ * @param kernel_end The position in memory where kernel ends.
+ */
 extern void mm_init(uint32_t kernel_end);
+
+/**
+ * @brief Function to extend available heap.
+ * 
+ * @param additional_size Additional size to be added.
+ */
 extern void mm_extend(uint32_t additional_size);
 
+/**
+ * @brief Function to constrict available heap.
+ * 
+ * @param removal_size Amount of size needed to be reduced.
+ */
+extern void mm_constrict(uint32_t removal_size);
+
+/**
+ * @brief Prints out heap information.
+ * 
+ */
 extern void mm_print_out();
 
+/**
+ * @brief Page based memory allocate.
+ * 
+ * @param size Amount of size needed to be allocated.
+ * @return char* Location in memory.
+ */
 extern char* pmalloc(size_t size);
+
+/**
+ * @brief Function to free a page.
+ * 
+ * @param mem Location in memory.
+ */
+extern void pfree(void *mem);
+
+/**
+ * @brief The main memory alloc function.
+ * 
+ * @param size Amount of size needed to be allocated.
+ * @return char* Location in memory.
+ */
 extern char* malloc(size_t size);
+
+/**
+ * @brief The main memory realloc function.
+ * 
+ * @param size Amount of size needed to be extened.
+ * @return char* Location in memory.
+ */
 extern char* realloc(void *ptr, size_t size);
+
+/**
+ * @brief The main free function for memory allocation.
+ * 
+ * @param mem Location in memory.
+ */
 extern void free(void *mem);
 
 #endif

source/includes/image/targa.h

@@ -11,6 +11,10 @@
 #include <basics.h>
 #include <opengl/glbackend.h>
 
+/**
+ * @brief Targa header.
+ * 
+ */
 typedef struct {
     int8  idLength;
     int8  colorMapType;

source/kernel/C/kernel.c

@@ -321,6 +321,14 @@ void main(void) {
 
     info("Welcome to FrostWing Operating System!", "(https://github.com/Frost-Wing)");
 
+    // glCreateContext();
+    // glCreateContextCustom(framebuffer->address, framebuffer->width, framebuffer->height);
+    // glClearColor(0, 0, 0, 0xff);
+    // glClear(GL_COLOR_BUFFER_BIT);
+    // display_png(module_request.response->modules[1]->address, module_request.response->modules[1]->size);
+    // glDrawTriangle((uvec2){10, 10}, (uvec2){100, 100}, (uvec2){100, 10}, 0xffdadbad, false);
+    // glDestroyContext(null);
+
     // glDestroyContext(null);
 
     // Below code is for triggering Page Fault
@@ -376,12 +384,6 @@ void main(void) {
     // int status_code = execute_binary();
     // printf("return code: 0x%x", status_code);
 
-    // glCreateContext();
-    // glCreateContextCustom(front_buffer, framebuffer->width, framebuffer->height);
-    // glClearColor(0, 0, 0, 0xff);
-    // glClear(GL_COLOR_BUFFER_BIT);
-    // glDrawTriangle((uvec2){10, 10}, (uvec2){100, 100}, (uvec2){100, 10}, 0xffdadbad, false);
-    // glDestroyContext(null);
 
     extern char* login_request();