Tokyo OS

Tokyo OS is a hobby operating system written in C, aiming to explore and learn about operating system development. It currently supports basic features like framebuffer output, serial communication, Global Descriptor Table (GDT) and Interrupt Descriptor Table (IDT) setup, and simple printing functionality.

Features

• Framebuffer Output: Basic display functionality to render text on the screen.
• Serial Communication (COM1): Initialization and basic communication through the COM1 serial port.
• Global Descriptor Table (GDT): Setup of the GDT for memory segmentation.
• Interrupt Descriptor Table (IDT): Setup of the IDT for interrupt handling.
• Basic Printing: printf and writeSerial function for outputting text to the framebuffer and serial port.

Getting Started

Prerequisites

• A cross-compiler toolchain for x86_64 (x86_64-elf-gcc and x86_64-elf-ld available in your PATH).
• NASM assembler.
• xorriso for ISO image creation.
• Limine bootloader tools (installed and available in your PATH).
• QEMU or another emulator/virtual machine for testing.

On Arch Linux:

sudo pacman -S --needed nasm libisoburn limine qemu-desktop
yay -S x86_64-elf-binutils x86_64-elf-gcc

The x86_64-elf-* cross compiler packages are available from the AUR. The Makefile expects x86_64-elf-gcc and x86_64-elf-ld to be available in your PATH.

Building and Running

1. Clone the repository:

   git clone https://github.com/aayushkdev/tokyoOS.git
   cd tokyoOS

2. Build the ISO image:

   make

   This will:

   • Compile the C and assembly source files.
   • Link the object files into a kernel binary.
   • Create an ISO image (dist/tokyo.iso) with the kernel and Limine bootloader.
   • Install the Limine bootloader onto the ISO.

3. Run in QEMU:

   To run the generated ISO image in QEMU, use:

   make run

4. Debug in QEMU:

   To run the generated ISO image in QEMU with debug flags enabled, use:

   make debug run

5. Cleaning the build:

   To remove generated files, use:

   make clean