2021-01-29 14:17:59 -05:00
|
|
|
# Uxn
|
|
|
|
|
|
2021-02-08 17:49:45 -05:00
|
|
|
A [stack-based VM](https://wiki.xxiivv.com/site/uxn.html), written in ANSI C.
|
2021-01-29 14:35:59 -05:00
|
|
|
|
2021-01-29 20:49:10 -05:00
|
|
|
## Assembly Syntax
|
2021-01-29 14:35:59 -05:00
|
|
|
|
2021-02-04 15:22:08 -05:00
|
|
|
### Write
|
|
|
|
|
|
2021-02-08 17:49:45 -05:00
|
|
|
- `;variable`, automatically assign an address to a label.
|
|
|
|
|
- `:const FFCF`, manually assign an address to a label.
|
|
|
|
|
- `@label`, assign the current address to a label.
|
2021-02-04 15:22:08 -05:00
|
|
|
|
|
|
|
|
### Read
|
|
|
|
|
|
2021-02-08 17:49:45 -05:00
|
|
|
- `,literal`, push label value to stack, prefixed with `LIT LEN`.
|
|
|
|
|
- `.pointer`, push label value to stack.
|
2021-02-04 15:22:08 -05:00
|
|
|
|
|
|
|
|
### Special
|
|
|
|
|
|
2021-02-08 17:49:45 -05:00
|
|
|
- `( comment )`, toggle parsing on/off.
|
|
|
|
|
- `|0010`, move to position in the program.
|
|
|
|
|
- `"hello`, push literal bytes for word "hello".
|
|
|
|
|
- `#04`, a zero-page address, equivalent to `,0004`.
|
2021-01-31 00:31:49 -05:00
|
|
|
|
2021-02-06 13:39:13 -05:00
|
|
|
### Operator modes
|
|
|
|
|
|
|
|
|
|
- `,1234 ,0001 ADD^`, 16-bits operators have the short flag `^`.
|
2021-02-07 23:49:00 -05:00
|
|
|
- `,12 ,11 GTH JMP?`, conditional operators have the cond flag `?`.
|
2021-02-06 13:39:13 -05:00
|
|
|
|
2021-01-29 14:35:59 -05:00
|
|
|
```
|
2021-02-05 17:01:34 -05:00
|
|
|
( hello world )
|
2021-02-04 15:22:08 -05:00
|
|
|
|
2021-02-05 17:01:34 -05:00
|
|
|
;iterator
|
|
|
|
|
:dev1r FFF0
|
|
|
|
|
:dev1w FFF1
|
2021-01-29 20:49:10 -05:00
|
|
|
|
2021-02-05 17:01:34 -05:00
|
|
|
|0100 @RESET
|
2021-01-30 17:25:48 -05:00
|
|
|
|
2021-02-07 23:49:00 -05:00
|
|
|
@word1 "hello_word ( len: 0x0b )
|
2021-02-05 17:01:34 -05:00
|
|
|
|
|
|
|
|
@loop
|
2021-02-07 23:49:00 -05:00
|
|
|
,dev1w STR ( write to stdout )
|
|
|
|
|
,incr JSR ( increment itr )
|
|
|
|
|
,word1 ,strlen JSR ( get strlen )
|
|
|
|
|
NEQ ,loop ROT JSR? ( loop != strlen )
|
2021-02-05 17:01:34 -05:00
|
|
|
|
2021-02-07 23:49:00 -05:00
|
|
|
BRK
|
|
|
|
|
|
|
|
|
|
@strlen
|
|
|
|
|
,0001 ADD^ LDR
|
|
|
|
|
RTS
|
2021-02-05 17:01:34 -05:00
|
|
|
|
2021-02-05 23:18:30 -05:00
|
|
|
@incr
|
|
|
|
|
,iterator LDR
|
|
|
|
|
,01 ADD
|
|
|
|
|
,iterator STR
|
|
|
|
|
,iterator LDR
|
|
|
|
|
RTS
|
2021-02-07 23:49:00 -05:00
|
|
|
|
2021-02-05 17:01:34 -05:00
|
|
|
|c000 @FRAME BRK
|
|
|
|
|
|d000 @ERROR BRK
|
|
|
|
|
|FFFA .RESET .FRAME .ERROR
|
2021-01-29 14:35:59 -05:00
|
|
|
```
|
|
|
|
|
|
2021-02-08 17:49:45 -05:00
|
|
|
## TODOs
|
2021-02-01 14:58:47 -05:00
|
|
|
|
2021-02-04 00:53:56 -05:00
|
|
|
### Assembler
|
|
|
|
|
|
2021-02-06 23:18:49 -05:00
|
|
|
- Implement shorthand operators
|
2021-02-07 12:01:40 -05:00
|
|
|
- Signed operations
|
2021-02-04 00:53:56 -05:00
|
|
|
|
|
|
|
|
### CPU
|
|
|
|
|
|
2021-02-07 15:13:38 -05:00
|
|
|
- Signed operations
|
|
|
|
|
- Catch overflow/underflow
|
2021-02-01 17:49:09 -05:00
|
|
|
- A Three-Way Decision Routine(http://www.6502.org/tutorials/compare_instructions.html)
|
2021-02-01 14:58:47 -05:00
|
|
|
- Draw pixel to screen
|
2021-02-07 23:49:00 -05:00
|
|
|
- Redo overflow/underflow mappping
|
2021-02-01 14:58:47 -05:00
|
|
|
- Detect mouse click
|
2021-01-31 00:31:49 -05:00
|
|
|
- SDL Layer Emulator
|
|
|
|
|
- Build PPU
|
2021-02-01 23:21:27 -05:00
|
|
|
|
2021-02-05 13:51:45 -05:00
|
|
|
### Devices
|
|
|
|
|
|
|
|
|
|
- Devices each have an input byte, an output byte and two request bytes.
|
|
|
|
|
|
2021-01-30 17:25:48 -05:00
|
|
|
## Refs
|
|
|
|
|
|
|
|
|
|
https://code.9front.org/hg/plan9front/file/a7f9946e238f/sys/src/games/nes/cpu.c
|
|
|
|
|
http://www.w3group.de/stable_glossar.html
|
|
|
|
|
http://www.emulator101.com/6502-addressing-modes.html
|
|
|
|
|
http://forth.works/8f0c04f616b6c34496eb2141785b4454
|
2021-02-05 23:18:30 -05:00
|
|
|
https://justinmeiners.github.io/lc3-vm/
|
