Project 2
Project 2
Networks
Prof. Forsyth
Project 2 - Interrupts
1 Introduction
We have spent the last few weeks implementing our 32-bit datapath. The simple 32-bit LC-4000 is capable
of performing advanced computational tasks and logical decision making. Now it is time for us to move on
to something more advanced—the upgraded LC-4000a enables the ability for programs to be interrupted.
Your assignment is to fully implement and test interrupts using the provided datapath and CircuitSim. You
will hook up the interrupt and data lines to the new timer device, modify the datapath and microcontroller
to support interrupt operations, and write an interrupt handler to operate this new device. You will also
use the tiny, inexpensive LC-4000a as an embedded system to monitor a kitchen appliance.
2 Requirements
Before you begin, please ensure you have done the following:
• Download the proper version of CircuitSim. A copy of CircuitSim is available under Files on Grade-
scope. You may also download it from the CircuitSim website (https://ra4king.github.io/CircuitSim/).
In order to run CircuitSim, Java must be installed. If you are a Mac user, you may need to right-click
on the JAR file and select “Open” in the menu to bypass Gatekeeper restrictions.
• CircuitSim is still under development and may have unknown bugs. Please back up your work using
some form of version control, such as a local/private git repository or Dropbox. Do not use public
git repositories; it is against the Georgia Tech Honor Code.
• The LC-4000a assembler is written in Python. If you do not have Python 2.6 or newer installed on
your system, you will need to install it before you continue.
Datapath
DrData
DATA
Microcontroller INT
INTA INTA
Timer Device Other Devices
For this assignment, you will add interrupt support to the LC-4000a datapath. Then, you will test your new
capabilities to handle interrupts using an external timer device.
Work in the LC-4000a.sim file. If you wish to use your existing datapath, make a copy with this name,
and add the devices we provided.
by using a specific gate to act like a pull-down resistor so that there is always a value asserted (See
Appendix C for more information)..
3. When a device receives an IntAck signal, it will drive its 32-bit device ID onto the I/O Data Bus.
To prevent devices from interfering with the processor, the I/O Data Bus is attached to the Main Bus
with a tri-state driver. Create this driver and the bus, and attach the microcontroller’s DrDATA
signal to the driver.
4. Modify the datapath so that the PC starts at 0x08 when the processor is reset. Normally the PC
starts at 0x00, however we need to make space for the interrupt vector table (IVT). Therefore, when
you actually load in the test code that you will write, it needs to start at 0x08. Please make sure that
your solution ensures that datapath can never execute from below 0x08 - or in other words, force the
PC to drive the value 0x08 if the PC is pointing in the range of the interrupt vector table.
5. Create hardware to support selecting the register $k0 within the microcode. This is needed by some
interrupt related instructions. Because we need to access $k0 outside of regular instructions, we cannot
use the Rx / Ry / Rz bits. HINT: Use only the register selection bits that the main ROM already
outputs to select $k0. Notice that there is an unused input to the RegSel multiplexer.
1. Be sure to read the appendix on the microcontroller before starting this section.
2. Modify the microcontroller to support asserting four new control signals:
(a) LdEnInt & EnInt to control whether interrupts are enabled/disabled. You will use these 2
signals to control the value of your interrupts enabled register.
(b) IntAck to send an interrupt acknowledge to the device.
(c) DrDATA to drive the value on the I/O Data Bus to the Main Bus.
3. Extend the size of the ROM accordingly.
4. Add the fourth ROM described in Appendix B: Microcontrol Unit to handle onInt.
5. Modify the FETCH macrostate microcode so that we actively check for interrupts. Normally this is
done within the INT macrostate (as described in Chapter 4 of the book and in the lectures) but we
are rolling this functionality in the FETCH macrostate for the sake of simplicity. You can accomplish
this by doing the following:
(a) First check to see if the CPU should be interrupted. To be interrupted, two conditions must be
true: (1) interrupts are enabled (i.e., the IE register must hold a ’1’), and (2) a device must be
asserting a ’1’ on the INT signal line.
(b) If not, continue with FETCH normally.
(c) If the CPU should be interrupted, then we enter the INT macrostate and perform the following:
i. Save the current PC to the register $k0.
ii. Disable interrupts.
iii. Assert the interrupt acknowledge signal (IntAck). Next, drive the device ID from the I/O
Data Bus and use it to index into the interrupt vector table to retrieve the new PC value.
The device will drive its device ID onto the I/O Data Bus one clock cycle after it receives
the IntAck signal.
iv. This new PC value should then be loaded into the PC.
Note: onInt works in the same manner that CmpOut did in Project 1. The processor
should branch to the appropriate microstate depending on the value of onInt. onInt
should be true when interrupts are enabled AND when there is an interrupt to be
acknowledged. Note: The mode bit mechanism and user/kernel stack separation
discussed in the textbook has been omitted for simplicity.
6. Implement the microcode for three new instructions for supporting interrupts as described in Chapter
4. These are the EI, DI, and RETI instructions. You need to write the microcode in the main ROM
as well as the SEQ ROM for these three new instructions. Keep in mind that:
(a) EI sets the IE register to 1.
(b) DI sets the IE register to 0.
(c) RETI loads $k0 into the PC, and enables interrupts.
You should refer to Chapter 4 of the textbook to see how to write a correct interrupt handler. As detailed
in that chapter, your handler will need to do the following:
1. First save the current value of $k0 (the return address to where you came from to the current handler)
2. Enable interrupts (which should have been disabled implicitly by the processor within the INT macrostate).
3. Save the state of the interrupted processor.
4. Implement the actual work to be done in the handler. In the case of this project, we want you to
increment a counter variable in memory, which we have already provided.
5. Restore the state of the original processor and return using RETI.
The handler you have written for the timer device should run every time the device interrupts the processor.
Make sure to write the handler such that interrupts can be nested. With that in mind, interrupts should be
disabled for as few instructions as possible within the handlers.
You will need to do the following:
1. Write the interrupt handler (should follow the above instructions or simply refer to Chapter 4 in your
book). In the case of this project, we want the interrupt handler to keep track of time in memory at
the predetermined location: 0xFFFF
2. Load the starting address of the first handler you just implemented in prj2.s into the interrupt vector
table at the appropriate addresses (the table is indexed using the device ID of the interrupting device).
Test your design before moving onto the next section. If it works correctly, you should see the value
at address 0xFFFF in memory increment as the program runs.
Project 2 Computer Systems and Networks Fall 2024
Datapath
Datapath
DAR LdDAR
DrData
ADDR
DATA
Microcontroller INT
INTA INTA
Timer Device Distance Tracker Other Devices
Figure 2: Interrupt Hardware for the LC-4000a with Basic I/O Support
Eager to put your newfound knowledge of device interrupts from CS2200 to good use, you decide to apply
what you’ve learned to your engineering passion: a distance tracker! You are interested to know the maximum
and minimum distance in that area.
You’ve rigged up a device that is able to report the current distance measured to an LC-4000a processor via
an interrupt. There’s only one issue: as of right now, your datapath can detect when an external device is
ready to interrupt the processor, but it cannot retrieve data from external devices.
In this phase of the project, you will add functionality for device-addressed input. You will then make use
of this functionality by adding a device simulating a distance tracker and writing a simple handler for the
device.
2. Modify the microcontroller to support a new control signal, LdDAR. This signal will be used in order
to enable writing to the DAR.
3. Implement the IN instruction in your microcode. This instruction takes a device address an immediate
offset (IR[19:0]), loads it into the DAR, and writes the value on the data bus into a register. When
it is done, it must clear the DAR (since interrupts use the data bus to communicate device IDs).
Examine the format of the IN instruction and consider what signals you might raise in order to write
a constant zero into the DAR.
6 Autograder
6.1 Testcases
Similar to the autograder used in Project 1, the autograder for Project 2 will run your prj2.s file using your
datapath and simulate the interrupt handling process. It will evaluate whether your handler codes perform
their intended tasks correctly. The Project 2 autograder includes four different test cases:
• Verification of hardware and microcode: Confirms that both your hardware and microcode are
implemented correctly.
• Device 1 interrupt handler check: Ensures that the assembly code for the Device 1 interrupt
handler is correctly implemented.
• Device 2 interrupt handler check: Validates the correct implementation of the assembly code for
the Device 2 interrupt handler.
• Comprehensive integration test: Combines all the components mentioned above into a single test
to evaluate their combined functionality.
You are encouraged to use the autograder as a tool to help debug your circuit and assembly code, but it
shouldn’t be your primary method. You’ll still need to identify which parts of your datapath, microcode,
or handler code aren’t functioning as expected. Once you are ready to submit to the autograder, you must
adhere to the following guidelines:
• Do not rename any existing components.
• Name your IE register as “IE.”
• Name your Interrupt ROM as “INT.”
• Use a single global clock.
• Use only one RAM for memory.
• Do not alter the layout of the microcode Excel sheet.
• If you’ve modified any constants in devices for debugging, revert them to their original values.
If the autograder fails, first check that you have followed all the rules above and those from Project 1. If the
autograder flags an issue with a device handler, load the assembled HEX of your prj2.s program into RAM,
clock it until the device interrupts, and monitor the state changes to identify where a component may be
malfunctioning. Occasionally, the error might not reproduce during the first interrupt of the device; in such
cases, observe all subsequent interrupts of that device to pinpoint the problem.
We strongly recommend testing your project locally before submitting it to Gradescope. For instructions
on local testing, refer to Appendix D.
When you encounter an error message, first try to reproduce it locally and analyze what you observe. If you
still need guidance, visit office hours or make a private post detailing your debugging attempts, rather than
just sharing the error message and a screenshot of your datapath. The TAs will need more information to
effectively help you resolve the issue.
Project 2 Computer Systems and Networks Fall 2024
If so, make a private post on Ed and link the gradescope submission for which the error occurred. A TA will
try to rerun your submission for you, and the correct autograder output should be displayed on the same
submission. Note, this will not count towards your submission count for the day.
7 Deliverables
To submit your project, you need to upload the following files to Gradescope:
• CircuitSim datapath file (LC-4000a.sim)
• Microcode file (microcode.xlsx)
• Assembly code (prj2.s)
If you are missing any of those files, you will get a 0, so make sure that you have uploaded all
three of them.
Always re-download your assignment from Gradescope after submitting to ensure that all
necessary files were properly uploaded. If what we download does not work, you will get a 0
regardless of what is on your machine.
This project will be demoed. In order to receive full credit, you must sign up for a demo slot and
complete the demo. We will announce when demo times are released, which will be after the project is due.
Project 2 Computer Systems and Networks Fall 2024
8.1 Registers
The LC-4000a has 16 general-purpose registers. While there are no hardware-enforced restraints on the uses
of these registers, your code is expected to follow the conventions outlined below.
1. Register 0 is always read as zero. Any values written to it are discarded. Regardless of what is
written to this register, it should always output zero.
2. Register 1 is used to hold the target address of a jump. It may also be used by pseudo-instructions
generated by the assembler.
3. Register 2 is where you should store any returned value from a subroutine call.
4. Registers 3 - 5 are used to store function/subroutine arguments. Note: registers 2 through 8 should
be placed on the stack if the caller wants to retain those values. These registers are fair game for the
callee (subroutine) to trash.
5. Registers 6 - 8 are designated for temporary variables. The caller must save these registers if they
want these values to be retained.
6. Registers 9 - 11 are saved registers. The caller may assume that these registers are never tampered
with by the subroutine. If the subroutine needs these registers, then it should place them on the stack
and restore them before they jump back to the caller.
7. Register 12 is reserved for handling interrupts.
8. Register 13 is the everchanging top of the stack; it keeps track of the top of the activation record for
a subroutine.
Project 2 Computer Systems and Networks Fall 2024
9. Register 14 is the anchor point of the activation frame. It is used to point to the first address on the
activation record for the currently executing process.
10. Register 15 is used to store the address a subroutine should return to when it is finished executing.
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
DR = SR1 + SR2;
Description
The ADD instruction obtains the first source operand from the SR1 register. The second source operand is
obtained from the SR2 register. The second operand is added to the first source operand, and the result is
stored in DR.
8.3.2 NAND
Assembler Syntax
NAND DR, SR1, SR2
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
DR = ~(SR1 & SR2);
Description
The NAND instruction performs a logical NAND (AND NOT) on the source operands obtained from SR1
and SR2. The result is stored in DR.
Project 2 Computer Systems and Networks Fall 2024
8.3.3 ADDI
Assembler Syntax
ADDI DR, SR1, immval20
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
DR = SR1 + SEXT(immval20);
Description
The ADDI instruction obtains the first source operand from the SR1 register. The second source operand is
obtained by sign-extending the immval20 field to 32 bits. The resulting operand is added to the first source
operand, and the result is stored in DR.
8.3.4 LW
Assembler Syntax
LW DR, offset20(BaseR)
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
DR = MEM[BaseR + SEXT(offset20)];
Description
An address is computed by sign-extending bits [19:0] to 32 bits and then adding this result to the contents
of the register specified by bits [23:20]. The 32-bit word at this address is loaded into DR.
Project 2 Computer Systems and Networks Fall 2024
8.3.5 SW
Assembler Syntax
SW SR, offset20(BaseR)
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
MEM[BaseR + SEXT(offset20)] = SR;
Description
An address is computed by sign-extending bits [19:0] to 32 bits and then adding this result to the contents
of the register specified by bits [23:20]. The 32-bit word obtained from register SR is then stored at this
address.
8.3.6 BEQ
Assembler Syntax
BEQ SR1, SR2, offset20
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
if (SR1 == SR2) {
PC = incrementedPC + offset20
}
Description
A branch is taken if SR1 is equal to SR2. If this is the case, the PC will be set to the sum of the incremented
PC (since we have already undergone fetch) and the sign-extended offset[19:0].
Project 2 Computer Systems and Networks Fall 2024
8.3.7 JALR
Assembler Syntax
JALR AT, RA
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
0110 AT RA unused
Operation
RA = PC;
PC = AT;
Description
First, the incremented PC (address of the instruction + 1) is stored into register RA. Next, the PC is loaded
with the value of register AT, and the computer resumes execution at the new PC.
8.3.8 HALT
Assembler Syntax
HALT
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
0111 unused
Description
The machine is brought to a halt and executes no further instructions.
8.3.9 BLT
Assembler Syntax
BLT SR1, SR2, offset20
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
if (SR1 < SR2) {
PC = incrementedPC + offset20
}
Description
A branch is taken if SR1 is less than SR2. If this is the case, the PC will be set to the sum of the incremented
PC (since we have already undergone fetch) and the sign-extended offset[19:0].
Project 2 Computer Systems and Networks Fall 2024
8.3.10 LEA
Assembler Syntax
LEA DR, label
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
DR = PC + SEXT(PCoffset20);
Description
An address is computed by sign-extending bits [19:0] to 32 bits and adding this result to the incremented
PC (address of instruction + 1). It then stores the computed address into register DR.
8.3.11 MIN
Assembler Syntax
MIN DR, SR1, SR2
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
if (SR1 < SR2) {
DR = SR1
} else {
DR = SR2
}
Description
The minimum is computed between the values in both source registers. It then stores the minimum value
in the register DR.
Note: MIN and MAX have the same opcode. Bit 4 being 0 indicates the MIN instruction.
The control flow for MIN must go through the CC ROM. Not doing so will cause you to
lose points!
Project 2 Computer Systems and Networks Fall 2024
8.3.12 MAX
Assembler Syntax
MAX DR, SR1, SR2
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
if (SR1 > SR2) {
DR = SR1
} else {
DR = SR2
}
Description
The maximum is computed between the values in both source registers. It then stores the maximum value
in the register DR.
Note: MIN and MAX have the same opcode. Bit 4 being 1 indicates the MAX instruction.
The control flow for MAX must go through the CC ROM. Not doing so will cause you to
lose points!
8.3.13 EI
Assembler Syntax
EI
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
1011 unused
Operation
IE = 1;
Description
The Interrupts Enabled register is set to 1, enabling interrupts.
Project 2 Computer Systems and Networks Fall 2024
8.3.14 DI
Assembler Syntax
DI
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
1100 unused
Operation
IE = 0;
Description
The Interrupts Enabled register is set to 0, disabling interrupts.
8.3.15 RETI
Assembler Syntax
RETI
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
1101 unused
Operation
PC = $k0;
IE = 1;
Description
The PC is restored to the return address stored in $k0. The Interrupts Enabled register is set to 1, enabling
interrupts.
Project 2 Computer Systems and Networks Fall 2024
8.3.16 IN
Assembler Syntax
IN DR, DeviceADDR
Encoding
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Operation
DAR = SEXT(addr20);
DR = DeviceData;
DAR = 0;
Description
The value in addr20 is sign-extended to determine the 32-bit device address. This address is then loaded
into the Device Address Register (DAR). The processor then reads a single word value off the device data
bus, and writes this value to the DR register. The DAR is then reset to zero, ending the device bus cycle.
Project 2 Computer Systems and Networks Fall 2024
As you can see, there are four different locations that the next state can come from: part of the output
from the previous state (main ROM), the sequencer ROM, the condition ROM, and the interrupt ROM.
The MUX controls which of these sources gets through to the state register. If the previous state’s “next
state” field determines where to go, neither the OPTest nor ChkCmp signals will be asserted. If the opcode
from the IR determines the next state (such as at the end of the FETCH state), the OPTest signal will
be asserted. If the comparison circuitry determines the next state (such as in the BGT instruction), the
ChkCmp signal will be asserted. If an interrupt needs to be dealt with (entering the INT macrostate), both
the OPTest and ChkCmp signals will be asserted.
The sequencer ROM should have one address per instruction, and the condition ROM should have three
addresses for when the branching condition is true, when it is false, and when we are executing FABS
microcode.
Before getting down to specifics you need to determine the control scheme for the datapath. To do this
examine each instruction, one by one, and construct a finite state bubble diagram showing exactly what
control signals will be set in each state. Also determine what are the conditions necessary to pass from one
state to the next. You can experiment by manually controlling your control signals on the bus you’ve created
in Phase 1 - Implementing a Basic Interrupt to make sure that your logic is sound.
Once the finite state bubble diagram is produced, the next step is to encode the contents of the Control Unit
ROM. Then you must design and build (in CircuitSim) the Control Unit circuit which will contain the four
ROMs, a MUX, and a state register. Your design will be better if it allows you to single step and ensure
that it is working properly. Finally, you will load the Control Unit’s ROMs with the hexadecimal generated
by your filled out microcode.xlsx.
Note that the input address to the ROM uses bit 0 for the lowest bit of the current state and 5 for the
highest bit for the current state.
Check the “assembly” folder again. You will notice that there is a new file: prj2.hex. This file contains the
assembled 32-bit instructions from your file in hexadecimal. If you are encountering errors when trying to
assemble, it is likely from one of the following reasons:
• If you are getting the error “failed to assemble”, then one or more of the instructions in your program
is invalid. This is almost always due to a syntax error (such as an additional comma or a misspelled
instruction).
• If you are getting a message regarding “unknown file” or “file not found”, then make sure that A) you
are in the “assembly” folder, and B) that you have properly spelled the file names correctly.
• If you are getting an error regarding “Python not found”, then this means that your computer does not
have Python on it. You can try to re-install Python, or simply just use the CS-2200 Docker Container,
where Python is pre-installed.
00000000
9D000042
3DD00000
260FFFFF
B6000000
Select all of the values in the .hex file, copy them to your clipboard, and open your datapath in CircuitSim.
Right click on the “Memory” component and select “View Internal State” from the pop-up menu. This will
bring you into the Memory component. Then, right click on the “RAM” and select “Edit Contents”. You
should see a big CSV pop-up on your screen, displaying the contents of your RAM. Paste your assembled
hex values into the RAM.
Project 2 Computer Systems and Networks Fall 2024
Your datapath is now ready to run your program! If you start clicking on the clock, you should see that
instructions will start executing. To speed things up, you can click on the “Simulation” tab at the top of
the screen. Here is a review of the basic functionalities in the “Simulation” tab:
• To make the clock run continuously, click Clock Enabled, or you can simply use Ctrl + K (Com-
mand + K on Mac).
• To pause the clock, simply do Ctrl + K (or Command + K) again.
• To change the frequency of the clock, click Frequency, where you can select how fast you want
the clock to run.
• To restart your program and reset your datapath, click Restart Simulation, or use Ctrl + R
(Command + R on Mac). Note that you will need to re-paste your hex values into RAM if you do
this.
While your datapath is running the program, you can pause it at anytime and right click on components to
view their internal state. For example, you can see if a particular register is being properly accessed or if a
memory address is being updated.