Major Structural Rewrite

Added
- ipxe iso image
- Kconfig files
- Modular Makefile system
- Qemu-specific shutdown driver
- Shutdown function in HAL
Changed
- Rewrote Multiboot code
- Modified Code Struture
- Changed build system entirely

Author: primis

.config

@@ -0,0 +1,51 @@
+#
+# Automatically generated file; DO NOT EDIT.
+# Apollo Kernel Configuration
+#
+CONFIG_ARCH=y
+
+#
+# Architectures
+#
+CONFIG_TARGET="x86"
+CONFIG_X86_BASE=y
+
+#
+# Drivers
+#
+
+#
+# Timekeeping
+#
+CONFIG_CLOCK_RTC_CMOS=y
+CONFIG_CLOCK_8254=y
+
+#
+# Base System Drivers
+#
+# CONFIG_QEMU_SHUTDOWN is not set
+CONFIG_CONSOLE=y
+
+#
+# Console Drivers
+#
+CONFIG_CONSOLE_VGA=y
+
+#
+# Serial Console Drivers
+#
+CONFIG_TTY_SERIAL_16550_UART=y
+
+#
+# IRQ Chips
+#
+CONFIG_IRQCHIP_8259=y
+CONFIG_LIBC=y
+
+#
+# Standard Library Functions
+#
+CONFIG_LIBC_MATH=y
+CONFIG_LIBC_STDIO=y
+CONFIG_LIBC_STRING=y
+# CONFIG_TESTING is not set

.gitignore

@@ -1,4 +1,5 @@
-# Gitignore file
+# User Setting files 
+.vscode*/
 
 # Prereq files
 *.d

CHANGELOG.md

@@ -4,6 +4,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.3] - 2022-04-40
+### Added
+- ipxe iso image 
+- Kconfig files
+- Modular Makefile system
+- Qemu-specific shutdown driver
+- Shutdown function in HAL
+### Changed
+- Rewrote Multiboot code
+- Modified Code Struture
+- Changed build system entirely
+
 ## [0.0.2] - 2018-12-12
 ### Added
 - MIT License tag for README.md

Kconfig

@@ -0,0 +1,9 @@
+mainmenu "Apollo Kernel Configuration"
+
+source "src/arch/Kconfig"
+
+source "src/drivers/Kconfig"
+
+source "src/libc/Kconfig"
+
+source "src/test/Kconfig"

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Apollo Developers <Allison Sargente et al.>
+Copyright (c) 2022 Apollo Developers <Allison Sargente et al.>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -3,13 +3,9 @@
 #############################
 .PHONY: all clean link
 
-
-
 # Git revision number
 GIT_REV		!= git rev-parse --short HEAD 2> /dev/null
 BUILD		:= build
-TARGETS		!= find . -maxdepth 1 -type f -name '*.mk'
-TARGETS		!= echo $(TARGETS) | sed -e 's/.mk//' -e 's/.\/target-//'
 
 # Documentation
 MDSOURCES	!= find docs -type f -name '*.md'
@@ -20,75 +16,55 @@ MDFLAGS		:= --from gfm --to html --standalone \
 HTMLDOCS	:= $(patsubst docs/%.md,$(HTMLDIR)/%.html,$(MDSOURCES))
 HTMLDIRS 	:= $(shell cd docs && find -type d | tr '\n' ' ')
 
-
-# Platform Agnostic Source Code
-CSOURCES_TI	!= find src/core src/libc src/adt -type f -name '*.c'
-
-# Third Party Source Code
-CSOURCES_TP	!= find src/third_party -type f -name '*.c'
-
-CSOURCES_TI	:= $(CSOURCES_TI) $(CSOURCES_TP)
-
-# Test Source Code
-TESTSOURCES != find src/test/core src/test/libc src/test/adt -type f -name '*.c'
-
 INCLUDEDIR	!= find src -type d -name "include" -printf "-I%p "
 
-all:
-
-ifndef TARGET
-	# Not a fatal error if clean or doc
-	ifeq($(MAKECMDGOALS),clean)
-	else ifeq ($(MAKECMDGOALS),doc)
-	else
-		$(error TARGET is not set, availible targets: $(TARGETS))
-endif
-
-TARGETL		!= echo $(TARGET) | tr '[:upper:]' '[:lower:]'
-
-ifdef TARGET
-	BUILD 	:= build-$(TARGETL)
--include target-$(TARGETL).mk
-endif
-
-COBJECTS	:= $(patsubst %.c,$(BUILD)/%.c.o,$(CSOURCES))
-SOBJECTS	:= $(patsubst %.s,$(BUILD)/%.s.o,$(SSOURCES))
-TESTOBJECTS	:= $(patsubst %.c,$(BUILD)/%.c.o,$(TESTSOURCES))
-SRCDIR		!= find src/ -type d | tr '\n' ' '
+include .config
+TARGETL		!= echo $(CONFIG_TARGET) | tr '[:upper:]' '[:lower:]'
+BUILD 		:= build-$(TARGETL)
+include $(shell pwd)/scripts/target-$(TARGETL).mk
 
 WARNINGS	:= -Wall -Wextra -Wno-unused-parameter
 DEFS		:= $(INCLUDEDIR) -fbuiltin -DGITREV="\"$(GIT_REV)\""
 
