View source for Getting Started with the EMAC OE SDK

{{todo| Complete (03.31.2015-13:42->BS+);(04.08.2015-15:00->BS+);(04.09.15-14:00->MD+);(04.21.2015-10:15->BS+);(04.24.2015-20:00->MD-);(04.28.2015-12:20->MD+);(04.29.2015-16:00->BS+);(04.29.2015-17:30->MD+);(04.30.2015-15:30->KY+); (07.22.2015-11:00->BS+)(10.07.2015-16:32->KY+)|Brian Serrano| project=OE 5.0,BS,MD,Complete,KY}}
{{#seo:
|title=Getting Started with the EMAC OE SDK
|titlemode=append
|keywords=EMAC SDK,Cross compiling, ARM Target Compiling, CMake Build System, CMake Cross Compiling, CMake, CMake Arm
|description=A basic tutorial for using the EMAC OE SDK.
}}

<!-- /*********************************************************************************************************/ -->
<!-- /****************************************  Page Description Text  ****************************************/ -->
<!-- /*********************************************************************************************************/ -->

<span style="background:#00FF00;color:#FF0000;font-size:300%"></span>
The EMAC OE SDK is distributed with a set of example projects intended to demonstrate how to use the EMAC OE toolchain and libraries. This page demonstrates the process of compiling an example project and running it on the target machine. Also, it provides a straightforward guide to the essential steps you need to follow to get started with cross compiling a simple program with gcc and running the program on your embedded machine.

__TOC__

<!-- /*********************************************************************************************************/ -->
<!-- /*****************************************  General Information  *****************************************/ -->
<!-- /*********************************************************************************************************/ -->
{{:Templateimpl:geninfo | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }}

The EMAC OE SDK is primarily distributed via our apt repository as a deb package for Ubuntu. Using EMAC's apt repository makes installing and updating the EMAC SDK and tools as easy as installing and updating any standard Ubuntu package.  This tutorial will show you how to configure your system to use the EMAC apt repository so that you can use the same package management tools you're familiar with in Ubuntu to install and update the EMAC provided SDK and tools.

EMAC also provides a tarball you can extract and install manually in case you're using a distribution other than Ubuntu (or a derivative), but EMAC strongly recommends using an Ubuntu LTS release.  The recent Ubuntu LTS releases have been thoroughly tested with the EMAC SDK and tools and are fully supported by EMAC.  Given the large number of alternate Linux distributions available, EMAC is only able to provide limited support (in the form of a manually installed tarball) for other Linux distributions.  

Each SDK includes the C/C++ header files and libraries compatible with the target hardware. It also includes the C/C++ cross-compiler toolchain components necessary to compile and debug custom application code. The links below will help you get started building and running the example projects on the target hardware.

More information on using Qt Creator with the EMAC SDK is available on the [[Getting_Started_With_Qt_Creator |Getting Started With Qt Creator]] page.

<!-- /*********************************************************************************************************/ -->
<!-- /*****************************************  Using/Working With  ******************************************/ -->
<!-- /*********************************************************************************************************/ -->
{{:Templateimpl:using | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }} 

=== Installing EMAC SDK ===

This is the EMAC Apt Repository, which hosts installation files for EMAC provided tools built for 64 bit Ubuntu 12.04 LTS and 14.04 LTS. To use this repository, a source for it must be added to your apt sources, and the key for the repository must be added to your machine. The steps below outline how to do this. 

