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/interrupts/interrupts.h | 41 +++++++++++++++++++++++++++++++++++---
 1 file changed, 38 insertions(+), 3 deletions(-)

(limited to 'src/kernel/interrupts/interrupts.h')

diff --git a/src/kernel/interrupts/interrupts.h b/src/kernel/interrupts/interrupts.h
index 755a633..80c9b27 100644
--- a/src/kernel/interrupts/interrupts.h
+++ b/src/kernel/interrupts/interrupts.h
@@ -1,14 +1,28 @@
 #ifndef MELVIX_INTERRUPTS_H
 #define MELVIX_INTERRUPTS_H
 
-// IDT
+/**
+ * Initialize the Interrupt Descriptor Table with 256 entries
+ */
 void idt_install();
 
+/**
+ * Add new gate (Interrupt Service Routine) to the Interrupt Descriptor Table
+ * @param num The index of the routine in the IDT
+ * @param base The base address of the ISR
+ * @param sel The kernel code segment (0x08)
+ * @param flags The IDT access byte entry (P DPL 01110)
+ */
 void idt_set_gate(unsigned char num, unsigned long base, unsigned short sel, unsigned char flags);
 
-// ISRS
+/**
+ * Install 32 exception ISRs into the IDT
+ */
 void isrs_install();
 
+/**
+ * Registers that get passed into an IRQ handler
+ */
 struct regs {
     unsigned int gs, fs, es, ds;
     unsigned int edi, esi, ebp, esp, ebx, edx, ecx, eax;
@@ -16,15 +30,36 @@ struct regs {
     unsigned int eip, cs, eflags, useresp, ss;
 };
 
-// IRQ
+/**
+ * Initialize the Interrupt Requests by mapping the ISRs to the correct
+ * entries in the IDT (install the exception handlers)
+ */
 void irq_install();
 
+/**
+ * Add a new Interrupt Request Handler
+ * @param irq The index of the IRQ routine
+ * @param handler The interrupt handler function
+ */
 void irq_install_handler(int irq, void (*handler)(struct regs *r));
 
+/**
+ * Uninstall a handler by index
+ * @param irq The index of the IRQ routine that should be removed
+ */
 void irq_uninstall_handler(int irq);
 
+/**
+ * Execute the handler of the IRQ
+ * @param r The ISR that should be handled
+ */
 void irq_handler(struct regs *r);
 
+/**
+ * Check if an IRQ is installed
+ * @param irq The index of the IRQ routine that should be checked
+ * @return 1 if installed, 0 if not
+ */
 int irq_is_installed(int irq);
 
 #endif
-- 
cgit v1.2.3