Обновление документации

This commit is contained in:
Aren 2023-12-15 18:25:38 +03:00
parent c212598468
commit 069ea689e1
1 changed files with 20 additions and 12 deletions

32
API.md
View File

@ -1,6 +1,6 @@
# Системные вызовы
## mem_alloc(size_t size)
## alloc(size_t size)
Выделение блока памяти размером `size`.
Вовзращает адрес на блок памяти или 0 в случае ошибки.
@ -10,7 +10,7 @@
- `-1 не хватает ОЗУ`;
- `-2 неправильный размер блока`.
## mem_free(uintptr_t mem)
## free(uintptr_t mem)
Освобождение блока памяти `mem`.
Вовзращает 0 в случае успеха или -1 в случае ошибки.
@ -19,7 +19,7 @@
- `-1 блок не найден`.
## sys_alloc_framebuffer()
## alloc_framebuffer()
Выделяет память под буфер кадра для отображения графического интерфейса.
Возвращает указатель на структуру `framebuffer_t` или 0, если произошла ошибка.
@ -28,7 +28,15 @@
- `-1 не удалось выделить память для буфера кадра`.
## sys_free_framebuffer(framebuffer_t *frame)
## fb_printf(char *str, ...)
Форматированный вывод строки на экран используя функцию ядра fb_printf.
### Будет удалено в ближайших обновлениях
- Для вывода используйте любой графический или псевдографический модуль
## free_framebuffer(framebuffer_t *frame)
Освобождает ранее выделенную память `frame` для буфера кадра. Возвращает 0 в случае успеха или -1, если произошла ошибка.
@ -36,23 +44,23 @@
- `-1 ошибка при освобождении памяти для буфера кадра`.
## sys_exit(int code)
## exit(int code)
Завершает выполнение текущего потока с кодом `code`.
## sys_get_error()
## get_error()
Получает код ошибки последней операции. Возвращает целочисленное значение, представляющее код ошибки.
## sys_get_info()
## get_info()
Получает информацию о текущей системе. Возвращает структуру `sys_info_t` содержащую информацию о системе.
## sys_get_module(uid_t module_id)
## get_module(uid_t module_id)
Получает информацию о модуле `module_id`. Возвращает структуру, содержащую информацию о модуле.
## sys_new_thread(func_t func)
## new_thread(func_t func)
Создает новый поток выполнения для функции `func`. Возвращает идентификатор созданного потока или 0 в случае ошибки.
@ -60,7 +68,7 @@
- `-1 ошибка при создании потока`.
## sys_delete_thread(uid_t thread_id)
## delete_thread(uid_t thread_id)
Удаляет указанный поток выполнения `thread_id`. Возвращает 0 в случае успеха или -1 в случае ошибки.
@ -69,11 +77,11 @@
- `-1 поток не найден`.
<!--
## sys_get_time()
## get_time()
Получает текущее время системы в формате timestamp. Возвращает целое число, представляющее количество секунд с начала эпохи.
## sys_set_alarm(time_t time, func_t func)
## set_alarm(time_t time, func_t func)
Устанавливает сигнал будильника на время time. При наступлении указанного времени будет вызвана функция func.