summaryrefslogtreecommitdiff
path: root/README.md
blob: ee84a1ef524c5b81a9723b384552e2720ef82a3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
Welcome to FoolOS
=================

![FoolOS Logo](https://gitweb.softwarefools.com/?p=miguel/fool-os.git;a=blob_plain;f=img/logo.png;hb=HEAD)

Abstract
--------
Welcome to the Home of the worlds most useless operating system.

Quick-start
-----------
Simply boot from the __FoolOS.iso__ in your favourite emulator 
or __dd__ to an USB stick and test on real hardware. 

Features
--------

* Booting with Multiboot (e.g. GRUB 2)
* 32-bit protected mode
* Logging to COM1
* Parsing ACPI and Multiboot Data (partly)
* Symmetrical Multiprocessing with LAPIC and IOAPIC
* APIC and PIT Timers
* Seperate GDT and IVT for each CPU
* Paging / Virtual Memory
* RAM image (ext2 read-only)
* Standard streams (stdin/stdout/stderr)
* Mouse and Keyboard support
* Multithreading & Multitasking
* Kernel and Userspace Tasks
* CPU Private Memory 
* Support for ELF binaries.
* IRQ Handling Framework
* Finegrained Spinlocks
* Superfast Task Scheduler
* PCI Bus scanning
* VESA Framebuffer with fallback to a text-only terminal
* C-library for Userspace (Newlib)
* Simple FoolShell
* Snake Game
* Ships with other useless userspace software

_Please note that most features are only very rudimentary and mostly buggy._

Multiboot
---------
The FoolOS Kernel is following the Multiboot Specification (0.6.96) 
providing a multiboot header and the entry point _start().

This in turn calls the C function kernel_main().

Building
--------

You should at least setup a gcc cross-compiler and setup newlib to
build FoolOS yourself.

GCC CROSS-COMPILER (i686-elf)

    https://wiki.osdev.org/GCC_Cross-Compiler (18 AUG 2018)
    ftp://ftp.fu-berlin.de/unix/languages/gcc/releases/gcc-8.2.0/gcc-8.2.0.tar.gz
    https://sunsite.icm.edu.pl/pub/gnu/binutils/binutils-2.31.1.tar.gz

NEWLIB

    https://wiki.osdev.org/Porting_Newlib (18 AUG 2018)
    ftp://sourceware.org/pub/newlib/newlib-3.0.0.20180802.tar.gz
    https://ftp.gnu.org/gnu/autoconf/autoconf-2.68.tar.gz
    https://ftp.gnu.org/gnu/automake/automake-1.11.6.tar.gz


Supported Platforms
-------------------
__TODO: update/recheck__

FoolOS is tested/developed on the following emulators/machines

* bochs 2.6.6 (compiled with: ./configure --enable-clgd54xx --enable-a20-pin --enable-debugger --enable-disasm --enable-e1000 --with-x --with-x11 --with-term --enable-smp) (add -lpthread to LIBS in the Makefile!)
* bochs 2.6.8 (compiled with: ./configure --enable-clgd54xx --enable-a20-pin --enable-debugger --enable-disasm --enable-e1000 --with-x --with-x11 --with-term --enable-smp) (add -lpthread to LIBS in the Makefile!)
* qemu 1.1.2
* virtual box 4.1.18
* Acer Aspire 1810TZ (Notebook)
* Q6600 on Asus p5n32-e sli plus (Desktop PC)
* 4790K on Asus (Desktop PC)

Todos
-----

* Cleanup Virtual Memory Manager / Flush TLB (?)
* Mouse & KB processing in seperate task.
* Kernel Stuff Reent?
* Posix getdents and cleanup syscalls
* Writing to ext2 RAM-image
* Mutexes

* GCC optimizations (break kernel?)

* Ethernet driver E1000 / NS2000 & Networking stack (ipxe network drivers?)

* Unit Testing

* GUI / Window Manager (update\_rect, etc..)
* Porting (ncurses, gcc, binutils, vim, apache...)

Disclaimer
----------

THIS IS A WORK IN PROGRESS.

This is a simple and useless "operating system", with a very basic set 
of features. It is the fruit of my fundamental explorations of the x86 
architecture and operating system design.

Copyright M.Idziorek 2014-2015,2018 <m.i@gmx.at> unless stated otherwise.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.