From 72df0de8cb579fd96449d19eb57fc71335907a19 Mon Sep 17 00:00:00 2001
From: Kimplul <kimi.h.kuparinen@gmail.com>
Date: Sun, 22 May 2022 23:35:02 +0300
Subject: add @file info to all files

+ Next step, start documenting contents of each file.
---
 arch/riscv64/kernel/cpu.c   | 5 +++++
 arch/riscv64/kernel/irq.c   | 5 +++++
 arch/riscv64/kernel/main.c  | 5 +++++
 arch/riscv64/kernel/pmem.c  | 5 +++++
 arch/riscv64/kernel/power.c | 5 +++++
 arch/riscv64/kernel/proc.c  | 5 +++++
 arch/riscv64/kernel/sbi.c   | 5 +++++
 arch/riscv64/kernel/timer.c | 5 +++++
 arch/riscv64/kernel/vmem.c  | 5 +++++
 9 files changed, 45 insertions(+)

(limited to 'arch/riscv64/kernel')

diff --git a/arch/riscv64/kernel/cpu.c b/arch/riscv64/kernel/cpu.c
index 3583a94..0558040 100644
--- a/arch/riscv64/kernel/cpu.c
+++ b/arch/riscv64/kernel/cpu.c
@@ -1,3 +1,8 @@
+/**
+ * @file cpu.c
+ * riscv64 implementation of cpu handling.
+ */
+
 #include <arch/cpu.h>
 
 id_t cpu_id()
diff --git a/arch/riscv64/kernel/irq.c b/arch/riscv64/kernel/irq.c
index fdcd21e..eb5dc02 100644
--- a/arch/riscv64/kernel/irq.c
+++ b/arch/riscv64/kernel/irq.c
@@ -1,3 +1,8 @@
+/**
+ * @file irq.c
+ * riscv64 implementation of irq handling.
+ */
+
 #include <apos/attrs.h>
 #include <apos/debug.h>
 #include <arch/irq.h>
diff --git a/arch/riscv64/kernel/main.c b/arch/riscv64/kernel/main.c
index 245fc9e..2cc1e12 100644
--- a/arch/riscv64/kernel/main.c
+++ b/arch/riscv64/kernel/main.c
@@ -1,3 +1,8 @@
+/**
+ * @file main.c
+ * riscv64 main
+ */
+
 #include <apos/utils.h>
 #include <arch/arch.h>
 #include <csr.h>
diff --git a/arch/riscv64/kernel/pmem.c b/arch/riscv64/kernel/pmem.c
index fc3fa40..0657244 100644
--- a/arch/riscv64/kernel/pmem.c
+++ b/arch/riscv64/kernel/pmem.c
@@ -1,3 +1,8 @@
+/**
+ * @file pmem.c
+ * riscv64 implementation of arch-specific physical memory handling
+ */
+
 #include <arch/pmem.h>
 
 stat_t stat_pmem_conf(void *fdt, size_t *max_order, size_t *base_bits,
diff --git a/arch/riscv64/kernel/power.c b/arch/riscv64/kernel/power.c
index a4d6568..061c286 100644
--- a/arch/riscv64/kernel/power.c
+++ b/arch/riscv64/kernel/power.c
@@ -1,3 +1,8 @@
+/**
+ * @file power.c
+ * riscv64 implementation of arch-specific power handling.
+ */
+
 #include <apos/power.h>
 #include <sbi.h>
 
diff --git a/arch/riscv64/kernel/proc.c b/arch/riscv64/kernel/proc.c
index 8653254..51a4ab3 100644
--- a/arch/riscv64/kernel/proc.c
+++ b/arch/riscv64/kernel/proc.c
@@ -1,3 +1,8 @@
+/**
+ * @file proc.c
+ * riscv64 implementation of arch-specific process handling.
+ */
+
 #include <apos/tcb.h>
 #include <apos/elf.h>
 #include <regs.h>
diff --git a/arch/riscv64/kernel/sbi.c b/arch/riscv64/kernel/sbi.c
index 93f5785..feadd8d 100644
--- a/arch/riscv64/kernel/sbi.c
+++ b/arch/riscv64/kernel/sbi.c
@@ -1,3 +1,8 @@
+/**
+ * @file sbi.c
+ * riscv64 specific OpenSBI handling.
+ */
+
 #include <sbi.h>
 
 struct sbiret sbi_ecall(int ext, int fid, unsigned long arg0,
diff --git a/arch/riscv64/kernel/timer.c b/arch/riscv64/kernel/timer.c
index 1f79c5b..98f8e16 100644
--- a/arch/riscv64/kernel/timer.c
+++ b/arch/riscv64/kernel/timer.c
@@ -1,3 +1,8 @@
+/**
+ * @file timer.c
+ * riscv64 implementation of arch-specific timers.
+ */
+
 #include <arch/timer.h>
 #include <libfdt.h>
 #include <csr.h>
diff --git a/arch/riscv64/kernel/vmem.c b/arch/riscv64/kernel/vmem.c
index 29bc084..56b04f3 100644
--- a/arch/riscv64/kernel/vmem.c
+++ b/arch/riscv64/kernel/vmem.c
@@ -1,3 +1,8 @@
+/**
+ * @file vmem.c
+ * riscv64 implementation of arch-specific virtual memory handling.
+ */
+
 #include <apos/string.h>
 #include <apos/pmem.h>
 #include <apos/vmem.h>
-- 
cgit v1.3