\documentclass[12pt]{article}

\begin{document}

\title{ECE1373S Project Requirements and Report}
\author{Paul Chow}
\date{\today}

\maketitle

\section{Project Demo}
About a week after the report is handed in, I'd like to have a demo of
your project by the group.

Your demo should include the following:
\begin{itemize}
  \item file system structure
  \item overview of your design environment
  \item how you did your testing/verification, both the original code
  and the running system
  \item example of using TestBuilder
  \item downloading your system
  \item running your system
\end{itemize}

\section{Report}

The rest of this is a guideline to help you organize your report with
a list of the major sections that you should include.
You should follow the structure as outlined as much as possible.

The \LaTeX\ source for this document is available at
\begin{verbatim}
www.eecg.toronto.edu/~pc/courses/vlsi/2003/
\end{verbatim}
if you want to use it as a starting point.

I would like the reports by Friday, June 6, 2003 (negotiable, but
this is a good target).

\section{Introduction}
This is an introduction to the design problem.
You do not have to be too detailed, just give a basic overview of what
you are doing, and cite the appropriate references.
This is mainly so that your report can stand on its own.

Some higher level block diagrams might be useful to describe
the overall functionality.
This is probably useful for later when you need to talk about parts of
the design.

\section{Current Status}
Briefly give the current state of the design.
\begin{itemize}
  \item What has been done.
  \item What remains to be done.
\end{itemize}

\section{Architectural Design}
\begin{itemize}
  \item discuss the steps/process you took to define the overall
  architecture and come up with the initial specifications that you
  used to start your design implementation
  \item If you were given some documents to work from, you should include them
	as an appendix and refer to them here.
  \begin{itemize}
    \item assumption here is that
  the specs may have later changed, but talk about what you did to
    arrive at your original specs
  \end{itemize}
  \item describe the architecture you developed  
\end{itemize}


\section{Specifications}

\begin{itemize}
  \item Outline the specifications you developed.
  \item
What problems did you have with the specifications as the design progressed?
  \item
What changes did you later make to the specifications and why?
\end{itemize}

\section{Methodology}
Describe your methodology of design and design strategy.
How did you attack the problem?
Include here descriptions of any tools you had to develop.

\subsection{Design Environment}
\begin{itemize}
  \item describe your design environment here
  \item tools used
  \item file structure/organization
  \item source code control
  \item how you handled multiple users accessing files
  \item etc.
\end{itemize}

\subsection{Partitioning}
\begin{itemize}
  \item How did you partition the design (in chip, on TM-3)?
  \item Why did you do it this way?
\end{itemize}

\subsection{Physical Design Strategy}
Describe your layout and circuit design strategy, if any, i.e., did
you do any floorplanning or anything like that to get better
performance in your design?



\subsection{Simulation and Verification}
\begin{itemize}
  \item Describe your simulation, and verification strategy.
  \item How did you verify the operation of your VHDL modules?
  \item Indicate, if any, possible holes in your strategy that may not
cover certain problems.
\end{itemize}

\section{Contributions}
Each member should contribute a section here (labelled with their
name) that briefly describes what they did in the project.
Be sure to include all things for the course, such as setting up
tools, scripts, etc.
Also, indicate what code you wrote and where I might look to see what
it looks like.

\section{Design Characteristics}
\subsection{Architecture}
Give some more detailed descriptions of the chip architecture.
\begin{itemize}
  \item What are all the pieces?  It would be helpful to indicate
  which VHDL modules correspond to these pieces.
  \item Briefly what do they do.
  \item How do they go together?
\end{itemize}

\subsection{Chip Characteristics}
\begin{itemize}
  \item utilization of chip(s) -- PAR report would be sufficient
\end{itemize}

\subsection{Computing System}
\begin{itemize}
  \item comments on requirements of the computing system
  \item disk utilization -- how much disk did you need
  \item CPU requirements -- memory requirements and performance
  \item How long did typical jobs take (synthesis, P\&R, etc.) for various
  aspects of the project.
	Give a table if you can and specs on the machine.  You don't have
	to be really accurate (approximate hours is fine).
  \item anything else?
\end{itemize}

\subsection{Where the Time Went}
If you need I can lend you the progress reports so that you can get
the actual numbers.
\begin{itemize}
  \item Give an analysis of how you spent your time.
  \item What were the major bottlenecks in your design.
\end{itemize}

\section{Problems}
Discuss problems you had.
\begin{itemize}
  \item Were there management problems?
  \item Were there interfacing problems (between partitions)?
  \item Did a particular tool cause a problem?
Which one?
What was the problem?
  \item Was there just not enough time, not enough people?
  \item Known problems in the design and suggest fixes.
  \item Anything else?
\end{itemize}

\section{Conclusions, Suggestions, Comments}
\begin{itemize}
  \item What do you think you got out of the course, if anything?
  \item What did you learn about systems design?
  \item Comments on the format of the course -- likes and dislikes
  \item Suggestions for improvement
%  \item Should this even be a project course?  Maybe assignments that
%demonstrated aspects of design would be better?
  \item Anything else you care to say?
\end{itemize}


\section*{Appendix:  Initial Descriptions}
Original handouts that were given to you about what to build.

\section*{Appendix:  Design Specifications}
This should be like a spec sheet about the chip and how it is to be used.
There should be enough information for someone who is taking over the
design to be able to figure out what you did.

\section*{Appendix:  Testing Strategy}
% This is a very important section for the successful testing of the chip!
\begin{itemize}
  \item You should describe the procedure for testing the design.
  \item You should give the various tests that are to be used,
where to find them, what each test is testing, what is to be expected.
\end{itemize}


\section*{Appendix:  Documentation}

Where to find the files, and your directory structure.
This should provide enough documentation so that someone else can find
all your stuff and continue with the project.

\section*{Appendix:  Schematics and other Details}
Include here any schematics and other details about your design that
you feel would be appropriate for anyone that needs to understand the
details of what you did.

\section*{Appendix:  Hints for the Next Time}

Please provide any general comments that you feel would be
helpful to future users regarding the tools, design environment,
computing environment, disk space required, etc.

\end{document}
