From b9c103e3048d2b28a2606a3b9693ec881425a732 Mon Sep 17 00:00:00 2001
From: Marvin Borner
Date: Sat, 28 Sep 2019 23:08:13 +0200
Subject: Added some documentation

---
 src/kernel/graphics/graphics.h | 34 +++++++++++++++++++++++++++++++++-
 src/kernel/graphics/vesa.h     | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 1 deletion(-)

(limited to 'src/kernel/graphics')

diff --git a/src/kernel/graphics/graphics.h b/src/kernel/graphics/graphics.h
index 3136b1e..e20d1ed 100644
--- a/src/kernel/graphics/graphics.h
+++ b/src/kernel/graphics/graphics.h
@@ -5,21 +5,53 @@
 #include <stdint.h>
 #include "vesa.h"
 
-// VGA
+/**
+ * Linked table of colors and hardware color codes
+ */
 enum vga_color;
 
+/**
+ * Initialize the terminal color and cursor position
+ */
 void terminal_initialize(void);
 
+/**
+ * Set the terminal color to a specified hardware color code
+ * @see enum vga_color
+ * @param color
+ */
 void terminal_set_color(uint8_t color);
 
+/**
+ * Clear the entire terminal screen
+ */
 void terminal_clear();
 
+/**
+ * Write a string to the terminal
+ * @param data The string that should be written
+ */
 void terminal_write_string(const char *data);
 
+/**
+ * Put a new char at the x+1 cursor position and
+ * handle according events (e.g. overflow, linebreak)
+ * @param c The character (can also be \n or \r)
+ */
 void terminal_put_char(char c);
 
+/**
+ * Put a new char at the x+1 cursor position,
+ * handle according events (e.g. overflow, linebreak) and
+ * execute the current command if c is linebreak (\n)
+ * @param c The character (can also be \n or \r)
+ */
 void terminal_put_keyboard_char(char c);
 
+/**
+ * Write a line to the terminal
+ * @param data The line (string) that should be written
+ */
 void terminal_write_line(const char *data);
 
 #endif
\ No newline at end of file
diff --git a/src/kernel/graphics/vesa.h b/src/kernel/graphics/vesa.h
index 203b06b..d163fb3 100644
--- a/src/kernel/graphics/vesa.h
+++ b/src/kernel/graphics/vesa.h
@@ -4,6 +4,10 @@
 #include <stdint.h>
 #include "../system.h"
 
+/**
+ * The CPUs response to the 0x4F00 call
+ * Used to receive the supported video modes
+ */
 struct vbe_info {
     char signature[4];
     uint32_t version;
@@ -19,6 +23,10 @@ struct vbe_info {
     char oem_data[256];
 } __attribute__ ((packed));
 
+/**
+ * The CPUs response to the 0x4F01 call
+ * Used to get information about a specific video mode code
+ */
 struct vbe_mode_info {
     uint16_t attributes;
     uint8_t window_a;
@@ -57,14 +65,43 @@ struct vbe_mode_info {
     uint8_t reserved1[206];
 } __attribute__ ((packed));
 
+/**
+ * Set the video mode to a specified resolution using
+ * a video mode code
+ * @param mode The requested video mode code from 0x4F00 call
+ * @return A structure with information about the video mode
+ */
 struct vbe_mode_info *vbe_set_mode(unsigned short mode);
 
+/**
+ * Find the highest resolution using 0x4F00 and call
+ * vbe_set_mode using the video_modes far_ptr
+ */
 void set_optimal_resolution();
 
+/**
+ * The current video mode
+ */
 int vbe_current_mode;
+
+/**
+ * The width of the current video mode
+ */
 int vbe_width;
+
+/**
+ * The height of the current video mode
+ */
 int vbe_height;
+
+/**
+ * The bits per pixel of the current video mode
+ */
 int vbe_bpp;
+
+/**
+ * The pitch (bytes per line) of the current video mode
+ */
 int vbe_pitch;
 
 #endif
-- 
cgit v1.2.3