source: rtems/README.configure @ 504112d

4.104.114.84.9
Last change on this file since 504112d was c7f8bbea, checked in by Joel Sherrill <joel.sherrill@…>, on Sep 29, 2004 at 8:44:45 PM

2004-09-29 Joel Sherrill <joel@…>

  • MAINTAINERS, README.configure, c/ACKNOWLEDGEMENTS, c/TOOL_TARGETS: i960 obsoleted and all references removed.
  • Property mode set to 100644
File size: 8.4 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 dmv152 bsps for m68k do:
122
123        (path_to_rtems_src)/configure --target=m68k-rtems
124
125        make RTEMS_BSP="mvme136 dmv152"
126       
127        make install RTEMS_BSP="mvme136 dmv152"
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
147  1.  See the README in the bare bsp source directory. This should
148      contain all info you need.
149  2.  The bare bsp source contains a script to show how to build it.
150  3.  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             : arm_bare_bsp armulator csb336 csb337 edb7312 vegaplus
180
181c4x             : c3xsim c4xsim
182
183h8300           : h8sim
184
185i386            : i386ex pc386 pc386dx pc486 pc586 pc686 pck6 ts_386ex
186                  NOTE: The "pc386" BSP can be compiled to support a
187                        variety of PC configurations including PC-104
188                        based solutions.
189
190m68k            : dmv152 csb360 gen68302 gen68340 gen68360 gen68360_040
191                  idp mcf5206elite mrm332 mvme136 mvme147 mvme147s
192                  mvme162 mvme162lx ods68302 sim68000 simcpu32
193
194no_cpu          : no_bsp  (porting example)
195
196mips            : p4600 p4650 (p4000 port with either R4600 or R4650)
197                  jmr3904 genmongoosev
198
199or32:           : orp
200
201powerpc         : dmv177 eth_comm gen405 helas403 mcp750 mbx8xx mtx603e
202                  mpc8260ads mvme230x ppcn_60x psim score603e ss555
203
204                  NOTE: The "motorola_powerpc" BSP is a single BSP which
205                  can be conditionally compiled to support most Motorola
206                  VMEbus, CompactPCI, and MTX boards.)
207
208sh              : gensh1 gensh2 shsim simsh4 gensh4
209
210sparc           : erc32 erc32nfp leon1 leon2
211
212any             : bare
213
214The following ports were considered obsoleted after the 4.6 releases
215and were removed: a29k, hppa, i960, and mips64orion.
216
217
2185. Makefile structure
219=====================
220
221The makefiles have been re-organized. Most gnu-based bsps now use three
222main makefiles:
223    + custom/default.cfg,
224    + custom/bsp.cfg and
225    + compilers/gcc-target-default.cfg.
226
227Default.cfg sets the default values of certain common build options.
228
229Bsp.cfg set bsp-specific build options and can also override the
230default settings.
231
232Gcc-target-default.cfg contains the common gcc definitions.
233
2346. Adding a bsp
235===============
236
237Please refer to the BSP and Device Driver Guide.
238
239
2407. Tested configurations
241========================
242
243All gnu-based bsps have been built on Linux.
244
245The native (posix) ports have been built and run only on Linux.
246
247The following configurations have NOT been tested:
248
249    + Anything on Nextstep, HPUX and Irix.
250    + The C4x and OR32 ports (requires specially patched toolchain)
251
2528. Prerequisites
253================
254
255Gawk version 2 or higher.
256GNU make version 3.72 or higher.
257Bash.
258gcc version > 2.8
259
260NOTE: These prerequisites are probably out of date but autoconf should detect
261      any problems.
Note: See TracBrowser for help on using the repository browser.