makehelp.txt

picoos源码。The RTOS and the TCP/IP stack will be built automatically.

/** @file makefile *//**
@defgroup make Make Environment
@ingroup intro


                     <h3> Introduction </h3>

pico]OS comes with a powerful make environment based on GNU Make.
The make files are universal to all target platforms and most compilers.
They are the first step to platform independent software developement. @n

The core files of the make environment are located in the subdirectory
<tt>picoos/make</tt>. The main makefile for pico]OS is stored in the
pico]OS root directory, and every platform port comes with a makefile
that teaches the platform dependent environment to the make system. @n

The makefiles were tested with GNU make 3.80 @n
For MS Windows platforms, you can download a Windows version of make
from http://mingw.sourceforge.net/download.shtml @n


@n                 <h3> Compiling pico]OS </h3>

To compile the pico]OS library, you need to execute the makefile in the
pico]OS root directory. The makefile knows three targets, that are: @n

 - @c all    builds the pico]OS library
 - @c clean  deletes all binaries generated by previous make run
 - @c docu   builds the documentation using the doxygen tool

The targets @c all and @c clean need the additional parameter @c PORT that
specifies the destination port. For example, a valid make call would look
like this (at the DOS prompt): @n

@code
C:\picoos-1.0.0> make all PORT=6502
@endcode

This will build pico]OS for the 6502 processor family. After the successful
execution of make you will find two new subdirectories: The @c obj
directory contains all generated object files, and the @c lib directory
the final library. @n

There is a second option available on the command line: @c BUILD=DEBUG
will build a debug version of the operating system, and a @c BUILD=RELEASE
will build a release version. Note that the debug version is the default
when this option is not given. @n

@b Note:  The name of the port is the name of its subdirectory
          in the @c ports directory. @n



@n      <h3> Compiling pico]OS from within an other project </h3>

Usually you will have more than one project that uses pico]OS. pico]OS is
only installed one time on the harddisk, and you have several projects that
link against the pico]OS library. Every project has different requirements on
the RTOS, thus each project has its own configuration files for pico]OS. To
avoid binary clashes with the other projects, it is required to tell make where
the configuration files are located and where the generated pico]OS library
shall be stored. This is done by two additional arguments in the command line
of the make call: @n

@code
C:\picoos-1.0.0> make all PORT=6502  RTOS_OUTPUTDIR=/repository/myproj/RTOS   \
                                     DIR_CONFIG=/repository/myproj/config
@endcode

The parameter @c RTOS_OUTPUTDIR tells make where to store the generated
pico]OS library. @c DIR_CONFIG specifies the directory where the configuration
files can be found. Note that the paths should be absolute paths, or,
relative paths from the view of pico]OS (and that is mostly impracticable).



@n               <h3> Building An Application </h3>

The pico]OS library is only the first step to an executable. The make
environment supports also the linking of object files and libraries
to get an executable. For example, you have written a 'hello world'
program that uses pico]OS. To compile and link the file @c hello.c you
need to perform the following steps: @n

 - create a subdirectory somewhere in the @c picoos directory tree
 - place your file @c hello.c in this directory
 - generate and place a makefile (or copy and rename the file @c outfile.mak
   from the examples directory) in the same directory. The makefile
   should look like this:

@code
01 # ---------------------------------------------------------------------------
02 # PRECONDITION SETUP
03 # ---------------------------------------------------------------------------
04
05 # Set relative path to the picoos root directory  -> YOU NEED TO CHANGE THIS!
06 RELROOT = ../../../picoos/
07
08 # Set fixed target platform                       -> YOU MAY CHANGE THIS!
09 #PORT = x86w32  (->need to be specified at the command line)
10
11 # Set fixed build mode (DEBUG or RELEASE)         -> YOU MAY CHANGE THIS!
12 #BUILD = DEBUG  (->need to be specified at the command line)
13
14 # Get pico]OS path from environment (if it is set)
15 ifneq '$(strip $(PICOOS))' ''
16 RELROOT := $(PICOOS)/
17 endif
18
19 # Include common makefile
20 include $(RELROOT)make/common.mak
21
22
23
24 # ---------------------------------------------------------------------------
25 # PROJECT SETTINGS
26 # ---------------------------------------------------------------------------
27
28 # To include the pico]OS nano layer, set this define to 1
29 NANO = 0
30
31 # Set target filename (the name of the executable, without extension)
32 TARGET = hello
33
34
35 ### Set up lists of source files ###
36
37 # Set list of C source files / assembler files
38 SRC_TXT = hello.c
39
40 # Set list of header files used by the C source files
41 SRC_HDR = 
42
43 # You may add some already compiled object files here
44 SRC_OBJ =
45
46 # Add the libraries you are using in your program here
47 SRC_LIB =
48
49
50 # Set additional C-defines
51 CDEFINES +=
52
53 # Set additional include paths
54 DIR_USRINC +=
55
56 # Set the directory that contains the configuration header files.
57 # If this variable is not set, the default configuration files will be
58 # taken from the port/default directory.
59 # If you wish to use your own configuration files, you can place them
60 # in the current directory. Then, set  DIR_CONFIG = $(CURRENTDIR)
61 DIR_CONFIG =
62
63 # Set the output directory for the generated binaries. If you do not
64 # set this variable, the files will be stored in the pico]OS root
65 # root directory structure (pioos/out, picoos/lib, picoos/obj)
66 DIR_OUTPUT = $(CURRENTDIR)/bin
67
68 # Include pico]OS based modules. Set here the list of modules
69 # (libraries) you want to use in your project. Note that the module
70 # name is the name of the directory where the sources and the makefile
71 # is stored. The makefile must be named "makefile" or "makefile.pico"
72 # Example:  MODULES += $(RELROOT)../lcdinterface
73 MODULES +=
74
75 # Execute external makefiles to build other libraries. Add here
76 # the filenames (with path) of other makefiles you wish to execute.
77 EXEC_MAKEFILES +=
78
79
80
81 # ---------------------------------------------------------------------------
82 # BUILD THE EXECUTABLE
83 # ---------------------------------------------------------------------------
84
85 include $(MAKE_OUT)
86
@endcode

The lines 6, 20, 32, 38 and 85 are mandatory. The @c PORT variable may also
be set at the command line when make is invoked, even like the @c BUILD mode.
@c RELROOT sets the relative way to the pico]OS root directory.
Line 20 includes the main makefile of the make environment. In line 29 you
can enable the nano layer of pico]OS that is available with pico]OS 0.8.0.
Line 32 sets the name of the executable to generate. Note that only the
basename must be specified, the file extension is added automatically.
Lines 37 to 47 set the source files that shall be linked to the pico]OS
library. @c SRC_TXT specifies a list of sourcecode files (in textual form).
@c SRC_OBJ and @c SRC_LIB specify a list of existing object files and
libraries that shall be linked to the executable. @c SRC_HDR is a list of
the header files that are used by your project.
In line 51 you can set preprocessor defines to control the compilation
of your software. The defines are passed to the compiler and can be checked
with the #if / #endif preprocessor command in the C source files.
Additional include paths for header files can be set in line 54. Please
use the preprocessor command @c #include @c <header.h> to include a header
file that is located in the global include path. If your application uses
an other configuration than the default, you can place your own configuration
files @c poscfg.h and @c noscfg.h into your project directory. You must then
set @c DIR_CONFIG (line 61) to the place where the configuration files are
located. Note that this path is absolute to the pico]OS root, so if your
project directory is <tt>picoos-1.0.0/myproject</tt>, you would set
<tt>DIR_CONFIG = myproject</tt>. To make things easier, the pre-defined
variable @c CURRENTDIR points always to the current directory.
In line 66 you may specify your own output directory for the generated
binaries. If you do not set this variable, the binaries will be saved in
the directory <tt>picoos-1.0.0/out/portname/rel_or_deb/</tt>.
Finally, the line 85 includes the makefile that starts the
build process. @n

There is something special you should notice: You can tell the
makefile to execute other, external makefiles. For example, this is useful
to start a makefile that shall compile a library that is used by your
program. Usually, you would add the library to the @c SRC_LIB variable in
line 47. The corresponding library makefile can be added to the variable
@c EXEC_MAKEFILES in line 77. Every time this makefile is executed, also the
library makefile will be executed, ensuring the library is up to date. @n

And there is another special thing: You can divide your project into smaller
modules. The modules are compiled to libraries and the libraries are then
linked to the main program. For your own libraries, you should use the 
template makefile 'library.mak' in the examples directory. A description of
this file you will find in the next section, see below. If you are using this
modularized architecture, you can simply add the modules you wish to link