# Add the EMAC Repository as an Apt source:
#:
#:'''For Ubuntu 12.04 LTS:'''
#:
#:{{cli | username=developer | hostname=ldc | <nowiki>echo "deb http://apt.emacinc.com/ubuntu precise non-free" > /etc/apt/sources.list.d/emac.list</nowiki> }}
#:
#:'''For Ubuntu 14.04 LTS:'''
#:
#:{{cli | username=developer | hostname=ldc | <nowiki>echo "deb http://apt.emacinc.com/ubuntu trusty non-free" > /etc/apt/sources.list.d/emac.list</nowiki> }}
#:
# Add the EMAC Apt Key:
#:
#:{{cli | username=developer | hostname=ldc | <nowiki>sudo sh -c 'wget -O - http://apt.emacinc.com/packages.emac.key</nowiki> {{!}} apt-key add -' }}
#:
#:'''Note that the 'O' above is a capital letter 'o', not a zero.'''
#:
# Update your apt cache:
#:
#:{{cli | username=developer | hostname=ldc | sudo apt-get update }}
#:
<ol start="4">
<li> Search for available EMAC packages:
{{clo | indent=2}}
{{clio | username=developer | hostname=ldc | sudo apt-cache search emac- }}
emac-common-toolchain - This package provides the common toolchain files.<br />
emac-ide-qtcreator - This package provides the Qt Creator IDE for the EMAC Software Development Kit.<br />
emac-sdk-examples - This package provides examples for the Qt Creator IDE and the EMAC Software Development Kit.<br />
emac-toolchain-armv5e - The SDK for cross compiling software for armv5e based targets running EMAC OE Linux.<br />
emac-toolchain-i586 - The SDK for cross compiling software for i586 based targets running EMAC OE Linux.<br />
emac-tools-at - The Auto Tools package for EMAC's Software Development Kit.<br />
emac-tools-projects - This package provides the oe_init_project tools for creating CMake based projects for EMAC OE 5.<br />
emac-tools-util - This package provides the scanserial tool from the EMAC Software Development Kit.<br />
{{clos}}
</li>
<li> Install desired EMAC packages:
{{cli | indent=1 | username=developer | hostname=ldc | apt-get install emac-sdk }}
</li>
</ol>

=== Connecting to a Target Board ===

A machine running EMAC OE Linux can be connected to through a serial port or through a network cable.  EMAC OE Linux allows users to log in via getty, and SSH (Secure Shell). A getty can be accessed via a serial connection (through a console) while SSH utilizes a network connection.  More information on establishing a physical connection to a board is available on the [[Serial_Connections |Serial Connections]] and [[Network_Connections |Network Connections]] page.

The next step after establishing a physical connection to the board is logging in.  For more information visit the [[System_Log_In | System Log In]] page.

=== Setting the Filesystem to Read-Write ===
The root filesystem on a machine running EMAC OE Linux is mounted read-only by default. In order to put files on the board, you may need to make the filesystem read-write. The [[Linux_Filesystem_Organization|Linux Filesystem Organization page]] has more information regarding which parts of the filesystem are mounted read-only by default versus which parts are always writeable.  Note that EMAC recommends installing your program into a read-only portion of the filesystem (according to the guide) to safeguard it from filesystem corruption (such as may be caused by removing power from the board without shutting down the operating system first, which is normal in embedded systems).

To remount the root filesytem in read-write mode, enter the following into the terminal: 
{{cli | oemntrw | hostname=ipac9x25}}

{{note|This will only change the root filesystem to read-write for the current boot.  When the system is rebooted, the root filesystem will once again be mounted read-only.}}

=== Transferring Files ===
The command line syntax for transferring a file using the SSH protocol is <code>scp file user@host:/directory</code>. SCP, or Secure Copy, is a way of securely transferring files between a local and remote host. For example, to send the file ''example.text'' to the <code>/home</code> directory of a system with the IP address 10.0.6.221, enter the following command:
{{cli | username=developer | hostname=ldc | scp example.text root@10.0.6.221:/home/ }}

Alternatively, you can leave off the path after the colon if you want the file to go directly into the home directory.

{{cli | username=developer | hostname=ldc | scp example.text root@10.0.6.221: }}

{{note|This copy operation will fail if the filesystem on the remote machine is mounted read-only, which is the default on most EMAC systems.  If you experience this failure, remount the root filesystem read-write (see above) and try again.}}

=== Remote Execution ===
SSH can also be used to execute programs on remote systems without logging in. The syntax for SSH remote execution is <code>ssh user@host "my_command -args file"</code>. The following is an example of a command to run a program on a board with the IP address ''10.0.6.221''.

{{cli | username=developer | hostname=ldc | ssh root@10.0.6.221 "/path/to/executable -args" }}


