# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
-GENERATE_LATEX = YES
+GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# generate an XML file that captures the structure of
# the code including all documentation.
-GENERATE_XML = NO
+GENERATE_XML = YES
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
-HAVE_DOT = NO
+HAVE_DOT = YES
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# the time of a run. So in most cases it will be better to enable call graphs
# for selected functions only using the \callgraph command.
-CALL_GRAPH = NO
+CALL_GRAPH = YES
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller dependency graph for every global function
# the time of a run. So in most cases it will be better to enable caller
# graphs for selected functions only using the \callergraph command.
-CALLER_GRAPH = NO
+CALLER_GRAPH = YES
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
/*! \file chipcon.c
\author Travis Goodspeed
-
- This is an implementation of the Chipcon 8051
- debugging protocol for the GoodFET.
+ \brief Chipcon 8051 debugging.
*/
/*! \file i2c.c
\author Travis Goodspeed
-
- GoodFET I2C Master Application
- Handles basic I/O
-
+ \brief I2C Master
*/
/*! \file jtag.c
\author Travis Goodspeed <travis at radiantmachines.com>
-
- This is an implementation of the low-level JTAG functions
- for the GoodFET project at http://goodfet.sf.net/
-
- See the license file for details of proper use.
+ \brief Low-level JTAG
*/
/*! \file jtag430.c
\author Travis Goodspeed <travis at radiantmachines.com>
-
- This is an implementation of the 16-bit MSP430 JTAG protocol
- for the GoodFET project at http://goodfet.sf.net/
-
- See the license file for details of proper use.
+ \brief MSP430 JTAG (16-bit)
*/
#include "platform.h"
/*! \file jtag430x2.c
\author Travis Goodspeed <travis at radiantmachines.com>
-
- This is an implementation of the MSP430X2 JTAG protocol
- for the GoodFET project at http://goodfet.sf.net/
-
- See the license file for details of proper use.
+ \brief MSP430X2 JTAG (20-bit)
*/
#include "platform.h"
//! Read data from address
unsigned int jtag430x2_readmem(unsigned long adr){
unsigned int toret=0;
- unsigned int tries=5;
+ //unsigned int tries=5;
while(1){
do{
/*! \file monitor.c
\author Travis Goodspeed
-
- This is an implementation of the SPI protocol
- for the GoodFET project.
+ \brief Local debug monitor.
*/
#include "command.h"
/*! \file spi.c
\author Travis Goodspeed
-
- This is an implementation of the SPI protocol
- for the GoodFET project.
+ \brief SPI Master
*/
//Higher level left to client application.
/*! \file goodfet.c\r
\author Travis Goodspeed\r
+ \brief Main module.\r
\r
This is the main module of the GoodFET, which calls the initialization\r
routines and delegates commands to the various applications.\r
-//! Application stuff.
+/*! \file apps.h
+ \author Travis Goodspeed
+ \brief Application definitions.
+*/
#define MONITOR 0x00
#define SPI 0x01
-//These high-level functions are implemented in chipcon.c.
+/*! \file chipcon.h
+ \author Travis Goodspeed
+ \brief Chipcon application functions.
+*/
//! Erase a chipcon chip.
-// Command handling functions.
+/*! \file command.h
+ \author Travis Goodspeed
+ \brief Command codes and buffers.
+*/
//! Global data buffer.
extern unsigned char cmddata[256];
+
#define cmddataword ((unsigned int*) cmddata)
#define cmddatalong ((unsigned long*) cmddata)
#define memorybyte ((unsigned char*) 0)
//! Transmit a debug string.
void debugstr(const char *str);
-//! Delay
+//! Delay for a count.
void delay(unsigned int count);
//! MSDelay
void msdelay(unsigned int ms);
+/*! \file jtag.h
+ \author Travis Goodspeed
+ \brief JTAG handler functions.
+*/
#include <signal.h>
#include <io.h>
-
+/*! \file monitor.h
+ \author Travis Goodspeed
+ \brief Debug monitor commands.
+*/
#include <signal.h>
#include <io.h>
-//! \file platform.h
+/*! \file platform.h
+ \author Travis Goodspeed
+ \brief Port and baud rate definitions.
+
+ The functions specified here are defined in the platform
+ definition file, such as msp430x1612.c or msp430x2618.c.
+*/
#include <signal.h>
#include <io.h>
-/** SPI **/
+/*! \file spi.h
+ \author Travis Goodspeed
+ \brief Definitions for the SPI application.
+*/
//Pins and I/O
/*! \file command.c
\author Travis Goodspeed
-
- These functions manage command interpretation.
+ \brief These functions manage command interpretation.
*/
#include "command.h"
serial_tx(*(str++));
}
-//! Transmits a debugging string out of line.
+/*! \brief Transmit a debug string.
+
+ Transmits a debugging string that is to be printed
+ out of line by the client. This is just for record-keeping;
+ it is not considered a proper reply to a query.
+ */
void debugstr(const char *str){
txstring(0xFF,0xFF,str);
}
projects / goodfet / commitdiff