X-Git-Url: http://git.squeep.com/?p=dcpu16;a=blobdiff_plain;f=dcpu16.h;h=f70372a0d11655034ff279e038aeb0930c54b9d4;hp=73592d9c358e907b1c8d1b7d62e17162ebd6045b;hb=94be117719b907e351bb2bf1096f6195daecd2aa;hpb=bca632cc1c329a45dde32f476b0ef9f6ef5db05a diff --git a/dcpu16.h b/dcpu16.h index 73592d9..f70372a 100644 --- a/dcpu16.h +++ b/dcpu16.h @@ -8,34 +8,103 @@ typedef unsigned short DCPU16_WORD; /* how much ram the system has */ #define DCPU16_RAM 0x10000 +#define DCPU16_INTERRUPT_QUEUE_SIZE 256 + +extern const char * const dcpu16_reg_names[]; +enum dcpu16_register_indexes { + DCPU16_REG_A = 0, + DCPU16_REG_B, + DCPU16_REG_C, + DCPU16_REG_X, + DCPU16_REG_Y, + DCPU16_REG_Z, + DCPU16_REG_I, + DCPU16_REG_J, + DCPU16_REG_PC, + DCPU16_REG_SP, + DCPU16_REG_EX, + DCPU16_REG_IA, + DCPU16_REG__NUM +}; /* a self-contained dcpu16 core */ struct dcpu16 { - unsigned long long cycle; /* number of cycles this core has executed */ - DCPU16_WORD reg[8]; /* system registers, a b c x y z i j */ - DCPU16_WORD pc; /* program counter */ - DCPU16_WORD sp; /* stack pointer */ - DCPU16_WORD o; /* overflow */ - unsigned int skip_ : 1; /* skip execution of next instruction */ - DCPU16_WORD ram[DCPU16_RAM]; /* memory */ - DCPU16_WORD reg_work_[2]; /* (private) work registers for holding literal values while decoding instructions */ + void (*warn_cb_)(char *fmt, ...); + void (*trace_cb_)(char *fmt, ...); + struct dcpu16_acct_cb *cb_table_; /* list of callbacks to invoke for certain events */ size_t cb_table_entries_; /* callback list maintenance */ size_t cb_table_allocated_; /* callback list maintenance */ + + struct dcpu16_hw *hw_table_; /* list of hardware attached to system */ + size_t hw_table_entries_; /* hardware list maintenance */ + size_t hw_table_allocated_; /* hardware list maintenance */ + + unsigned long long cycle_; /* number of cycles this core has executed */ + unsigned int skip_ : 1; /* skip execution of next instruction */ + unsigned int interrupts_deferred_ : 1; /* queue software interrupts */ + unsigned int on_fire_ : 1; /* cpu is on fire */ + DCPU16_WORD reg_work_[2]; /* work registers for holding literal values while decoding instructions */ + DCPU16_WORD interrupts_[DCPU16_INTERRUPT_QUEUE_SIZE]; /* fifo of pending interrupts */ + size_t interrupts_head_; /* interrupt queue maintenance */ + size_t interrupts_tail_; /* interrupt queue maintenance */ + + DCPU16_WORD reg[DCPU16_REG__NUM]; /* system registers, a b c x y z i j */ + DCPU16_WORD ram[DCPU16_RAM]; /* memory */ }; -/* these are used for accounting/watchpointing/&c */ +/* these are used for accounting/watchpointing/modules/&c */ typedef unsigned int dcpu16_acct_event; -#define DCPU16_ACCT_EV_READ (1<<1) -#define DCPU16_ACCT_EV_WRITE (1<<2) -#define DCPU16_ACCT_EV_NOP (1<<3) -#define DCPU16_ACCT_EV_RESET (1<<4) +typedef void (dcpu16_ev_cb_t)(struct dcpu16 *, dcpu16_acct_event, DCPU16_WORD, void *); +#define DCPU16_ACCT_EV_CYCLE (1<<1) +#define DCPU16_ACCT_EV_READ (1<<2) +#define DCPU16_ACCT_EV_WRITE (1<<3) +#define DCPU16_ACCT_EV_NOP (1<<4) +#define DCPU16_ACCT_EV_RESET (1<<5) struct dcpu16_acct_cb { - void (*fn)(struct dcpu16 *, dcpu16_acct_event e, DCPU16_WORD addr, void *); + dcpu16_ev_cb_t *fn; void *data; dcpu16_acct_event mask; }; +typedef void (dcpu16_hw_signal_t)(struct dcpu16 *, struct dcpu16_hw *); +/* these are used to define hardware attached to the system */ +struct dcpu16_hw { + struct dcpu16 *vm; /* which system do I belong to */ + struct dcpu16_hw_module *mod; /* whence I came */ + char *name_; + + DCPU16_WORD id_l; + DCPU16_WORD id_h; + DCPU16_WORD ver; + DCPU16_WORD mfg_l; + DCPU16_WORD mfg_h; + + dcpu16_hw_signal_t *hwi; + dcpu16_hw_signal_t *cycle; + dcpu16_hw_signal_t *reset; + + void *data; +}; + +/* human-readable text describing hw module control operations, for convenience's sake */ +struct dcpu16_hw_ctl_cmd { + char *command; + char *data_in_type; + char *data_out_type; + char *description; +}; +typedef int (dcpu16_hw_data_init_t)(struct dcpu16_hw *, void *); +typedef void (dcpu16_hw_data_free_t)(struct dcpu16_hw *); +typedef int (dcpu16_hw_ctl_t)(struct dcpu16_hw *, const char *, void *, void *); +struct dcpu16_hw_module { + struct dcpu16_hw *template; + dcpu16_hw_data_init_t *data_init; + dcpu16_hw_data_free_t *data_free; + dcpu16_hw_ctl_t *ctl; + struct dcpu16_hw_ctl_cmd *ctl_cmd; +}; + /* instantiate a new core */ struct dcpu16 *dcpu16_new(void); @@ -48,11 +117,24 @@ void dcpu16_state_print(struct dcpu16 *); /* print the contents of ram from second to third argument */ void dcpu16_dump_ram(struct dcpu16 *, DCPU16_WORD, DCPU16_WORD); +/* print words in buf as asm */ +DCPU16_WORD dcpu16_mnemonify_buf(DCPU16_WORD *); + /* print the instruction at the specified address, returns number of words consumed in decoding */ DCPU16_WORD dcpu16_disassemble_print(struct dcpu16 *, DCPU16_WORD); +/* create and delete 'hardware' objects */ +struct dcpu16_hw *dcpu16_hw_new(struct dcpu16 *, struct dcpu16_hw_module *, void *); +void dcpu16_hw_del(struct dcpu16_hw **); + +/* set options on hardware objects */ +int dcpu16_hw_ctl(struct dcpu16_hw *, const char *, void *, void *); + +/* register new 'hardware' device with system */ +int dcpu16_hw_attach(struct dcpu16 *, struct dcpu16_hw *); + /* register a callback for an accounting event */ -int dcpu16_acct_add(struct dcpu16 *, dcpu16_acct_event mask, void (*fn)(struct dcpu16 *, dcpu16_acct_event, DCPU16_WORD, void *), void *data); +int dcpu16_acct_add(struct dcpu16 *, dcpu16_acct_event, dcpu16_ev_cb_t *, void *); /* execute the next instruction */ void dcpu16_step(struct dcpu16 *); @@ -60,6 +142,9 @@ void dcpu16_step(struct dcpu16 *); /* release a core */ void dcpu16_delete(struct dcpu16 **); +int dcpu16_interrupt(struct dcpu16 *, DCPU16_WORD); +void dcpu16_cycle_inc(struct dcpu16 *, unsigned int); + /* register callbacks to handle warning and debug messages, default is writing to stderr, may be set to null */ void dcpu16_warn_cb_set(void (*)(char *, ...)); void dcpu16_trace_cb_set(void (*)(char *, ...));