=== Basic Compiling ===
The two subsections below show the two common options for how to compile source code. The first subsection demonstrates how to use the EMAC [[ #CMake_Compiling| CMake ]] tool, while the second subsection demonstrates how to compile c code [[ #Manual_Compiling | manually ]].

==== CMake Compiling ====
===== Host Machine Compiling =====

This section demonstrates how to use the EMAC CMake tool to generate CMake files automatically for a project. When using the EMAC SDK there are currently two options for cross compiling:
* arm
* x86
For the purposes of this guide, the <tt>arm</tt> option will be used for the listed examples.

Navigate to the directory where the project will be located. Then run the CMake new project script.
{{clo}}
{{clio | username=developer | hostname=ldc | pwd=~/projects | oe_init_project -n hello.c }}
If desired, please enter a name for this project, otherwise press Enter to use the default: hello_emac <br />

-- Creating new project directory... <br />
-- Creating new source file... <br />
-- Building custom CMakeLists.txt file... <br />
-- Done. <br />

Do you want to create a build directory for this project? (y/n) y <br />

-- Creating build directory... <br />

Do you want to run cmake for this project? (y/n) y <br />

-- Using system compiler <br />
-- The C compiler identification is GNU 4.8.2 <br />
-- The CXX compiler identification is GNU 4.8.2 <br />
-- Check for working C compiler: /usr/bin/cc <br />
-- Check for working C compiler: /usr/bin/cc -- works <br />
-- Detecting C compiler ABI info <br />
-- Detecting C compiler ABI info - done <br />
-- Check for working CXX compiler: /usr/bin/c++ <br />
-- Check for working CXX compiler: /usr/bin/c++ -- works <br />
-- Detecting CXX compiler ABI info <br />
-- Detecting CXX compiler ABI info - done <br />
-- Configuring done <br />
-- Generating done <br />
-- Build files have been written to: /home/developer/projects/hello_emac/hello_emac-build <br />

Do you want to compile this project? (y/n) y

Scanning dependencies of target hello_emac <br />
[100%] Building C object CMakeFiles/hello_emac.dir/hello.c.o <br />
Linking C executable hello_emac <br />
[100%] Built target hello_emac <br />
{{clos}}

The executable, in this case,  is now inside the <code> hello_emac/hello_emac-build </code> directory.

===== Target Machine Compiling =====

The CMake project script has now made a project directory that contains the following:
* CMakeLists.txt
* Source code file (''hello.c'' in this case)
* ''README'' file
* Desktop Build Directory (''hello_emac-build'' in this case)

The ''CMakeLists.txt'' contains the required information to automatically create a ''Makefile'' for a given architecture.  This was created by the EMAC <tt>oe_init_project</tt> script, and will need to be modified over time as a project grows.  The comments in the file generated by the EMAC tool will provide a good starting point for how to add additional source files and how to perform other common tasks related to maintaining your CMake build system as your project grows.  The CMake project provides extensive documentation on how to work with these files.

The source code file generated by the script (''hello.c'') contains a basic Hello World style program.

The ''README'' file contains more information on using ''CMake'' with the EMAC 5.0 SDK.

The Desktop Build Directory (''hello_emac-build'') contains the executable ''hello_emac'', the ''Makefile'', and various cache files.  These were automatically created by CMake and by the build system, and can be recreated at any time.

It is useful to have a Desktop Build Directory because it is easier (in the beginning) to use the desktop to verify all code changes before cross-compiling for a target board. This will be useful until the application under development depends upon resources which are only available on the target hardware, such as certain devices drivers or the touchscreen (if so equipped).

Use the following steps to cross-compile the project and send it to a target board.
<br />
<br />
<cl>
1. In a terminal, navigate to the base directory of the project.
{{note | If the target board being used is <tt>x86</tt>, then change all occurrences of <tt>arm</tt> in the following sections below to <tt>x86</tt>.}}
* Create a build directory for cross compiling. 
{{cli | username=developer | hostname=ldc | pwd=~/projects/hello_emac | mkdir hello_emac-build-arm }} 
* Change directories into the newly created directory.
{{cli | username=developer | hostname=ldc | pwd=~/projects/hello_emac | cd hello_emac-build-arm }} 
* Run cmake using the target architecture.
{{cli | username=developer | hostname=ldc | pwd=~/projects/hello_emac/hello_emac-build-arm | 1 = cmake .. -DARCH:STRING=arm }} 
* Compile the code using make.
{{cli | username=developer | hostname=ldc | pwd=~/projects/hello_emac/hello_emac-build-arm | make }} 

The <code> make </code> command creates the target executable in the <code> hello_emac-build-arm </code> directory.
* Now copy the executable to the target board. For information on copying the executable file, see the [[ #Transferring_Files | Transferring Files ]] section.
</cl>
<br />
<br />

==== Manual Compiling ====
===== Host Machine Compiling =====
<br />{{note|In these examples we are using the Ipac-9x25 board. Your board's processor's architecture will determine which file needs to be sourced. These files come from the EMAC SDK toolchain.}}

Create a file called hello.c using a text editor such as vi, vim, nano, or gedit. Then copy and paste the source code from the [[ #Hello_World_System_Log_Example | Hello World System Log Example ]] section in the text editor of your choice.

Once you've created and saved the file with the source code, use the following syntax to compile the program called hello.c:
{{cli | username=developer | hostname=ldc | gcc -o hello hello.c }}

If there is no error in your code then the compiler will successfully create an executable file called hello in the current directory.

To verify this, enter the following command:
{{clo}}
{{clio | username=developer | hostname=ldc | ls -l hello* }}
-rwxrwxr-x 1 bserrano bserrano 9583 Apr  6 12:45 hello <br />
-rwxr-xr-x 1 bserrano bserrano  129 Apr  6 12:28 hello.c 
{{clos}}

To run the program, enter the following command:
{{clo}}
{{clio | username=developer | hostname=ldc | ./hello }}
Hello EMAC OE!
{{clos}}

OR
{{clo}}
{{clio | username=developer | hostname=ldc | /path/to/hello }}
Hello EMAC OE!
{{clos}}
<br />
<br />

===== Target Board Compiling =====

To compile for the target board, you must <code>source</code> the <code>environment-setup-armv5e-emac-linux-gnueabi</code> file.
{{cli | username=developer | hostname=ldc | source /opt/emac/5.0/environment-setup-armv5e-emac-linux-gnueabi }}

Once you are in the directory with the source file, enter the following command:
{{cli | username=developer | hostname=ldc | $CC -o hello hello.c }}

{{note|Once you source the file in your current terminal, you can only use it to cross-compile your program for the target board. You can no longer compile it for your host machine. To compile it to your host machine, simply open a new terminal.}}

After sourcing the file, copy the program over to the target board using <code>scp</code>. Enter the following command:
{{clo}}
{{clio | username=developer | hostname=ldc | scp hello root@10.0.6.221: }}
root@10.0.6.221's password: 

hello                                         100% 9583     9.4KB/s   00:00    
{{clos}}

After copying the program, you can now execute the program on the target board. Enter the following command:
{{clo}}
{{clio | username=developer | hostname=ldc | ssh root@10.0.6.221 ./hello}}
root@10.0.6.221's password: <br /> 
Hello EMAC OE!
{{clos}}
<br />
<br />

=== Linux Filesystem Organization ===
In order to prevent confusion and promote portability, a standard was created for the organization of the Linux filesystem.  To ensure future portability of software created today, promote maintainability of software, and ensure proper utilization of available storage on an embedded machine, this standard should be followed as much as possible.  This document covers parts of the standard and gives information about the customizations made to it by EMAC OE to accommodate embedded hardware.  A link is provided to the standards document which covers the organization of the Linux filesystem at the end of this document. For more information visit the [[Linux_Filesystem_Organization | Linux Filesystem Organization]] page.

EMAC recommends <tt>/usr/local/bin</tt> as the location for software you deploy.

{{clo}}
/usr/local/bin/
{{clos}}

{{note|It is important to pay attention to the filesystem structure in order to ensure that your application will work as expected when the filesystem is in production. Reasons for this include:
<cl>
 1. Only certain directories, such as <tt>/var/</tt> and <tt>/tmp/</tt>, are writeable when the filesystem is read-only.
 * Only certain directories should contain executables, such as <tt>/bin/</tt>, <tt>/usr/bin/</tt>, and <tt>/usr/local/bin/</tt>.
 * Following this directory structure properly will make it easier to port your software to a newer release of EMAC OE later on.
</cl>}}

=== Remote Debugging ===

When working with embedded systems the binary is usually compiled on a development machine with a different CPU architecture than what is on the target machine. This can be a problem when, as is typically the case, the target machine lacks the system resources to run a debugger. In these cases, it is possible to use the GNU debugger (<tt>gdb</tt>) on the development machine to remotely debug the target machine provided it has a flavor-matched version of a program named <tt>gdbserver</tt>. All EMAC OE builds are packaged with a flavor-matched <tt>gdbserver</tt> to simplify the setup process for developers.

{{note | A flavor-matched <tt>gdbserver</tt> is one which is built against the same source code revision as the <tt>gdb</tt> client for your desktop, because <tt>gdb</tt> does not have a stable interface for attaching to the <tt>gdbserver</tt>.  In fact, the interface changes slightly with almost every release, so if you find yourself having difficulty getting <tt>gdb</tt> and <tt>gdbserver</tt> to communicate with each other, make sure they're the exact same version before trying any other debugging steps.}}

For more information visit the [[Remote_Debugging_EMAC_OE_SDK_Projects_with_gdbserver | Remote Debugging EMAC OE SDK Projects with gdbserver]] page.

<!-- /*********************************************************************************************************/ -->
<!-- /*****************************************       Examples        *****************************************/ -->
<!-- /*********************************************************************************************************/ -->
{{:Templateimpl:examples | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }}

=== Hello World System Log Example ===
This example will print <code>Hello EMAC OE!</code> to the syslog facility as well as the console. This will allow you to log, debug, and send status messages to the system logger.

To compile and run this program, see the sections above.

<syntaxhighlight lang="c">
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <syslog.h>

int main(int argc, char** argv)
{    
    char message[] = "Hello EMAC OE!";

    openlog("slog", LOG_PID|LOG_CONS, LOG_USER);
    syslog(LOG_INFO, "%s", message);
    closelog();    

    printf("%s\n", message);

    return 0;
}
</syntaxhighlight>

This is extremely useful because it allows you to save a record of the output that you might not see first hand.

To verify the output of the program went into syslog, enter the following command:
{{clo}}
{{clio | username=developer | hostname=ldc | tail /var/log/syslog}}
Apr  7 14:10:06 ENG-26-LX dhclient: DHCPACK of 10.0.6.237 from 10.0.2.1<br />
Apr  7 14:10:06 ENG-26-LX dhclient: bound to 10.0.6.237 -- renewal in 3306 seconds.<br />
Apr  7 14:17:01 ENG-26-LX CRON[21193]: (root) CMD (   cd / && run-parts --report /etc/cron.hourly)<br />
Apr  7 14:54:41 ENG-26-LX hpcups[21266]: prnt/hpcups/HPCupsFilter.cpp 689: First raster data plane..<br />
Apr  7 14:55:31  hpcups[21266]: last message repeated 3 times<br />
Apr  7 15:05:12 ENG-26-LX dhclient: DHCPREQUEST of 10.0.6.237 on eth0 to 10.0.2.1 port 67<br />
Apr  7 15:05:12 ENG-26-LX dhclient: DHCPACK of 10.0.6.237 from 10.0.2.1<br />
Apr  7 15:05:12 ENG-26-LX dhclient: bound to 10.0.6.237 -- renewal in 3559 seconds.<br />
Apr  7 15:17:01 ENG-26-LX CRON[21302]: (root) CMD (   cd / && run-parts --report /etc/cron.hourly)<br />
Apr  7 15:27:08 ENG-26-LX slog[21375]: Hello EMAC OE!
{{clos}}

As you can see on the bottom line, your program output has been recorded and date stamped in syslog.

For more information on system logging visit the [[System_Logging| System Logging ]] page.

<!-- /*********************************************************************************************************/ -->
<!-- /******************************************   More Information   *****************************************/ -->
<!-- /*********************************************************************************************************/ -->
{{:Templateimpl:moreinfo | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }}
* [[Getting_Started_With_Qt_Creator |Getting Started With Qt Creator]]

{{:Templateimpl:whatnext | initials=BS | title=Getting Started with the EMAC OE SDK | desc=Basic tutorial for using the EMAC OE SDK. | project=OE 5.0 }}
* [[System_Log_In | System Log In]]
* [[Serial_Connections | Serial Connections ]]
* [[Network_Connections | Network_Connections ]]
* [[System_Log_In | System Log In ]]
* [[Remote_Debugging_EMAC_OE_SDK_Projects_with_gdbserver | Remote Debugging EMAC OE SDK Projects with gdbserver ]]
* [[Linux_Filesystem_Organization | Linux Filesystem Organization]]
* [[Creating_a_New_EMAC_OE_SDK_Project_with_CMake | Creating a Project with CMake ]]
* [[Remote_Debugging_EMAC_OE_SDK_with_gdbserver | Remote Debugging EMAC OE SDK Projects with gdbserver]]
* [[System_Logging | System Logging ]]