update docstrings

Author: alexeev-prog

CHANGELOG.md

@@ -1,3 +1,9 @@
+commit c84a331ecb6a9547e255a833f04024ec20e0ac1d
+Author: Alexeev Bronislav <[email protected]>
+Date:   Thu Aug 28 15:39:31 2025 +0700
+
+    update docstrings and small changes in architecture
+
 commit fe56d138e16ac2875812c876bd9059d8c80e9e72
 Author: Alexeev Bronislav <[email protected]>
 Date:   Wed Aug 27 04:47:13 2025 +0700

src/kernel/cpu/idt.h

@@ -5,6 +5,7 @@
 
 /* Селекторы сегментов */
 #define KERNEL_CS 0x08
+#define IDT_ENTRIES 256
 
 /* Как определяется каждый элемент прерывания (обработчик) */
 typedef struct {
@@ -13,26 +14,35 @@ typedef struct {
     u8 always0;
     /*
     Бит 7 первого байта: "Присутствует прерывание"
-  Биты 6-5: Уровень привилегий вызывающего абонента (0=ядро..3=пользователь)
-  Бит 4: Устанавливается равным 0 для элементов прерывания
-  Биты 3-0: биты 1110 = десятичное число 14 = "32-разрядный элемент прерывания"*/
+    Биты 6-5: Уровень привилегий вызывающего абонента (0=ядро..3=пользователь)
+    Бит 4: Устанавливается равным 0 для элементов прерывания
+    Биты 3-0: биты 1110 = десятичное число 14 = "32-разрядный элемент прерывания"*/
     u8 flags;
     u16 high_offset; /* Higher 16 bits of handler function address */
 } __attribute__((packed)) idt_gate_t;
 
-/* A pointer to the array of interrupt handlers.
- * Assembly instruction 'lidt' will read it */
+/* Указатель на массив обработчиков прерывания.
+  Ассемблерная инструкция 'lidt' читает это. */
 typedef struct {
     u16 limit;
     u32 base;
 } __attribute__((packed)) idt_register_t;
 
-#define IDT_ENTRIES 256
 extern idt_gate_t idt[IDT_ENTRIES];
 extern idt_register_t idt_reg;
 
-/* Functions implemented in idt.c */
+/**
+ * @brief Заготовка обработчика IDT
+ *
+ * @param n
+ * @param handler
+ **/
 void set_idt_gate(int n, u32 handler);
+
+/**
+ * @brief Заготовка IDT
+ *
+ **/
 void set_idt();
 
 #endif

src/kernel/cpu/isr.h

@@ -70,18 +70,41 @@ extern void irq15();
 #define IRQ14 46
 #define IRQ15 47
 
-/* Struct which aggregates many registers */
+/* Структура для аггрегации регистров */
 typedef struct {
     u32 ds; /* сегмент данных */
     u32 edi, esi, ebp, esp, ebx, edx, ecx, eax; /* запушен pusha. */
     u32 int_no, err_code; /* Число прерывания и код ошибки */
     u32 eip, cs, eflags, useresp, ss; /* запушить процессором автоматически */
 } registers_t;
 
+/**
+ * @brief Обработка ISR
+ *
+ **/
 void isr_install();
+
+/**
+ * @brief Обработчик ISR
+ *
+ * @param r регистры
+ **/
 void isr_handler(registers_t r);
+
+/**
+ * @brief установка IRQ
+ *
+ **/
 void irq_install();
+
 typedef void (*isr_t)(registers_t);
+
+/**
+ * @brief Регистрация обработчика прерывания
+ *
+ * @param n номер прерывания
+ * @param handler обработчик
+ **/
 void register_interrupt_handler(u8 n, isr_t handler);
 
 #endif

src/kernel/cpu/ports.h

@@ -3,10 +3,12 @@
 
 #include "../kklibc/ctypes.h"
 
-// unsigned char port_byte_in (u16 port);
-// void port_byte_out (u16 port, u8 data);
+/**
+ * @brief Out ports
+ *
+ * @param port порт
+ * @param data данные
+ **/
 void outports(u16 port, u16 data);
-// unsigned short port_word_in (u16 port);
-// void port_word_out (u16 port, u16 data);
 
 #endif

src/kernel/cpu/timer.h

@@ -3,6 +3,11 @@
 
 #include "../kklibc/ctypes.h"
 
+/**
+ * @brief Инициализация таймера
+ *
+ * @param freq частота
+ **/
 void init_timer(u32 freq);
 
 #endif

src/kernel/drivers/keyboard.h

@@ -7,4 +7,8 @@
 
 #include "../kklibc/ctypes.h"
 
+/**
+ * @brief Инициализация драйвера клавиатуры
+ *
+ **/
 void init_keyboard();

src/kernel/drivers/lowlevel_io.h

@@ -4,7 +4,33 @@
  *  Title: Заголовочный файл для drivers/lowlevel_io.c
  */
 
+/**
+ * @brief Port byte in
+ *
+ * @param port порт
+ **/
 unsigned char port_byte_in(unsigned short port);
+
+/**
+ * @brief Port byte out
+ *
+ * @param port порт
+ * @param data данные
+ **/
 void port_byte_out(unsigned short port, unsigned char data);
+
+/**
+ * @brief Poort word in
+ *
+ * @param port порт
+ * @return unsigned char
+ **/
 unsigned char port_word_in(unsigned short port);
+
+/**
+ * @brief Port word out
+ *
+ * @param port порт
+ * @param data данные
+ **/
 void port_word_out(unsigned short port, unsigned short data);

src/kernel/drivers/screen.h

@@ -90,15 +90,78 @@
 #define REG_SCREEN_DATA 0x3d5
 
 /* Публичное API ядра */
+
+/**
+ * @brief Получение оффсета курсора
+ *
+ * @return int
+ **/
 int get_cursor_offset();
+
+/**
+ * @brief Стандартная очистка экрана
+ *
+ **/
 void clear_screen();
+
+/**
+ * @brief Очистка и заполнение экраном halted cpu
+ *
+ **/
 void halted_cpu_screen_clear();
+
+/**
+ * @brief Вывод текста в определенном месте
+ *
+ * @param message сообщение
+ * @param col колонка
+ * @param row ряд
+ * @param color цвет
+ **/
 void kprint_at(char* message, int col, int row, int color);
+
+/**
+ * @brief Вывод текста
+ *
+ * @param message сообщение
+ **/
 void kprint(char* message);
+
+/**
+ * @brief Вывод текста с новой строкой
+ *
+ * @param message сообщение
+ **/
 void kprintln(char* message);
+
+/**
+ * @brief Цветной вывод с новой строкой
+ *
+ * @param message сообщение
+ * @param color цвет
+ **/
 void kprintln_colored(char* message, int color);
+
+/**
+ * @brief Цветной вывод
+ *
+ * @param message сообщение
+ * @param color цвет
+ **/
 void kprint_colored(char* message, int color);
+
+/**
+ * @brief Вывод символа backspace
+ *
+ **/
 void kprint_backspace();
+
+/**
+ * @brief Красный экран для паники ядра
+ *
+ * @param title заголовок
+ * @param description описание
+ **/
 void panic_red_screen(char* title, char* description);
 
 #endif

src/kernel/kernel/kernel.h

@@ -1,6 +1,11 @@
 #ifndef KERNEL_H
 #define KERNEL_H
 
+/**
+ * @brief Обработка пользовательского ввода в шелле
+ *
+ * @param input
+ **/
 void user_input(char* input);
 
 extern int shell_cursor_offset;

src/kernel/kernel/sysinfo.h

@@ -3,6 +3,10 @@
 
 #include "../kklibc/ctypes.h"
 
+/**
+ * @brief Структура информации о системе
+ *
+ **/
 typedef struct {
     u32 total_memory;
     u32 free_memory;
@@ -15,8 +19,24 @@ typedef struct {
 } system_info_t;
 
 // Функции для получения информации
+
+/**
+ * @brief Детектирование процессора
+ *
+ **/
 void detect_cpu(void);
+
+/**
+ * @brief Детектирование памяти
+ *
+ **/
 void detect_memory(void);
+
+/**
+ * @brief Получение системной информации
+ *
+ * @return system_info_t*
+ **/
 system_info_t* get_system_info();
 
 #endif