source: rtems/README.configure @ 78a345f6

4.104.115
Last change on this file since 78a345f6 was 3fc13ac9, checked in by Joel Sherrill <joel.sherrill@…>, on 10/02/08 at 22:33:44

2008-10-02 Joel Sherrill <joel.sherrill@…>

  • README.configure: Add new M32R port. It is just a beginning but the BSP is functional enough to initialize and shutdown RTEMS.
  • Property mode set to 100644
File size: 8.3 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, Solaris and HPUX.
92
93      arm-rtems4.10
94      bfin-rtems4.10
95      h8300-rtems4.10
96      i386-rtems4.10
97      m32c-rtems4.10
98      m32r-rtems4.10
99      m68k-rtems4.10
100      mips-rtems4.10
101      no_cpu-rtems4.10
102      powerpc-rtems4.10
103      sh-rtems4.10
104      sparc-rtems4.10
105      bare                    see notes
106
107The cross-compiler is set to $(target)-gcc by default.
108
109To build, run make in the build directory. To specify which bsps to build,
110add the RTEMS_BSP="bsp1 bsp2 .." to the make command.  Specifying multiple
111BSPs to build only works from the top level build directory.
112
113Installation is done under $(prefix)/rtems.
114
115As an example, to build and install the mvme136 and mvme162 bsps for m68k do:
116
117      (path_to_rtems_src)/configure --target=m68k-rtems
118
119      make RTEMS_BSP="mvme136 mvme162"
120     
121      make install RTEMS_BSP="mvme136 mvme162"
122
123The sample tests are built by 'make all' when configured with
124--enable-tests=samples.  Use --enable-tests=all to build the full
125test suite.
126
127Documentation is built separately from the source code.
128
1292.2 Target Dependent Notes
130
131bare:
132
1331.  See the README in the bare bsp source directory. This should
134    contain all info you need.
1352.  The bare bsp source contains a script to show how to build it.
1363.  The configure flags must be used to get the bare bsp to work.
137    The --enable-bare-cpu-model and --enable-bare-cpu-cflags are the
138    only pieces of information. The module is usually a gcc module
139    such as m68302 or mcpu32. The flags are passed directly to gcc.
140    Use "" if more than one option is specified.
141
1423. To use the installed RTEMS library
143=====================================
144
145To use the installed RTEMS bsps to build applications, the application
146makefile has to include a bsp-specific makefile that will define the
147RTEMS variables necessary to find include files and libraries. The
148bsp-specific makefile is installed at
149
150      $(RTEMS_MAKEFILE_PATH)/Makefile.inc
151
152For the erc32 bsp installed at /usr/local/cross, the environment
153variable RTEMS_MAKEFILE_PATH would be set as follows to the
154following:
155
156/usr/local/cross/sparc-rtems/rtems/erc32/Makefile.inc
157
1584. Supported target bsps
159========================
160
161The following bsps are supported:
162
163host-based      : posix (on Linux, FreeBSD, Cygwin, Solaris, and HPUX)
164
165arm             : csb336 csb337 edb7312 gba gp32 nds rtl22x rtl22xx_t
166                  smdk2410
167
168avr:            : none
169
170bfin            : eZKit533 bf537Stamp
171
172c4x             : c3xsim c4xsim
173
174h8300           : h8sim
175
176i386            : i386ex pc386 pc386dx pc486 pc586 pc686 pck6 ts_386ex
177                NOTE: The "pc386" BSP can be compiled to support a
178                      variety of PC configurations including PC-104
179                      based solutions.
180
181m32c            : m32csim
182
183m32r            : m32rsim
184
185m68k            : av5282 csb360 gen68302 gen68360 gen68360_040
186                genmcf548x idp mcf5206elite mcf52235 mcf5235 mcf5239
187                m5484FireEngine mrm332 mvme136 mvme147s mvme162 mvme162lx
188                mvme167 ods68302 pgh360 sim68000 simcpu32 uC5282
189
190no_cpu          : no_bsp  (porting example)
191
192mips            : csb350 genmongoosev hurricane jmr3904 rbtx4925 rbtx4938
193                p4600 p4650
194
195powerpc         : brs5l ep1a gen5200 gen83xx haleakala hsc_cm01 icecube
196                mbx821_001 mbx821_002 mbx821_002b mbx860_001b mbx860_002
197                mbx860_005b mcp750 mvme2100 mvme2307 mtx603e
198                mvme5500 mpc55xxevb mpc8260ads mpc8313erdb mpc8349eamds
199                pghplus pm520_cr825 pm520_ze30 psim score603e ss555
200                tqm8xx_stk8xx virtex
201
202                  NOTE: The "motorola_powerpc" BSP is a single BSP which
203                  can be conditionally compiled to support most Motorola
204                  VMEbus, CompactPCI, and MTX boards.)
205
206                  NOTE: The mbx8xx, gen5200, gen83xx, and tqm8xx BSPs are
207                  designed to handle a variety of boards based on the same
208                  family of system on chips CPUs
209
210sh              : gensh1 gensh2 gensh4 simsh1 simsh2 simsh4
211
212sparc           : erc32 sis leon2 leon3
213
214any             : bare
215
216The following ports were considered obsoleted after the 4.6 releases
217and were removed: a29k, hppa, i960, mips64orion, and or32.
218
219
2205. Makefile structure
221=====================
222
223The makefiles have been re-organized. Most gnu-based bsps now use three
224main makefiles:
225    + custom/default.cfg,
226    + custom/bsp.cfg and
227    + compilers/gcc-target-default.cfg.
228
229Default.cfg sets the default values of certain common build options.
230
231Bsp.cfg set bsp-specific build options and can also override the
232default settings.
233
234Gcc-target-default.cfg contains the common gcc definitions.
235
2366. Adding a bsp
237===============
238
239Please refer to the BSP and Device Driver Guide.
240
241
2427. Tested configurations
243========================
244
245All gnu-based bsps have been built on Linux.
246
247The native (posix) ports have been built and run only on Linux.
248
249The following configurations have NOT been tested:
250
251    + Anything on Nextstep, HPUX and Irix.
252    + The C4x and OR32 ports (requires specially patched toolchain)
253
2548. Prerequisites
255================
256
257Gawk version 2 or higher.
258GNU make version 3.72 or higher.
259Bash.
260gcc version > 2.8
261
262NOTE: These prerequisites are probably out of date but autoconf should detect
263      any problems.
Note: See TracBrowser for help on using the repository browser.