[Refactor] SCIKit and DDKit.

[IMP} Prevent DDK from being included when we aren't in kernel mode.

Signed-off-by: Amlal EL Mahrouss <amlalelmahrouss@icloud.com>

16 files changed, 425 insertions, 0 deletions

diff --git a/DDKit/DispatchKernelCall.S b/DDKit/DispatchKernelCall.S
new file mode 100644
index 00000000..b6ce8004
--- /dev/null
+++ b/DDKit/DispatchKernelCall.S
@@ -0,0 +1,36 @@
+/**
+ lang: asm
+ compiler: gnu
+ */
+
+.globl __kernelCallDispatch
+
+.text
+
+/* Really simple function, takes our va-list,
+    and brings it to the trap handler in the kernel. */
+
+#ifdef __DDK_AMD64__
+
+/* args rcx, rdx, r8, r9 */
+__kernelCallDispatch:
+    int $0x33
+    ret
+
+#elif defined(__DDK_POWER64__)
+
+/* args r8, r9, r10, r11 */
+__kernelCallDispatch:
+    /* There is no specific interrupt request id for a system call in POWER. */
+    sc
+    blr
+
+#elif defined(__DDK_ARM64__)
+
+/* args x0, x8, x9, x10, x11 is kept to tell that this is a kernel call */
+__kernelCallDispatch:
+    /* There is no specific interrupt request id for a system call in ARM64 as well. */
+    mov x11, #0x33
+    svc #0
+
+#endif
diff --git a/DDKit/KernelAlloc.c b/DDKit/KernelAlloc.c
new file mode 100644
index 00000000..f1044324
--- /dev/null
+++ b/DDKit/KernelAlloc.c
@@ -0,0 +1,34 @@
+/* -------------------------------------------
+
+    Copyright ZKA Technologies
+
+    Purpose: DDK allocator.
+
+------------------------------------------- */
+
+#include <DDKit/KernelStd.h>
+
+/**
+    \brief Allocates a new heap on the kernel's side.
+    \param sz the size of the heap block.
+    \return the newly allocated pointer.
+*/
+DK_EXTERN void* kernelAlloc(size_t sz)
+{
+    if (!sz) ++sz;
+
+	void* ptr = kernelCall("NewHeap", 1, &sz, sizeof(size_t));
+
+    return ptr;
+}
+
+/**
+    \brief Frees a pointer from the heap.
+    \param ptr the pointer to free.
+*/
+DK_EXTERN void kernelFree(void* ptr)
+{
+    if (!ptr) return;
+
+	kernelCall("DeleteHeap", 1, ptr, 0);
+}
diff --git a/DDKit/KernelCall.c b/DDKit/KernelCall.c
new file mode 100644
index 00000000..fb29fc6a
--- /dev/null
+++ b/DDKit/KernelCall.c
@@ -0,0 +1,36 @@
+/* -------------------------------------------
+
+	Copyright ZKA Technologies
+
+	Purpose: DDK kernel call.
+
+------------------------------------------- */
+
+#include <DDKit/KernelStd.h>
+#include <stdarg.h>
+
+/// @brief this is an internal call, do not use it.
+DK_EXTERN __attribute__((naked)) void* __kernelCallDispatch(const char* name, int32_t cnt, void* data, size_t sz);
+
+/// @brief Interupt kernel
+/// @param kernelRpcName RPC name
+/// @param cnt number of elements in **data** pointer.
+/// @param data data pointer.
+/// @param sz The size of the whole data pointer.
+/// @retval void* kernel call was successful.
+/// @retval nil kernel call failed, call kernelLastError(void)
+DK_EXTERN void* kernelCall(const char* kernelRpcName, int32_t cnt, void* data, size_t sz)
+{
+	if (!kernelRpcName || cnt == 0)
+		return nil;
+
+	return __kernelCallDispatch(kernelRpcName, cnt, data, sz);
+}
+
+/// @brief Add system call.
+/// @param slot system call slot
+/// @param slotFn, syscall slot.
+DK_EXTERN void kernelAddSyscall(const int slot, void (*slotFn)(void* a0))
+{
+	kernelCall("AddSyscall", slot, slotFn, 0);
+}
diff --git a/DDKit/KernelCxxRt.cxx b/DDKit/KernelCxxRt.cxx
new file mode 100644
index 00000000..93980532
--- /dev/null
+++ b/DDKit/KernelCxxRt.cxx
@@ -0,0 +1,29 @@
+/* -------------------------------------------
+
+    Copyright ZKA Technologies
+
+    Purpose: DDK C++ runtime.
+
+------------------------------------------- */
+
+#include <DDKit/KernelStd.h>
+
+void* operator new(size_t sz)
+{
+    return kernelAlloc(sz);
+}
+
+void operator delete(void* ptr)
+{
+    kernelFree(ptr);
+}
+
+void* operator new[](size_t sz)
+{
+    return kernelAlloc(sz);
+}
+
+void operator delete[](void* ptr)
+{
+    kernelFree(ptr);
+}
diff --git a/DDKit/KernelDev.c b/DDKit/KernelDev.c
new file mode 100644
index 00000000..d0c7570d
--- /dev/null
+++ b/DDKit/KernelDev.c
@@ -0,0 +1,29 @@
+/* -------------------------------------------
+
+	Copyright ZKA Technologies
+
+	Purpose: DDK Text I/O.
+
+------------------------------------------- */
+
+#include <DDKit/KernelDev.h>
+#include <DDKit/KernelString.h>
+
+/// @brief Open a new binary device from path.
+DK_EXTERN kernelDeviceRef kernelOpenDevice(const char* devicePath)
+{
+	if (!devicePath)
+		return nil;
+
+	return kernelCall("OpenDevice", 1, (void*)devicePath, kernelStringLength(devicePath));
+}
+
+/// @brief Close any device.
+/// @param device valid device.
+DK_EXTERN void kernelCloseDevice(kernelDeviceRef device)
+{
+	if (!device)
+		return;
+
+	kernelCall("CloseDevice", 1, device, sizeof(kernelDevice));
+}
diff --git a/DDKit/KernelDev.h b/DDKit/KernelDev.h
new file mode 100644
index 00000000..4e640d9d
--- /dev/null
+++ b/DDKit/KernelDev.h
@@ -0,0 +1,32 @@
+/* -------------------------------------------
+
+	Copyright ZKA Technologies
+
+	Purpose: DDK Devices.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <DDKit/KernelStd.h>
+
+struct _kernelDevice;
+
+/// @brief Kernel Device driver.
+typedef struct _kernelDevice
+{
+	char name[255];					   // the device name. Could be /./DEVICE_NAME/
+	void* (*read)(void* arg, int len); // read from device.
+	void (*write)(void* arg, int len);
+	void (*wait)(void);								 // write to device.
+	struct _kernelDevice* (*open)(const char* path); // open device.
+	void (*close)(struct _kernelDevice* dev);		 // close device.
+} kernelDevice, *kernelDeviceRef;
+
+/// @brief Open a new device from path.
+/// @param devicePath the device's path.
+DK_EXTERN kernelDeviceRef kernelOpenDevice(const char* devicePath);
+
+/// @brief Close any device.
+/// @param device valid device.
+DK_EXTERN void kernelCloseDevice(kernelDeviceRef device);
diff --git a/DDKit/KernelPrint.c b/DDKit/KernelPrint.c
new file mode 100644
index 00000000..b7e20d24
--- /dev/null
+++ b/DDKit/KernelPrint.c
@@ -0,0 +1,37 @@
+/* -------------------------------------------
+
+	Copyright ZKA Technologies
+
+	Purpose: DDK Text I/O.
+
+------------------------------------------- */
+
+#include <DDKit/KernelPrint.h>
+
+DK_EXTERN void kernelPrintChar(const char ch)
+{
+	char assembled[2] = {0};
+	assembled[0]	  = ch;
+	assembled[1]	  = 0;
+
+	kernelCall("WriteCharacter", 1, assembled, 1);
+}
+
+/// @brief print string to UART.
+/// @param message UART to transmit.
+DK_EXTERN void kernelPrintStr(const char* message)
+{
+	if (!message)
+		return;
+	if (*message == 0)
+		return;
+
+	size_t index = 0;
+	size_t len	 = kernelStringLength(message);
+
+	while (index < len)
+	{
+		kernelPrintChar(message[index]);
+		++index;
+	}
+}
diff --git a/DDKit/KernelPrint.h b/DDKit/KernelPrint.h
new file mode 100644
index 00000000..0556923a
--- /dev/null
+++ b/DDKit/KernelPrint.h
@@ -0,0 +1,18 @@
+/* -------------------------------------------
+
+	Copyright ZKA Technologies
+
+	Purpose: DDK Text I/O.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <DDKit/KernelString.h>
+
+/// @brief print character into UART.
+DK_EXTERN void kernelPrintChar(const char ch);
+
+/// @brief print string to UART.
+/// @param message string to transmit to UART.
+DK_EXTERN void kernelPrintStr(const char* message);
diff --git a/DDKit/KernelStd.h b/DDKit/KernelStd.h
new file mode 100644
index 00000000..bdd8ce3d
--- /dev/null
+++ b/DDKit/KernelStd.h
@@ -0,0 +1,67 @@
+/* -------------------------------------------
+
+	Copyright ZKA Technologies
+
+	Purpose: DDK Definitions.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <stdint.h>
+#include <stddef.h>
+
+#if defined(__cplusplus)
+#define DK_EXTERN extern "C"
+#define nil		  nullptr
+#define DK_FINAL final
+#else
+#define DK_EXTERN extern
+#define nil		  ((void*)0)
+#define DK_FINAL
+#endif // defined(__cplusplus)
+
+#ifndef __KERNEL__
+#error !!! including header in kernel mode !!!
+#endif // __KERNEL__
+
+struct DDK_STATUS_STRUCT;
+
+/// \brief DDK status structure (__at_enable, __at_disable...)
+struct DDK_STATUS_STRUCT DK_FINAL
+{
+	int32_t action_id;
+	int32_t issuer_id;
+	int32_t group_id;
+};
+
+/// @brief Call kernel (interrupt 0x33)
+/// @param kernelRpcName
+/// @param cnt number of elements in **dat**
+/// @param dat data ptr
+/// @param sz sz of whole data ptr.
+/// @return result of call
+DK_EXTERN void* kernelCall(const char* kernelRpcName, int32_t cnt, void* dat, size_t sz);
+
+/// @brief add system call.
+/// @param slot system call slot
+/// @param slotFn, syscall slot.
+DK_EXTERN void kernelAddSyscall(const int slot, void (*slotFn)(void* a0));
+
+/// @brief allocate heap ptr.
+/// @param sz size of ptr.
+/// @return the pointer allocated or **nil**.
+DK_EXTERN void* kernelAlloc(size_t sz);
+
+/// @brief free heap ptr.
+/// @param pointer to free
+DK_EXTERN void kernelFree(void*);
+
+/// @brief The highest API version of the DDK.
+DK_EXTERN int32_t c_api_version_highest;
+
+/// @brief The lowest API version of the DDK.
+DK_EXTERN int32_t c_api_version_least;
+
+/// @brief c_api_version_least+c_api_version_highest combined version.
+DK_EXTERN int32_t c_api_version;
\ No newline at end of file
diff --git a/DDKit/KernelString.c b/DDKit/KernelString.c
new file mode 100644
index 00000000..3ef65cf2
--- /dev/null
+++ b/DDKit/KernelString.c
@@ -0,0 +1,39 @@
+/* -------------------------------------------
+
+	Copyright ZKA Technologies
+
+	Purpose: DDK Strings.
+
+------------------------------------------- */
+
+#include <DDKit/KernelString.h>
+
+DK_EXTERN size_t kernelStringLength(const char* in)
+{
+	if (in == nil)
+		return 0;
+	if (*in == 0)
+		return 0;
+
+	size_t index = 0;
+
+	while (in[index] != 0)
+	{
+		++index;
+	}
+
+	return index;
+}
+
+DK_EXTERN int kernelStringCopy(char* dst, const char* src, size_t len)
+{
+	size_t index = 0;
+
+	while (index != len)
+	{
+		dst[index] = src[index];
+		++index;
+	}
+
+	return index;
+}
diff --git a/DDKit/KernelString.h b/DDKit/KernelString.h
new file mode 100644
index 00000000..07d33c7e
--- /dev/null
+++ b/DDKit/KernelString.h
@@ -0,0 +1,17 @@
+/* -------------------------------------------
+
+	Copyright ZKA Technologies
+
+	Purpose: DDK Strings.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <DDKit/KernelStd.h>
+
+/// @brief DDK equivalent of POSIX's string.h
+/// @file kernelString.h
+
+DK_EXTERN size_t kernelStringLength(const char* in);
+DK_EXTERN int	 kernelStringCopy(char* dst, const char* src, size_t len);
diff --git a/DDKit/KernelVersion.c b/DDKit/KernelVersion.c
new file mode 100644
index 00000000..0f27d345
--- /dev/null
+++ b/DDKit/KernelVersion.c
@@ -0,0 +1,21 @@
+/* -------------------------------------------

+

+	Copyright ZKA Technologies

+

+	Purpose: DDK versioning.

+

+------------------------------------------- */

