modify README.md

This commit is contained in:
krolxon 2026-01-08 21:48:29 +05:30
parent 467ec78e89
commit 5d34df5e38
1 changed files with 72 additions and 29 deletions

101
README.md
View File

@ -1,10 +1,46 @@
# 8-Bit CPU Emulator # 8-Bit CPU Emulator
## CPU Architecture This project is an educational 8-bit CPU emulator written in Rust, it's build to understand core computer architecture concepts such as instruction sets, flags,
- Word Size control flow, stacks and system calls.
- **Data Width:** 8 bits
- **Address width:** 16 bits This project is **not** a production CPU and **not** accurate. It is designed purely for learning and experimentation.
- **Address space:** 64 KB (0x0000-0xFFFF)
-----
## Features
- Custom 8-bit ISA (control-flow and arithmetic operations)
- 4 general-purpose registers
- 64 KB (0x0000-0xFFFF) byte-addressable memory
- Two-pass assembler with label support
- Stack-based function calls
- Stack is software-managed and grows downward
---
## Registers
| Register | Size | Description |
| -------- | ------ | ------------------------------ |
| A | 8-bit | General-purpose register |
| B | 8-bit | General-purpose register |
| C | 8-bit | General-purpose register |
| D | 8-bit | General-purpose register |
| PC | 16-bit | Program Counter |
| SP | 16-bit | Stack pointer |
## Flags Register
The CPU maintains a small flags register.
| Flag | Description |
| ----- | ------------ |
| Z | Zero flag - set if last result was `0` |
| C | Carry/Borrow flag |
- Control-flow instructions do **not** modify flags.
## Supported Instructions ## Supported Instructions
@ -21,41 +57,48 @@
| DIV | div r1, r2 | | DIV | div r1, r2 |
| CALL | call \<label\> | | CALL | call \<label\> |
| SYS | sys \<syscall_no\> | | SYS | sys \<syscall_no\> |
| HLT (Halt) | hlt | | HLT (Halt) | hlt |
## Registers
| Register | Size | Description |
| -------- | ------ | ------------------------------ |
| A | 8-bit | General |
| B | 8-bit | General |
| C | 8-bit | General |
| D | 8-bit | General |
| PC | 16-bit | Program Counter |
| SP | 16-bit | Stack pointer |
## Flags
| Flag | Description |
| ----- | ------------ |
| Z | Zero Flag |
| C | Carry/Borrow |
## Syscalls ## Syscalls
| Imm | Meaning | | Imm | Meaning |
| --- | ------- | | --- | ------- |
| 0 | Exit Program | | 0 | Exit Program |
| 1 | Print register A as integer | | 1 | Print register A as integer |
| 2 | Print register A as ASCII char | | 2 | Print register A as ASCII char |
- Syscalls also do not modify flags
## Example assembly program
```assembly
mov b, 3
mov a, 1
loop:
sub b, a
jnz loop
sys 1 ; print register A
sys 0 ; exit
```
## Usage
# Usage
```bash ```bash
cargo run -- --f <examples/filename.asc> cargo run -- --f <examples/filename.asc>
``` ```
## Todo ## Non-goals
1. No pipelining
2. No interrupts
3. No virtual memory
4. No privilege levels
5. No hardware I/O
## Goals
- [x] Assembler - [x] Assembler
- [x] Lexer/Tokenizer - [x] Lexer/Tokenizer
- [x] Add label support (supporting JMP/JZ/JNZ) - [x] Add label support (supporting JMP/JZ/JNZ)
@ -66,5 +109,5 @@ cargo run -- --f <examples/filename.asc>
- [x] CALL - [x] CALL
- [x] RET - [x] RET
- [x] SYS - [x] SYS
- [ ] Better Error handling - [ ] Better error-handling
- [ ] TUI Debugger - [ ] TUI debugger