meta: important document improvements.

Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>

27 files changed, 52 insertions, 51 deletions

diff --git a/src/32x0/32x0_boot.32x b/src/32x0/32x0_boot.32x
index 44ee037..5256293 100644
--- a/src/32x0/32x0_boot.32x
+++ b/src/32x0/32x0_boot.32x
@@ -3,7 +3,7 @@
 ;; interrupts: 0x800 (much like the 64x0)
 ;; brief: jump to main
 
-;; Copyright 2024, Amlal EL Mahrouss, all rights reserved.
+;; Copyright 2024, Amlal El Mahrouss, all rights reserved.
 
 %def ROMBOOT_BASE $1000
 
diff --git a/src/64x0/64x0_boot.64x b/src/64x0/64x0_boot.64x
index 6ee71b2..7fb6825 100644
--- a/src/64x0/64x0_boot.64x
+++ b/src/64x0/64x0_boot.64x
@@ -3,7 +3,7 @@
 # interrupts: 1M - 2048
 # brief: jump to r16 which contains the code to jump on.
 
-# Copyright 2024, Amlal EL Mahrouss, all rights reserved.
+# Copyright 2024, Amlal El Mahrouss, all rights reserved.
 
 export .text __start
     lda r15, 0x7c00
diff --git a/src/amd64/amd64-boot.asm b/src/amd64/amd64-boot.asm
index d578aa9..1601727 100644
--- a/src/amd64/amd64-boot.asm
+++ b/src/amd64/amd64-boot.asm
@@ -1,5 +1,5 @@
 ;; AMD64 NeBoot Master Boot Program.
-;; Written by Amlal EL Mahrouss
+;; Written by Amlal El Mahrouss
 
 %define ENTRYPOINT 0x00FF
 
diff --git a/src/amd64/amd64-test.asm b/src/amd64/amd64-test.asm
index b89e522..c71a191 100644
--- a/src/amd64/amd64-test.asm
+++ b/src/amd64/amd64-test.asm
@@ -1,5 +1,5 @@
 ;; AMD64 NeBoot Sample program.
-;; Written by Amlal EL Mahrouss
+;; Written by Amlal El Mahrouss
 
 [bits 16]
 [org 0x7c00]
diff --git a/src/arm64/arm64-30pin.c b/src/arm64/arm64-30pin.c
index eb89c67..2ede2e4 100644
--- a/src/arm64/arm64-30pin.c
+++ b/src/arm64/arm64-30pin.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/arm64/arm64-boot.S b/src/arm64/arm64-boot.S
index 4fbd3f8..1f77371 100644
--- a/src/arm64/arm64-boot.S
+++ b/src/arm64/arm64-boot.S
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-    Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved.
+    Copyright (C) 2024-2025, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/arm64/arm64-err.c b/src/arm64/arm64-err.c
index c734ada..68333ad 100644
--- a/src/arm64/arm64-err.c
+++ b/src/arm64/arm64-err.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/arm64/arm64-start-context.S b/src/arm64/arm64-start-context.S
index 5a2539b..315bcc1 100644
--- a/src/arm64/arm64-start-context.S
+++ b/src/arm64/arm64-start-context.S
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-    Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+    Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/arm64/arm64-uart.c b/src/arm64/arm64-uart.c
index 4723204..b0d31db 100644
--- a/src/arm64/arm64-uart.c
+++ b/src/arm64/arm64-uart.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/hal/neboot-ahci-driver.c b/src/hal/neboot-ahci-driver.c
index 1ee1272..4b26a74 100644
--- a/src/hal/neboot-ahci-driver.c
+++ b/src/hal/neboot-ahci-driver.c
@@ -1,17 +1,17 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
 /**
  * @file neboot-ahci-driver.cc
- * @author Amlal EL Mahrouss (amlal@nekernel.org)
+ * @author Amlal El Mahrouss (amlal@nekernel.org)
  * @brief SATA Disk support, via AHCI.
  * @version 0.2
  * @date 2024-01-16
  *
- * @copyright Copyright (c) 2024-2025, Amlal EL Mahrouss.
+ * @copyright Copyright (c) 2024-2025, Amlal El Mahrouss.
  *
  */
 
