Files
rtems/make
Joel Sherrill ba46ffa616 This is a large patch from Eric Valette <valette@crf.canon.fr> that was
described in the message following this paragraph.  This patch also includes
a mcp750 BSP.

From valette@crf.canon.fr Mon Jun 14 10:03:08 1999
Date: Tue, 18 May 1999 01:30:14 +0200 (CEST)
From: VALETTE Eric <valette@crf.canon.fr>
To: joel@oarcorp.com
Cc: raguet@crf.canon.fr, rtems-snapshots@oarcorp.com, valette@crf.canon.fr
Subject: Questions/Suggestion regarding RTEMS PowerPC code (long)


Dear knowledgeable RTEMS powerpc users,

As some of you may know, I'm currently finalizing a port
of RTEMS on a MCP750 Motorola board. I have done most
of it but have some questions to ask before submitting
the port.

In order to understand some of the changes I have made
or would like to make, maybe it is worth describing the
MCP750 Motorola board.

the MCP750 is a COMPACT PCI powerpc board with :

	1) a MPC750 233 MHz processor,
	2) a raven bus bridge/PCI controller that
	implement an OPENPIC compliant interrupt controller,
	3) a VIA 82C586 PCI/ISA bridge that offers a PC
	compliant IO for keyboard, serial line, IDE, and
	the well known PC 8259 cascaded PIC interrupt
	architecture model,
	4) a DEC 21140 Ethernet controller,
	5) the PPCBUG Motorola firmware in flash,
	6) A DEC PCI bridge,

This architecture is common to most Motorola 60x/7xx
board except that :
	1) on VME board, the DEC PCI bridge is replaced by
	a VME chipset,
	2) the VIA 82C586 PCI/ISA bridge is replaced by
	another bridge that is almost fully compatible
	with the via bridge...

So the port should be a rather close basis for many
60x/7xx motorola board...

On this board, I already have ported Linux 2.2.3 and
use it both as a development and target board.

Now the questions/suggestions I have :

1)  EXCEPTION CODE
-------------------

As far as I know exceptions on PPC are handled like
interrupts. I dislike this very much as :

	a) Except for the decrementer exception (and
	maybe some other on mpc8xx), exceptions are
	not recoverable and the handler just need to print
	the full context and go to the firmware or debugger...
	b) The interrupt switch is only necessary for the
	decrementer and external interrupt (at least on
	6xx,7xx).
	c) The full context for exception is never saved and
	thus cannot be used by debugger... I do understand
	the most important for interrupts low level code
	is to save the minimal context enabling	to call C
	code for performance reasons. On non recoverable
	exception on the other hand, the most important is
	to save the maximum information concerning proc status
	in order to analyze the reason of the fault. At
	least we will need this in order to implement the
	port of RGDB on PPC

==> I wrote an API for connecting raw exceptions (and thus
raw interrupts) for mpc750. It should be valid for most
powerpc processors... I hope to find a way to make this coexist
with actual code layout. The code is actually located
in lib/libcpu/powerpc/mpc750 and is thus optional
(provided I write my own version of exec/score/cpu/powerpc/cpu.c ...)

See remark about files/directory layout organization in 4)

2) Current Implementation of ISR low level code
-----------------------------------------------

I do not understand why the MSR EE flags is cleared
again in exec/score/cpu/powerpc/irq_stubs.S

#if (PPC_USE_SPRG)
	mfmsr	r5
	mfspr   r6, sprg2
#else
        lwz	r6,msr_initial(r11)
	lis     r5,~PPC_MSR_DISABLE_MASK@ha
        ori     r5,r5,~PPC_MSR_DISABLE_MASK@l
	and	r6,r6,r5
	mfmsr	r5
#endif

Reading the doc, when a decrementer interrupt or an
external interrupt is active, the MSR EE flag is already
cleared. BTW if exception/interrupt could occur, it would
trash SRR0 and SRR1. In fact the code may be useful to set
MSR[RI] that re-enables exception processing. BTW I will need
to set other value in MSR to handle interrupts :

	a) I want the MSR[IR] and MSR[DR] to be set for
	performance reasons and also because I need DBAT
	support to have access to PCI memory space as the
	interrupt controller is in the PCI space.

