remove Choice ship
[fleet.git] / ships / Alu2.ship
1 ship: Alu2
2
3 == Ports ===========================================================
4 data  in:   in1
5 data  in:   in2
6 data  in:   inOp
7   constant ADD: 0
8   constant SUB: 1
9   constant MAX: 2
10   constant MIN: 3
11
12 data  out:  out
13
14
15 == TeX ==============================================================
16
17 {\tt Alu2} is a ``two-input'' arithmetic logic unit.  It includes
18 logic for performing arithmetic operations on a pair of arguments.
19 Currently this includes
20 addition ({\sc add}),
21 subtraction ({\sc sub}),
22 maximum ({\sc max}), and
23 minimum ({\sc min}).
24
25 \subsection*{Semantics}
26
27 When a value is present at each of {\tt in1}, {\tt in2} and {\tt
28 inOp}, these three values are consumed.  Based on the value consumed
29 at {\tt inOp}, the requested operation is performed on the values
30 consumed from {\tt in1} and {\tt in2}.  The result of this operation
31 is then made available at {\tt out}.
32
33 \subsection*{To Do}
34
35 The {\it link bit} and other features of \cite{ies31} are not yet
36 implemented.
37
38 The carry-in, carry-out, zero-test, negative-test, and overflow-test
39 flags typically present in a conventional processor ALU are also not
40 yet implemented.
41
42 == Fleeterpreter ====================================================
43 public long resolveLiteral(String literal) {
44   if (literal.equals("ADD")) return 0;
45   if (literal.equals("SUB")) return 1;
46   if (literal.equals("MAX")) return 2;
47   if (literal.equals("MIN")) return 3;
48   return super.resolveLiteral(literal);
49 }
50 public void service() {
51   if (box_in1.dataReadyForShip() &&
52       box_in2.dataReadyForShip() &&
53       box_inOp.dataReadyForShip() &&
54       box_out.readyForDataFromShip()) {
55       long a      = box_in1.removeDataForShip();
56       long b      = box_in2.removeDataForShip();
57       long op     = box_inOp.removeDataForShip();
58       switch((int)op) {
59           case 0: box_out.addDataFromShip(a+b); // ADD
60               break;
61           case 1: box_out.addDataFromShip(a-b); // SUB
62               break;
63           case 2: box_out.addDataFromShip(Math.max(a,b)); // MAX
64               break;
65           case 3: box_out.addDataFromShip(Math.min(a,b)); // MIN
66               break;
67           default: box_out.addDataFromShip(0);
68               break;
69       }
70   }
71 }
72
73 == FleetSim ==============================================================
74
75 == FPGA ==============================================================
76
77   always @(posedge clk) begin
78     if (!rst) begin
79       `reset
80     end else begin
81       if (out_r    && out_a)    out_r    <= 0;
82       if (!in1_r   && in1_a)    in1_a    <= 0;
83       if (!in2_r   && in2_a)    in2_a    <= 0;
84       if (!inOp_r  && inOp_a)   inOp_a   <= 0;
85       if (!out_r && !out_a && in1_r && !in1_a && in2_r && !in2_a && inOp_r && !inOp_a) begin
86         out_r <= 1;
87         in1_a <= 1;
88         in2_a <= 1;
89         inOp_a <= 1;
90         case (inOp_d)
91           0: out_d <= in1_d + in2_d;
92           1: out_d <= in1_d - in2_d;
93           2: out_d <= in1_d > in2_d ? in1_d : in2_d;
94           3: out_d <= in1_d > in2_d ? in2_d : in1_d;
95           default: out_d <= 0;
96         endcase        
97       end
98     end
99   end
100
101 == Test ==============================================================================
102 // expected output
103 #ship debug : Debug
104 #ship alu   : Alu2
105
106 #expect 17
107 #expect 1
108 #expect 8
109 #expect 9
110
111 debug.in:   [*] take, deliver;
112 alu.in1:
113   literal 9; load repeat counter with 4; deliver;
114
115 alu.in2:
116   literal 8; load repeat counter with 4; deliver;
117
118 alu.in1:    [*] take, deliver;
119 alu.in2:    [*] take, deliver;
120 alu.out:    [*] take, sendto debug.in;
121
122 alu.inOp:
123  literal Alu2.inOp[ADD]; deliver;
124  literal Alu2.inOp[SUB]; deliver;
125  literal Alu2.inOp[MIN]; deliver;
126  literal Alu2.inOp[MAX]; deliver;
127
128
129
130 == Contributors =========================================================
131 Adam Megacz <megacz@cs.berkeley.edu>