moved module/hw fields around

[dcpu16] / dcpu16.h

diff --git a/dcpu16.h b/dcpu16.h
index ebf20721051e11823f4113735d443a13541d56bd..d0b366ac6d1a7e223eb357d7da6acf4012e4ff83 100644 (file)
--- a/dcpu16.h
+++ b/dcpu16.h
@@ -67,12 +67,27 @@ struct dcpu16_acct_cb {
     dcpu16_acct_event mask;
 };
 
-typedef void (dcpu16_hw_signal_t)(struct dcpu16 *, void *);
-typedef void (dcpu16_hw_data_free_t)(struct dcpu16_hw *);
-/* these are used to define hardware attached to the system */
+typedef void (dcpu16_hw_signal_t)(struct dcpu16 *, struct dcpu16_hw *);
+/* this structure defines a specific instance of this type of 'hardware' */
 struct dcpu16_hw {
-    struct dcpu16 *vm;  /* which system do I belong to */
-    char *name_;
+    struct dcpu16 *vm;              /* which system do I belong to */
+    struct dcpu16_hw_module *mod;   /* whence I came */
+    void *data;                     /* per-instance 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 {
+    char *name_;                /* dymo label on front panel */
 
     DCPU16_WORD id_l;
     DCPU16_WORD id_h;
@@ -80,19 +95,14 @@ struct dcpu16_hw {
     DCPU16_WORD mfg_l;
     DCPU16_WORD mfg_h;
 
-    dcpu16_hw_signal_t *hwi;
-    dcpu16_hw_signal_t *cycle;
-    dcpu16_hw_signal_t *reset;
+    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;
-    void *data;
-};
-
-typedef int (dcpu16_hw_data_init_t)(struct dcpu16_hw *, 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 */
@@ -101,20 +111,21 @@ 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 *);
 
 /* 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 *);
@@ -125,7 +136,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 */