next up previous
Next: About this document Up: No Title Previous: Checkpoint

Final Documentation and Demo

Start early and check with the TAs or Prof. Brunvand to make sure that you understand how things are working! The documentation you should be prepared to 361handin after the final demo includes the same stuff you've been doing all along:

  1. A block diagram of the system showing each of the two main parts in detail (datapath and control state machine). Show the State machine as a block and how it connects to the other parts (counters, registers, etc) that you used.
  2. Complete, documented, design of the state machine, including state diagram, state transition table, state assignment, encoded state transition table, next state equations, Karnaugh maps (or espresso or misII) for the next state logic, and the output logic.
  3. A set of logic schematics for the circuit. These must be drawn in Viewdraw, and should show everything that will included in the Xilinx part and also the parts that will be wired up on the circuit board. The highest-top-level schematic should have the switches and lights, and a symbol that represents the circuitry contained in the Xilinx part. You should call the final highest-top-level schematic TOPA as usual. Note that by ``highest-top-level schematic'' I mean the schematic that contains the switches, lights, and single Xilinx-symbol. (Recall that all the Xilinx circuits must be under that one Xilinx symbol. )
  4. A circuit simulation using Viewsim. The command file that applies inputs and checks them using ``check'' statements should be turned in along with a log file of simulation results. If you use a program to generate tests, include the source for that program. Important note: if you use a program to generate tests, include the source for the program, not the executable. Also include instructions on how to compile and run the program. If you have huge machine generated test files, or huge log files, delete them before using 361handin! A good rule of thumb is that the part you should include is the part you wrote by hand (unless the machine generated stuff is very small).
  5. A layout sheet which shows where the chips will be located on the circuit board. For chips on the Xilinx board, you can still show where they will be, even if the board-symbol doesn't show the Xilinx part.

Remember that if you don't document your design, and you don't comment the documentation so that the TA can understand it, you won't be getting full credit even if everything works! If everything doesn't work quite right it's even more vital to have clearly documented what you did!


next up previous
Next: About this document Up: No Title Previous: Checkpoint

Erik Brunvand
Sat Nov 29 15:21:21 MST 1997