aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: af5513ce6ec11234058a6c110169bb9de9c544a2 (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
# 8-Bit CPU Emulator

## CPU Architecture
- Word Size
    - **Data Width:** 8 bits
    - **Address width:** 16 bits
    - **Address space:** 64 KB (0x0000-0xFFFF)

## Supported Instructions

| Instruction | Syntax |
| ----------- | ---------------- |
| MOV         | mov dest, src  OR mov reg, imm     |
| ADD         | add r1, r2     OR add reg, imm     |
| SUB         | sub r1, r2     OR sub reg, imm     |
| JMP         | jmp addr       OR jmp addr         |
| JZ          | jz addr        OR jz addr          |
| JNZ         | jnz addr       OR jnz addr         |
| CMP         | cmp r1, r2     OR cmp reg, imp     |
| MUL         | mul r1, r2     |
| DIV         | div r1, r2     |
| CALL        | call \<label\>     |
| SYS         | sys \<syscall_no\> |
| 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
| Imm | Meaning |
| --- | ------- |
| 0   | Exit Program |
| 1   | Print register A as integer |
| 2   | Print register A as ASCII char |


# Usage
```bash
cargo run -- --f <examples/filename.asc>
```

## Todo
- [x] Assembler
    - [x] Lexer/Tokenizer
    - [x] Add label support (supporting JMP/JZ/JNZ)
- [x] Add instructions
    - [x] CMP
    - [x] MUL
    - [x] DIV
    - [x] CALL
    - [x] RET
    - [x] SYS
- [ ] Better Error handling
- [ ] TUI Debugger