typo, missing semicolon

[dcpu16] / dcpu16.h

diff --git a/dcpu16.h b/dcpu16.h
index f70372a0d11655034ff279e038aeb0930c54b9d4..94e70a3fc02cf901c064ab622ecb2a57a561553e 100644 (file)
--- a/dcpu16.h
+++ b/dcpu16.h
@@ -59,32 +59,24 @@ typedef void (dcpu16_ev_cb_t)(struct dcpu16 *, dcpu16_acct_event, DCPU16_WORD, v
 #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)
+#define DCPU16_ACCT_EV_REG_READ (1<<4)
+#define DCPU16_ACCT_EV_REG_WRITE (1<<5)
+#define DCPU16_ACCT_EV_NOP      (1<<6)
+#define DCPU16_ACCT_EV_RESET    (1<<7)
 struct dcpu16_acct_cb {
-    dcpu16_ev_cb_t *fn;
-    void *data;
-    dcpu16_acct_event mask;
+    dcpu16_ev_cb_t *fn; /* call this */
+    void *data;         /* also mention this */
+    dcpu16_acct_event mask; /* when (mask & event) is true and */
+    DCPU16_WORD addr_l, /* addr is this or higher and */
+                addr_h; /* addr is this or lower */
 };
 
 typedef void (dcpu16_hw_signal_t)(struct dcpu16 *, struct dcpu16_hw *);
-/* these are used to define hardware attached to the system */
+/* this structure defines a specific instance of this type of 'hardware' */
 struct dcpu16_hw {
-    struct dcpu16 *vm;  /* which system do I belong to */
+    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;
+    void *data;                     /* per-instance data */
 };
 
 /* human-readable text describing hw module control operations, for convenience's sake */
@@ -94,12 +86,24 @@ struct dcpu16_hw_ctl_cmd {
     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;
+    char *name_;                /* dymo label on front panel */
+
+    DCPU16_WORD id_l;
+    DCPU16_WORD id_h;
+    DCPU16_WORD ver;
+    DCPU16_WORD mfg_l;
+    DCPU16_WORD mfg_h;
+
+    dcpu16_hw_signal_t *hwi;    /* hardware interrupt handler */
+    dcpu16_hw_signal_t *cycle;  /* cycle tick handler */
+    dcpu16_hw_signal_t *reset;  /* reset handler */
+
+    dcpu16_hw_data_init_t *data_init;   /* how to allocate a dcpu16_hw instance's data */
     dcpu16_hw_data_free_t *data_free;
     dcpu16_hw_ctl_t *ctl;
     struct dcpu16_hw_ctl_cmd *ctl_cmd;
@@ -111,12 +115,6 @@ struct dcpu16 *dcpu16_new(void);
 /* reset a core to initial state */
 void dcpu16_reset(struct dcpu16 *);
 
-/* print the current state of a core */
-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 *);
 
@@ -134,7 +132,7 @@ int dcpu16_hw_ctl(struct dcpu16_hw *, const char *, void *, void *);
 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 *);
+int dcpu16_acct_add(struct dcpu16 *, dcpu16_acct_event, dcpu16_ev_cb_t *, DCPU16_WORD, DCPU16_WORD, void *);
 
 /* execute the next instruction */
 void dcpu16_step(struct dcpu16 *);
@@ -142,7 +140,10 @@ void dcpu16_step(struct dcpu16 *);
 /* release a core */
 void dcpu16_delete(struct dcpu16 **);
 
+/* signal hardware interrupt */
 int dcpu16_interrupt(struct dcpu16 *, DCPU16_WORD);
+
+/* consume a cycle */
 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 */