Reading the code, I see others have the same kind of request :

/* SCE 980217
 *
 * We need address translation ON when we call our ISR routine

	mtmsr	r5

 */

This is just another prof that even the lowest level
IRQ code is fundamentally board dependent and
not simply processor dependent especially when
the processor use external interrupt controller
because it has a single interrupt request line...

Note that if you look at the PPC code high level interrupt
handling code, as the "set_vector" routine that really connects
the interrupt is in the BSP/startup/genpvec.c,
the fact that IRQ handling is BSP specific is DE-FACTO
acknowledged.

I know I have already expressed this and understand that this
would require some heavy change in the code but believe
me you will reach a point where you will not be able
to find a compatible while optimum implementation for low level
interrupt handling code...) In my case this is already true...

So please consider removing low level IRQ handling from
exec/score/cpu/* and only let there exception handling code...
Exceptions are usually only processor dependent and do
not depend on external hardware mechanism to be masked or
acknowledged or re-enabled (there are probably exception but ...)

I have already done this for pc386 bsp but need to make it again.
This time I will even propose an API.

3) R2/R13 manipulation for EABI implementation
----------------------------------------------

I do not understand the handling of r2 and r13 in the
EABI case. The specification for r2 says pointer to sdata2,
sbss2 section => constant. However I do not see -ffixed-r2
passed to any compilation system in make/custom/*
(for info linux does this on PPC).

So either this is a default compiler option when choosing
powerpc-rtems and thus we do not need to do anything with
this register as all the code is compiled with this compiler
and linked together OR this register may be used by rtems code
and then we do not need any special initialization or
handling.

The specification for r13 says pointer to the small data
area. r13 argumentation is the same except that as far
as I know the usage of the small data area requires
specific compiler support so that access to variables is
compiled via loading the LSB in a register and then
using r13 to get full address... It is like a small
memory model and it was present in IBM C compilers.

=> I propose to suppress any specific code for r2 and
r13 in the EABI case.

4) Code layout organization (yes again :-))
-------------------------------------------

I think there are a number of design flaws in the way
the code is for ppc organized and I will try to point them out.
I have been beaten by this again on this new port, and
was beaten last year while modifying code for pc386.

a) exec/score/cpu/* vs lib/libcpu/cpu/*.

I think that too many things are put in exec/score/cpu that
have nothing to do with RTEMS internals but are rather
related to CPU feature.

This include at least :

	a) registers access routine (e.g GET_MSR_Value),
	b) interrupt masking/unmasking routines,
	c) cache_mngt_routine,
	d) mmu_mngt_routine,
	e) Routines to connect the raw_exception, raw_interrupt
	handler,

b) lib/libcpu/cpu/powerpc/*

With a processor family as exuberant as the powerpc family,
and their well known subtle differences (604 vs 750) or
unfortunately majors (8xx vs 60x)  the directory structure
is fine (except maybe the names that are not homogeneous)

	powerpc

ppc421 mpc821 ...

I only needed to add mpc750. But the fact that libcpu.a was not
produced was a pain and the fact that this organization may
duplicates code is also problematic.

So, except if the support of automake provides a better solution
I would like to propose something like this :

		powerpc

mpc421 	mpc821	...	mpc750	shared wrapup

with the following rules :

	a) "shared" would act as a source container for sources that may
	be shared among processors. Needed files would be compiled inside
	the processor specific directory using the vpath Makefile
	mechanism. "shared" may also contain compilation code
	for routine that are really shared and not worth to inline...
	(did not found many things so far as registers access routine
	ARE WORTH INLINING)... In the case something is compiled there,
	it should create libcpushared.a

	b) layout under processor specific directory is free provided
	that
		1)the result of the compilation process exports :

		libcpu/powerpc/"PROC"/*.h in $(PROJECT_INCLUDE)/libcpu

		2) each processor specific directory creates
		a library called libcpuspecific.a
	Note that this organization enables to have a file that
	is nearly the same than in shared but that must differ
	because of processor differences...

	c) "wrapup" should create libcpu.a using libcpushared.a
	libcpuspecific.a and export it $(PROJECT_INCLUDE)/libcpu

The only thing I have no ideal solution is the way to put shared
definitions in "shared" and only processor specific definition
in "proc". To give a concrete example, most MSR bit definition
are shared among PPC processors and only some differs. if we create
a single msr.h in shared it will have ifdef. If in msr.h we
include libcpu/msr_c.h we will need to have it in each prowerpc
specific directory (even empty). Opinions are welcomed ...

Note that a similar mechanism exist in libbsp/i386 that also
contains a shared directory that is used by several bsp
like pc386 and i386ex and a similar wrapup mechanism...

NB: I have done this for mpc750 and other processors could just use
similar Makefiles...

c) The exec/score/cpu/powerpc directory layout.

I think the directory layout should be the same than the
libcpu/powerpc. As it is not, there are a lot of ifdefs
inside the code... And of course low level interrupt handling
code should be removed...

Besides that I do not understand why

	1) things are compiled in the wrap directory,
	2) some includes are moved to rtems/score,

I think the "preinstall" mechanism enables to put
everything in the current directory (or better in a per processor
directory),


5) Interrupt handling API
-------------------------

Again :-). But I think that using all the features the PIC
offers is a MUST for RT system. I already explained in the
prologue of this (long and probably boring) mail that the MCP750
boards offers an OPENPIC compliant architecture and that
the VIA 82586 PCI/ISA bridge offers a PC compatible IO and
PIC mapping. Here is a logical view of the RAVEN/VIA 82586
interrupt mapping :


---------    0  ------
| OPEN	| <-----|8259|
| PIC	|	|    |    2  ------
|(RAVEN)|	|    | <-----|8259|
|	|	|    |	     |    |   11
|	|	|    |	     |    | <----
|	|	|    |	     |    |
|	|	|    |	     |    |
---------       ------	     |    |
    ^			     ------
    |		VIA PCI/ISA bridge
    |  x
    -------- PCI interrupts

OPENPIC offers interrupt priorities among PCI interrupts
and interrupt selective masking. The 8259 offers the same kind
of feature. With actual powerpc interrupt code :

	1) there is no way to specify priorities among
	interrupts handler. This is REALLY a bad thing.
	For me it is as importnat as having priorities
	for threads...
	2) for my implementation, each ISR should
	contain the code that acknowledge the RAVEN
	and 8259 cascade, modify interrupt mask on both
	chips, and reenable interrupt at processor level,
	..., restore then on interrupt return,.... This code
	is actually similar to code located in some
	genpvec.c powerpc files,
	3) I must update _ISR_Nesting_level because
	irq.inl use it...
	4) the libchip code connects the ISR via set_vector
	but the libchip handler code does not contain any code to
	manipulate external interrupt controller hardware
	in order to acknoledge the interrupt or re-enable
	them (except for the target hardware of course)
	So this code is broken unless set_vector adds an
	additionnal prologue/epilogue before calling/returning
	from in order to acknoledge/mask the raven and the
	8259 PICS... => Anyway already EACH BSP MUST REWRITE
	PART OF INTERRUPT HANDLING CODE TO CORRECTLY IMPLEMENT
	SET_VECTOR.

I would rather offer an API similar to the one provided
in libbsp/i386/shared/irq/irq.h so that :

	1) Once the driver supplied methods is called the
	only things the ISR has to do is to worry about the
	external hardware that triggered the interrupt.
	Everything on openpic/VIA/processor would have been
	done by the low levels (same things as set-vector)
	2) The caller will need to supply the on/off/isOn
	routine that are fundamental to correctly implements
	debuggers/performance monitoring is a portable way
	3) A globally configurable interrupt priorities
	mechanism...

I have nothing against providing a compatible
set_vector just to make libchip happy but
as I have already explained in  other
mails (months ago), I really think that the ISR
connection should be handled by the BSP and that no
code containing irq connection should exist the
rtems generic layers... Thus I really dislike
libchip on this aspect because in a long term
it will force to adopt the less reach API
for interrupt handling that exists (set_vector).

Additional note : I think the _ISR_Is_in_progress()
inline routine should be :

	1) Put in a processor specific section,
	2) Should not rely on a global variable,

As :
	a) on symmetric MP, there is one interrupt level
	per CPU,
	b) On processor that have an ISP (e,g 68040),
	this variable is useless (MSR bit testing could
	be used)
	c) On PPC, instead of using the address of the
	variable via __CPU_IRQ_info.Nest_level a dedicated
	SPR could be used.

NOTE:	most of this is also true for _Thread_Dispatch_disable_level


END NOTE
--------

Please do not take what I said in the mail as a criticism for
anyone who submitted ppc code. Any code present helped me
a lot understanding PPC behavior. I just wanted by this
mail to :
	1) try to better understand the actual code,
	2) propose concrete ways of enhancing current code
	by providing an alternative implementation for MCP750. I
	will make my best effort to try to brake nothing but this
	is actually hard due to the file layout organisation.
	3) make understandable some changes I will probably make
	if joel let me do them :-)

Any comments/objections are welcomed as usual.



--
   __
  /  `                   	Eric Valette
 /--   __  o _.          	Canon CRF
(___, / (_(_(__         	Rue de la touche lambert
				35517 Cesson-Sevigne  Cedex
				FRANCE
Tel: +33 (0)2 99 87 68 91	Fax: +33 (0)2 99 84 11 30
E-mail: valette@crf.canon.fr
1999-06-14 16:51:13 +00:00
..

#
#  $Id$
#

    make/README

    This file describes the layout and conventions of the make tree used in
    the RTEMS software project and others.
    All of these "make" trees are substantially similar; however this
    file documents the current state of the rtems Makefile tree.

    This make tree was developed originally to simplify porting projects
    between various os's.  The primary goals are:

        .  simple *and* customizable individual makefiles

        .  use widely available GNU make.  There is no pre-processing or
            automatic generation of Makefiles.

        .  Same makefiles work on *many* host os's due to portability
            of GNU make and the host os config files.

        .  Support for different compilers and operating systems
            on a per-user basis.  Using the same sources (including
            Makefiles) one developer can develop and test under SVR4,
            another under 4.x, another under HPUX.

        .  Builtin support for compiling "variants" such as debug,
            profile, and tcov versions.  These variants can be built
            recursively.

        .  Control of system dependencies.  "hidden" dependencies on
            environment variables (such as PATH)
            have been removed whenever possible.  No matter what your
            PATH variable is set to, you should get the same thing
            when you 'make' as everyone else on the project.

    This description attempts to cover all aspects of the Makefile tree.  Most
    of what is described here is maintained automatically by the configuration
    files.

    The example makefiles in make/Templates should be used as a starting
    point for new directories.

    There are 2 main types of Makefile:

        directory and leaf.

    Directory Makefiles
    -------------------

        A Makefile in a source directory with sub-directories is called a
        "directory" Makefile.

        Directory Makefile's are simply responsible for acting as "middle-men"
        and recursing into their sub-directories and propagating the make.

        For example, directory src/bin will contain only a Makefile and
        sub-directories.  No actual source code will reside in the directory.
        The following commands:

            $ cd src/bin
            $ make all

        would descend into all the subdirectories of 'src/bin' and recursively
        perform a 'make all'.

        A 'make debug' will recurse thru sub-directories as a debug build.

        A template directory Makefile which should work in almost all
        cases is in make/Templates/Makefile.dir


    Leaf Makefiles
    --------------

        Source directories that contain source code for libraries or
        programs use a "leaf" Makefile.

        These makefiles contain the rules necessary to build programs
        (or libraries).

        A template leaf Makefile is in Templates/Makefile.leaf .  A template
        leaf Makefile for building libraries is in Templates/Makefile.lib .


    NOTE: To simplify nested makefile's and source maintenance, we disallow
    combining source and directories (that make(1) would be expected to
    recurse into) in one source directory.  Ie., a directory in the source
    tree may contain EITHER source files OR recursive sub directories, but NOT
    both.

    Variants (where objects go)
    ---------------------------

        All binary targets are placed in a sub-directory whose name is (for
        example):

            o-force386/                -- binaries (no debug, no profile)
            o-force386-debug/          -- debug binaries
            o-force386-profile/        -- profiling binaries

        Using the template Makefiles, this will all happen automatically.

        Within a Makefile, the ${ARCH} variable is set to o-force386,
        o-force386-debug, etc., as appropriate.

        Typing 'make' will place objects in o-force386.
        'make debug' will place objects in o-force386-debug.
        'make profile' will place objects in o-force386-profile.

        NOTE:  For RTEMS work, the word 'force386' is the specified
               RTEMS_BSP (specified in the modules file)

        The debug and profile targets are equivalent to 'all' except that
        CFLAGS and/or LDFLAGS are modified as per the compiler config file for
        debug and profile support.

        Targets debug_install and profile_install are equivalent to 'make
        install' except that debug (or profile) variants are built and
        installed.

        The targets debug, profile, debug_install, profile_install, etc., can be
        invoked recursively at the directory make level.  So from the top of a
        tree, one could install a debug version of everything under that point
        by:

            $ cd src/lib
            $ gmake debug_install

        When building a command that is linked with a generated library, the
        appropriate version of the library will be linked in.

        For example, the following fragments link the normal, debug, or
        profile version of "libmine.a" as appropriate:

            LDLIBS   += $(LIBMINE)
            LIBMINE = ../libmine/${ARCH}/libmine.a

            ${ARCH}/pgm: $(LIBMINE) ${OBJS}
                $(LINK.c) -o $@ ${OBJS} $(LDLIBS)

        If we do 'gmake debug', then the library in
        ../libmine/sparc-debug/libmine.a will be linked in.  If $(LIBMINE)
        might not exist (or might be out of date) at this point, we could add

            ${LIBMINE}: FORCEIT
	        cd ../libmine; ${MAKE} ${VARIANT_VA}

        The above would generate the following command to build libmine.a:

            cd ../libmine; gmake debug

        The macro reference ${VARIANT_VA} converts ${ARCH} to the word 'debug'
        (in this example) and thus ensures the proper version of the library
        is built.


    Targets
    -------

        All Makefile's support the following targets:

            all                     -- make "everything"
            install                 -- install "everything"

        The following targets are provided automatically by
        the included config files:

            clean                   -- delete all targets
            clobber                 -- 'clean' plus delete sccs'd files
            lint                    -- run lint or lint-like tool
            get                     -- "sccs get" all sources
            depend                  -- build a make dependency file
            "variant targets"       -- special variants, see below


        All directory Makefiles automatically propagate all these targets.  If
        you don't wish to support 'all' or 'install' in your source directory,
        you must leave the rules section empty, as the parent directory Makefile
        will attempt it on recursive make's.


    Configuration
    -------------

        All the real work described here happens in file(s) included
        from your Makefile.

        All Makefiles include a customization file which is used to select
        compiler and host operating system.  The environment variable
        RTEMS_CUSTOM must point to this file; eg:

                /.../make/custom/force386.cfg

        All leaf Makefile's also include either 'make/leaf.cfg' (or
        'make/lib.cfg' for building libraries).  These config files provide
        default rules and set up the command macros as appropriate.

        All directory Makefiles include 'make/directory.cfg'.  directory.cfg
        provides all the rules for recursing through sub directories.

        The Makefile templates already perform these include's.

        'make/leaf.cfg' (or directory.cfg) in turn includes:

            a file specifying general purpose rules appropriate for
                both leaf and directory makefiles.
                ( make/main.cfg )

            personality modules specified by the customization file for:
                compiler            ( make/compilers/??.cfg )


        private customization files
        ---------------------------

            [ $(RTEMS_CUSTOM) ]

            Your own private configuration file.  Specifies which of the above
            files you want to include.

            Example: custom/force386.cfg

               CONFIG.$(HOST_ARCH).OS = $(RTEMS_ROOT)/make/os/HPUX-9.0.cfg

               # HOST Compiler config file
               # You may also want to specify where the compiler resides here.
               CC_$(HOST_ARCH)_DIR=/usr/local
               CONFIG.$(HOST_ARCH).CC   = $(RTEMS_ROOT)/make/compilers/gcc.cfg

               ## Target compiler config file, if any
               CC_$(TARGET_ARCH)_DIR=$(RTEMS_GNUTOOLS)
               CONFIG.$(TARGET_ARCH).CC = $(RTEMS_ROOT)/make/compilers/gcc-force386.cfg

        generic rules file
        ------------------

            [ make/main.cfg ]
            included by leaf.cfg or directory.cfg.

            This file contains some standard rules and variable assignments
            that all Makefiles need.

            It also includes the FORCEIT: pseudo target.


        OS config file for host machine
        -------------------------------

            [ make/os/OS-NAME.cfg ]
            included by main.cfg

            Figures out the target architecture and specifies command names
            for the OS tools including RCS/CVS (but NOT for the compiler tools).


        Compiler configuration for the target
        -------------------------------------

            [ compilers/COMPILER-NAME.cfg ]
            included by leaf.cfg

            Specifies the names of tools for compiling programs.
            Names in here should be fully qualified, and NOT depend on $PATH.

            Also specifies compiler flags to be used to generate optimized,
            debugging and profile versions, as well as rules to compile
            assembly language and make makefile dependencies.


    Configuration Variables
    -----------------------

        Variables you have to set in the environment or in your Makefile.
        Note: the rtems module files set RTEMS_ROOT and RTEMS_CUSTOM
        for you.

        Environment Variables
        ---------------------

            RTEMS_BSP      -- name of your 'bsp' eg: force386

            RTEMS_ROOT     -- The root of your source tree.
                              All other file names are derived from this.
                              [ eg: % setenv RTEMS_ROOT $HOME/work/rtems ]

            RTEMS_CUSTOM   -- name of your config files in make/custom
                              Example:
                                 $(RTEMS_ROOT)/make/custom/$(RTEMS_BSP).cfg

            RTEMS_GNUTOOLS -- root of the gcc tools for the target

            The value RTEMS_ROOT is used in the custom
            files to generate the make(1) variables:

                PROJECT_ROOT
                PROJECT_RELEASE
                PROJECT_TOOLS

            etc., which are used within the make config files themselves.
            (The files in make/*.cfg try to avoid use of word RTEMS so
            they can be more easily shared by other projects)

        Preset variables
        ----------------

            Aside from command names set by the os and compiler config files,
            a number of MAKE variables are automatically set and maintained by
            the config files.

            CONFIG.$(HOST_ARCH).CC
                        -- full path of C compilation config file, set by custom
                           config file.

            PROJECT_RELEASE
                        -- release/install directory
                           [ $(PROJECT_ROOT) ]

            PROJECT_BIN
                        -- directory for installed binaries
                           [ $(PROJECT_ROOT)/bin ]

            PROJECT_TOOLS
                        -- directory for build environment commands
                           [ eg: $(PROJECT_ROOT)/build-tools ]

            TARCH       -- ${TARGET_ARCH}
                           [ eg: o-forc386 ]
                           obsolete and should not be referenced

            ARCH        -- target sub-directory for object code
                           [ eg: o-force386 or o-force386-debug ]

            HOST_ARCH
                        -- host machine architecture name
                           [ eg: sun4, sparc on SVR4 ]

            VARIANTS    -- full list of all possible values for $(ARCH);
                           used mainly for 'make clean'
                           [ eg: "o-force386 o-force386-debug o-force386-profile" ]

            VARIANT_VA  -- Variant name.
                           Normally "", but for 'make debug' it is "debug",
                           for 'make profile', "profile, etc.

                           see make/leaf.cfg for more info.


        Preset compilation variables
        ----------------------------

          This is a list of some of the compilation variables.
          Refer to the compiler config files for the complete list.

            CFLAGS_OPTIMIZE_V   -- value of optimize flag for compiler
                                   [ eg: -O ]

            CFLAGS_DEBUG_V      -- value of debug flag for compiler
                                   [ eg: -g ]

            CFLAGS_PROFILE_V    -- compiler profile flags
                                   [ eg: -pg ]

            CFLAGS_DEBUG_OPTIMIZE_V
                                -- optimize flag if compiling for debug
                                     [ eg: "" ]

            CFLAGS_DEBUG
            CFLAGS_PROFILE
            CFLAGS_OPTIMIZE     -- current values for each depending
                                    on make variant.

            LDFLAGS_STATIC_LIBRARIES_V
                                -- ld option for static libraries
                                    -Bstatic or -dy (svr4)

            LDFLAGS_SHARED_LIBRARIES_V
                                -- ld option for dynamic libraries
                                    -Bdynamic or -dn (svr4)

            LIB_SOCKET
                                -- ld(1) -l option(s) to provide
                                    socket support.

            LIB_MATH            -- ld(1) -l option(s) to provide
                                    math library.


            Makefile Variables
            ------------------

                The following variables may be set in a typical Makefile.

                C_PIECES    -- File names of your .c files without '.c' suffix.
                               [ eg: C_PIECES=main funcs stuff ]

                CC_PIECES   -- ditto, except for .cc files

                S_PIECES    -- ditto, except for .S files.

                LIB         -- target library name in leaf library makefiles.
                               [ eg: LIB=${ARCH}/libmine.a ]

                H_FILES     -- your .h files in this directory.
                               [ eg: H_FILES=stuff.h extra.h ]

                DEFINES     -- cc -D items.  Included in CPPFLAGS.
                               leaf Makefiles.
                               [ eg: DEFINES += -DUNIX ]

                CPPFLAGS    -- -I include directories.
                               leaf Makefiles.
                               [ eg: CPPFLAGS += -I../include ]

                YFLAGS      -- Yacc flags.
                               leaf Makefiles.
                               [ eg: YFLAGS += -v ]

                LD_PATHS    -- arguments to -L for ld.
                               Will be prefixed with '-L' or '-L ' as appropriate
                               and included in LDFLAGS.

                LDFLAGS     -- -L arguments to ld; more may be ADDed.

                LD_LIBS     -- libraries to be linked in.
                               [ eg: LDLIBS += ../libfoo/${ARCH}/libfoo.a ]

                XCFLAGS     -- "extra" CFLAGS for special needs.  Pre-pended
                               to CFLAGS.
                               Not set or used by Makefiles.
                               Can be set on command line to pass extra flags
                               to the compiler.

                XCPPFLAGS   -- ditto for CPPFLAGS
                               Can be set on command line to pass extra flags
                               to the preprocessor.

                XCCPPFLAGS  -- same as XCPPFLAGS for C++.

                XCCFLAGS    -- same as XCFLAGS for C++.

                SUB_DIRS    -- list of sub directories for make recursion.
                               directory Makefiles only.
                               [ eg: SUB_DIRS=cpu bsp ]

                CLEAN_ADDITIONS
                            -- list of files or directories that should
                               be deleted by 'make clean'
                               [ eg: CLEAN_ADDITIONS += y.tab.c ]

                               See 'leaf.cfg' for the 'clean:' rule and its
                               default deletions.

                CLOBBER_ADDITIONS
                            -- list of files or directories that should
                               be deleted by 'make clobber'
                               Since 'make clobber' includes 'make clean',
                               you don't need to duplicate items in both.

                TARGET_ARCH -- target architecture (eg: o-force386)
                               leaf makefiles only.
                               Should be specified before 'include leaf.cfg'.
                               Only needs to be specified if your target is
                               different from output of `arch`.

            Command names
            -------------

                The following commands should only be called
                as make variables:

                    MAKE,INSTALL,SHELL

                    ECHO,CAT,RM,CP,MV,LN,MKDIR,CHMOD

                    ED,SED

                    CC,CPP,AS,AR,LD,NM,SIZE,RANLIB,MKLIB,
                    YACC,LEX,LINT,CTAGS,ETAGS

            Special Directory Makefile Targets
            ----------------------------------

                all_WRAPUP
                clean_WRAPUP
                install_WRAPUP
                clean_WRAPUP
                clobber_WRAPUP
                depend_WRAPUP
                            -- Specify additional commands for recursive
                               (directory level) targets.

                               This is handy in certain cases where you need
                               to do bit of work *after* a recursive make.

    make/Templates
    --------------

        This directory contains Makefile and source file templates that
        should help in creating or converting makefiles.

        Makefile.leaf
            Template leaf Makefiles.

        Makefile.lib
            Template leaf library Makefiles.

        Makefile.dir
            Template "directory" makefile.