buildyamon.txt

Au1200 yamon release 02.29J

Building YAMON
May 16, 2007

To build YAMON for the Au1x00/Pb1x00, do the following things.

1) Install the supplied GNU tool-chain (see the QuickStart Guide).

2) Extract the YAMON sources. Use Winzip, and be sure to select
the option

  Use Folder Names

so that the directory structure is preserved.

Note the ZIP archive is password-protected.  The password is in 
the file 'Yamon Software Agreement.pdf' in the same directory as
this document.

3) Invoke the Cygwin BASH shell for the subsequent commands (this
step is not necessary if performing on a Unix host).

4) Configure YAMON for the desired board:

  % cd yamon
  % cd bin
  % make install
  % vi makefile

and change the variable

  BUILDTYPE

to reflect the proper board. Be sure to use all uppercase as the
board type is translated into a C pre-processor #define and used
in the YAMON source code.

4a) If building on a Unix host, you may need to remove extraneous
carriage returns (^M) and make sure all script files (*.pl) are
executable.  Failure to do both of these may cause the build to fail.
Typical error messages are:

"bad interpreter: No such file or directory"
   (the shell literally tries to invoke /usr/bin/perl^M )

"/bin/sh: line 1: ./postproc.pl: Permission denied"
   (postproc.pl is not marked executable)

You must mark a file executable after using dos2unix because it marks
files readable and writable only.

  % dos2unix *.pl
  % chmod +x *.pl

5) Build YAMON:

  % make

When the make process completes, there is an srecord in the
current directory by the name similar to:

  yamon-02.08PB1000.rec

This S-Record can then be used by a part programmer (or YAMON
itself) to program into the Flash. The filename has two important
pieces of information in it: the version and the board name.

When updating YAMON on the board, please read the file

  UpdateYAMON.txt

for the recommended instructions for updating YAMON.

There are many places where YAMON was adapted for the Au1x00.
The following files represent the majority, but certainly not all,
of the effort for porting YAMON to the Au1x00/Pb1x00.

  yamon/arch/init/reset_pb1000.S              # Pb1000 reset sequence
  yamon/arch/init/reset_pb1100.S              # Pb1100 reset sequence
  yamon/arch/init/reset_pb1500.S              # Pb1500 reset sequence
  yamon/arch/init/cpu/init_au1000.S           # setup debug display
  yamon/arch/init/platform/init_platform.c    # misc
  yamon/arch/init/platform/init_platform_s.S  # debug messages
  yamon/init/reset/reset.S                    # invoke reset sequence
  yamon/drivers/serial/serial_Au1000.c        # serial port driver
  yamon/drivers/rtc/rtc_au1000.c              # rtc driver
  yamon/drivers/lan/MAC_AU1000.c              # ethernet driver
  yamon/drivers/flash/flash_amd.c             # AMD29D323 flash driver
  yamon/drivers/flash/flash_strata.c          # Intel Strata flash driver


If porting YAMON, the majority of the effort should be isolated to
creating a valid reset_XXXX.S file and plugging this file into the
reset.S file. This version of YAMON is created such that all Au1xxx/
Pb1xxx boards are treated as the same "platform" within YAMON.