doc updates to ships

[fleet.git] / ships / Debug.ship

diff --git a/ships/Debug.ship b/ships/Debug.ship
index aaeff49..e1af16d 100644 (file)
--- a/ships/Debug.ship
+++ b/ships/Debug.ship
@@ -1,19 +1,32 @@
 ship: Debug
 
 == Ports ===========================================================
-data  in:   data
+data  in:   in
 
 == Constants ========================================================
 
 == TeX ==============================================================
 
+This ship is used for debugging.  It has only one port, {\tt in}.
+Programmers should send debug report values to this port.  How such
+values are reported back to the programmer doing the debugging is left
+unspecified.
+
+\subsection*{To Do}
+
+Provide an {\tt inOp} port and use opcode ports \cite{am25} to
+effectively allow multiple independent ``debug streams''
+
+Provide a way to programmatically read back the output of the debug
+ship.
+
 == Fleeterpreter ====================================================
 public void service() {
-  if (box_data.dataReadyForShip())
-    ((Interpreter)getFleet()).debug(box_data.removeDataForShip());
+  if (box_in.dataReadyForShip())
+    ((Interpreter)getFleet()).debug(box_in.removeDataForShip());
 }
 
-== ArchSim ==============================================================
+== FleetSim ==============================================================
 
 == FPGA ==============================================================
 `include "macros.v"
@@ -36,5 +49,14 @@ module debug (clk, data_debug_data_r, data_debug_data_a, data_debug_data,
 
 endmodule
 
+== Test ================================================================
+#expect 25
+
+#ship debug : Debug
+
+debug.in:
+  literal 25;
+  deliver;
+
 == Contributors =========================================================
 Adam Megacz <megacz@cs.berkeley.edu>