The Kernel of Erlends Operating System

Welcome to the documentation site for the Operating System (OS) Kernel. The pages found here documents kernel architecture, functions and features. Use the table of contents below to navigate. If this is your first time here and you intend to contribute to the project, you shold make certain you have read everything in the "Features" and "Contributing" categories. These chapters will introduce you to the OS and how things work (APIs, repositories, building etc.).

If you have any questions that cannot be answered by this wiki, feel free to ask a question in one of the Slack groups. Not only will you get answers, you will also help filling any holes in the documentation.

Table of Contents

• Features
  • Feature Overview
  • Separation of kernel- and userspace
  • Memory and Memory Allocation
  • Multitasking
  • Loading Executables at Runtime
  • Signals
  • Virtual File System
• Hardware Requirements
  • General Hardware Requirements
• Contributing
  • Git Workflow
  • Code Standards
  • Documenting Your Code
  • Writing a User Program
  • OOP in C
• Operating System Architecture
  • Architecture Overview
• Subsystems
  • Userspace Networking (usn)
  • RS422 Networking (enet)
  • DevFS (/dev)
  • KernelFS (/kfs)
  • PipeFS (/pipe)
  • ProcFS (/proc)
• Application Binary Interface (ABI)
  • Basic File Operations
  • open
  • close
  • read
  • write
  • ioctl/fcntl
  • Extended File Operations
  • lseek
  • fstat
  • File System Operations
  • stat
  • link
  • unlink
  • rename
  • mkdir
  • opendir
  • closedir
  • readdir
  • statvfs
  • Mount and Unmount Operations
  • mount
  • unmount
  • Process Operations for the Current Process
  • exit
  • getpid
  • signal
  • trampoline (Internal use only)
  • getcwd
  • chdir
  • dup2
  • yield
  • getpgrp
  • setpgid
  • Time and Timing Operations
  • times (Not implemented)
  • nanosleep
  • gettimeofday
  • Process Operations on Other Processes
  • posix_spawn
  • waitpid
  • kill
  • Socket Operations
  • bind
  • recvfrom
  • sendto
  • socket
  • listen To be written
  • accept To be written
  • connect To be written
  • sockopt To be written
  • sockmisc To be written
  • netdb To be written
  • Scheduling
  • sched Contains the following functions: sched_get_priority_max sched_get_priority_min sched_getparam sched_getscheduler sched_rr_get_interval sched_setparam sched_setscheduler sched_yield
  • Memory Management
  • memman Contains the following functions: mmap munmap
• Drivers
  • can To be written
  • dma
  • fbcon To be written
  • flash To be written
  • gpio
  • i2c To be written
  • i2s To be written
  • ir To be written
  • lcd To be written
  • led To be written
  • net To be written
  • null
  • pwm To be written
  • raid
  • ramdisk To be written
  • rtc To be written
  • sdio To be written
  • spi To be written
  • sys
  • touch To be written
  • tty To be written
  • vol To be written
  • ws2811 To be written
• Core Utilities
  • cat
  • cp
  • date
  • df
  • echo
  • free
  • grep
  • kill
  • ls
  • mkdir
  • mkfifo
  • mount
  • mv
  • nano
  • pwd
  • rm
  • rmdir
  • save
  • sh
  • sleep
  • top
  • umount
  • ush