diff --git a/src/hal/neboot-flash-driver.c b/src/hal/neboot-flash-driver.c
index d1b0907..b46e242 100644
--- a/src/hal/neboot-flash-driver.c
+++ b/src/hal/neboot-flash-driver.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/neboot-bootnet.c b/src/neboot-bootnet.c
index a547b35..73aff94 100644
--- a/src/neboot-bootnet.c
+++ b/src/neboot-bootnet.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2025, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2025, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/neboot-cpu-api.c b/src/neboot-cpu-api.c
index 4617343..ac25602 100644
--- a/src/neboot-cpu-api.c
+++ b/src/neboot-cpu-api.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/neboot-cxx-abi.cc b/src/neboot-cxx-abi.cc
index 88b2a6a..ee622f8 100644
--- a/src/neboot-cxx-abi.cc
+++ b/src/neboot-cxx-abi.cc
@@ -1,6 +1,7 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
+  Copyright (C) 2025, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/neboot-partition-map-parse.c b/src/neboot-partition-map-parse.c
index 7d8f80f..00df4ea 100644
--- a/src/neboot-partition-map-parse.c
+++ b/src/neboot-partition-map-parse.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/neboot-partition-map.c b/src/neboot-partition-map.c
index edc66e7..d27f534 100644
--- a/src/neboot-partition-map.c
+++ b/src/neboot-partition-map.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/neboot-pci-tree.c b/src/neboot-pci-tree.c
index a506323..832aa22 100644
--- a/src/neboot-pci-tree.c
+++ b/src/neboot-pci-tree.c
@@ -1,17 +1,17 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
 /**
  * @file neboot-pci-tree.c
- * @author Amlal EL Mahrouss (amlal@nekernel.org)
+ * @author Amlal El Mahrouss (amlal@nekernel.org)
  * @brief PCI tree implementation.
  * @version 0.1
  * @date 2024-01-22
  *
- * @copyright Copyright (c) 2024 Amlal EL Mahrouss
+ * @copyright Copyright (c) 2024 Amlal El Mahrouss
  *
  */
 
@@ -23,15 +23,15 @@
 /// Standard Root table (Mahrouss Table)
 #define NB_PCI_ROOT_NAME "/pci-tree/@/"
 
