Documentation for Each Block

1
Documentation for Each Block
John DeHartjdd_at_arl.wustl.edu http//www.arl.wust
l.edu/arl
2
Revision History

• 8/29/06 (JDD)
• Created
• 9/19/06 (JDD)
• Add memory accesses, reg usage, signal usage,
  initialization, data structures, critical path,
  etc.
• Add schedule of reviews.

3
Overview

• Each implementer of a block should provide the
  documentation described in these slides
• The documentation for each block should reside in
  a standard place in our Subversion repository
  tree
• The documentation for each block will be reviewed
  by the whole group at a series of scheduled
  meetings.

4
Outline

• Definition of interfaces In/Out
• Block diagram of module
• Including list of files where code for each
  block/module exists.
• Macros
• List macros and files where they can be found
• For each macro, provide a few lines of comments
  in the code that describes the macro.
• Document local and global registers used by
  macro.
• Memory assumptions
• What addresses are pre-defined, etc
• Initialization of Memory
• Data Structures
• Control Blocks
• Details of memory accesses, xfer register usage,
  signal usage.
• Critical path
• Testing
• Develop a well defined acceptance test that
  convinces you that your block works
• Document acceptance test
• Pktgen project file?
• Known bugs

5
Schedule

• 9/19/06 Review
• 9/26/06 Parse Brandon
• 10/03/06 IPv4 Hdr Format Jing
• 10/10/06 LC Key Extract Mike
• 10/17/06 QM Amy and Sailesh
• 10/24/06 Lookup John
• 10/31/06 LC Hdr Format Dave
• 11/07/06 Rx/Tx Mods Dave
• 11/14/06 Control Fred

6
Extra

• The next set of slides are for templates or extra
  information if needed

7
Text Slide Template
8
Image Slide Template