further reorg of module abstraction and control interface

[dcpu16] / dcpu16.h

diff --git a/dcpu16.h b/dcpu16.h
index 35c1fe878877ba8ce9cf00c8f4e55a54caf60633..f70372a0d11655034ff279e038aeb0930c54b9d4 100644 (file)
--- a/dcpu16.h
+++ b/dcpu16.h
@@ -10,8 +10,28 @@ typedef unsigned short DCPU16_WORD;
 #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 {
+    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 */
@@ -20,6 +40,7 @@ struct dcpu16 {
     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 */
@@ -28,12 +49,7 @@ struct dcpu16 {
     size_t interrupts_head_;            /* interrupt queue maintenance */
     size_t interrupts_tail_;            /* interrupt queue maintenance */
 
-    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 ex;                     /* overflow */
-    DCPU16_WORD ia;                     /* interrupt address */
+    DCPU16_WORD reg[DCPU16_REG__NUM];   /* system registers, a b c x y z i j */
     DCPU16_WORD ram[DCPU16_RAM];        /* memory */
 };
 
@@ -51,18 +67,44 @@ struct dcpu16_acct_cb {
     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;
-    void (*int_fn)(struct dcpu16 *, void *);
+
+    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);
 
@@ -81,8 +123,15 @@ 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_add(struct dcpu16 *, struct dcpu16_hw *);
+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, dcpu16_ev_cb_t *, void *);
@@ -93,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 *, ...));