summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2026-01-19 21:51:20 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2026-01-19 21:51:20 +0100
commit7ec77f42f45fb3b3479818636943923b9416a170 (patch)
tree33f608b06d865285fb6ef1eaf752ae77cbb16a17 /doc
parent465a99f17f9e8f56813f225f09a6a1a498be9deb (diff)
chore: {kernel, launch, libSystem}: Implementation and WiP improvements.v0.1.211
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/specs/SPECIFICATION_MACROS.md5
-rw-r--r--doc/specs/SPECIFICATION_MBCI.md3
-rw-r--r--doc/specs/SPECIFICATION_OS.md9
-rw-r--r--doc/tex/openhefs.tex2
-rw-r--r--doc/tex/trace_server.tex17
5 files changed, 34 insertions, 2 deletions
diff --git a/doc/specs/SPECIFICATION_MACROS.md b/doc/specs/SPECIFICATION_MACROS.md
index 3acef7af..3b091454 100644
--- a/doc/specs/SPECIFICATION_MACROS.md
+++ b/doc/specs/SPECIFICATION_MACROS.md
@@ -4,6 +4,8 @@
===================================
+The NeKernel System uses macro to configure its compilation. Some of them shall not be defined at the same time to avoid run-time issues.
+
===================================
# 1: NeKernel/BootZ:
@@ -13,6 +15,9 @@
- `__nekernel_max_cores` -> Max SMP cores usable by NeKernel's scheduler.
- `__nekernel_boot_core_index` -> Index of the boot core (0, 1, or 3).
- `__nekernel_allow_non_nekernel_pe` -> Allow non-subsystem 17 to run on NeKernel.
+- `__nekernel_halkit_include_processor` HALKit include directory for Processor.h
+- `__nekernel_dma_pool_start` NeKernel DMA pool start.
+- `__nekernel_dma_pool_size` NeKernel DMA pool size.
===================================
diff --git a/doc/specs/SPECIFICATION_MBCI.md b/doc/specs/SPECIFICATION_MBCI.md
index 648529cf..4c6aa0b9 100644
--- a/doc/specs/SPECIFICATION_MBCI.md
+++ b/doc/specs/SPECIFICATION_MBCI.md
@@ -14,7 +14,8 @@
===================================
-- MBCI Host
+- MBCI Client, the controlled MBCI component.
+- MBCI Host, it shall govern how the MBCI Client act.
- MBCI Authentication key (24-bit number)
- MBCI Host Kind and Flags.
diff --git a/doc/specs/SPECIFICATION_OS.md b/doc/specs/SPECIFICATION_OS.md
index 346ae3c9..9838609a 100644
--- a/doc/specs/SPECIFICATION_OS.md
+++ b/doc/specs/SPECIFICATION_OS.md
@@ -77,3 +77,12 @@
- Multi-drive support (A, B, C, D indices).
- Packet-based I/O operations.
- Separation of read/write operations per drive.
+
+===================================
+
+# 6: The TraceSrv:
+
+==================================
+
+- Opcode Based Debug System.
+- Packet Based Messages with a 'type' field. The 'type' field shall decide how the message shall be interpreted.
diff --git a/doc/tex/openhefs.tex b/doc/tex/openhefs.tex
index 136d651c..8503bcd0 100644
--- a/doc/tex/openhefs.tex
+++ b/doc/tex/openhefs.tex
@@ -12,7 +12,7 @@
\maketitle
-\section{Overview}
+\section{Abstract}
The High-throughput Extended File System (OpenHeFS) is a custom filesystem tailored for performance, structure, and compact representation. It uses red-black trees for directory indexing, sparse block slicing for file layout, and fixed-size metadata structures optimized for 512-byte sector alignment.
\section{Constants and Macros}
diff --git a/doc/tex/trace_server.tex b/doc/tex/trace_server.tex
new file mode 100644
index 00000000..55ef491b
--- /dev/null
+++ b/doc/tex/trace_server.tex
@@ -0,0 +1,17 @@
+\documentclass{article}
+\usepackage{graphicx}
+
+\title{TraceSrv: The Trace Subsystem}
+\author{Amlal El Mahrouss}
+\date{\today}
+
+\begin{document}
+
+\maketitle
+
+\begin{abstract}
+{The Trace Subsystem in NeKernel is responsible for handling tracing and debugging functionalities within the operating system kernel.
+This document provides an overview of the design and components of the Trace Subsystem, including its message structures and communication protocols.}
+\end{abstract}
+
+\end{document} \ No newline at end of file