-static struct hw_cb_pci_tree* cb_base_tree   = nil;
-static struct hw_cb_pci_tree* cb_latest_tree = nil;
-static struct hw_cb_pci_tree* cb_last_tree   = nil;
+static struct hw_nb_pci_tree* cb_base_tree   = nil;
+static struct hw_nb_pci_tree* cb_latest_tree = nil;
+static struct hw_nb_pci_tree* cb_last_tree   = nil;
 
 /// \brief Init the PCI device tree structure.
 /// \return if it already exists -> false
 /// Otherwise true.
 boolean cb_pci_init_tree(void) {
-  cb_base_tree = (struct hw_cb_pci_tree*) (NB_PCI_TREE_BASE);
+  cb_base_tree = (struct hw_nb_pci_tree*) (NB_PCI_TREE_BASE);
 
   // huh? anyway let's ignore it then.
   if (cb_base_tree->d_magic != NB_PCI_DEV_MAGIC) {
@@ -46,7 +46,7 @@ boolean cb_pci_init_tree(void) {
     cb_base_tree->d_off_struct   = 0;
     cb_base_tree->d_version      = NB_PCI_VERSION;
 
-    cb_base_tree->d_next_sibling = (cb_pci_num_t) (cb_base_tree + sizeof(struct hw_cb_pci_tree));
+    cb_base_tree->d_next_sibling = (cb_pci_num_t) (cb_base_tree + sizeof(struct hw_nb_pci_tree));
     cb_base_tree->d_first_node   = (cb_pci_num_t) cb_base_tree;
 
     cb_put_string(">> Append root device: " NB_PCI_ROOT_NAME "\r\n");
@@ -64,12 +64,12 @@ boolean cb_pci_init_tree(void) {
 boolean cb_pci_append_tree(const caddr_t name, cb_pci_num_t struct_ptr, cb_pci_num_t struct_sz) {
   if (!name || *name == 0 || cb_latest_tree == nil) return no;
 
-  struct hw_cb_pci_tree* cb_pci_tree = (struct hw_cb_pci_tree*) (cb_latest_tree);
+  struct hw_nb_pci_tree* cb_pci_tree = (struct hw_nb_pci_tree*) (cb_latest_tree);
 
   while (cb_pci_tree->d_magic == NB_PCI_DEV_MAGIC) {
     if (strcmp(cb_pci_tree->d_name, name) == 0) return no;
 
-    cb_pci_tree = (struct hw_cb_pci_tree*) (cb_pci_tree + sizeof(struct hw_cb_pci_tree));
+    cb_pci_tree = (struct hw_nb_pci_tree*) (cb_pci_tree + sizeof(struct hw_nb_pci_tree));
   }
 
   cb_pci_tree->d_magic = NB_PCI_DEV_MAGIC;
@@ -82,7 +82,7 @@ boolean cb_pci_append_tree(const caddr_t name, cb_pci_num_t struct_ptr, cb_pci_n
   cb_pci_tree->d_sz_props   = 0;
   cb_pci_tree->d_version    = NB_PCI_VERSION;
 
-  cb_pci_tree->d_next_sibling = (cb_pci_num_t) (cb_pci_tree + sizeof(struct hw_cb_pci_tree));
+  cb_pci_tree->d_next_sibling = (cb_pci_num_t) (cb_pci_tree + sizeof(struct hw_nb_pci_tree));
   cb_pci_tree->d_first_node   = (cb_pci_num_t) cb_latest_tree;
 
   cb_latest_tree = cb_pci_tree;
diff --git a/src/neboot-print-name.c b/src/neboot-print-name.c
index 90fe104..ae15373 100644
--- a/src/neboot-print-name.c
+++ b/src/neboot-print-name.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/neboot-start.c b/src/neboot-start.c
index 29a3389..4d0032a 100644
--- a/src/neboot-start.c
+++ b/src/neboot-start.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
@@ -18,7 +18,7 @@
 // @brief Start file // This is where the firmware starts it's initialization //
 // code. //
 
-// @author Amlal EL Mahrouss //
+// @author Amlal El Mahrouss //
 
 /////////////////////////////////////////////////////////////////////////////////////////
 
@@ -29,23 +29,23 @@ extern int cb_boot_processor_ready;
 
 /// @brief hardware thread counter (rv64 only)
 #ifdef __COMPILE_RISCV__
-uint64_t __cb_hart_counter = 0UL;
+uint64_t __nb_hart_counter = 0UL;
 #endif
 
 /// @brief Start executing the firmware.
 /// @param
 void cb_start_exec(void) {
 #ifndef __COMPILE_RISCV__
-  static uint64_t __cb_hart_counter = 0UL;
+  static uint64_t __nb_hart_counter = 0UL;
 #endif
 
-  ++__cb_hart_counter;
+  ++__nb_hart_counter;
 
-  uintptr_t hart = __cb_hart_counter;
+  uintptr_t hart = __nb_hart_counter;
 
   // let the hart 0 init our stuff.
   if (hart == 0) {
-    cb_put_string("CB> Welcome to NeBoot, (c) Amlal EL Mahrouss. Built the ");
+    cb_put_string("CB> Welcome to NeBoot, (c) Amlal El Mahrouss. Built the ");
     cb_put_string(__DATE__);
     cb_put_string("\r\r\n");
 
@@ -147,7 +147,7 @@ void cb_start_exec(void) {
   /// end of TODO
 
   while (yes) {
-    if (__cb_hart_counter == 0) {
+    if (__nb_hart_counter == 0) {
       cb_restart_machine();
     }
   }
diff --git a/src/neboot-string.c b/src/neboot-string.c
index 0c249a4..4ebe08a 100644
--- a/src/neboot-string.c
+++ b/src/neboot-string.c
@@ -1,17 +1,17 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
 /**
  * @file neboot-string.c
- * @author Amlal EL Mahrouss (amlal@nekernel.org)
+ * @author Amlal El Mahrouss (amlal@nekernel.org)
  * @brief string library.
  * @version 0.1
  * @date 2024-01-16
  *
- * @copyright Copyright (c) 2024 Amlal EL Mahrouss
+ * @copyright Copyright (c) 2024 Amlal El Mahrouss
  *
  */
 
diff --git a/src/ppc64/ppc64-err.c b/src/ppc64/ppc64-err.c
index 1ef0089..8cde319 100644
--- a/src/ppc64/ppc64-err.c
+++ b/src/ppc64/ppc64-err.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------

 

-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.

+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.

 

 ------------------------------------------- */

 

diff --git a/src/ppc64/ppc64-hal.c b/src/ppc64/ppc64-hal.c
index 993e5be..949d4fa 100644
--- a/src/ppc64/ppc64-hal.c
+++ b/src/ppc64/ppc64-hal.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------

 

-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.

+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.

 

 ------------------------------------------- */

 

diff --git a/src/ppc64/ppc64-uart.c b/src/ppc64/ppc64-uart.c
index 9830342..0176e60 100644
--- a/src/ppc64/ppc64-uart.c
+++ b/src/ppc64/ppc64-uart.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------

 

-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.

+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.

 

 ------------------------------------------- */

 

diff --git a/src/rv64/rv64-api.s b/src/rv64/rv64-api.s
index b4a0749..29ee302 100644
--- a/src/rv64/rv64-api.s
+++ b/src/rv64/rv64-api.s
@@ -1,7 +1,7 @@
 # ====================================
 #
-#   Amlal EL Mahrouss NeBoot
-#   (c) Amlal EL Mahrouss all rights reserved.
+#   Amlal El Mahrouss NeBoot
+#   (c) Amlal El Mahrouss all rights reserved.
 #
 #   Purpose: Assembler API for RISC-V
 #
diff --git a/src/rv64/rv64-boot.s b/src/rv64/rv64-boot.s
index a9afd02..c51a398 100644
--- a/src/rv64/rv64-boot.s
+++ b/src/rv64/rv64-boot.s
@@ -2,7 +2,7 @@
  *	========================================================
  *
  *	NeBoot
- * 	Copyright 2024, Amlal EL Mahrouss, all rights reserved.
+ * 	Copyright 2024, Amlal El Mahrouss, all rights reserved.
  *
  *  	Purpose: Startup code for RISC-V.
  *
@@ -33,7 +33,7 @@ cb_reset_vector:
 	.cfi_endproc
 
 cb_start_exec_asm:
-	lw t0, __cb_hart_counter
+	lw t0, __nb_hart_counter
 	lw t1, cb_boot_processor_ready
 
 	not t0, t0
@@ -110,5 +110,5 @@ cb_stack_list:
 cb_stack_align:
 	.word 0x8000
 
-__cb_max_harts:
+__nb_max_harts:
 	.word 2
diff --git a/src/rv64/rv64-err.c b/src/rv64/rv64-err.c
index a616d83..fb8f7f7 100644
--- a/src/rv64/rv64-err.c
+++ b/src/rv64/rv64-err.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */
 
diff --git a/src/rv64/rv64-uart.c b/src/rv64/rv64-uart.c
index 22b0793..c69d302 100644
--- a/src/rv64/rv64-uart.c
+++ b/src/rv64/rv64-uart.c
@@ -1,6 +1,6 @@
 /* -------------------------------------------
 
-  Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved.
+  Copyright (C) 2024, Amlal El Mahrouss, all rights reserved.
 
 ------------------------------------------- */