source: rtems/README.configure @ 73cdeb6

4.104.114.84.9
Last change on this file since 73cdeb6 was 73cdeb6, checked in by Thomas Doerfler <Thomas.Doerfler@…>, on Jul 4, 2007 at 12:25:49 PM

merged individual exception handler code to a common one.

  • Property mode set to 100644
File size: 8.6 KB
Line 
1#
2#  $Id$
3#
4
51. Autoconf support
6===================
7
8This version of RTEMS is configured with GNU autoconf. RTEMS can be
9configured and built either standalone or together with the compiler
10tools in the Cygnus one-tree structure. Using autoconf also means
11that RTEMS now can be built in a separate build directory.
12
13To re-generate auto*tool generated files (configure, Makefile.in etc),
14autoconf-2.59 and automake-1.8 are required.
15
162. Installation
17===============
18
192.1 Standalone build
20
21To configure RTEMS for a specific target, run configure in the build
22directory. In addition to the standard configure options, the following
23RTEMS-specific option are supported:
24
25      --disable-rtems-inlines
26      --disable-posix
27      --disable-itron
28      --disable-networking
29      --enable-cxx
30      --enable-bare-cpu-model=<MODEL>
31      --enable-bare-cpu-cflags=<FLAGS>
32      --enable-multiprocessing
33      --enable-rtemsbsp="bsp1 bsp2 ..."
34      --enable-tests
35      --enable-rdbg            (only valid for i386 and some PowerPC BSPs)
36      --enable-docs
37
38In addition, the following standard autoconf options are frequently
39used when configuring RTEMS installations:
40
41      --prefix=INSTALL_DIRECTORY
42
43By default, inline routines are used instead of macros where possible.
44Macros can be selected using the --disable-inlines option.  [NOTE:
45Some APIs may not support macro versions of their inline routines.]
46
47By default, the RTEMS POSIX 1003.1b interface is built for targets that support
48it. It can be disabled with the --disable-posix option.
49
50By default, the RTEMS uITRON interface is built for targets that support
51it. It can be disabled with the --disable-itron option.
52
53By default, the RTEMS networking support is built for targets which
54support it.  It can be specifically disabled for those targets
55with the --disable-networking option.
56
57By default, the RTEMS remote debugger server support is not built.
58It can be specifically enabled for the targets that support it.
59with the --enable-rdbg option. NB : the RTEMS networking support
60must be enabled to support the remote debugger server.
61
62By default, the RTEMS support of C++ is disabled.  It can be enabled
63with the --enable-cxx option. If the rtems++ C++ library is installed
64it will also be build.
65
66By default, the RTEMS test suites are NOT configured -- only the
67sample tests are built.  --enable-tests will configure
68the RTEMS test suite. The default speeds up the build
69and configure process when the tests are not desired.
70
71By default, RTEMS is built using arguments and build rules which require a
72gcc supporting the -specs option, ie. a gcc >= 2.8.
73[The --disable-gcc28 option, which has been present in former releases, has
74been removed.]
75
76By default, multiprocessing is is not built.  It can be enabled
77for those BSPs supporting it by the --enable-multiprocessing option.
78
79By default, all bsps for a target are built. The bare BSP is not built
80unless directly specified. There are  two ways of changing this:
81
82+ use the --enable-rtemsbsp option which will set the specified
83  bsps as the default bsps, or
84+ set the RTEMS_BSP variable during make (see below).
85
86The --enable-rtemsbsp= option configures RTEMS for a specific board
87within a target architecture.  Remember that the target specifies the
88CPU family while the BSP specifies the precise board you will be using.
89The following targets are supported:
90
91      (none)                    will build the host-based version on Linux,
92                              Solaris and HPUX.
93
94      arm-rtems
95      c4x-rtems
96      h8300-rtems
97      i386-rtems
98      m68k-rtems
99      mips-rtems
100      no_cpu-rtems
101      or32-rtems
102      powerpc-rtems
103      sh-rtems
104      sparc-rtems
105      bare                    see notes
106
107The cross-compiler is set to $(target)-gcc by default. This can be
108overridden by:
109
110+ using the --program-prefix option to configure to specify the
111  string which will prepended to the tool names.  Be sure to include
112  a trailing "-".  For example, to use a m68k-coff toolset, use the
113  --program-prefix=m68k-coff- option.
114
115To build, run make in the build directory. To specify which bsps to build,
116add the RTEMS_BSP="bsp1 bsp2 .." to the make command.  Specifying multiple
117BSPs to build only works from the top level build directory.
118
119Installation is done under $(prefix)/rtems.
120
121As an example, to build and install the mvme136 and mvme162 bsps for m68k do:
122
123      (path_to_rtems_src)/configure --target=m68k-rtems
124
125      make RTEMS_BSP="mvme136 mvme162"
126     
127      make install RTEMS_BSP="mvme136 mvme162"
128
129The sample tests are built by 'make all', do a 'make test' to build the full
130test suite.
131
132By default, --enable-docs is disabled and documentation is not built.
133
1342.2 Build with Cygnus one-tree release
135
136[NOTE: This section does not apply anymore.]
137
138To build and install RTEMS with the one-tree structure, just copy the rtems
139directory to the tree. The one-tree configure.in and Makefile.in has to be
140replaced with the RTEMS-aware versions. The build options are the same as
141for the standalone build.
142
1432.3 Target Dependent Notes
144
145bare:
146
1471.  See the README in the bare bsp source directory. This should
148    contain all info you need.
1492.  The bare bsp source contains a script to show how to build it.
1503.  The configure flags must be used to get the bare bsp to work.
151    The --enable-bare-cpu-model and --enable-bare-cpu-cflags are the
152    only pieces of information. The module is usually a gcc module
153    such as m68302 or mcpu32. The flags are passed directly to gcc.
154    Use "" if more than one option is specified.
155
1563. To use the installed RTEMS library
157=====================================
158
159To use the installed RTEMS bsps to build applications, the application
160makefile has to include a bsp-specific makefile that will define the
161RTEMS variables necessary to find include files and libraries. The
162bsp-specific makefile is installed at
163
164      $(RTEMS_MAKEFILE_PATH)/Makefile.inc
165
166For the erc32 bsp installed at /usr/local/cross, the environment
167variable RTEMS_MAKEFILE_PATH would be set as follows to the
168following:
169
170/usr/local/cross/sparc-rtems/rtems/erc32/Makefile.inc
171
1724. Supported target bsps
173========================
174
175The following bsps are supported:
176
177host-based      : posix (on Linux, FreeBSD, Cygwin, Solaris, and HPUX)
178
179arm             : csb336 csb337 edb7312 gba gp32 rtl22x
180
181avr:            : none
182
183bfin            : eZKit533
184
185c4x             : c3xsim c4xsim
186
187h8300           : h8sim
188
189i386            : 386ex pc386 pc386dx pc486 pc586 pc686 pck6 ts_386ex
190                NOTE: The "pc386" BSP can be compiled to support a
191                      variety of PC configurations including PC-104
192                      based solutions.
193
194m68k            : gen68360 gen68360_040 mvme136 mvme147s mvme162 mvme162lx
195                mvme167 ods68302 sim68000 mcf5206elite uC5282
196                gen68302 csb360 simcpu32 mrm332 av5282 gen68340 mcf5235 idp
197
198no_cpu          : no_bsp  (porting example)
199
200mips            : csb350 genmongoosev hurricane jmr3904 rbtx4925 rbtx4938
201
202powerpc         : psim score603e mcp750 mvme2100 mvme2307 mpc8260ads ss555
203                  mvme5500 ep1a pm520_cr825 pm520_ze30 gen405 helas403
204                  mbx821_001 mbx821_002 mbx821_002b mbx860_001b
205                  mbx860_002 mbx860_005b mtx603e brs5l gen5200 ep5200
206                  virtex
207
208                  NOTE: The "motorola_powerpc" BSP is a single BSP which
209                  can be conditionally compiled to support most Motorola
210                  VMEbus, CompactPCI, and MTX boards.)
211
212                  NOTE: The ep5200 is a clone of the 5200Lite a.k.a. IceCube.
213
214sh              : gensh1 gensh2 gensh4 shsim simsh4 simsh7045
215
216sparc           : erc32 sis leon2 leon3
217
218any             : bare
219
220The following ports were considered obsoleted after the 4.6 releases
221and were removed: a29k, hppa, i960, mips64orion, and or32.
222
223
2245. Makefile structure
225=====================
226
227The makefiles have been re-organized. Most gnu-based bsps now use three
228main makefiles:
229    + custom/default.cfg,
230    + custom/bsp.cfg and
231    + compilers/gcc-target-default.cfg.
232
233Default.cfg sets the default values of certain common build options.
234
235Bsp.cfg set bsp-specific build options and can also override the
236default settings.
237
238Gcc-target-default.cfg contains the common gcc definitions.
239
2406. Adding a bsp
241===============
242
243Please refer to the BSP and Device Driver Guide.
244
245
2467. Tested configurations
247========================
248
249All gnu-based bsps have been built on Linux.
250
251The native (posix) ports have been built and run only on Linux.
252
253The following configurations have NOT been tested:
254
255    + Anything on Nextstep, HPUX and Irix.
256    + The C4x and OR32 ports (requires specially patched toolchain)
257
2588. Prerequisites
259================
260
261Gawk version 2 or higher.
262GNU make version 3.72 or higher.
263Bash.
264gcc version > 2.8
265
266NOTE: These prerequisites are probably out of date but autoconf should detect
267      any problems.
Note: See TracBrowser for help on using the repository browser.