+HELPER_MK	:= $(shell pwd)/scripts/helper.mk
+MK_FLAGS	:= --no-print-directory -s
+SUBDIRS		:= $(shell find . -name Makefile)
+SUBDIRS		:= $(patsubst %Makefile,%,$(SUBDIRS))
+SUBDIRS	 	:= $(patsubst %./,%,$(SUBDIRS))
+OBJECTS		:= $(shell for dir in $(SUBDIRS); do\
+				 TOP_DIR=`pwd` $(MAKE) $(MK_FLAGS) -f $(HELPER_MK) -C $$dir;\
+				 done;)
+
+ifeq ($(CONFIG_TESTING),y)
+	DEFS	+= -DTEST_HARNESS=1
+	BIN		:= test-$(BIN)
+endif
 
+OBJECTS		:= $(patsubst %.o,$(BUILD)/%.o,$(OBJECTS))
+SRCDIR		!= find src/ -type d | tr '\n' ' '
 
-all: test link doc
+all: link doc
 
 # C files are compiled universally the same, assembler targets are defined in
 # The target specific makefiles
 $(BUILD)/%.c.o: %.c Makefile | setup_builddir
 	@printf "\033[1mCC\033[0m   $<\n"
 	@$(CC) -c $< -o $@ $(DEFS) $(TARGET_DEFS) $(WARNINGS)
 
-link: $(SOBJECTS) $(COBJECTS)
+link: $(OBJECTS)
 	@printf "\033[1mLINK\033[0m $@\n"
 	@$(CC) $(DEFS) $(WARNINGS) $(LDFLAGS) $(TARGET_LDFLAGS) \
-	-o bin/$(BIN) $(SOBJECTS) $(COBJECTS)
+	-o bin/$(BIN) $(OBJECTS)
 
 setup_builddir:
 	@mkdir -p $(BUILD)
 	@cd $(BUILD) && mkdir -p `echo $(SRCDIR)`
 
 clean:
 	@printf "\033[1mCLEAN\033[0m \n"
-	@find $(BUILD) -type f -name '*.o' -exec rm {} +
+	@find . -type d -name "build*" -exec rm -rf {} +
 	@find $(HTMLDIR) -type f -exec rm {} +
 
-test: DEFS += -DTEST_HARNESS=1
-test: $(SOBJECTS) $(COBJECTS) $(TESTOBJECTS)
-	@printf "\033[1mLINK TEST\033[0m $0\n"
-	@$(CC) $(DEFS) $(WARNINGS) $(LDFLAGS) $(TARGET_LDFLAGS) \
-	-o bin/test-$(BIN) $(SOBJECTS) $(COBJECTS) $(TESTOBJECTS)
-
 doc_setup:
 	@mkdir -p $(HTMLDIR)
 	@cd $(HTMLDIR) && mkdir -p $(HTMLDIRS)
@@ -98,3 +74,6 @@ doc: doc_setup | $(HTMLDOCS)
 html/%.html: docs/%.md
 	@printf "\033[1mHTML\033[0m $<\n"
 	@$(MARKDOWN) $(MDFLAGS) $< --output $@
+
+menuconfig:
+	@kconfig-mconf Kconfig

README.md

@@ -1,13 +1,16 @@
 ### The Apollo Project
