mirror of
https://github.com/elua/elua.git
synced 2025-01-08 20:56:17 +08:00
c08e1ae7b0
- deleting references to the old build system - arch_newport switched to AsciiDoc and updated with the new build system/configurator - added 'source-highlighter' as a dependency to the doc builder
185 lines
10 KiB
HTML
185 lines
10 KiB
HTML
$$HEADER$$
|
|
<h3>Toolchains for eLua</h3>
|
|
<p>You need (at least) a toolchain if you decide to build <b>eLua</b> yourself. The toolchain must contain at least a compiler, an assembler, a linker and (most likely) a tool to extract binary
|
|
data from the compiled image (in order to build the actual firmware). Also, a program that reports the sizes of different sections in the compiled image is often used to give an idea about the
|
|
resource consumption of <b>eLua</b>. You can use as many toolchains as you want for a given target, as long as the build scripts know to handle them. This
|
|
section outlines the different toolchain choices available for compiling <b>eLua</b>. Use the links below to navigate directly to your target of interest.</p>
|
|
<ul>
|
|
<li><a href="#armcortex">Toolchains for ARM and Cortex</a></li>
|
|
<li><a href="#avr32">Toolchains for AVR32</a></li>
|
|
<li><a href="#i386">Toolchains for i386</a></li>
|
|
</ul>
|
|
<p>If you have a different toolchain, refer to the <a href="#configuration">toolchain configuration</a> paragraph in this document.</p>
|
|
<a name="armcortex"><h2>Toolcains for ARM and Cortex</h2></a>
|
|
<p>You have multiple options when building <b>eLua</b> for ARM and Cortex CPUs:</p>
|
|
<ul>
|
|
<li>build your own toolchain. Even if you have a toolchain already available, you might want to do this for maximum flexibility and control (for example to control the libc build flags, or to
|
|
use specific version of the tools). Check <a href="tchainbuild.html">this link</a> for a step by step tutorial on building your own toolchain.</li>
|
|
<li>use a readily available toolchain. This saves you the hassle of building the toolchain yourself, which makes the process quicker and less error-prone.</li>
|
|
</ul>
|
|
<p>Because building a toolchain is already covered in another section of the documentation, we'll focus on installing a pre-compiled toolchain here. ARM is a very popular architecture, and because
|
|
of this there are a lot of toolchains available for download free of charge. One of the most popular ones comes from <a href="http://www.codesourcery.com">CodeSourcery</a>, and we'll cover it here for a number of important reasons:</p>
|
|
<ul>
|
|
<li>it has support for both "traditional" ARM targets and Cortex-M3 (Thumb2) targets</li>
|
|
<li>it comes with user-friendly installers for both Linux and Windows</li>
|
|
<li>it has fairly good documentation</li>
|
|
<li><b>eLua</b> supports this toolchain for all its ARM and Cortex targets</li>
|
|
</ul>
|
|
<p>Obtaining and installing the toolchain is very easy:</p>
|
|
<ol>
|
|
<li>go to <a href="http://www.codesourcery.com/sgpp/lite/arm/portal/subscription?@template=lite">the CodeSourcery download location</a> for the toolchain.</li>
|
|
<li>select from the table the current version in the "EABI" line (the link to the current version is just above the "All versions..." link).</li>
|
|
<li>download and run the installer.</li>
|
|
</ol>
|
|
<p>That's all! Make sure that the location of the toolchain is in your $PATH and build <b>eLua</b> with the <b>toolchain=codesourcery</b> option.</p>
|
|
<a name="avr32"><h2>Toolchains for AVR32</h2></a>
|
|
<p>Currently you have only one option for AVR32: download and install the toolchain from <a href="http://www.atmel.com">Atmel</a>. Unfortuntely they don't provide an installer, just a bunch of
|
|
Linux packages with some dependencies, so the installation process might be a bit tricky. These are the steps you should follow to install Atmel's AVR32 toolchain:</p>
|
|
<ul>
|
|
<li>download the correct version for your Linux distribution (in this case Ubuntu) from <a href="http://www.atmel.com/dyn/products/tools_card.asp?tool_id=4118">here</a>.</li>
|
|
<li>unzip the downloaded archive to a temporary directory, you'll get a bunch of .deb packages</li>
|
|
<li>install the packages from this command line (the package names are based on version 2.1.4 of the toolchain, change them as needed if you're using a different version):
|
|
<pre><code>$ sudo dpkg -i libavr32ocd1_3.0.9-1_i386.deb libavr32sim_0.2.1-1_i386.deb
|
|
$ sudo dpkg -i libavrtools1_3.0.9-1_i386.deb libelfdwarfparser_2.0.7-1_i386.deb
|
|
$ sudo dpkg -i avr32headers_1.9.11-1_all.deb
|
|
$ sudo dpkg -i avr32parts_1.9.9-1_all.deb
|
|
$ sudo dpkg -i avr32-binutils_2.17.atmel.1.2.6-2_i386
|
|
$ sudo dpkg -i avr32-gcc-newlib_4.2.2-atmel.1.0.8-2_i386.deb
|
|
$ sudo dpkg -i avr32program_3.0.4-1_i386.deb</code></pre>
|
|
If dpkg complains about missing dependencies, install them as required and resume the installation process.
|
|
</li>
|
|
</ul>
|
|
<p>That's it. Your toolchain is already be in $PATH (since it installs itself in /usr/bin) so you should be ready to build <b>eLua</b> for AVR32.</p>
|
|
<a name="i386"><h2>Toolchains for i386</h2></a>
|
|
<p>Currently the only tested procedure for building <b>eLua</b> for i386 is to <a href="tc_386.html">build an i386 toolchain</a>. Other toolchains might work equally well though, but none was tested so far.
|
|
</p>
|
|
<a name="configuration"><h3>Toolchain configuration in eLua <span style="color: red;">(WIP)</span></h3></a>
|
|
<p>The <b>eLua</b> build system makes provisions for specifying an unlimited number of toolchains for a given target, selectable via the build_elua <b>toolchain=...</b> option. The default structure
|
|
of each of the toolchains supported by default is listed in the table below.</p>
|
|
<table class="table_center">
|
|
<tbody>
|
|
<tr>
|
|
<th>Toolchain</th>
|
|
<th style="text-align:center;" rowspan="2">Name</th>
|
|
<th style="text-align:center;" rowspan="2">Compiler</th>
|
|
<th style="text-align:center;" rowspan="2">Linker</th>
|
|
<th style="text-align:center;" rowspan="2">Assembler</th>
|
|
<th style="text-align:center;" rowspan="2">Size tool</th>
|
|
<th style="text-align:center;" rowspan="2">Image copy tool</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Platform</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="color: rgb(255, 102, 0);">ARM (ELF)</td>
|
|
<td style="text-align:center;">arm-gcc</td>
|
|
<td style="text-align:center;">arm-elf-gcc</td>
|
|
<td style="text-align:center;">arm-elf-ld</td>
|
|
<td style="text-align:center;">arm-elf-as</td>
|
|
<td style="text-align:center;">arm-elf-size</td>
|
|
<td style="text-align:center;">arm-elf-objcopy</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="color: rgb(255, 102, 0);">ARM (EABI)</td>
|
|
<td style="text-align:center;">codesourcery</td>
|
|
<td style="text-align:center;">arm-none-eabi-gcc</td>
|
|
<td style="text-align:center;">arm-none-eabi-ld</td>
|
|
<td style="text-align:center;">arm-none-eabi-as</td>
|
|
<td style="text-align:center;">arm-none-eabi-size</td>
|
|
<td style="text-align:center;">arm-none-eabi-objcopy</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="color: rgb(255, 102, 0);">Cortex (ELF)</td>
|
|
<td style="text-align:center;">arm-gcc</td>
|
|
<td style="text-align:center;">arm-elf-gcc</td>
|
|
<td style="text-align:center;">arm-elf-ld</td>
|
|
<td style="text-align:center;">arm-elf-as</td>
|
|
<td style="text-align:center;">arm-elf-size</td>
|
|
<td style="text-align:center;">arm-elf-objcopy</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="color: rgb(255, 102, 0);">Cortex (EABI)</td>
|
|
<td style="text-align:center;">codesourcery</td>
|
|
<td style="text-align:center;">arm-none-eabi-gcc</td>
|
|
<td style="text-align:center;">arm-none-eabi-ld</td>
|
|
<td style="text-align:center;">arm-none-eabi-as</td>
|
|
<td style="text-align:center;">arm-none-eabi-size</td>
|
|
<td style="text-align:center;">arm-none-eabi-objcopy</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="color: rgb(255, 102, 0);">AVR32</td>
|
|
<td style="text-align:center;">avr32-gcc</td>
|
|
<td style="text-align:center;">avr32-gcc</td>
|
|
<td style="text-align:center;">avr32-ld</td>
|
|
<td style="text-align:center;">avr32-s</td>
|
|
<td style="text-align:center;">avr32-size</td>
|
|
<td style="text-align:center;">avr32-objcopy</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="color: rgb(255, 102, 0);">i386</td>
|
|
<td style="text-align:center;">i686-gcc</td>
|
|
<td style="text-align:center;">i686-elf-gcc</td>
|
|
<td style="text-align:center;">i686-elf-ld</td>
|
|
<td style="text-align:center;">nasm</td>
|
|
<td style="text-align:center;">i686-elf-size</td>
|
|
<td style="text-align:center;">i686-elf-objcopy</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p>If you need to add a new toolchain or modify an existing one, take a look build_data.lua. A toolchain-related fragment of build_data.lua is shown below:</p>
|
|
<pre><code># List of toolchains
|
|
local toolchain_list = {
|
|
<b># This defines a toolchain with the name "arm-gcc"</b>
|
|
[ 'arm-gcc' ] = {
|
|
compile = 'arm-elf-gcc',
|
|
link = 'arm-elf-ld',
|
|
asm = 'arm-elf-as',
|
|
bin = 'arm-elf-objcopy',
|
|
size = 'arm-elf-size',
|
|
cross_cpumode = 'little',
|
|
cross_lua = 'float_arm 64',
|
|
cross_lualong = 'int 32',
|
|
version = '--version'
|
|
},
|
|
<b># Another toolchain, this time called "arm-eabi-gcc"</b>
|
|
[ 'arm-eabi-gcc' ] = {
|
|
compile = 'arm-eabi-gcc',
|
|
link = 'arm-eabi-ld',
|
|
asm = 'arm-eabi-as',
|
|
bin = 'arm-eabi-objcopy',
|
|
size = 'arm-eabi-size',
|
|
cross_cpumode = 'little',
|
|
cross_lua = 'float 64',
|
|
cross_lualong = 'int 32',
|
|
version = '--version'
|
|
},
|
|
................
|
|
}
|
|
|
|
-- Toolchain to arch mapping
|
|
local toolchain_map = {
|
|
arm = { 'arm-gcc', 'codesourcery', 'devkitarm', 'arm-eabi-gcc' },
|
|
cortexm3 = { 'arm-gcc', 'codesourcery', 'devkitarm', 'arm-eabi-gcc' },
|
|
................
|
|
}
|
|
|
|
-- CPU to platform mapping also defines the platform architecture
|
|
-- which is used in turn to find the usable toolchains in toolchain_map
|
|
local platform_list =
|
|
{
|
|
at91sam7x = { cpus = { 'AT91SAM7X256', 'AT91SAM7X512' }, arch = 'arm' },
|
|
lm3s = { cpus = { 'LM3S1968', 'LM3S8962', 'LM3S6965', 'LM3S6918', 'LM3S9B92', 'LM3S9D92' }, arch = 'cortexm3' },
|
|
................
|
|
}</code></pre>
|
|
<p>From this fragment it's easy to understand that there are two main places in build_data.lua that must be taken into account when dealing with toolchain:</p>
|
|
<ul>
|
|
<li>the definition of <b>toolchain_list</b>. This is a list of all the supported toolchains with all their relevant components (compiler, linker, assembler, image copy tool and size tool).</li>
|
|
<li>the toolchain-to-architecture map in <b>toolchain_map</b>. The first element of this array will be automatically used if a <b>toolchain=...</b> option is not specified on the command line.</li>
|
|
</ul>
|
|
<p>Please note that in order to add a new toolchain to <b>eLua</b> it's generally not enough to edit just build_data.lua. As different toolchains have different command line options, one should also
|
|
edit the platform's build configuration file (<i>src/platform/<platform name>/conf.lua</i>) and make it aware of the new toolchain. The exact procedure for doing this is highly dependent on
|
|
the toolchain and it's well beyond the scope of this tutorial.</p>
|
|
$$FOOTER$$
|
|
|