+

+#include <KernelStd.h>

+

+#ifndef cDDKVersionHighest

+#define cDDKVersionHighest 1

+#endif // cDDKVersionHighest

+

+#ifndef cDDKVersionLowest

+#define cDDKVersionLowest 1

+#endif // cDDKVersionLowest

+

+int32_t c_api_version_highest = cDDKVersionHighest;

+int32_t c_api_version_least = cDDKVersionLowest;

+int32_t c_api_version = cDDKVersionHighest | cDDKVersionLowest;
\ No newline at end of file
diff --git a/DDKit/ReadMe.md b/DDKit/ReadMe.md
new file mode 100644
index 00000000..cde81cf7
--- /dev/null
+++ b/DDKit/ReadMe.md
@@ -0,0 +1,9 @@
+# DDK (Device Driver Kit)
+
+A kit used to write kernel HALs, using the NDK compiler suite.
+
+## How to use it
+
+Simply link against libDDK.
+
+###### Copyright 2024 ZKA Technologies, all rights reserved.
diff --git a/DDKit/compile_flags.txt b/DDKit/compile_flags.txt
new file mode 100644
index 00000000..48dfa8fe
--- /dev/null
+++ b/DDKit/compile_flags.txt
@@ -0,0 +1,2 @@
+-std=c17
+-I../
diff --git a/DDKit/source_deploy.xml b/DDKit/source_deploy.xml
new file mode 100644
index 00000000..6a03fdf8
--- /dev/null
+++ b/DDKit/source_deploy.xml
@@ -0,0 +1,5 @@
+<SourceDeploy>

+<HiddenFiles>

+    <SourceFile>*.cxx, *.c, *.S</SourceFile>

+</HiddenFiles>

+</SourceDeploy>

diff --git a/DDKit/x86_64.make b/DDKit/x86_64.make
new file mode 100644
index 00000000..f261d432
--- /dev/null
+++ b/DDKit/x86_64.make
@@ -0,0 +1,14 @@
+##################################################

+# (C) ZKA Technologies, all rights reserved.

+# This is the DDK's makefile.

+##################################################

+

+CC=x86_64-w64-mingw32-gcc

+INC=-I./ -I../

+FLAGS=-ffreestanding -shared -std=c17 -std=c++20 -D__KERNEL__ -fno-rtti -fno-exceptions -D__DDK_AMD64__ -Wl,--subsystem=17

+VERSION=-DcDDKVersionLowest=1 -DcDDKVersionHighest=1

+OUTPUT=libDDK.so

+

+.PHONY: x86_64-build

+x86_64-build:

+	$(CC) $(INC) $(FLAGS) $(VERSION) $(wildcard *.c) $(wildcard *.S) $(wildcard *.cxx) -o $(OUTPUT)
\ No newline at end of file