-_(C) 2013 - 2021 Primis Computers (Allie Sargente et al)_
+_(C) 2013 - 2022 Primis Computers (Allie Sargente et al)_
 ![](https://img.shields.io/apm/l/vim-mode.svg)
 
 Requirements:
 =================================================
 This is a kernel project for x86 Hardware. Current compilation needs:
 * GNU Make (Or Compatible)
 * NASM, The Netwide Assembler
-* GCC
+* GCC (cross compiler heavily suggested, such as i586-elf-gcc)
+
+Optionally, for customizing builds, any application capable of reading Kconfig
+files will work. If on debian based systems, the package `kconfig-frontends` is suggested.
 
 The kernel is written in X86-Assembly and ANSI-C. We are currently working
 on making it as portable as possible.
@@ -27,12 +30,30 @@ The API is in a state of flux. If developing applications, stick to
 functions from the standard c library. All others may be depreciated /
 removed without notice.
 
+Running
+=================================================
+The best way to run latest is to use the ipxe images. 
+These should work on any VM/PC with a network card and
+will load the latest kernel from kernel.primis.org
+You can also load x86-sys.mod from any multiboot
+compatible bootloader such as GRUB.
+
+Building
+=================================================
+Once all the pre-requisites software has been aquired,
+you can build a kernel simply by typing `make`. The make
+file defaults to x86 with most of the features set.
+To customize features you can either directly edit the
+`.config` file in the root directory of the project, or
+you can run `make menuconfig` if you have `kconfig-frontends`
+or it's equivilent package installed on your distro.
+
 History:
 =================================================
 This kernel descends from several failed kernel projects;
-* ScorchOS; by Bob Moss and Nicholas Sargente. Circa 2010
-* Mercury/SaturnOS; by Brandon Cornell and Nicholas Sargente. Circa 2012
-* Apollo Kernel Project; Circa 2009-2011. Nicholas Sargente.
+* ScorchOS; by Bob Moss and Allie Sargente. Circa 2010
+* Mercury/SaturnOS; by Brandon Cornell and Allie Sargente. Circa 2012
+* Apollo Kernel Project; Circa 2009-2011. Allie Sargente.
 
 This kernel takes base code from Bkerndev and James Molloy's Tutorials:
 * http://www.osdever.net/bkerndev/Docs/title.htm

bin/hosted-sys.mod

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:91f0719f1cd7ce36f5017fc7e76d96176a8ecf83a22664383d8166d1cf94b2d3
-size 47416
+oid sha256:ce65efe55cad543fd615919645c1e00f1bceffec9d3b6e3eab7e0016c29fbc02
+size 34704

bin/ipxe.iso

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:926a41938b9d4a859f2401d967e503b192f5d6152f640cc708b10f462619cb0e
+size 56440

bin/test-hosted-sys.mod

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:881d8057cbecdaf83834a4fb16bf4daf8937dc38c52f5415812bac6780a7a78c
-size 78272
+oid sha256:3344766812619e1b21fe06877e6e8c87755c6f14f0511f8d682e7e0125486802
+size 73548

bin/test-x86-sys.mod

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:c8560c0fe662f184e717ba162d1a2194fc041c1fd84ae8e276f239a894b15d4a
-size 68196
+oid sha256:f97156d6ab230840fd73cc35a168b3cf46d9e47920bf3da71580b459ee66e7d3
+size 56512

bin/x86-sys.mod

@@ -0,0 +1,15 @@
+include $(TOP_DIR)/.config
+include Makefile
+
+CUR_DIR		:= $(shell pwd)
+CUR_DIR		:= $(patsubst $(TOP_DIR)/%,./%, $(CUR_DIR))
+
+ifeq ($(CONFIG_TESTING),y)
+	obj_y 	+= $(test_y) 
+endif
+
+obj_y		:= $(patsubst %.c,$(CUR_DIR)/%.c.o,$(obj_y))
+obj_y		:= $(patsubst %.s,$(CUR_DIR)/%.s.o,$(obj_y))
+
+all:
+	@echo $(obj_y)

scripts/helper.mk

@@ -2,6 +2,5 @@
 
 BIN			:= hosted-sys.mod
 TARGET_DEFS	:= -DHOSTED=1
-CSOURCES	:= $(shell find src/arch/hosted -type f -name "*.c") $(CSOURCES_TI)
 
 # That's it!

target-hosted.mk scripts/target-hosted.mk

@@ -1,6 +1,6 @@
 # Makefile for Apollo Project
 # Target is x86
-# Copyright 2018 Apollo Developers
+# Copyright 2022 Apollo Developers
 
 
 # Check for different Cross compilers in reverse order
@@ -18,16 +18,11 @@ TARGET_LDFLAGS	:= -m32 -Tsrc/arch/x86/x86-link.ld -nostdlib -n
 $(warning Using default GCC, please consider installing a cross compiler!)
 endif
 
-
-
 BIN				:= x86-sys.mod
 AS				:= nasm
 ASFLAGS			:= -felf -dGITREV="'$(GIT_REV)'"
 TARGET_DEFS 	:= -DX86=1 -m32 -masm=intel -ffreestanding -nostdlib	
 TARGET_LDFLAGS	?= -m32 -Tsrc/arch/x86/x86-link.ld -nostdlib -lgcc -n
-CSOURCES	:= $(shell find src/arch/x86 -type f -name "*.c") $(CSOURCES_TI)
-SSOURCES 	:= $(shell find src/arch/x86 -type f -name "*.s") $(SSOURCES_TI)
-TESTSOURCES += $(shell find src/test/arch/x86 -type f -name "*.c")
 
 $(BUILD)/%.s.o: %.s | setup_builddir
 	@printf "\033[1mAS\033[0m   $<\n"

target-x86.mk scripts/target-x86.mk

@@ -0,0 +1,7 @@
+##############################
+# Apollo Project             #
+# ADT Code Makefile          #
+# (c) 2022 Apollo Developers #
+##############################
+
+obj_y := buddy.c bitmap.c ringbuf.c

src/adt/Makefile

@@ -0,0 +1,7 @@
+##############################
+# Apollo Project             #
+# ADT Test Makefile          #
+# (c) 2022 Apollo Developers #
+##############################
+
+test_y := test_ringbuf.c

src/adt/testing/Makefile

@@ -26,5 +26,4 @@ TEST(ringbuf_test, readWriteTest)
     char_ringbuf_write(&test_buf, "Hello", 6);
     char_ringbuf_read(&test_buf, buff2, 6);
     TEST_ASSERT_EQUAL_STRING("Hello", buff2);
-}
-
+}