= Basis =
==Calling syslog method from shell==
To do that, use '''logger''' command :
<pre class="target">
# logger -t "MYTAGNAME" "I like otters with cream"
</pre>

You can then see the message in /var/log/messages:
<pre class="target">
# tail /var/log/messages
...
Oct 16 16:50:13 armadeus user.notice MYTAGNAME: I like otters with cream
</pre>

==Calling syslog method from your C source code==
This part is quite simple, but we need to correctly use each parameter.
First step is to declare us as syslog client :
<source lang="C">
...
#include <syslog.h>

int main(int argc, char *argv[])
{
...
openlog("program_name", LOG_PID, LOG_USER);
...
closelog();
...
}
</source>
Then, you can call syslog from your code using printf like format :
<source lang="C">
...
syslog(LOG_INFO, "%s called with %d arguments\n", argv[0], argc);
...
</source>
If you compile the source file:
<source lang="C">
// log_syslog.c
#include <syslog.h>

int main(int argc, char *argv[])
{
openlog("program_name", LOG_PID, LOG_USER);
syslog(LOG_INFO, "%s called with %d arguments", argv[0], argc - 1);
closelog();
return 0;
}
</source>
With the command :
<pre class="apf">
itsme@mycomputer:~/log_syslog$ gcc log_syslog.c -o log-syslog
</pre>
Then run it 2 times :
<pre class="apf">
itsme@mycomputer:~/log_syslog$ ./log_syslog
itsme@mycomputer:~/log_syslog$ ./log_syslog pim pam poum
</pre>
You will probably obtain no result in shell, but you can take a look in your system log (/var/log/syslog or /var/log/messages)
<pre class="apf">
itsme@mycomputer:~/log_syslog$ tail -n 2 /var/log/syslog
Sep 19 18:46:49 mycomputer program_name[3022]: ./log_syslog called with 0 arguments
Sep 19 18:46:53 mycomputer program_name[3023]: ./log_syslog called with 3 arguments
</pre>
We can notice, that the lines contain program_name[PID] pattern showing us the name we have specified in openlog and the pid of the process because we ask it with LOG_PID argument.

= Packages =

== Busybox ==

By default, syslog is managed by busybox, it can be configured using menuconfig :

<pre class="host">
$ make busybox-menuconfig
</pre>

The configuration menu can be found here :

<pre class="config">
System Logging Utilities --->
</pre>

== Buildroot packages ==

Some other packages are available under buildroot. To see it launch buildroot menuconfig :

<pre class="host">
$ make menuconfig
</pre>

Select option :
<pre class="config">
Package Selection for the target --->
[*] Show packages that are also provided by busybox
</pre>

Then go to following menu and choose your prefered syslog implementation ;-):
<pre class="config">
Target packages --->
System tools --->
...
[ ] rsyslog
...
[ ] sysklogd
...
[ ] syslog-ng
...
</pre>

== Tips ==
* By default logs are not persistent (/var/log points to /tmp). To have persistent logs with rotation every 1Mbytes, one can try to add this to his post_build.sh script:
<source lang="bash">
# for persistent and rotating log messages
rm -rf $1/var/log
mkdir $1/var/log
sed -i -e 's/SYSLOGD_ARGS=""/SYSLOGD_ARGS="-s 1024 -b 10"/' $1/etc/init.d/S01syslogd
</source>

UsingSyslog

2025-10-10T12:50:43Z

JulienB:

= Basis =
==Calling syslog method from shell==
To do that, use '''logger''' command :
<pre class="target">
# logger -t "MYTAGNAME" "I like otters with cream"
</pre>

You can then see the message in /var/log/messages:
<pre class="target">
# tail /var/log/messages
...
Oct 16 16:50:13 armadeus user.notice MYTAGNAME: I like otters with cream
</pre>

==Calling syslog method from your C source code==
This part is quite simple, but we need to correctly use each parameter.
First step is to declare us as syslog client :
<source lang="C">
...
#include <syslog.h>

int main(int argc, char *argv[])
{
...
openlog("program_name", LOG_PID, LOG_USER);
...
closelog();
...
}
</source>
Then, you can call syslog from your code using printf like format :
<source lang="C">
...
syslog(LOG_INFO, "%s called with %d arguments\n", argv[0], argc);
...
</source>
If you compile the source file:
<source lang="C">
// log_syslog.c
#include <syslog.h>

int main(int argc, char *argv[])
{
openlog("program_name", LOG_PID, LOG_USER);
syslog(LOG_INFO, "%s called with %d arguments", argv[0], argc - 1);
closelog();
return 0;
}
</source>
With the command :
<pre class="apf">
itsme@mycomputer:~/log_syslog$ gcc log_syslog.c -o log-syslog
</pre>
Then run it 2 times :
<pre class="apf">
itsme@mycomputer:~/log_syslog$ ./log_syslog
itsme@mycomputer:~/log_syslog$ ./log_syslog pim pam poum
</pre>
You will probably obtain no result in shell, but you can take a look in your system log (/var/log/syslog or /var/log/messages)
<pre class="apf">
itsme@mycomputer:~/log_syslog$ tail -n 2 /var/log/syslog
Sep 19 18:46:49 mycomputer program_name[3022]: ./log_syslog called with 0 arguments
Sep 19 18:46:53 mycomputer program_name[3023]: ./log_syslog called with 3 arguments
</pre>
We can notice, that the lines contain program_name[PID] pattern showing us the name we have specified in openlog and the pid of the process because we ask it with LOG_PID argument.

= Packages =

== Busybox ==

By default, syslog is managed by busybox, it can be configured using menuconfig :

<pre class="host">
$ make busybox-menuconfig
</pre>

The configuration menu can be found here :

<pre class="config">
System Logging Utilities --->
</pre>

== Buildroot packages ==

Some other packages are available under buildroot. To see it launch buildroot menuconfig :

<pre class="host">
$ make menuconfig
</pre>

Select option :
<pre class="config">
Package Selection for the target --->
[*] Show packages that are also provided by busybox
</pre>

Then go to following menu and choose your prefered syslog implementation ;-):
<pre class="config">
Target packages --->
System tools --->
...
[ ] rsyslog
...
[ ] sysklogd
...
[ ] syslog-ng
...
</pre>

== Tips ==
* By default logs are not persistent (/var/log points to /tmp). To have persistent logs with rotation every 1Mbytes, one can try to add this to his post_build.sh script:
<code source="bash">
# for persistent and rotating log messages
rm -rf $1/var/log
mkdir $1/var/log
sed -i -e 's/SYSLOGD_ARGS=""/SYSLOGD_ARGS="-s 1024 -b 10"/' $1/etc/init.d/S01syslogd
</code>

UsingSyslog

2025-10-07T12:48:33Z

JulienB: /* Buildroot packages */

Communicate

2025-09-16T12:45:43Z

JulienB: /* Install packages */

<noinclude>
How-To connect your Armadeus board to your development Host.

==Forewords==
The default connection uses a simple Serial Link either with a RS232 Null-Modem cable (with or without USB<->serial adapter) or with a miniUSB cable ([[APF51]] / [[APF28]] / [[APF6]]).

As you will have to transfer some MBytes of data, the Ethernet link is nice to have, if not mandatory. 
In order to use these two ways of transfer with the APF target, a terminal emulator (for Serial link) and a TFTP server (for Ethernet link) have to be configured.
</noinclude>
At this stage, you should have something looking like that (IP addresses may change): 
[[Image:BoardConnection.png]]

{{:RS232 Terminal configuration}}

==TFTP server==
In order to send your image files (U-Boot, Linux, rootfs or FPGA's firmware) at higher speed (than serial port) to your Armadeus board, you can use the Ethernet link and [http://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol a TFTP server].
Once the server configured, the files located in the server shared directory (''/tftpboot'' by default) will be accessible from the U-Boot/Linux TFTP clients.

===TFTP server installation===
====Install packages====
{| cellpadding="20" cellspacing="0"
|* On *Ubuntu / Debian:
<pre class="host">
$ sudo apt-get install tftpd-hpa xinetd
</pre>
or use your preferred graphical package manager
||
|* On Fedora:
<pre class="host">
$ rpm -q tftpd xinetd
</pre>
||
|* On OpenSUSE 11.3:
<pre class="host">
sudo zypper install tftp yast2-tftp-server
sudo yast2 tftp-server
</pre>
Choose Enable to start the TFTP server. It might be required to open the TFTP port in your firewall.
For more details see: [http://en.opensuse.org/SDB:YaST_TFTP_Server YaST TFTP Server on OpenSUSE site]
|}

====Create server's directory====
* Then create the directory (''/tftpboot/'') that will contain all the files that the server will export:
<pre class="host">
$ sudo mkdir /tftpboot
$ sudo chmod 777 /tftpboot
</pre>

===Server configuration===
* '''As root user''' edit or create the ''/etc/xinetd.d/tftp'' configuration file and modify/add it the following lines:
# default: off
# description: The tftp server serves files using the trivial file transfer
# protocol. The tftp protocol is often used to boot diskless
# workstations, download configuration files to network-aware printers,
# and to start the installation process for some operating systems.
service tftp
{
socket_type = dgram
protocol = udp
wait = yes
user = root
server = /usr/sbin/in.tftpd
server_args = -s /tftpboot
# disable = yes
}

* Restart xinetd service:
<pre class="host">
$ sudo killall -HUP xinetd
</pre>
<noinclude>
For more information regarding how-to setup a TFTP server please check one of many Web How-to:
* [https://linuxlink.timesys.com/docs/linux_tftp Another how-to configure a TFTP Server for Linux]
* [http://www.webune.com/forums/how-to-install-tftp-server-in-linux.html till another how-to...]
* [http://doc.ubuntu-fr.org/tftpd ubuntu TFTP server documentation in French]

=== Troubleshooting ===

====Timeout in U-Boot====
*On recent Debian distribution (sid?), it seems that installing ''ckermit'' package may switch inetd server from ''xinetd'' to ''openbsd-inetd''. If you fall in that case, then you have to configure ''/etc/inetd.conf'' by adding the following line:
<pre class=host>
tftp dgram udp wait nobody /usr/sbin/tcpd /usr/sbin/in.tftpd -s /tftpboot
</pre>
* Then restart inetd:
<pre class=host>
/etc/init.d/openbsd-inetd restart
</pre>

====Connection refused====
It looks like xinetd configuration is not sufficient in some recent versions of this tool. IPv6 is enabled by default and seems to be not compatible with the TFTP protocol. A simple inetd configuration should work for people who have this problem (''connection refused'' in system logs with addresses like ::ffff:192.168.0.100).

* Edit (as root user) - if necessary - the ''/etc/inetd.conf'' file and add this line:
<pre>
tftp dgram udp wait nobody /usr/sbin/tcpd /usr/sbin/in.tftpd -s /tftpboot
</pre>

* Install inetd tools

On Ubuntu/Debian
<pre>
$ sudo apt-get install inetutils-tools
</pre>

* Setup the hosts rules: edit (as root user) ''/etc/hosts.allow'' and add the following lines:
<pre>
in.tftpd: ALL
tftpd: ALL
</pre>

* Restart inetd
<pre>
$ /etc/init.d/openbsd-inetd restart
</pre>

It's done... and should work for most people.

==Links==
* [http://www.columbia.edu/kermit/ Kermit Homepage]
* [http://www.jls-info.com/julien/linux/ GTKTerm Homepage]
* [http://www.linuxhomenetworking.com/wiki/index.php/Quick_HOWTO_:_Ch16_:_Telnet,_TFTP,_and_xinetd#TFTP TFTP server quick how-to]
* [https://linuxlink.timesys.com/docs/linux_tftp Another how-to configure a TFTP Server for Linux]
* [http://www.webune.com/forums/how-to-install-tftp-server-in-linux.html till another how-to...]
* [http://doc.ubuntu-fr.org/tftpd ubuntu TFTP server documentation in French]
* [[Connection_with_U-Boot_under_Windows | configuring RS-232 and TFTP on Windows to communicate with your board]]
</noinclude>

LinuxInstall

2025-09-16T11:25:28Z

JulienB: /* Configure SDK/BSP options */

<noinclude>
<big>How-To install Armadeus Software Development Kit (SDK) on Linux systems. This SDK is currently based on the (excellent) [http://buildroot.net/ Buildroot].</big>
</noinclude>

The installation was successfully tested on the following distributions:
* Debian Lenny (5.0), Squeeze (6.0.x), Wheezy (7.2), Jessie (8.0)
* X/KUbuntu Edgy Eft (6.10), Gutsy Gibbon (7.10), Hardy Heron (8.04) & Jaunty Jackalope (9.04)
* Ubuntu Lucid Lynx (10.04) (32 & 64bits), 12.04 LTS (32 & 64bits), 13.10 (32 & 64bits), 14.04, 15.04 & 16.04
* LUbuntu 17.10
* Mandriva 2006
* Fedora Core 3 & 4, Fedora 10, Laughlin (14)
* Red Hat Enterprise 5.2
* Gentoo 10.0 (32 & 64 bits)
* SuSE 10.1, OpenSUSE 11.3 - 12.3

'''The installation may fail on:'''
* Ubuntu Karmic Koala (9.10): tslib fails to build

'''APF28 requirements:'''
* APF28 board requires a Linux distribution with (GNU) tar version 1.20 or later to compile the Linux Kernel - Please update or upgrade your Linux distribution.

==Prerequisites for Linux installation==
{{Note|From here we assume that your Linux system has a ''make'' version '''greater or equal to''' 3.81. To check it:
<pre class="host">
$ make -v
GNU Make 3.81
...
</pre>
}}
For armadeus up to 3.4, make should be '''strictly''' make-3.81 (make-3.82 is too strict). A Fedora (14 and 15) -specific solution can be found later; other recent distributions such as mageia1 also have make-3.82, and a generic solution, based on configure&& make&& sudo make install can be used to install make-3.81 (which can be retrieved from http://ftp.gnu.org/gnu/make/make-6.81.tar.gz) in /usr/local/bin (and , according to one's PATH, make 3-81 can be invoked directly or as /usr/local/bin/make).

Depending on your distribution, some additional packages are required:

===Debian/Ubuntu based systems===
[[Ubuntu/Debian installation prerequisites]]

===Mandriva based systems===
[[Mandriva installation prerequisites]]

===RPM-based systems (RedHat, Fedora, CentOS)===
[[RedHat/Fedora installation prerequisites]]

===OpenSuse based systems===
[[OpenSuse installation prerequisites]]

===Gentoo based systems===
[[Gentoo installation prerequisites]]

==Get Armadeus software==
* '''If you are a "careful" user''', then download [https://gitlab.com/armadeus/armadeus-bsp/-/tags the latest stable installation tarball from gitlab] and detar it wherever you want:
<pre class="host">
$ tar xjvf armadeus-7.0.tar.bz2
</pre>
* '''If you want the latest snapshot or if you have a recent SOM ([[OPOS6UL]]/[[OPOS8MM]])''', the whole development tree can be checked out from our [[GIT]] repository.
<pre class="host">
$ git clone git@gitlab.com:armadeus/armadeus-bsp.git armadeus
or if you don't have a gitlab account:
$ git clone https://gitlab.com/armadeus/armadeus-bsp.git armadeus
</pre>

* depending on your previous choice, a directory named ''armadeus/'' or ''armadeus-7.0/'' will be created on your hard-disk and will contain all the files you need.

'''Remarks''':
* '''Do not use spaces''' in the directory name !
* '''Do not use a directory path beginning with /usr.''' It is a known bug of Buildroot (until BR2012.11, at 2012-12).
* GIT write/push accesses are limited to the integrators ([[User:JulienB|JulienB]], [[User:SebastienSz|SebastienSz]], [[User:Jorasse|Jorasse]], [[User:FabienM|FabienM]], [[User:SebastienR|SebastienR]])

==Configure SDK/BSP options==
{{Note|If you are new to Armadeus and have troubles compiling armadeus-5.x/armadeus-6.x using the following instructions, you may find some hints here: [[Releases]]}}
*Go to the directory where you put the Armadeus sources:
<pre class="host">
$ cd armadeus/ (or armadeus-7.0/)
</pre>
*The first time you compile an Armadeus distribution you have to specify the target (here the [[APF9328]]) to work with.
<pre class="host">
$ make apf9328_defconfig
</pre>
This command reloads the default configuration to support your target and automatically start a Buildroot's configuration menu.

* Current valid default configurations are:
<pre class="host">
apf9328_defconfig apf27_defconfig pps_defconfig apf28_defconfig apf51_defconfig pps51_defconfig apf6_defconfig apf6legacy_defconfig opos6ul_defconfig opos6ulnano_defconfig opos6ulsp_defconfig opos8mm-legacy-5.10_defconfig opos93-legacy-6.1_defconfig opos93sp-legacy-6.1_defconfig
</pre>
{{Note| To get the full list of available config just type make, it will download buildroot and print following message :
<pre class="host">
$ make
[...]
System not configured. Use make <board>_defconfig
armadeus valid configurations are:
opos6ul_legacy_defconfig opos6ulnano-preempt-rt_defconfig apf6_defconfig pps_defconfig opos6ultest_defconfig apf51_defconfig opos6ulsp_defconfig apf6dawnsmalllinux_defconfig apf27preempt-rt_defconfig apf27test_defconfig apf27_defconfig apf28legacytest_defconfig opos6ullegacy-4.14_defconfig opos6ulnano_defconfig apf28legacy_defconfig apf6mainline-4.19_defconfig opos6ul_defconfig apf6legacy_defconfig apf6xenomai_defconfig apf51test_defconfig opos6ul-preempt-rt_defconfig apf6legacy-preempt-rt_defconfig apf6legacy-4.1_defconfig pps51_defconfig apf6mainline-4.9_defconfig apf28test_defconfig apf28_defconfig apf6mediacenter_defconfig opos6ullegacy-4.9_defconfig opos6ul_recovery_defconfig apf6failsafe_defconfig apf6test_defconfig opos6ullegacy-4.1_defconfig apf27xenomai_defconfig

Makefile:129: recipe for target '/usr/local/projects/apf6_sp_419/buildroot/.configured' failed
make: *** [/usr/local/projects/apf6_sp_419/buildroot/.configured] Error 1
</pre>
}}

For PPS boards, please see [[APF27_PPS]] or [[PPS51]] Wiki pages, as these boards have specific build.

* After some downloads, you will get the Buildroot configuration interface:

{{Note|If you ever made changes during the following steps, at any time, you can reload the default configuration with:
$ make xxx_defconfig (xxx depending on your module name)}}

[[Image:Menuconfig3.png]] 
*If you are not familiar with Buildroot here are some tips:
*# you can move the highlighted item with the "up"/"down" arrow keys
*# with the "left"/"right" arrow keys you can choose between "Select", "Exit" or "Help" buttons
*# "space"/"enter":
*#* selects the currently highlighted item if you are on the "Select" button
*#* go back in previous menu if you are on "Exit" button
*#* show you some Help for current item if you are on "Help" button
*# for more Help about Buildroot commands, select "Help" in the main configuration screen

* Update the memory configuration of your board ('''if needed'''; by default BSP is configured for the minimal memory configuration available on the corresponding board):

:In menu:
:<pre class="config">System configuration ---> [*] Armadeus Device Support ---></pre>

:you can check and change the quantity of RAM available on your Armadeus board:
:[[Image:Build_config_memory.png]]
:For [[APF9328]] the memory can be either 16 or 32MiB (be sure to select 1 RAM chip)
:For [[APF27]] it could be either 64MiB or 128MiB (2 x 64MiB) (in that case be sure to select 2 chips of 64MiB instead of 1 chip of 128MiB).
:For [[APF51]] it could be either 256MiB or 512MiB (2x256MiB) (in such case be sure to select 2 chips of 256MiB instead of 1 chip of 512).
:For [[APF28]] The memory can be 128, 256, 512 or 1024MiB (be sure to select 1 RAM chip).
:For [[APF6]]/[[APF6SP]] The memory can be 512 Mbytes or 1Gbytes with ram chip size of 512Mbytes.
:For [[OPOS6UL]]/[[OPOS6UL_NANO]] The memory size is automatically detected so you don't care ;-)

* You may decrease the compilation time by increasing the number of parallel jobs running simultaneously on your system (the result is not guaranteed). This option is located in:
:<pre class="config">Build Options ---> (0) Number of jobs to run simultaneously</pre>
0 means that Buildroot will try to guess automatically how much parallel jobs it can launch.

* During the SDK/BSP build, a lot of software archives are downloaded from Internet. The downloaded files are put by default in the ''armadeus/downloads/'' directory. '''If you have several views or plan to build the toolchain several times''', we advise you to put all the downloaded files in ''/local/downloads'' (for example). This is done by configuring Buildroot to use this directory for all your views. Nevertheless, Buildroot will be downloaded separately for each build environment you set up.
:<pre class="config">Build options ---> (...) Download dir</pre>
:[[Image:Build_config_download.png]]
{{Note|Of course, ''/local/downloads'' should exists on your system and you should have writing rights on it !}}
* In recent Buildroot you can also use the following method:
export BR2_DL_DIR=/local/downloads

* After the build, we advise you to copy all the files in ''downloads/'' / ''/local/downloads'' on a removable medium, in case you want to install the development tools on other systems, without to have to reload all the archives.

* Now, Exit the configuration tool and save your configuration

* You can come back to this configuration menu, by typing (your changes will be kept):
<pre class="host">
make menuconfig
</pre>

==Launch build==
$ make
The toolchain and the full distribution are automatically built. During this procedure, several files are downloaded from Internet. 
'''Please wait for a while.... it takes at least one hour for the first run!''' 
By default, the downloaded files/tarball are put in the ''armadeus/downloads/'' directory. Please see the previous chapter to know how to optimize that if you plan to build several views or want to build faster.

==Enjoy the result==
The generated binary files can be found in the subdirectory ''buildroot/output/images'':
*''apf9328-u-boot.brec'' (only on [[APF9328]]): BRecord image that can be used with the bootstrap, if U-Boot is not installed or not working (see [[BootLoader]] page)
*''xxx-u-boot.bin'': U-Boot image file to be used with U-Boot itself, (see [[BootLoader#Update_U-Boot | updating U-Boot]])
*''xxx-linux.bin'': Linux image to use with U-Boot, (see [[Target_Software_Installation#Linux_kernel_installation | updating Linux]])
*''xxx-rootfs.jffs2'': JFFS2 filesystem/rootfs image to use with U-Boot, (see [[Target_Software_Installation#Linux_rootfs_installation | updating rootfs]])
*''xxx-rootfs.ubi'' (not supported on [[APF9328]]): [[UBIFS|UBI]] filesystem/rootfs image to use with U-Boot, (see [[Target_Software_Installation#Linux_rootfs_installation | updating rootfs]])
*''xxx-rootfs.ext4'': EXT4 filesystem/rootfs image to use with U-Boot, (on [[APF6]] and [[OPOS6UL]])
*''xxx-rootfs.tar'': for an NFS/MMC based rootfs, (see [[Network_Configuration#Boot_from_NFS | Booting from NFS]] & [[MultiMediaCard#Booting_from_MMC.2FSD | Booting from a MMC/SD]])

'''Please note the new naming convention of binary files and directories (since Armadeus 4.0)'''

*''buildroot/output/build'': contains all the build results for target root filesystem, Linux, Busybox and U-Boot...
*''buildroot/output/toolchain/'': cross compilation toolchain's build dir. Binaries usable for cross-compilation are in ''buildroot/output/host/usr/bin''.
*''buildroot/output/target/'': target filessytem before generating rootfs images

More information is available in the [http://buildroot.uclibc.org/buildroot.html Buildroot's documentation]

* Note: Previous versions (3.x) of Armadeus SDK stored the generated binary files at a different place: '' ''buildroot/binaries/XX/'' (where XX was the name of your board).

<noinclude>

You then copy the binary image to your server directory:
<pre class="host">
$ cp buildroot/output/images/* /tftpboot
</pre>

==To keep your local copy/repository up-to-date with the armadeus GIT repository==
<pre class="host">
$ git pull
</pre>
This will update your working directory to the latest release.

Note: if "git pull" fails because a directory or a file already exists, then do:
$ rm -rf <this-directory/file>
$ git pull

You can do a:
$ make apfXX_defconfig
to have the latest features automatically activated.

You have to do a '''make''' to rebuild binary files and then upload the binary files to your target.

Note: if definitively everything goes wrong while it worked before the last update.
You can apply the following procedure (all your modifications in buildroot will be lost):
$ rm -rf buildroot/
$ rm Makefile
$ git pull
$ make apfXX_defconfig
$ make
$ cp buildroot/output/images/* /tftpboot

Enjoy!
</noinclude>

LinuxInstall

2025-09-16T11:22:41Z

JulienB: /* Get Armadeus software */

<noinclude>
<big>How-To install Armadeus Software Development Kit (SDK) on Linux systems. This SDK is currently based on the (excellent) [http://buildroot.net/ Buildroot].</big>
</noinclude>

The installation was successfully tested on the following distributions:
* Debian Lenny (5.0), Squeeze (6.0.x), Wheezy (7.2), Jessie (8.0)
* X/KUbuntu Edgy Eft (6.10), Gutsy Gibbon (7.10), Hardy Heron (8.04) & Jaunty Jackalope (9.04)
* Ubuntu Lucid Lynx (10.04) (32 & 64bits), 12.04 LTS (32 & 64bits), 13.10 (32 & 64bits), 14.04, 15.04 & 16.04
* LUbuntu 17.10
* Mandriva 2006
* Fedora Core 3 & 4, Fedora 10, Laughlin (14)
* Red Hat Enterprise 5.2
* Gentoo 10.0 (32 & 64 bits)
* SuSE 10.1, OpenSUSE 11.3 - 12.3

'''The installation may fail on:'''
* Ubuntu Karmic Koala (9.10): tslib fails to build

'''APF28 requirements:'''
* APF28 board requires a Linux distribution with (GNU) tar version 1.20 or later to compile the Linux Kernel - Please update or upgrade your Linux distribution.

==Prerequisites for Linux installation==
{{Note|From here we assume that your Linux system has a ''make'' version '''greater or equal to''' 3.81. To check it:
<pre class="host">
$ make -v
GNU Make 3.81
...
</pre>
}}
For armadeus up to 3.4, make should be '''strictly''' make-3.81 (make-3.82 is too strict). A Fedora (14 and 15) -specific solution can be found later; other recent distributions such as mageia1 also have make-3.82, and a generic solution, based on configure&& make&& sudo make install can be used to install make-3.81 (which can be retrieved from http://ftp.gnu.org/gnu/make/make-6.81.tar.gz) in /usr/local/bin (and , according to one's PATH, make 3-81 can be invoked directly or as /usr/local/bin/make).

Depending on your distribution, some additional packages are required:

===Debian/Ubuntu based systems===
[[Ubuntu/Debian installation prerequisites]]

===Mandriva based systems===
[[Mandriva installation prerequisites]]

===RPM-based systems (RedHat, Fedora, CentOS)===
[[RedHat/Fedora installation prerequisites]]

===OpenSuse based systems===
[[OpenSuse installation prerequisites]]

===Gentoo based systems===
[[Gentoo installation prerequisites]]

==Get Armadeus software==
* '''If you are a "careful" user''', then download [https://gitlab.com/armadeus/armadeus-bsp/-/tags the latest stable installation tarball from gitlab] and detar it wherever you want:
<pre class="host">
$ tar xjvf armadeus-7.0.tar.bz2
</pre>
* '''If you want the latest snapshot or if you have a recent SOM ([[OPOS6UL]]/[[OPOS8MM]])''', the whole development tree can be checked out from our [[GIT]] repository.
<pre class="host">
$ git clone git@gitlab.com:armadeus/armadeus-bsp.git armadeus
or if you don't have a gitlab account:
$ git clone https://gitlab.com/armadeus/armadeus-bsp.git armadeus
</pre>

* depending on your previous choice, a directory named ''armadeus/'' or ''armadeus-7.0/'' will be created on your hard-disk and will contain all the files you need.

'''Remarks''':
* '''Do not use spaces''' in the directory name !
* '''Do not use a directory path beginning with /usr.''' It is a known bug of Buildroot (until BR2012.11, at 2012-12).
* GIT write/push accesses are limited to the integrators ([[User:JulienB|JulienB]], [[User:SebastienSz|SebastienSz]], [[User:Jorasse|Jorasse]], [[User:FabienM|FabienM]], [[User:SebastienR|SebastienR]])

==Configure SDK/BSP options==
{{Note|If you are new to Armadeus and have troubles compiling armadeus-5.x/armadeus-6.x using the following instructions, you may find some hints here: [[Releases]]}}
*Go to the directory where you put the Armadeus sources:
<pre class="host">
$ cd armadeus/ (or armadeus-7.0/)
</pre>
*The first time you compile an Armadeus distribution you have to specify the target (here the [[APF9328]]) to work with.
<pre class="host">
$ make apf9328_defconfig
</pre>
This command reloads the default configuration to support your target and automatically start a Buildroot's configuration menu.

* Current valid default configurations are:
<pre class="host">
apf9328_defconfig apf27_defconfig pps_defconfig apf28_defconfig apf51_defconfig pps51_defconfig apf6_defconfig apf6legacy_defconfig opos6ul_defconfig opos6ulnano_defconfig
</pre>
{{Note| To get the full list of available config just type make, it will download buildroot and print following message :
<pre class="host">
$ make
[...]
System not configured. Use make <board>_defconfig
armadeus valid configurations are:
opos6ul_legacy_defconfig opos6ulnano-preempt-rt_defconfig apf6_defconfig pps_defconfig opos6ultest_defconfig apf51_defconfig opos6ulsp_defconfig apf6dawnsmalllinux_defconfig apf27preempt-rt_defconfig apf27test_defconfig apf27_defconfig apf28legacytest_defconfig opos6ullegacy-4.14_defconfig opos6ulnano_defconfig apf28legacy_defconfig apf6mainline-4.19_defconfig opos6ul_defconfig apf6legacy_defconfig apf6xenomai_defconfig apf51test_defconfig opos6ul-preempt-rt_defconfig apf6legacy-preempt-rt_defconfig apf6legacy-4.1_defconfig pps51_defconfig apf6mainline-4.9_defconfig apf28test_defconfig apf28_defconfig apf6mediacenter_defconfig opos6ullegacy-4.9_defconfig opos6ul_recovery_defconfig apf6failsafe_defconfig apf6test_defconfig opos6ullegacy-4.1_defconfig apf27xenomai_defconfig

Makefile:129: recipe for target '/usr/local/projects/apf6_sp_419/buildroot/.configured' failed
make: *** [/usr/local/projects/apf6_sp_419/buildroot/.configured] Error 1
</pre>
}}

For PPS boards, please see [[APF27_PPS]] or [[PPS51]] Wiki pages, as these boards have specific build.

* After some downloads, you will get the Buildroot configuration interface:

{{Note|If you ever made changes during the following steps, at any time, you can reload the default configuration with:
$ make xxx_defconfig (xxx depending on your module name)}}

[[Image:Menuconfig3.png]] 
*If you are not familiar with Buildroot here are some tips:
*# you can move the highlighted item with the "up"/"down" arrow keys
*# with the "left"/"right" arrow keys you can choose between "Select", "Exit" or "Help" buttons
*# "space"/"enter":
*#* selects the currently highlighted item if you are on the "Select" button
*#* go back in previous menu if you are on "Exit" button
*#* show you some Help for current item if you are on "Help" button
*# for more Help about Buildroot commands, select "Help" in the main configuration screen

* Update the memory configuration of your board ('''if needed'''; by default BSP is configured for the minimal memory configuration available on the corresponding board):

:In menu:
:<pre class="config">System configuration ---> [*] Armadeus Device Support ---></pre>

:you can check and change the quantity of RAM available on your Armadeus board:
:[[Image:Build_config_memory.png]]
:For [[APF9328]] the memory can be either 16 or 32MiB (be sure to select 1 RAM chip)
:For [[APF27]] it could be either 64MiB or 128MiB (2 x 64MiB) (in that case be sure to select 2 chips of 64MiB instead of 1 chip of 128MiB).
:For [[APF51]] it could be either 256MiB or 512MiB (2x256MiB) (in such case be sure to select 2 chips of 256MiB instead of 1 chip of 512).
:For [[APF28]] The memory can be 128, 256, 512 or 1024MiB (be sure to select 1 RAM chip).
:For [[APF6]]/[[APF6SP]] The memory can be 512 Mbytes or 1Gbytes with ram chip size of 512Mbytes.
:For [[OPOS6UL]]/[[OPOS6UL_NANO]] The memory size is automatically detected so you don't care ;-)

* You may decrease the compilation time by increasing the number of parallel jobs running simultaneously on your system (the result is not guaranteed). This option is located in:
:<pre class="config">Build Options ---> (0) Number of jobs to run simultaneously</pre>
0 means that Buildroot will try to guess automatically how much parallel jobs it can launch.

* During the SDK/BSP build, a lot of software archives are downloaded from Internet. The downloaded files are put by default in the ''armadeus/downloads/'' directory. '''If you have several views or plan to build the toolchain several times''', we advise you to put all the downloaded files in ''/local/downloads'' (for example). This is done by configuring Buildroot to use this directory for all your views. Nevertheless, Buildroot will be downloaded separately for each build environment you set up.
:<pre class="config">Build options ---> (...) Download dir</pre>
:[[Image:Build_config_download.png]]
{{Note|Of course, ''/local/downloads'' should exists on your system and you should have writing rights on it !}}
* In recent Buildroot you can also use the following method:
export BR2_DL_DIR=/local/downloads

* After the build, we advise you to copy all the files in ''downloads/'' / ''/local/downloads'' on a removable medium, in case you want to install the development tools on other systems, without to have to reload all the archives.

* Now, Exit the configuration tool and save your configuration

* You can come back to this configuration menu, by typing (your changes will be kept):
<pre class="host">
make menuconfig
</pre>

==Launch build==
$ make
The toolchain and the full distribution are automatically built. During this procedure, several files are downloaded from Internet. 
'''Please wait for a while.... it takes at least one hour for the first run!''' 
By default, the downloaded files/tarball are put in the ''armadeus/downloads/'' directory. Please see the previous chapter to know how to optimize that if you plan to build several views or want to build faster.

==Enjoy the result==
The generated binary files can be found in the subdirectory ''buildroot/output/images'':
*''apf9328-u-boot.brec'' (only on [[APF9328]]): BRecord image that can be used with the bootstrap, if U-Boot is not installed or not working (see [[BootLoader]] page)
*''xxx-u-boot.bin'': U-Boot image file to be used with U-Boot itself, (see [[BootLoader#Update_U-Boot | updating U-Boot]])
*''xxx-linux.bin'': Linux image to use with U-Boot, (see [[Target_Software_Installation#Linux_kernel_installation | updating Linux]])
*''xxx-rootfs.jffs2'': JFFS2 filesystem/rootfs image to use with U-Boot, (see [[Target_Software_Installation#Linux_rootfs_installation | updating rootfs]])
*''xxx-rootfs.ubi'' (not supported on [[APF9328]]): [[UBIFS|UBI]] filesystem/rootfs image to use with U-Boot, (see [[Target_Software_Installation#Linux_rootfs_installation | updating rootfs]])
*''xxx-rootfs.ext4'': EXT4 filesystem/rootfs image to use with U-Boot, (on [[APF6]] and [[OPOS6UL]])
*''xxx-rootfs.tar'': for an NFS/MMC based rootfs, (see [[Network_Configuration#Boot_from_NFS | Booting from NFS]] & [[MultiMediaCard#Booting_from_MMC.2FSD | Booting from a MMC/SD]])

'''Please note the new naming convention of binary files and directories (since Armadeus 4.0)'''

*''buildroot/output/build'': contains all the build results for target root filesystem, Linux, Busybox and U-Boot...
*''buildroot/output/toolchain/'': cross compilation toolchain's build dir. Binaries usable for cross-compilation are in ''buildroot/output/host/usr/bin''.
*''buildroot/output/target/'': target filessytem before generating rootfs images

More information is available in the [http://buildroot.uclibc.org/buildroot.html Buildroot's documentation]

* Note: Previous versions (3.x) of Armadeus SDK stored the generated binary files at a different place: '' ''buildroot/binaries/XX/'' (where XX was the name of your board).

<noinclude>

You then copy the binary image to your server directory:
<pre class="host">
$ cp buildroot/output/images/* /tftpboot
</pre>

==To keep your local copy/repository up-to-date with the armadeus GIT repository==
<pre class="host">
$ git pull
</pre>
This will update your working directory to the latest release.

Note: if "git pull" fails because a directory or a file already exists, then do:
$ rm -rf <this-directory/file>
$ git pull

You can do a:
$ make apfXX_defconfig
to have the latest features automatically activated.

You have to do a '''make''' to rebuild binary files and then upload the binary files to your target.

Note: if definitively everything goes wrong while it worked before the last update.
You can apply the following procedure (all your modifications in buildroot will be lost):
$ rm -rf buildroot/
$ rm Makefile
$ git pull
$ make apfXX_defconfig
$ make
$ cp buildroot/output/images/* /tftpboot

Enjoy!
</noinclude>

LinuxInstall

2025-09-16T11:22:16Z

JulienB: /* Get Armadeus software */

<noinclude>
<big>How-To install Armadeus Software Development Kit (SDK) on Linux systems. This SDK is currently based on the (excellent) [http://buildroot.net/ Buildroot].</big>
</noinclude>

The installation was successfully tested on the following distributions:
* Debian Lenny (5.0), Squeeze (6.0.x), Wheezy (7.2), Jessie (8.0)
* X/KUbuntu Edgy Eft (6.10), Gutsy Gibbon (7.10), Hardy Heron (8.04) & Jaunty Jackalope (9.04)
* Ubuntu Lucid Lynx (10.04) (32 & 64bits), 12.04 LTS (32 & 64bits), 13.10 (32 & 64bits), 14.04, 15.04 & 16.04
* LUbuntu 17.10
* Mandriva 2006
* Fedora Core 3 & 4, Fedora 10, Laughlin (14)
* Red Hat Enterprise 5.2
* Gentoo 10.0 (32 & 64 bits)
* SuSE 10.1, OpenSUSE 11.3 - 12.3

'''The installation may fail on:'''
* Ubuntu Karmic Koala (9.10): tslib fails to build

'''APF28 requirements:'''
* APF28 board requires a Linux distribution with (GNU) tar version 1.20 or later to compile the Linux Kernel - Please update or upgrade your Linux distribution.

==Prerequisites for Linux installation==
{{Note|From here we assume that your Linux system has a ''make'' version '''greater or equal to''' 3.81. To check it:
<pre class="host">
$ make -v
GNU Make 3.81
...
</pre>
}}
For armadeus up to 3.4, make should be '''strictly''' make-3.81 (make-3.82 is too strict). A Fedora (14 and 15) -specific solution can be found later; other recent distributions such as mageia1 also have make-3.82, and a generic solution, based on configure&& make&& sudo make install can be used to install make-3.81 (which can be retrieved from http://ftp.gnu.org/gnu/make/make-6.81.tar.gz) in /usr/local/bin (and , according to one's PATH, make 3-81 can be invoked directly or as /usr/local/bin/make).

Depending on your distribution, some additional packages are required:

===Debian/Ubuntu based systems===
[[Ubuntu/Debian installation prerequisites]]

===Mandriva based systems===
[[Mandriva installation prerequisites]]

===RPM-based systems (RedHat, Fedora, CentOS)===
[[RedHat/Fedora installation prerequisites]]

===OpenSuse based systems===
[[OpenSuse installation prerequisites]]

===Gentoo based systems===
[[Gentoo installation prerequisites]]

==Get Armadeus software==
* '''If you are a "careful" user''', then download [https://gitlab.com/armadeus/armadeus-bsp/-/tags the latest stable installation tarball from gitlab] and detar it wherever you want:
<pre class="host">
$ tar xjvf armadeus-7.0.tar.bz2
</pre>
* '''If you want the latest snapshot or if you have a recent SOM ([[OPOS6UL]]/[[OPOS8MM]])''', the whole development tree can be checked out from our [[GIT]] repository.
<pre class="host">
$ git clone git@gitlab.com:armadeus/armadeus-bsp.git armadeus
or if you don't have a gitlab account:
$ https://gitlab.com/armadeus/armadeus-bsp.git armadeus
</pre>

* depending on your previous choice, a directory named ''armadeus/'' or ''armadeus-7.0/'' will be created on your hard-disk and will contain all the files you need.

'''Remarks''':
* '''Do not use spaces''' in the directory name !
* '''Do not use a directory path beginning with /usr.''' It is a known bug of Buildroot (until BR2012.11, at 2012-12).
* GIT write/push accesses are limited to the integrators ([[User:JulienB|JulienB]], [[User:SebastienSz|SebastienSz]], [[User:Jorasse|Jorasse]], [[User:FabienM|FabienM]], [[User:SebastienR|SebastienR]])

==Configure SDK/BSP options==
{{Note|If you are new to Armadeus and have troubles compiling armadeus-5.x/armadeus-6.x using the following instructions, you may find some hints here: [[Releases]]}}
*Go to the directory where you put the Armadeus sources:
<pre class="host">
$ cd armadeus/ (or armadeus-7.0/)
</pre>
*The first time you compile an Armadeus distribution you have to specify the target (here the [[APF9328]]) to work with.
<pre class="host">
$ make apf9328_defconfig
</pre>
This command reloads the default configuration to support your target and automatically start a Buildroot's configuration menu.

* Current valid default configurations are:
<pre class="host">
apf9328_defconfig apf27_defconfig pps_defconfig apf28_defconfig apf51_defconfig pps51_defconfig apf6_defconfig apf6legacy_defconfig opos6ul_defconfig opos6ulnano_defconfig
</pre>
{{Note| To get the full list of available config just type make, it will download buildroot and print following message :
<pre class="host">
$ make
[...]
System not configured. Use make <board>_defconfig
armadeus valid configurations are:
opos6ul_legacy_defconfig opos6ulnano-preempt-rt_defconfig apf6_defconfig pps_defconfig opos6ultest_defconfig apf51_defconfig opos6ulsp_defconfig apf6dawnsmalllinux_defconfig apf27preempt-rt_defconfig apf27test_defconfig apf27_defconfig apf28legacytest_defconfig opos6ullegacy-4.14_defconfig opos6ulnano_defconfig apf28legacy_defconfig apf6mainline-4.19_defconfig opos6ul_defconfig apf6legacy_defconfig apf6xenomai_defconfig apf51test_defconfig opos6ul-preempt-rt_defconfig apf6legacy-preempt-rt_defconfig apf6legacy-4.1_defconfig pps51_defconfig apf6mainline-4.9_defconfig apf28test_defconfig apf28_defconfig apf6mediacenter_defconfig opos6ullegacy-4.9_defconfig opos6ul_recovery_defconfig apf6failsafe_defconfig apf6test_defconfig opos6ullegacy-4.1_defconfig apf27xenomai_defconfig

Makefile:129: recipe for target '/usr/local/projects/apf6_sp_419/buildroot/.configured' failed
make: *** [/usr/local/projects/apf6_sp_419/buildroot/.configured] Error 1
</pre>
}}

For PPS boards, please see [[APF27_PPS]] or [[PPS51]] Wiki pages, as these boards have specific build.

* After some downloads, you will get the Buildroot configuration interface:

{{Note|If you ever made changes during the following steps, at any time, you can reload the default configuration with:
$ make xxx_defconfig (xxx depending on your module name)}}

[[Image:Menuconfig3.png]] 
*If you are not familiar with Buildroot here are some tips:
*# you can move the highlighted item with the "up"/"down" arrow keys
*# with the "left"/"right" arrow keys you can choose between "Select", "Exit" or "Help" buttons
*# "space"/"enter":
*#* selects the currently highlighted item if you are on the "Select" button
*#* go back in previous menu if you are on "Exit" button
*#* show you some Help for current item if you are on "Help" button
*# for more Help about Buildroot commands, select "Help" in the main configuration screen

* Update the memory configuration of your board ('''if needed'''; by default BSP is configured for the minimal memory configuration available on the corresponding board):

:In menu:
:<pre class="config">System configuration ---> [*] Armadeus Device Support ---></pre>

:you can check and change the quantity of RAM available on your Armadeus board:
:[[Image:Build_config_memory.png]]
:For [[APF9328]] the memory can be either 16 or 32MiB (be sure to select 1 RAM chip)
:For [[APF27]] it could be either 64MiB or 128MiB (2 x 64MiB) (in that case be sure to select 2 chips of 64MiB instead of 1 chip of 128MiB).
:For [[APF51]] it could be either 256MiB or 512MiB (2x256MiB) (in such case be sure to select 2 chips of 256MiB instead of 1 chip of 512).
:For [[APF28]] The memory can be 128, 256, 512 or 1024MiB (be sure to select 1 RAM chip).
:For [[APF6]]/[[APF6SP]] The memory can be 512 Mbytes or 1Gbytes with ram chip size of 512Mbytes.
:For [[OPOS6UL]]/[[OPOS6UL_NANO]] The memory size is automatically detected so you don't care ;-)

* You may decrease the compilation time by increasing the number of parallel jobs running simultaneously on your system (the result is not guaranteed). This option is located in:
:<pre class="config">Build Options ---> (0) Number of jobs to run simultaneously</pre>
0 means that Buildroot will try to guess automatically how much parallel jobs it can launch.

* During the SDK/BSP build, a lot of software archives are downloaded from Internet. The downloaded files are put by default in the ''armadeus/downloads/'' directory. '''If you have several views or plan to build the toolchain several times''', we advise you to put all the downloaded files in ''/local/downloads'' (for example). This is done by configuring Buildroot to use this directory for all your views. Nevertheless, Buildroot will be downloaded separately for each build environment you set up.
:<pre class="config">Build options ---> (...) Download dir</pre>
:[[Image:Build_config_download.png]]
{{Note|Of course, ''/local/downloads'' should exists on your system and you should have writing rights on it !}}
* In recent Buildroot you can also use the following method:
export BR2_DL_DIR=/local/downloads

* After the build, we advise you to copy all the files in ''downloads/'' / ''/local/downloads'' on a removable medium, in case you want to install the development tools on other systems, without to have to reload all the archives.

* Now, Exit the configuration tool and save your configuration

* You can come back to this configuration menu, by typing (your changes will be kept):
<pre class="host">
make menuconfig
</pre>

==Launch build==
$ make
The toolchain and the full distribution are automatically built. During this procedure, several files are downloaded from Internet. 
'''Please wait for a while.... it takes at least one hour for the first run!''' 
By default, the downloaded files/tarball are put in the ''armadeus/downloads/'' directory. Please see the previous chapter to know how to optimize that if you plan to build several views or want to build faster.

==Enjoy the result==
The generated binary files can be found in the subdirectory ''buildroot/output/images'':
*''apf9328-u-boot.brec'' (only on [[APF9328]]): BRecord image that can be used with the bootstrap, if U-Boot is not installed or not working (see [[BootLoader]] page)
*''xxx-u-boot.bin'': U-Boot image file to be used with U-Boot itself, (see [[BootLoader#Update_U-Boot | updating U-Boot]])
*''xxx-linux.bin'': Linux image to use with U-Boot, (see [[Target_Software_Installation#Linux_kernel_installation | updating Linux]])
*''xxx-rootfs.jffs2'': JFFS2 filesystem/rootfs image to use with U-Boot, (see [[Target_Software_Installation#Linux_rootfs_installation | updating rootfs]])
*''xxx-rootfs.ubi'' (not supported on [[APF9328]]): [[UBIFS|UBI]] filesystem/rootfs image to use with U-Boot, (see [[Target_Software_Installation#Linux_rootfs_installation | updating rootfs]])
*''xxx-rootfs.ext4'': EXT4 filesystem/rootfs image to use with U-Boot, (on [[APF6]] and [[OPOS6UL]])
*''xxx-rootfs.tar'': for an NFS/MMC based rootfs, (see [[Network_Configuration#Boot_from_NFS | Booting from NFS]] & [[MultiMediaCard#Booting_from_MMC.2FSD | Booting from a MMC/SD]])

'''Please note the new naming convention of binary files and directories (since Armadeus 4.0)'''

*''buildroot/output/build'': contains all the build results for target root filesystem, Linux, Busybox and U-Boot...
*''buildroot/output/toolchain/'': cross compilation toolchain's build dir. Binaries usable for cross-compilation are in ''buildroot/output/host/usr/bin''.
*''buildroot/output/target/'': target filessytem before generating rootfs images

More information is available in the [http://buildroot.uclibc.org/buildroot.html Buildroot's documentation]

* Note: Previous versions (3.x) of Armadeus SDK stored the generated binary files at a different place: '' ''buildroot/binaries/XX/'' (where XX was the name of your board).

<noinclude>

You then copy the binary image to your server directory:
<pre class="host">
$ cp buildroot/output/images/* /tftpboot
</pre>

==To keep your local copy/repository up-to-date with the armadeus GIT repository==
<pre class="host">
$ git pull
</pre>
This will update your working directory to the latest release.

Note: if "git pull" fails because a directory or a file already exists, then do:
$ rm -rf <this-directory/file>
$ git pull

You can do a:
$ make apfXX_defconfig
to have the latest features automatically activated.

You have to do a '''make''' to rebuild binary files and then upload the binary files to your target.

Note: if definitively everything goes wrong while it worked before the last update.
You can apply the following procedure (all your modifications in buildroot will be lost):
$ rm -rf buildroot/
$ rm Makefile
$ git pull
$ make apfXX_defconfig
$ make
$ cp buildroot/output/images/* /tftpboot

Enjoy!
</noinclude>

Ubuntu/Debian installation prerequisites

2025-09-16T11:04:40Z

JulienB: /* Mandatory packages */

==Mandatory packages==
* you can use the following commands (one at a time) to get them (assuming your userid is allowed to use ''sudo'' (execution of commands as root)):
<pre class="host">
sudo apt-get install -y build-essential gcc g++ autoconf automake libtool bison flex gettext
sudo apt-get install -y patch subversion texinfo wget git-core
sudo apt-get install -y libncurses6 libncurses-dev
sudo apt-get install -y zlib1g-dev liblzo2-2 liblzo2-dev
sudo apt-get install -y libacl1 libacl1-dev gawk cvs curl lzma
sudo apt-get install -y uuid-dev mercurial unzip
sudo apt-get install -y libftdi-dev
sudo apt-get install -y bc quilt

# for Linaro external toolchain of APF6 on 64bits Host:
sudo apt-get install -y lib32stdc++6 lib32z1

# to use recover tool if board is bricked:
# python 2 : / python 3 :
sudo apt-get install -y python-serial python-usb libusb-1.0-0-dev / sudo apt-get install -y python3-serial python3-usb libusb-dev
</pre>

* you will need ''bash'' as system interpreter and '''NOT''' ''dash'':
<pre class="host">
$ sudo dpkg-reconfigure dash (choose No)
</pre>

===Localization===
* if your distribution is localized in a language different of English, you will need to install "en_US" locale in order to compile the toolchain (by default our toolchain (uClibc) is configured to only support English). If not, you will get compilation errors like this one:
<pre class="host">
...
extra/locale/locale_mmap.h:46: error: '__LOCALE_DATA_WCctype_II_LEN' undeclared here (not in a function)
...
</pre>
To solve this, install en_US.UTF-8 locale with the following:
<pre class="host">
$ sudo dpkg-reconfigure locales
</pre>

===64 bits Hosts===
* On Debian/Jessie, these packages seems to be required (on 64 bits Host):
<pre class="host">
sudo apt-get install libx32stdc++6 libx32stdc++-4.9-dev lib64stdc++6
</pre>
* On Debian 9 the following seems also recommended:
<pre class="host">
sudo apt-get install libssl1.0-dev
</pre>
On LUbuntu 16.04 it is:
<pre class="host">
sudo apt-get install libssl-dev
</pre>
otherwise you will get:
<pre class="host">
scripts/extract-cert.c:21:25: fatal error: openssl/bio.h: No such file or directory
compilation terminated.
scripts/Makefile.host:90: recipe for target 'scripts/extract-cert' failed
</pre>

* On *Ubuntu 16.04, the following is required:
<pre class=host>
sudo apt-get install gcc-multilib
</pre>

otherwise you may get:
<pre class="host">
In file included from ../../../libgcc/libgcc2.c:27:0:
../../../libgcc/../gcc/tsystem.h:87:19: fatal error: stdio.h: No such file or directory
#include <stdio.h>
^
compilation terminated.
</pre>

==Optional packages==
Not mandatory but useful to add for compiling some Buildroot packages:
<pre class="host">
sudo apt-get -y install libglib2.0-dev
# for fbtest
sudo apt-get -y install libnetpbm10-dev
# for Matchbox
sudo apt-get -y install python-xcbgen
# for mesa
sudo apt-get -y install xutils-dev
# for imx_usb
sudo apt-get -y install pkg-config
</pre>

===Java devt===
{| cellspacing="20"
|
====Ubuntu====
* To compile java jamvm and gnu-classpath:
<pre class="host">
sudo apt-get -y install gcj-jdk
</pre>
||
====Debian====
* To compile java jamvm and gnu-classpath:
<pre class="host">
sudo apt-get -y install java-gcj-compat-dev default-jdk
</pre>
|}

Preempt-rt

2025-02-20T16:53:54Z

JulienB:

preempt-rt are a series of patches to improve Linux kernel realtime performances. This page explain how to use it.

==Installation==
* Depending on your board, you may have a Buildroot defconfig to apply preempt-rt patches automagically. For example for [[OPOS6UL]]:
<pre class=host>
$ make opos6ul-preempt-rt_defconfig
</pre>

* If no config is available, you will have to do the job yourself, by finding a kernel version compatible with preempt-rt patches from https://www.kernel.org/pub/linux/kernel/projects/rt/

==Usage==
* You can change realtime priority of tasks with ''chrt''. For example to set process X to priority 20 in FIFO scheduling queue, you have to do:
<pre class=apf>
# chrt -p -f 20 X

pid X's current scheduling policy: SCHED_OTHER
pid X's current scheduling priority: 0
pid X's new scheduling policy: SCHED_FIFO
pid X's new scheduling priority: 20
</pre>
* The more priority you set, the more your process is prioritary.
* Priority queues are OTHER (no realtime), FIFO (First In First Out), RR (Round Robin time share)
* You can validate realtime performances of your system with ''cyclictest''. For example to launch 10 processes triggering on timer set to 10ms with different descending priorities, you can do:
<pre class=apf>
# cyclictest -t 10 -p 20 -n -i 10000 --priospread

/dev/cpu_dma_latency set to 0us
policy: fifo: loadavg: 0.45 0.23 0.10 1/86 230

T: 0 ( 219) P:99 I:10000 C: 34012 Min: 67 Act: 166 Avg: 174 Max: 536
T: 1 ( 220) P:98 I:10500 C: 32393 Min: 76 Act: 228 Avg: 202 Max: 719
T: 2 ( 221) P:97 I:11000 C: 30920 Min: 66 Act: 170 Avg: 197 Max: 1154
T: 3 ( 222) P:96 I:11500 C: 29576 Min: 65 Act: 217 Avg: 194 Max: 1176
T: 4 ( 223) P:95 I:12000 C: 28343 Min: 72 Act: 167 Avg: 194 Max: 1912
...
</pre>
* times are in microseconds

==Links==
* https://wiki.linuxfoundation.org/realtime/documentation/howto/applications/preemptrt_setup
* https://wiki.linuxfoundation.org/realtime/documentation/howto/applications/application_base

[[Category:Real-Time]]

Preempt-rt

2025-02-20T16:26:18Z

JulienB: /* Installation */

preempt-rt are a series of patches to improve Linux kernel realtime performances. This page explain how to use it.

==Installation==
* Depending on your board, you may have a Buildroot defconfig to apply preempt-rt automatically. For example for [[OPOS6UL]]:
<pre class=host>
$ make opos6ul-preempt-rt_defconfig
</pre>

* If no config is available, you will have to do the job yourself, by finding a kernel version compatible with preempt-rt patches from https://www.kernel.org/pub/linux/kernel/projects/rt/

==Usage==
* You can change realtime priority of tasks with ''chrt''. For example to set process X to priority 20 in FIFO scheduling queue, you have to do:
<pre class=apf>
# chrt -p -f 20 X

pid X's current scheduling policy: SCHED_OTHER
pid X's current scheduling priority: 0
pid X's new scheduling policy: SCHED_FIFO
pid X's new scheduling priority: 20
</pre>
* The more priority you set, the more your process is prioritary.
* Priority queues are OTHER (no realtime), FIFO (First In First Out), RR (Round Robin time share)
* You can validate realtime performances of your system with ''cyclictest''. For example to launch 10 processes triggering on timer set to 10ms with different descending priorities, you can do:
<pre class=apf>
# cyclictest -t 10 -p 20 -n -i 10000 --priospread

/dev/cpu_dma_latency set to 0us
policy: fifo: loadavg: 0.45 0.23 0.10 1/86 230

T: 0 ( 219) P:99 I:10000 C: 34012 Min: 67 Act: 166 Avg: 174 Max: 536
T: 1 ( 220) P:98 I:10500 C: 32393 Min: 76 Act: 228 Avg: 202 Max: 719
T: 2 ( 221) P:97 I:11000 C: 30920 Min: 66 Act: 170 Avg: 197 Max: 1154
T: 3 ( 222) P:96 I:11500 C: 29576 Min: 65 Act: 217 Avg: 194 Max: 1176
T: 4 ( 223) P:95 I:12000 C: 28343 Min: 72 Act: 167 Avg: 194 Max: 1912
...
</pre>
* times are in microseconds

==Links==
* https://wiki.linuxfoundation.org/realtime/documentation/howto/applications/preemptrt_setup
* https://wiki.linuxfoundation.org/realtime/documentation/howto/applications/application_base

[[Category:Real-Time]]

Secure boot on OPOS93

2025-02-13T14:59:44Z

JulienB: /* Closing the OPOS93 */

= Introduction =

This document is a quick how-to boot a signed boot firmware on the OPOS93 SoM. It summarizes the documents provided by NXP:

* [https://www.nxp.com/doc/an12312 AN12312]
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.1.22-2.0.0/doc/imx/ahab/introduction_ahab.txt
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.6.36-2.1.0/doc/imx/ahab/guides/mx8ulp_9x_secure_boot.txt

= Requirements =

== IMX CST TOOL ==

* Download the [https://www.nxp.com/webapp/Download?colCode=IMX_CST_TOOL_NEW IMX CST TOOL] and unarchive it:

<pre class="host">
tar xf IMX_CST_TOOL_NEW.tgz
</pre>

== imx-mkimage ==

* Checkout the imx-mkimage:

<pre class="host">
git clone -b lf-6.6.36-2.1.0 https://github.com/nxp-imx/imx-mkimage.git
</pre>

== Latest Armadeus U-Boot ==

* Make sure you have the latest Armadeus U-Boot installed on you OPOS93 SoM. It must have the '''ahab_status''' commands:

<pre class="opos">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open
...
</pre>

If the command is not available on your OPOS93 SoM, update to the latest Armadeus U-Boot.

= Generating a PKI tree =

* To generate your PKI tree, go to the CST TOOL directory and use the script '''ahab_pki_tree.sh''':

<pre class="host">
$ cd cst-3.4.1/
$ ./keys/ahab_pki_tree.sh
...
Do you want to use an existing CA key (y/n)?: n
Do you want to use Elliptic Curve Cryptography (y/n)?: y
Enter length for elliptic curve to be used for PKI tree:
Possible values p256, p384, p521: p384
Enter the digest algorithm to use: sha384
Enter PKI tree duration (years): 5
Do you want the SRK certificates to have the CA flag set? (y/n)?: y
</pre>

= Generating SRK Table and SRK Hash =

* Generate the SRK Table and SRK Hash with '''srktool''':

<pre class="host">
$ cd crts/
$ ../linux64/bin/srktool -a -d sha256 -s sha384 -t SRK_1_2_3_4_table.bin \
-e SRK_1_2_3_4_fuse.bin -f 1 -c \
SRK1_sha384_secp384r1_v3_usr_crt.pem,\
SRK2_sha384_secp384r1_v3_usr_crt.pem,\
SRK3_sha384_secp384r1_v3_usr_crt.pem,\
SRK4_sha384_secp384r1_v3_usr_crt.pem
</pre>

* Regenerate the SRK HASH (SRK_1_2_3_4_fuse.bin) by using SHA256 with SRK_1_2_3_4_table.bin:

<pre class="host">
$ openssl dgst -binary -sha256 SRK_1_2_3_4_table.bin > SRK_1_2_3_4_fuse.bin
</pre>

* Check if the hash in the SRK_1_2_3_4_fuse.bin is correct:

<pre class="host">
$ hexdump -C SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024

$ sha256sum SRK_1_2_3_4_table.bin
db2959f290dfc39c53394566e0b7582985e6f3b1af00983de5e804fe7a451024 SRK_1_2_3_4_table.bin
</pre>

= Signing the boot image =

* From the images directory of the Armadeus BSP, copy the files needed to generate a boot image (SPL, U-Boot proper, ATF) into the i.MX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp <path to BSP Armadeus>/images/u-boot.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/u-boot-spl.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/bl31.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/lpddr4* <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/ahab-container.img <path to imx-mkimage>/iMX93/mx93a1-ahab-container.img
</pre>

== Signing ATF + U-Boot proper Image container ==

* Generate the u-boot-atf-container.img file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 u-boot-atf-container.img
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x0
CST: CONTAINER 0: Signature Block: offset is at 0x110
Offsets = 0x0 0x110
</pre>

* A CSF description file is needed to sign the u-boot-atf-container.img file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_uboot_atf.txt here]. In this file, update the offset you previously noted and the eventually the name and path of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "u-boot-atf-container.img"
# Offsets = Container header Signature block
Offsets = 0x0 0x110
</pre>

* Sign the u-boot-atf-container.img with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_uboot_atf.txt -o signed-u-boot-atf-container.img
</pre>

* Replace the u-boot-atf-container.img file with the signed-u-boot-atf-container.img file in the iMX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp signed-u-boot-atf-container.img <path to imx-mkimage>/iMX93/u-boot-atf-container.img
</pre>

== Signing the boot image ==

* Generate the flash.bin file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 flash_singleboot
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x400
CST: CONTAINER 0: Signature Block: offset is at 0x490
Offsets = 0x400 0x490
</pre>

* Another CSF description file is needed to sign the flash.bin file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_boot_image.txt here]. In this file, update the offset you previously noted and the eventually the name of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "/home/sszy/development/imx-mkimage/iMX93/flash.bin"
# Offsets = Container header Signature block (printed out by mkimage)
Offsets = 0x400 0x490
</pre>

* Sign the flash.bin file with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_boot_image.txt -o signed-flash.bin
</pre>

= Flashing U-Boot =

* On your computer, copy the signed boot image into the root directory of your tftp server:

<pre class="host">
cp flash-signed.bin /tftproot/opos93-u-boot.bin
</pre>

* On your OPOS93, update U-Boot as usual:

<pre class="opos">
BIOS> run update_uboot
</pre>

= Burning SRK hash into the fuses =

* On your host computer, dump the SRK hash:

<pre class="host">
$ od -t x4 SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024
</pre>

* On the OPOS93, on U-Boot, burn the SRK hash into the fuses.
'''Obviously, don't burn these values but the ones the previous command outputs with your keys !'''

<pre class="opos">
BIOS> fuse prog 16 0 0xdb2959f2
BIOS> fuse prog 16 1 0x90dfc39c
BIOS> fuse prog 16 2 0x53394566
BIOS> fuse prog 16 3 0xe0b75829
BIOS> fuse prog 16 4 0x85e6f3b1
BIOS> fuse prog 16 5 0xaf00983d
BIOS> fuse prog 16 6 0xe5e804fe
BIOS> fuse prog 16 7 0x7a451024
</pre>

= Checking =

* Power off / on the board, and stop the boot into U-Boot. Run the ahab_status command. If everything is ok, there should be no AHAB events:

<pre class="opos">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open

No Events Found!
</pre>

= Closing the OPOS93 =

{{Warning|Before closing your OPOS93, make sure everything is ok (double or triple check...), there is no AHAB events and you are able to boot a signed image. A missigned boot image on a closed OPOS93 will make your OPOS93 unrecoverable !}}

* To close your OPOS93, run the '''ahab_close''' command:

<pre class="opos">
BIOS> ahab_close
</pre>

* Reboot and check with the '''ahab_status''' command:

<pre class="opos">
BIOS> ahab_status
Lifecycle: 0x00000020, OEM Closed

No Events Found!
</pre>

Secure boot on OPOS93

2025-02-13T14:59:27Z

JulienB: /* Checking */

= Introduction =

This document is a quick how-to boot a signed boot firmware on the OPOS93 SoM. It summarizes the documents provided by NXP:

* [https://www.nxp.com/doc/an12312 AN12312]
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.1.22-2.0.0/doc/imx/ahab/introduction_ahab.txt
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.6.36-2.1.0/doc/imx/ahab/guides/mx8ulp_9x_secure_boot.txt

= Requirements =

== IMX CST TOOL ==

* Download the [https://www.nxp.com/webapp/Download?colCode=IMX_CST_TOOL_NEW IMX CST TOOL] and unarchive it:

<pre class="host">
tar xf IMX_CST_TOOL_NEW.tgz
</pre>

== imx-mkimage ==

* Checkout the imx-mkimage:

<pre class="host">
git clone -b lf-6.6.36-2.1.0 https://github.com/nxp-imx/imx-mkimage.git
</pre>

== Latest Armadeus U-Boot ==

* Make sure you have the latest Armadeus U-Boot installed on you OPOS93 SoM. It must have the '''ahab_status''' commands:

<pre class="opos">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open
...
</pre>

If the command is not available on your OPOS93 SoM, update to the latest Armadeus U-Boot.

= Generating a PKI tree =

* To generate your PKI tree, go to the CST TOOL directory and use the script '''ahab_pki_tree.sh''':

<pre class="host">
$ cd cst-3.4.1/
$ ./keys/ahab_pki_tree.sh
...
Do you want to use an existing CA key (y/n)?: n
Do you want to use Elliptic Curve Cryptography (y/n)?: y
Enter length for elliptic curve to be used for PKI tree:
Possible values p256, p384, p521: p384
Enter the digest algorithm to use: sha384
Enter PKI tree duration (years): 5
Do you want the SRK certificates to have the CA flag set? (y/n)?: y
</pre>

= Generating SRK Table and SRK Hash =

* Generate the SRK Table and SRK Hash with '''srktool''':

<pre class="host">
$ cd crts/
$ ../linux64/bin/srktool -a -d sha256 -s sha384 -t SRK_1_2_3_4_table.bin \
-e SRK_1_2_3_4_fuse.bin -f 1 -c \
SRK1_sha384_secp384r1_v3_usr_crt.pem,\
SRK2_sha384_secp384r1_v3_usr_crt.pem,\
SRK3_sha384_secp384r1_v3_usr_crt.pem,\
SRK4_sha384_secp384r1_v3_usr_crt.pem
</pre>

* Regenerate the SRK HASH (SRK_1_2_3_4_fuse.bin) by using SHA256 with SRK_1_2_3_4_table.bin:

<pre class="host">
$ openssl dgst -binary -sha256 SRK_1_2_3_4_table.bin > SRK_1_2_3_4_fuse.bin
</pre>

* Check if the hash in the SRK_1_2_3_4_fuse.bin is correct:

<pre class="host">
$ hexdump -C SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024

$ sha256sum SRK_1_2_3_4_table.bin
db2959f290dfc39c53394566e0b7582985e6f3b1af00983de5e804fe7a451024 SRK_1_2_3_4_table.bin
</pre>

= Signing the boot image =

* From the images directory of the Armadeus BSP, copy the files needed to generate a boot image (SPL, U-Boot proper, ATF) into the i.MX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp <path to BSP Armadeus>/images/u-boot.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/u-boot-spl.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/bl31.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/lpddr4* <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/ahab-container.img <path to imx-mkimage>/iMX93/mx93a1-ahab-container.img
</pre>

== Signing ATF + U-Boot proper Image container ==

* Generate the u-boot-atf-container.img file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 u-boot-atf-container.img
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x0
CST: CONTAINER 0: Signature Block: offset is at 0x110
Offsets = 0x0 0x110
</pre>

* A CSF description file is needed to sign the u-boot-atf-container.img file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_uboot_atf.txt here]. In this file, update the offset you previously noted and the eventually the name and path of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "u-boot-atf-container.img"
# Offsets = Container header Signature block
Offsets = 0x0 0x110
</pre>

* Sign the u-boot-atf-container.img with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_uboot_atf.txt -o signed-u-boot-atf-container.img
</pre>

* Replace the u-boot-atf-container.img file with the signed-u-boot-atf-container.img file in the iMX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp signed-u-boot-atf-container.img <path to imx-mkimage>/iMX93/u-boot-atf-container.img
</pre>

== Signing the boot image ==

* Generate the flash.bin file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 flash_singleboot
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x400
CST: CONTAINER 0: Signature Block: offset is at 0x490
Offsets = 0x400 0x490
</pre>

* Another CSF description file is needed to sign the flash.bin file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_boot_image.txt here]. In this file, update the offset you previously noted and the eventually the name of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "/home/sszy/development/imx-mkimage/iMX93/flash.bin"
# Offsets = Container header Signature block (printed out by mkimage)
Offsets = 0x400 0x490
</pre>

* Sign the flash.bin file with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_boot_image.txt -o signed-flash.bin
</pre>

= Flashing U-Boot =

* On your computer, copy the signed boot image into the root directory of your tftp server:

<pre class="host">
cp flash-signed.bin /tftproot/opos93-u-boot.bin
</pre>

* On your OPOS93, update U-Boot as usual:

<pre class="opos">
BIOS> run update_uboot
</pre>

= Burning SRK hash into the fuses =

* On your host computer, dump the SRK hash:

<pre class="host">
$ od -t x4 SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024
</pre>

* On the OPOS93, on U-Boot, burn the SRK hash into the fuses.
'''Obviously, don't burn these values but the ones the previous command outputs with your keys !'''

<pre class="opos">
BIOS> fuse prog 16 0 0xdb2959f2
BIOS> fuse prog 16 1 0x90dfc39c
BIOS> fuse prog 16 2 0x53394566
BIOS> fuse prog 16 3 0xe0b75829
BIOS> fuse prog 16 4 0x85e6f3b1
BIOS> fuse prog 16 5 0xaf00983d
BIOS> fuse prog 16 6 0xe5e804fe
BIOS> fuse prog 16 7 0x7a451024
</pre>

= Checking =

* Power off / on the board, and stop the boot into U-Boot. Run the ahab_status command. If everything is ok, there should be no AHAB events:

<pre class="opos">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open

No Events Found!
</pre>

= Closing the OPOS93 =

{{Warning|Before closing your OPOS93, make sure everything is ok (double or triple check...), there is no AHAB events and you are able to boot a signed image. A missigned boot image on a closed OPOS93 will make your OPOS93 unrecoverable !}}

* To close your OPOS93, run the '''ahab_close''' command:

<pre class="host">
BIOS> ahab_close
</pre>

* Reboot and check with the '''ahab_status''' command:

<pre class="host">
BIOS> ahab_status
Lifecycle: 0x00000020, OEM Closed

No Events Found!
</pre>

Secure boot on OPOS93

2025-02-13T14:59:06Z

JulienB: /* Burning SRK hash into the fuses */

= Introduction =

This document is a quick how-to boot a signed boot firmware on the OPOS93 SoM. It summarizes the documents provided by NXP:

* [https://www.nxp.com/doc/an12312 AN12312]
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.1.22-2.0.0/doc/imx/ahab/introduction_ahab.txt
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.6.36-2.1.0/doc/imx/ahab/guides/mx8ulp_9x_secure_boot.txt

= Requirements =

== IMX CST TOOL ==

* Download the [https://www.nxp.com/webapp/Download?colCode=IMX_CST_TOOL_NEW IMX CST TOOL] and unarchive it:

<pre class="host">
tar xf IMX_CST_TOOL_NEW.tgz
</pre>

== imx-mkimage ==

* Checkout the imx-mkimage:

<pre class="host">
git clone -b lf-6.6.36-2.1.0 https://github.com/nxp-imx/imx-mkimage.git
</pre>

== Latest Armadeus U-Boot ==

* Make sure you have the latest Armadeus U-Boot installed on you OPOS93 SoM. It must have the '''ahab_status''' commands:

<pre class="opos">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open
...
</pre>

If the command is not available on your OPOS93 SoM, update to the latest Armadeus U-Boot.

= Generating a PKI tree =

* To generate your PKI tree, go to the CST TOOL directory and use the script '''ahab_pki_tree.sh''':

<pre class="host">
$ cd cst-3.4.1/
$ ./keys/ahab_pki_tree.sh
...
Do you want to use an existing CA key (y/n)?: n
Do you want to use Elliptic Curve Cryptography (y/n)?: y
Enter length for elliptic curve to be used for PKI tree:
Possible values p256, p384, p521: p384
Enter the digest algorithm to use: sha384
Enter PKI tree duration (years): 5
Do you want the SRK certificates to have the CA flag set? (y/n)?: y
</pre>

= Generating SRK Table and SRK Hash =

* Generate the SRK Table and SRK Hash with '''srktool''':

<pre class="host">
$ cd crts/
$ ../linux64/bin/srktool -a -d sha256 -s sha384 -t SRK_1_2_3_4_table.bin \
-e SRK_1_2_3_4_fuse.bin -f 1 -c \
SRK1_sha384_secp384r1_v3_usr_crt.pem,\
SRK2_sha384_secp384r1_v3_usr_crt.pem,\
SRK3_sha384_secp384r1_v3_usr_crt.pem,\
SRK4_sha384_secp384r1_v3_usr_crt.pem
</pre>

* Regenerate the SRK HASH (SRK_1_2_3_4_fuse.bin) by using SHA256 with SRK_1_2_3_4_table.bin:

<pre class="host">
$ openssl dgst -binary -sha256 SRK_1_2_3_4_table.bin > SRK_1_2_3_4_fuse.bin
</pre>

* Check if the hash in the SRK_1_2_3_4_fuse.bin is correct:

<pre class="host">
$ hexdump -C SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024

$ sha256sum SRK_1_2_3_4_table.bin
db2959f290dfc39c53394566e0b7582985e6f3b1af00983de5e804fe7a451024 SRK_1_2_3_4_table.bin
</pre>

= Signing the boot image =

* From the images directory of the Armadeus BSP, copy the files needed to generate a boot image (SPL, U-Boot proper, ATF) into the i.MX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp <path to BSP Armadeus>/images/u-boot.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/u-boot-spl.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/bl31.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/lpddr4* <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/ahab-container.img <path to imx-mkimage>/iMX93/mx93a1-ahab-container.img
</pre>

== Signing ATF + U-Boot proper Image container ==

* Generate the u-boot-atf-container.img file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 u-boot-atf-container.img
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x0
CST: CONTAINER 0: Signature Block: offset is at 0x110
Offsets = 0x0 0x110
</pre>

* A CSF description file is needed to sign the u-boot-atf-container.img file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_uboot_atf.txt here]. In this file, update the offset you previously noted and the eventually the name and path of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "u-boot-atf-container.img"
# Offsets = Container header Signature block
Offsets = 0x0 0x110
</pre>

* Sign the u-boot-atf-container.img with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_uboot_atf.txt -o signed-u-boot-atf-container.img
</pre>

* Replace the u-boot-atf-container.img file with the signed-u-boot-atf-container.img file in the iMX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp signed-u-boot-atf-container.img <path to imx-mkimage>/iMX93/u-boot-atf-container.img
</pre>

== Signing the boot image ==

* Generate the flash.bin file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 flash_singleboot
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x400
CST: CONTAINER 0: Signature Block: offset is at 0x490
Offsets = 0x400 0x490
</pre>

* Another CSF description file is needed to sign the flash.bin file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_boot_image.txt here]. In this file, update the offset you previously noted and the eventually the name of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "/home/sszy/development/imx-mkimage/iMX93/flash.bin"
# Offsets = Container header Signature block (printed out by mkimage)
Offsets = 0x400 0x490
</pre>

* Sign the flash.bin file with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_boot_image.txt -o signed-flash.bin
</pre>

= Flashing U-Boot =

* On your computer, copy the signed boot image into the root directory of your tftp server:

<pre class="host">
cp flash-signed.bin /tftproot/opos93-u-boot.bin
</pre>

* On your OPOS93, update U-Boot as usual:

<pre class="opos">
BIOS> run update_uboot
</pre>

= Burning SRK hash into the fuses =

* On your host computer, dump the SRK hash:

<pre class="host">
$ od -t x4 SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024
</pre>

* On the OPOS93, on U-Boot, burn the SRK hash into the fuses.
'''Obviously, don't burn these values but the ones the previous command outputs with your keys !'''

<pre class="opos">
BIOS> fuse prog 16 0 0xdb2959f2
BIOS> fuse prog 16 1 0x90dfc39c
BIOS> fuse prog 16 2 0x53394566
BIOS> fuse prog 16 3 0xe0b75829
BIOS> fuse prog 16 4 0x85e6f3b1
BIOS> fuse prog 16 5 0xaf00983d
BIOS> fuse prog 16 6 0xe5e804fe
BIOS> fuse prog 16 7 0x7a451024
</pre>

= Checking =

* Power off / on the board, and stop the boot into U-Boot. Run the ahab_status command. If everything is ok, there should be no AHAB events:

<pre class="code">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open

No Events Found!
</pre>

= Closing the OPOS93 =

{{Warning|Before closing your OPOS93, make sure everything is ok (double or triple check...), there is no AHAB events and you are able to boot a signed image. A missigned boot image on a closed OPOS93 will make your OPOS93 unrecoverable !}}

* To close your OPOS93, run the '''ahab_close''' command:

<pre class="host">
BIOS> ahab_close
</pre>

* Reboot and check with the '''ahab_status''' command:

<pre class="host">
BIOS> ahab_status
Lifecycle: 0x00000020, OEM Closed

No Events Found!
</pre>

Secure boot on OPOS93

2025-02-13T14:57:10Z

JulienB: /* Flashing U-Boot */

= Introduction =

This document is a quick how-to boot a signed boot firmware on the OPOS93 SoM. It summarizes the documents provided by NXP:

* [https://www.nxp.com/doc/an12312 AN12312]
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.1.22-2.0.0/doc/imx/ahab/introduction_ahab.txt
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.6.36-2.1.0/doc/imx/ahab/guides/mx8ulp_9x_secure_boot.txt

= Requirements =

== IMX CST TOOL ==

* Download the [https://www.nxp.com/webapp/Download?colCode=IMX_CST_TOOL_NEW IMX CST TOOL] and unarchive it:

<pre class="host">
tar xf IMX_CST_TOOL_NEW.tgz
</pre>

== imx-mkimage ==

* Checkout the imx-mkimage:

<pre class="host">
git clone -b lf-6.6.36-2.1.0 https://github.com/nxp-imx/imx-mkimage.git
</pre>

== Latest Armadeus U-Boot ==

* Make sure you have the latest Armadeus U-Boot installed on you OPOS93 SoM. It must have the '''ahab_status''' commands:

<pre class="opos">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open
...
</pre>

If the command is not available on your OPOS93 SoM, update to the latest Armadeus U-Boot.

= Generating a PKI tree =

* To generate your PKI tree, go to the CST TOOL directory and use the script '''ahab_pki_tree.sh''':

<pre class="host">
$ cd cst-3.4.1/
$ ./keys/ahab_pki_tree.sh
...
Do you want to use an existing CA key (y/n)?: n
Do you want to use Elliptic Curve Cryptography (y/n)?: y
Enter length for elliptic curve to be used for PKI tree:
Possible values p256, p384, p521: p384
Enter the digest algorithm to use: sha384
Enter PKI tree duration (years): 5
Do you want the SRK certificates to have the CA flag set? (y/n)?: y
</pre>

= Generating SRK Table and SRK Hash =

* Generate the SRK Table and SRK Hash with '''srktool''':

<pre class="host">
$ cd crts/
$ ../linux64/bin/srktool -a -d sha256 -s sha384 -t SRK_1_2_3_4_table.bin \
-e SRK_1_2_3_4_fuse.bin -f 1 -c \
SRK1_sha384_secp384r1_v3_usr_crt.pem,\
SRK2_sha384_secp384r1_v3_usr_crt.pem,\
SRK3_sha384_secp384r1_v3_usr_crt.pem,\
SRK4_sha384_secp384r1_v3_usr_crt.pem
</pre>

* Regenerate the SRK HASH (SRK_1_2_3_4_fuse.bin) by using SHA256 with SRK_1_2_3_4_table.bin:

<pre class="host">
$ openssl dgst -binary -sha256 SRK_1_2_3_4_table.bin > SRK_1_2_3_4_fuse.bin
</pre>

* Check if the hash in the SRK_1_2_3_4_fuse.bin is correct:

<pre class="host">
$ hexdump -C SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024

$ sha256sum SRK_1_2_3_4_table.bin
db2959f290dfc39c53394566e0b7582985e6f3b1af00983de5e804fe7a451024 SRK_1_2_3_4_table.bin
</pre>

= Signing the boot image =

* From the images directory of the Armadeus BSP, copy the files needed to generate a boot image (SPL, U-Boot proper, ATF) into the i.MX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp <path to BSP Armadeus>/images/u-boot.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/u-boot-spl.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/bl31.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/lpddr4* <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/ahab-container.img <path to imx-mkimage>/iMX93/mx93a1-ahab-container.img
</pre>

== Signing ATF + U-Boot proper Image container ==

* Generate the u-boot-atf-container.img file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 u-boot-atf-container.img
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x0
CST: CONTAINER 0: Signature Block: offset is at 0x110
Offsets = 0x0 0x110
</pre>

* A CSF description file is needed to sign the u-boot-atf-container.img file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_uboot_atf.txt here]. In this file, update the offset you previously noted and the eventually the name and path of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "u-boot-atf-container.img"
# Offsets = Container header Signature block
Offsets = 0x0 0x110
</pre>

* Sign the u-boot-atf-container.img with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_uboot_atf.txt -o signed-u-boot-atf-container.img
</pre>

* Replace the u-boot-atf-container.img file with the signed-u-boot-atf-container.img file in the iMX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp signed-u-boot-atf-container.img <path to imx-mkimage>/iMX93/u-boot-atf-container.img
</pre>

== Signing the boot image ==

* Generate the flash.bin file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 flash_singleboot
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x400
CST: CONTAINER 0: Signature Block: offset is at 0x490
Offsets = 0x400 0x490
</pre>

* Another CSF description file is needed to sign the flash.bin file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_boot_image.txt here]. In this file, update the offset you previously noted and the eventually the name of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "/home/sszy/development/imx-mkimage/iMX93/flash.bin"
# Offsets = Container header Signature block (printed out by mkimage)
Offsets = 0x400 0x490
</pre>

* Sign the flash.bin file with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_boot_image.txt -o signed-flash.bin
</pre>

= Flashing U-Boot =

* On your computer, copy the signed boot image into the root directory of your tftp server:

<pre class="host">
cp flash-signed.bin /tftproot/opos93-u-boot.bin
</pre>

* On your OPOS93, update U-Boot as usual:

<pre class="opos">
BIOS> run update_uboot
</pre>

= Burning SRK hash into the fuses =

* On your host computer, dump the SRK hash:

<pre class="host">
$ od -t x4 SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024
</pre>

* On the OPOS93, on U-Boot, burn the SRK hash into the fuses.
'''Obviously, don't burn these values but the ones the previous command outputs with your keys !'''

<pre class="host">
BIOS> fuse prog 16 0 0xdb2959f2
BIOS> fuse prog 16 1 0x90dfc39c
BIOS> fuse prog 16 2 0x53394566
BIOS> fuse prog 16 3 0xe0b75829
BIOS> fuse prog 16 4 0x85e6f3b1
BIOS> fuse prog 16 5 0xaf00983d
BIOS> fuse prog 16 6 0xe5e804fe
BIOS> fuse prog 16 7 0x7a451024
</pre>

= Checking =

* Power off / on the board, and stop the boot into U-Boot. Run the ahab_status command. If everything is ok, there should be no AHAB events:

<pre class="code">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open

No Events Found!
</pre>

= Closing the OPOS93 =

{{Warning|Before closing your OPOS93, make sure everything is ok (double or triple check...), there is no AHAB events and you are able to boot a signed image. A missigned boot image on a closed OPOS93 will make your OPOS93 unrecoverable !}}

* To close your OPOS93, run the '''ahab_close''' command:

<pre class="host">
BIOS> ahab_close
</pre>

* Reboot and check with the '''ahab_status''' command:

<pre class="host">
BIOS> ahab_status
Lifecycle: 0x00000020, OEM Closed

No Events Found!
</pre>

Secure boot on OPOS93

2025-02-13T14:56:08Z

JulienB: /* Latest Armadeus U-Boot */

= Introduction =

This document is a quick how-to boot a signed boot firmware on the OPOS93 SoM. It summarizes the documents provided by NXP:

* [https://www.nxp.com/doc/an12312 AN12312]
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.1.22-2.0.0/doc/imx/ahab/introduction_ahab.txt
* https://github.com/nxp-imx/uboot-imx/blob/lf-6.6.36-2.1.0/doc/imx/ahab/guides/mx8ulp_9x_secure_boot.txt

= Requirements =

== IMX CST TOOL ==

* Download the [https://www.nxp.com/webapp/Download?colCode=IMX_CST_TOOL_NEW IMX CST TOOL] and unarchive it:

<pre class="host">
tar xf IMX_CST_TOOL_NEW.tgz
</pre>

== imx-mkimage ==

* Checkout the imx-mkimage:

<pre class="host">
git clone -b lf-6.6.36-2.1.0 https://github.com/nxp-imx/imx-mkimage.git
</pre>

== Latest Armadeus U-Boot ==

* Make sure you have the latest Armadeus U-Boot installed on you OPOS93 SoM. It must have the '''ahab_status''' commands:

<pre class="opos">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open
...
</pre>

If the command is not available on your OPOS93 SoM, update to the latest Armadeus U-Boot.

= Generating a PKI tree =

* To generate your PKI tree, go to the CST TOOL directory and use the script '''ahab_pki_tree.sh''':

<pre class="host">
$ cd cst-3.4.1/
$ ./keys/ahab_pki_tree.sh
...
Do you want to use an existing CA key (y/n)?: n
Do you want to use Elliptic Curve Cryptography (y/n)?: y
Enter length for elliptic curve to be used for PKI tree:
Possible values p256, p384, p521: p384
Enter the digest algorithm to use: sha384
Enter PKI tree duration (years): 5
Do you want the SRK certificates to have the CA flag set? (y/n)?: y
</pre>

= Generating SRK Table and SRK Hash =

* Generate the SRK Table and SRK Hash with '''srktool''':

<pre class="host">
$ cd crts/
$ ../linux64/bin/srktool -a -d sha256 -s sha384 -t SRK_1_2_3_4_table.bin \
-e SRK_1_2_3_4_fuse.bin -f 1 -c \
SRK1_sha384_secp384r1_v3_usr_crt.pem,\
SRK2_sha384_secp384r1_v3_usr_crt.pem,\
SRK3_sha384_secp384r1_v3_usr_crt.pem,\
SRK4_sha384_secp384r1_v3_usr_crt.pem
</pre>

* Regenerate the SRK HASH (SRK_1_2_3_4_fuse.bin) by using SHA256 with SRK_1_2_3_4_table.bin:

<pre class="host">
$ openssl dgst -binary -sha256 SRK_1_2_3_4_table.bin > SRK_1_2_3_4_fuse.bin
</pre>

* Check if the hash in the SRK_1_2_3_4_fuse.bin is correct:

<pre class="host">
$ hexdump -C SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024

$ sha256sum SRK_1_2_3_4_table.bin
db2959f290dfc39c53394566e0b7582985e6f3b1af00983de5e804fe7a451024 SRK_1_2_3_4_table.bin
</pre>

= Signing the boot image =

* From the images directory of the Armadeus BSP, copy the files needed to generate a boot image (SPL, U-Boot proper, ATF) into the i.MX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp <path to BSP Armadeus>/images/u-boot.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/u-boot-spl.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/bl31.bin <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/lpddr4* <path to imx-mkimage>/iMX93/
$ cp <path to BSP Armadeus>/images/ahab-container.img <path to imx-mkimage>/iMX93/mx93a1-ahab-container.img
</pre>

== Signing ATF + U-Boot proper Image container ==

* Generate the u-boot-atf-container.img file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 u-boot-atf-container.img
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x0
CST: CONTAINER 0: Signature Block: offset is at 0x110
Offsets = 0x0 0x110
</pre>

* A CSF description file is needed to sign the u-boot-atf-container.img file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_uboot_atf.txt here]. In this file, update the offset you previously noted and the eventually the name and path of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "u-boot-atf-container.img"
# Offsets = Container header Signature block
Offsets = 0x0 0x110
</pre>

* Sign the u-boot-atf-container.img with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_uboot_atf.txt -o signed-u-boot-atf-container.img
</pre>

* Replace the u-boot-atf-container.img file with the signed-u-boot-atf-container.img file in the iMX93 directory of the imx-mkimage tool:

<pre class="host">
$ cp signed-u-boot-atf-container.img <path to imx-mkimage>/iMX93/u-boot-atf-container.img
</pre>

== Signing the boot image ==

* Generate the flash.bin file:

<pre class="host">
$ cd <path to imx-mkimage>
$ make SOC=iMX9 flash_singleboot
</pre>

* Note the offset the imx-mkimage tool outputs:

<pre class="host">
CST: CONTAINER 0 offset: 0x400
CST: CONTAINER 0: Signature Block: offset is at 0x490
Offsets = 0x400 0x490
</pre>

* Another CSF description file is needed to sign the flash.bin file. You can download it [https://github.com/nxp-imx/uboot-imx/raw/refs/tags/lf-6.6.36-2.1.0/doc/imx/ahab/csf_examples/csf_boot_image.txt here]. In this file, update the offset you previously noted and the eventually the name of the keys:

<pre class="host">
...
Source = "../crts/SRK1_sha384_secp384r1_v3_ca_crt.pem"
...
[Authenticate Data]
# Binary to be signed generated by mkimage
File = "/home/sszy/development/imx-mkimage/iMX93/flash.bin"
# Offsets = Container header Signature block (printed out by mkimage)
Offsets = 0x400 0x490
</pre>

* Sign the flash.bin file with the CST TOOL:

<pre class="host">
$ cd <path to CST TOOL>
$ ./linux64/bin/cst -i ~/Downloads/csf_boot_image.txt -o signed-flash.bin
</pre>

= Flashing U-Boot =

* On your computer, copy the signed boot image into the root directory of your tftp server:

<pre class="host">
cp flash-signed.bin /tftproot/opos93-u-boot.bin
</pre>

* On your OPOS93, update U-Boot as usual:

<pre class="code">
BIOS> run update_uboot
</pre>

= Burning SRK hash into the fuses =

* On your host computer, dump the SRK hash:

<pre class="host">
$ od -t x4 SRK_1_2_3_4_fuse.bin
0000000 db2959f2 90dfc39c 53394566 e0b75829
0000020 85e6f3b1 af00983d e5e804fe 7a451024
</pre>

* On the OPOS93, on U-Boot, burn the SRK hash into the fuses.
'''Obviously, don't burn these values but the ones the previous command outputs with your keys !'''

<pre class="host">
BIOS> fuse prog 16 0 0xdb2959f2
BIOS> fuse prog 16 1 0x90dfc39c
BIOS> fuse prog 16 2 0x53394566
BIOS> fuse prog 16 3 0xe0b75829
BIOS> fuse prog 16 4 0x85e6f3b1
BIOS> fuse prog 16 5 0xaf00983d
BIOS> fuse prog 16 6 0xe5e804fe
BIOS> fuse prog 16 7 0x7a451024
</pre>

= Checking =

* Power off / on the board, and stop the boot into U-Boot. Run the ahab_status command. If everything is ok, there should be no AHAB events:

<pre class="code">
BIOS> ahab_status
Lifecycle: 0x00000008, OEM Open

No Events Found!
</pre>

= Closing the OPOS93 =

{{Warning|Before closing your OPOS93, make sure everything is ok (double or triple check...), there is no AHAB events and you are able to boot a signed image. A missigned boot image on a closed OPOS93 will make your OPOS93 unrecoverable !}}

* To close your OPOS93, run the '''ahab_close''' command:

<pre class="host">
BIOS> ahab_close
</pre>

* Reboot and check with the '''ahab_status''' command:

<pre class="host">
BIOS> ahab_status
Lifecycle: 0x00000020, OEM Closed

No Events Found!
</pre>

U-Boot Splash Screen

2025-01-17T13:20:16Z

JulienB: /* Installation */

=Introduction=
On this page you will learn how to activate LCD support in U-Boot and display a Splash Screen at boot.
{{Note|The following instructions have only be tested on [[OPOS6UL]].}}

=Installation=
* Save your image as BMP file (in Gimp use Run-Length (RLE) encoding, no alpha channel and no color informations (compatibility options). If the RLE option is grayed out, go to Image > Mode and select Indexed...)
* Activate LCD in U-Boot (here ST0700, must be done by default in recent BSP):
<pre class="apf">
BIOS> setenv videomode video=ctfb:x:800,y:480,depth:18,pclk:30030,le:30,ri:210,up:23,lo:22,hs:16,vs:1,sync:1073741824,vmode:0
</pre>

=Test it=
<pre class="apf">
BIOS> tftpboot ${loadaddr} xxx.bmp
BIOS> bmp info ${loadaddr}
Image size : 296 x 72
Bits per pixel: 8
Compression : 0
</pre>

<pre class="apf">
BIOS> bmp display ${loadaddr} 100 50
</pre>

=Deploy it=
* Here we assume that logo is stored in ''/boot'' directory of rootfs eMMC partition as ''logo.bmp'':
<pre class="apf">
BIOS> setenv splashimage 0x80000000
BIOS> setenv splashfile /boot/logo.bmp
BIOS> setenv splashsource mmc_fs
</pre>

=Continuity with Linux Boot Logo=
* If you want Linux to keep your U-Boot Logo during boot process, then some tweaks are needed:
** define CONFIG_SYS_MEM_TOP_HIDE in U-Boot configuration file, here we reserve 2MBytes: <source lang="c">#define CONFIG_SYS_MEM_TOP_HIDE (2 << 20)</source>
* Force framebuffer RAM address in U-Boot LCD driver ([[OPOS6UL]] has 256MBytes (0x10000000) RAM starting at physical 0x80000000):<source lang="diff">@@ -197,8 +197,8 @@
panel.memSize = mode.xres * mode.yres * panel.gdfBytesPP;

/* Allocate framebuffer */
- fb = memalign(ARCH_DMA_MINALIGN,
- roundup(panel.memSize, ARCH_DMA_MINALIGN));
+ fb = (void *)0x8fe00000; /*memalign(ARCH_DMA_MINALIGN,
+ roundup(panel.memSize, ARCH_DMA_MINALIGN));*/
if (!fb) {
printf("MXSFB: Error allocating framebuffer!\n");
return NULL;
</source>

* Tell Linux to not print cursor on Framebuffer and to not use last 2M of RAM: <pre class="apf">BIOS> setenv extrabootargs vt.global_cursor_default=0 mem=248M</pre>

* Force framebuffer RAM address to same value in Linux LCD driver: <source lang="diff">@@ -825,17 +824,18 @@
var->vmode = FB_VMODE_NONINTERLACED;

/* Memory allocation for framebuffer */
+#define FORCED_FB_ADDR 0x8fe00000
fb_size = SZ_2M;
- fb_virt = dma_alloc_wc(dev, PAGE_ALIGN(fb_size), &fb_phys, GFP_KERNEL);
+ fb_virt = ioremap_wc(FORCED_FB_ADDR, fb_size);
if (!fb_virt)
return -ENOMEM;

+ fb_phys = FORCED_FB_ADDR;
fb_info->fix.smem_start = fb_phys;
fb_info->screen_base = fb_virt;
fb_info->screen_size = fb_info->fix.smem_len = fb_size;

- if (mxsfb_restore_mode(host, vmode))
- memset(fb_virt, 0, fb_size);
+ mxsfb_restore_mode(host, vmode);

return 0;
}</source>
* Remove following options of your Linux config file:
<source lang="diff">-CONFIG_FRAMEBUFFER_CONSOLE=y
-CONFIG_FRAMEBUFFER_CONSOLE_DETECT_PRIMARY=y
-CONFIG_FONTS=y
-CONFIG_FONT_8x8=y
-CONFIG_FONT_8x16=y</source>

* Reflash all that on your board and... That's it ! ;-)

=Links=
* http://www.denx.de/wiki/DULG/UBootSplashScreen

[[Category:Boot Logo]]

Debian on APF

2025-01-17T10:50:27Z

JulienB: /* Copying the filesystem on the APF */

This page details how to install Debian on an [[APF27]] / [[APF28]] / [[APF51]] / [[APF6]] / [[OPOS6UL]].

==Requirements==
* an APF/OPOS SOM (with corresponding docking/devt board)
* a development PC running linux
* the debootstrap program installed on the development PC
* the ARM qemu-user, statically linked on the development PC
* about an hour of free time

==Lazy guys==
* For the lazy one and also beholder of an [[APF6]], you can find an image here: [http://dl.free.fr/j283bzIbH apf6_debian_wheezy_rootfs.ext4].
* For the lazy one and also beholder of an [[OPOS6UL]], you can find an image here: [http://dl.free.fr/onh3mtEbn opos6ul_debian_jessie_rootfs.ext4].
* Download it and put it in your TFTP directory:
<pre class="host">
# cp xxx_debian_wheezy_rootfs.ext4 /tftpboot/xxx-rootfs.ext4 (where xxx is the name of you module)
</pre>
* reflash your rootfs from U-Boot (if you have 512 Mbytes of RAM):
<pre class="apf">
BIOS> run update_rootfs
</pre>
* or use [[U-Boot_UMS_on_APF_%26_OPOS|UMS mode]] otherwise.
* Then you can reset your board and directly skip to [[Debian_on_APF#First_login| "First login"]].

==Preparing the development PC==
* In this tutorial, we use Ubuntu on the development PC. Any other distribution can be used with some adjustments but of course, Debian based distributions are recommended.

* Let's first install all the packages that will be used :
<pre class="host">
$ sudo apt-get install debootstrap qemu-user-static
</pre>

* then get in a root shell and prepare a work folder:
<pre class="host">
$ sudo su
# cd anywhere_you_have_free_space
# mkdir apf_debian
# cd apf_debian
</pre>

==Bootstrapping the Debian filesystem==

* The debootstrap command is generating a base debian filesystem by downloading all debian base packages and unpacking them in a folder, in order to build a fresh debian root filesystem.
* Installing deb packages is not only extracting archive files, it also consists in running scripts after unpacking the files. Running these scripts is handled by the script interpreters that have been unpacked in the generated folders. Therefore generating an ARM debian filesystem on an x86 based computer requires to do this in two steps.
* Let's run the first step. That one consists in downloading all the deb packages and unpacking the files, but without running the scripts :
<pre class="host">
# debootstrap --foreign --arch=armel bookworm rootfs http://ftp.debian.org/debian
</pre>
* The ''--foreign'' option makes debootstrap stop right after unpacking.
* The ''--arch'' option specifies the architecture we want to make a rootfs for, ''armel'' is the name of the ARM port of debian for processors without FPU.
{{Note|On [[APF6]] & [[OPOS6UL]] you might want to use ''armhf'' (i.MX6 has an FPU) instead of ''armel''.}}
* ''jessie'' is the name of the debian version we want to get (latest stable one). ''rootfs'' is the name of the subfolder where debootstrap will work. Finally we give the URL of the debian mirror we want to use (you can use another one which sits in your country, to make it faster).
* This process may take a while: it will download all the debian base packages from the mirror and unpack them in the ''rootfs/'' folder.

== second stage of debootstrap ==
* The next step is to run the second stage of debootstrap. That stage consists in finalizing the installation of the package by running the configuration scripts we mentionned earlier. Since these scripts will be executed using the interpreter who is in the new filesystem, and not by the interpreter from your development PC, we are now facing a problem : the interpreter in that new filesystem is an ARM program, and won't run on an x86 system. To overcome this, we will make use of ''qemu'', who allows to run foreign architecture Linux programs through emulation.
* First, we need to copy the qemu binary into the new filesystem :
<pre class="host">
# cp /usr/bin/qemu-arm-static rootfs/usr/bin/
</pre>
* Then we can launch the second stage of debootstrap; qemu will automatically run the ARM binaries :
<pre class="host">
# DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true LC_ALL=C LANGUAGE=C LANG=C chroot rootfs debootstrap/debootstrap --second-stage
</pre>
* This process may also take a while: it will run the scripts of each package, in order to finalize the package installation.
<pre class="host">
...
I: Base system installed successfully.
</pre>

==Tweaking the filesystem==

* After the file system has been generated by debootstrap, some adjustments need to be done.
* First, we need to have debian run a getty on the console serial port (replace ''ttyXXX'' with ''ttymxc2'' on [[APF51]], ''ttySMX0'' on [[APF27]], ''ttymxc3'' on [[APF6]], ''ttymxc0'' on [[OPOS6UL]]), otherwise no login prompt will be available on the console port :
<pre class="host">
# echo 'T0:23:respawn:/sbin/getty -L ttyXXX 115200 vt100' >> rootfs/etc/inittab
</pre>

* 'If not already done', the debian mirror also has to be specified in the APT configuration, in order to install new debian packages later :
<pre class="host">
# echo 'deb http://ftp.debian.org/debian bookworm main' > rootfs/etc/apt/sources.list
</pre>

* The hostname of the debian system has to be set properly (here ''apf6'', change it accordingly to your board):
<pre class="host">
# echo 'apf6' > rootfs/etc/hostname
# echo '127.0.1.1 apf6' >> rootfs/etc/hosts
</pre>
* Remove root password (for first login):
<pre class="host">
# sed -i -e 's/root:\*:/root::/' rootfs/etc/shadow
</pre>
* Add ''eth0'' network interface configuration:
<pre class="host">
# echo -e "\nauto eth0\nallow-hotplug eth0\niface eth0 inet dhcp\n" >> rootfs/etc/network/interfaces
</pre>
* Copy kernel image and modules:
<pre class="host">
# export ARMADEUS_BSP_PATH=your_armadeus_bsp_path
# cp -r ${ARMADEUS_BSP_PATH}/buildroot/output/target/boot rootfs/
# cp -r ${ARMADEUS_BSP_PATH}/buildroot/output/target/lib/modules rootfs/lib/
</pre>
* Finally we can clean the APT cache (we no longer need the deb files, and that will save quite some disk space):
<pre class="host">
# chroot rootfs apt-get clean
</pre>

==Copying the filesystem on the APF==
* Now that the debian filesystem is ready, it must be transferred to the APF. You have 2 solutions:

===1] Overwriting default rootfs on Flash (APF6/OPOS6UL)===
* The [[APF6]]/[[OPOS6UL]] eMMC has enough space to run debian directly on it.
* To finalize installation you will need ''resize2fs'' tool (recent version of Armadeus BSP), so copy it to Debian rootfs (Armadeus binaries for [[APF6]]/[[OPOS6UL]] are compatible with Debian armhf port):
<pre class="host">
# cp $ARMADEUS_BSP_PATH/buildroot/output/target/sbin/resize2fs rootfs/sbin/
</pre>
* To generate a .ext4 image from the ''rootfs/'' directory:
<pre class="host">
# $ARMADEUS_BSP_PATH/buildroot/output/host/usr/sbin/mkfs.ext4 -d ./rootfs/ -r 1 -N 0 -m 5 -L "rootfs" -I 256 -O ^64bit,^metadata_csum,uninit_bg opos_debian_bookworm_rootfs.ext4 384M

# PATH=$PATH:$ARMADEUS_BSP_PATH/buildroot/output/host/usr/bin/:$ARMADEUS_BSP_PATH/buildroot/output/host/usr/sbin/ \
mke2img -G 4 -R 1 -d ./rootfs/ -o apf_debian_jessie_rootfs.ext4
# cp apf_debian_jessie_rootfs.ext4 /tftpboot/XXX-rootfs.ext4 (where XXX is the name of your module)
# chmod a+rw /tftpboot/opos6ul-rootfs.ext4
</pre>
* Now on your board, boot into U-Boot and:
<pre class="apf">
BIOS> run update_rootfs
</pre>
* If the rootfs image is too big for your SoM RAM size, you can also use [[U-Boot_UMS_on_APF_%26_OPOS|UMS]] USB mode of U-Boot to flash this image.
* Congratulations, you can go to [[Debian_on_APF#First_login|first login]]

===2] Using Debian on Flash while keeping default rootfs (APF6/APF51)===

* This tutorial will describe a method that will allow to keep the original Armadeus system on the board, and that will permit to choose which system to boot very easily. It is not the only way to run Debian on the APF, but it is quite convenient.

* You need to have an [[APF51]] or an [[APF6]] running the Buildroot based original system.

* The first step is to pack the debian filesystem that has been created on the development PC:
<pre class="host">
# tar cvf debian_arm_rootfs.tar rootfs/
</pre>
* You will end up with a ~150 MBytes tarball
* Then this archive should be transferred to the APF board. You can use a USB key or a microSD for example. (or TFTP if you have a lot of free space on your APF NAND; then put the file in ''/root'' on the APF)

* Now, on the APF, the archive should be extracted (from the media holding it to the APF NAND FLASH). '''Don't forget the p option of tar''', which is required to properly extract permissions on files :
<pre class="apf">
# cd /root
# tar xvpf debian_arm_rootfs.tar
</pre>

* We will boot this distribution using ''chroot''. We need to write a script that will be run by the kernel on startup and that will do the chroot at an early stage of the boot process, so that nothing from the original rootfs is started when we want to boot Debian. To do this, create a file called ''/debinit'' that contains the following lines :
<pre class="apf">
#!/bin/sh
mount -t proc none /root/rootfs/proc
exec chroot /root/rootfs /sbin/init
</pre>

* This script needs to be executable :
<pre class="apf">
# chmod 755 /debinit
</pre>

* Kernel modules and firmware files need to be copied from the default filesystem to the Debian filesystem :
<pre class="apf">
# cp -r /lib/modules/* /root/rootfs/lib/modules
# cp -r /lib/firmware /root/rootfs/lib/firmware
# chroot /root/rootfs /sbin/depmod -a
</pre>
==== Configure U-Boot to boot debian ====
* Finally, we need to configure U-Boot so it tells the kernel to use that script on bootup. Reboot your board, press a key to interrupt the automatic boot in U-Boot, then do :
{| border="1" cellpadding="10" cellspacing="0" summary="depboot definition depending on board" class="wikitable"
|- style="background:#efefef;" align="center"
! APF51 || APF6
|---
|<pre class="apf">
BIOS> setenv debboot 'setenv extrabootargs ${extrabootargs} init=/debinit; run ubifsboot'
BIOS> saveenv
</pre>
|<pre class="apf">
BIOS> setenv debboot 'setenv extrabootargs ${extrabootargs} init=/debinit; run emmcboot'
BIOS> saveenv
</pre>
|}

* That's all. Now you board will keep booting the original system but if you want to boot debian instead, you can interrupt the autoboot of U-Boot and run the command :

<pre class="apf">
BIOS> run debboot
</pre>

* In case you want the board to boot debian automatically, you can do so by running :
<pre class="apf">
BIOS> setenv bootcmd run debboot
BIOS> saveenv
</pre>

* You can then switch back to the original Armadeus system by running :
<pre class="apf">
BIOS> setenv bootcmd run ubifsboot
BIOS> saveenv
</pre>

==First login==
Whaoouh ! It booted ! ;-)

<pre class="apf">
Debian GNU/Linux 8 apfxx/opos6ul ttySMX0/ttymxc2|0

apfxx/opos6ul login:
</pre>

* Login as root with no password

* If rootfs is mounted read-only, then remount it rw:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# mount -o remount,rw /dev/mmcblk2p2
</pre>
||
<pre class="apf">
root@opos6ul:~# mount -o remount,rw /dev/mmcblk0p2
</pre>
|}

* You might also definitely change this behavior (rootfs mounted read-only), by modifying U-Boot's ''mmcroot'' variable: replace ro with rw:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# reboot
BIOS> setenv mmcroot /dev/mmcblk2p2 rw
BIOS> saveenv
</pre>
||
<pre class="apf">
root@opos6ul:~# reboot
BIOS> setenv mmcroot /dev/mmcblk0p2 rw
BIOS> saveenv
</pre>
|}

* On modules with eMMC '''only''', if you replaced the default rootfs, you might want to use all eMMC space for debian:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# /usr/sbin/resize2fs /dev/mmcblk2p2
</pre>
||
<pre class="apf">
root@opos6ul:~# /usr/sbin/resize2fs /dev/mmcblk0p2
</pre>
|}

* If ''/etc/mtab'' is absent, regenerate it:
<pre class="apf">
root@opos6ul:~# grep -v rootfs /proc/mounts > /etc/mtab
</pre>

* Update packages (network should be up and running):
<pre class="apf">
root@apfxx:~# apt-get update
root@apfxx:~# apt-get upgrade
...
</pre>

* If the keyboard layout doesn't suite yours, you can change it with (keyboard type, then keymap):
<pre class="apf">
root@apfxx:~# dpkg-reconfigure keyboard-configuration
</pre>

* Setup system and RTC date:
<pre class="apf">
root@apfxx:~# date 012011552010
Wed Jan 20 11:55:00 UTC 2010
root@apfxx:~# hwclock -wu
</pre>

* If you don't have any RTC chip (or no RTC backup cell) on your development board but have Internet access, then it could be a good idea to install ''ntpdate'' and use it:
<pre class="apf">
root@apfxx:~# apt-get install ntpdate
...
root@apfxx:~# ntpdate-debian
</pre>

* To configure TimeZone:
<pre class="apf">
root@apfxx:~# dpkg-reconfigure tzdata
</pre>

* Change root password:
<pre class="apf">
root@apfxx:~# passwd
</pre>

* Add a user (''armadeus''):
<pre class="apf">
root@apfxx:~# adduser armadeus
</pre>

* Remove x86 qemu used during installation to get some free space:
<pre class="apf">
root@apfxx:/tmp# rm /usr/bin/qemu-arm-static
</pre>

* If you want remote network/SSH access to your board:
<pre class="apf">
root@apf|oposxx:~# apt-get install dropbear
</pre>

* Other packages that may also be useful (for development):
<pre class="apf">
root@apfxx:~# apt-get install build-essential gcc-4.8 tftp vim strace i2c-tools iw psmisc
</pre>

* If you want an X server (requires ~60 MBytes of free space):
<pre class="apf">
root@apfxx:~# apt-get install xserver-xorg (xserver-xfbdev ?)
</pre>
* If you want some apps for X (requires ~20 MBytes of free space):
<pre class="apf">
root@apfxx:~# apt-get install x11-apps
</pre>
* If you want a graphical login manager:
<pre class="apf">
root@apfxx:~# apt-get install xdm
</pre>
* if you want a touchscreen calibrator and a virtual keyboard:
<pre class="apf">
root@apfxx:~# apt-get install xinput-calibrator xvkbd
</pre>
* if you want a lightweight Web browser:
<pre class="apf">
root@apfxx:~# apt-get install netsurf
</pre>
* If you want a desktop manager (requires >300 MBytes o_O):
<pre class="apf">
root@apfxx:~# apt-get install xfce4
</pre>
* You might also want to try another "lightweight" desktop manager (>600 MBytes o_O<):
<pre class="apf">
root@apfxx:~# apt-get install lxde
</pre>

==Known issues==
===APF27===
* Xorg won't start. (compatibility problem with framebuffer driver)

===APF51===
* There's a kernel oops during the boot process. This is related to the SPI driver.
* Booting takes quite some time because udev has an issue with the SPI port and it takes some time before it timeouts and continues the boot.

===APF6===
* ''hcitool lescan'' command is reported to not work. Use ''bluetoothctl'' instead.

===OPOS6UL===
* onboard Wi-Fi chip doesn't seem operational.
* to have Wi-Fi firmware on Debian Jessie:
<pre class="apf">
root@opos6ul:~# vim /etc/apt/sources.list
add non-free
root@opos6ul:~# apt-get update
root@opos6ul:~# apt-get install firmware-brcm80211
</pre>

===Console Port Issues===
In some cases the boot crashes and errors like these appear
<pre class="host">
init: Id "T0" respawning too fast: disabled for 5 minutes
</pre>
It means that the /dev folder haven't been populated with your console serial port.

To fix this, you need to reboot the apf and run armadeus system, then you need to do the following commands :
<pre class="apf">
# cp -r /dev/ttymxc0 /root/rootfs/dev/ttymxc0 (for apf51)
# cp -r /dev/ttySMX0 /root/rootfs/dev/ttySMX0 (for apf27)
</pre>

You also need to check that the file /root/rootfs/etc/securetty contains the console serial port (ttymxc0 for APF51 and ttySMX0 for APF27) if not :
<pre class="apf">
# echo 'ttymxc0' >> /root/rootfs/etc/securetty (for apf51)
# echo 'ttySMX0' >> /root/rootfs/etc/securetty (for apf27)
</pre>
It will allow the root user to login via this serial console.

It could also affects other ports and you will need to do the same procedure for them (ttyX, fbX, input, ttymxcX, ttySMXX, etc.)

==Automatically starts your custom application==
* Edit a shell script named ''/etc/init.d/myapp'', here we suppose your application is named ''/root/myapp'':
<source lang="bash">
#!/bin/sh

### BEGIN INIT INFO
# Provides: myapp
# Required-Start: $network $remote_fs $syslog
# Required-Stop: $network $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop:
# Short-Description: Start my application
### END INIT INFO

PATH=/sbin:/bin:/usr/sbin:/usr/bin

. /lib/lsb/init-functions

MY_APP=/root/myapp

test -x $MY_APP || exit 5

case $1 in
start)
log_daemon_msg "Starting my app"
$MY_APP &
;;
stop)
log_daemon_msg "Stopping my app"
;;
restart)
$0 stop && sleep 2 && $0 start
;;
*)
echo "Usage: $0 {start|stop|restart}"
exit 2
;;
esac
</source>
* make it executable:
<pre class="apf">
root@opos6ul:~# chmod a+x /etc/init.d/myapp
</pre>
* create a symlink to start the previous script in runlevel 5:
<pre class="apf">
root@opos6ul:~# ln -sf /etc/init.d/myapp /etc/rc5.d/S99myapp
</pre>
* reboot and check that you application is successfully started ;-)

==Links==
* [http://www.debian.org/releases/stable/i386/apds03.html.en Installing Debian GNU/Linux from a Unix/Linux System]
* http://free-electrons.com/blog/embdebian-with-multistrap/
* http://wiki.debian.org/Xfce
* [http://fr.scribd.com/doc/123130564/Installation-de-Debian-sur-la-carte-Armadeus-APF28 Enhanced french tutorial to install Debian on an APF28 board]
* [[Buildroot_inside_Debian_on_APF]]

[[Category:Distribution]]

Debian on APF

2025-01-16T17:23:50Z

JulienB:

This page details how to install Debian on an [[APF27]] / [[APF28]] / [[APF51]] / [[APF6]] / [[OPOS6UL]].

==Requirements==
* an APF/OPOS SOM (with corresponding docking/devt board)
* a development PC running linux
* the debootstrap program installed on the development PC
* the ARM qemu-user, statically linked on the development PC
* about an hour of free time

==Lazy guys==
* For the lazy one and also beholder of an [[APF6]], you can find an image here: [http://dl.free.fr/j283bzIbH apf6_debian_wheezy_rootfs.ext4].
* For the lazy one and also beholder of an [[OPOS6UL]], you can find an image here: [http://dl.free.fr/onh3mtEbn opos6ul_debian_jessie_rootfs.ext4].
* Download it and put it in your TFTP directory:
<pre class="host">
# cp xxx_debian_wheezy_rootfs.ext4 /tftpboot/xxx-rootfs.ext4 (where xxx is the name of you module)
</pre>
* reflash your rootfs from U-Boot (if you have 512 Mbytes of RAM):
<pre class="apf">
BIOS> run update_rootfs
</pre>
* or use [[U-Boot_UMS_on_APF_%26_OPOS|UMS mode]] otherwise.
* Then you can reset your board and directly skip to [[Debian_on_APF#First_login| "First login"]].

==Preparing the development PC==
* In this tutorial, we use Ubuntu on the development PC. Any other distribution can be used with some adjustments but of course, Debian based distributions are recommended.

* Let's first install all the packages that will be used :
<pre class="host">
$ sudo apt-get install debootstrap qemu-user-static
</pre>

* then get in a root shell and prepare a work folder:
<pre class="host">
$ sudo su
# cd anywhere_you_have_free_space
# mkdir apf_debian
# cd apf_debian
</pre>

==Bootstrapping the Debian filesystem==

* The debootstrap command is generating a base debian filesystem by downloading all debian base packages and unpacking them in a folder, in order to build a fresh debian root filesystem.
* Installing deb packages is not only extracting archive files, it also consists in running scripts after unpacking the files. Running these scripts is handled by the script interpreters that have been unpacked in the generated folders. Therefore generating an ARM debian filesystem on an x86 based computer requires to do this in two steps.
* Let's run the first step. That one consists in downloading all the deb packages and unpacking the files, but without running the scripts :
<pre class="host">
# debootstrap --foreign --arch=armel bookworm rootfs http://ftp.debian.org/debian
</pre>
* The ''--foreign'' option makes debootstrap stop right after unpacking.
* The ''--arch'' option specifies the architecture we want to make a rootfs for, ''armel'' is the name of the ARM port of debian for processors without FPU.
{{Note|On [[APF6]] & [[OPOS6UL]] you might want to use ''armhf'' (i.MX6 has an FPU) instead of ''armel''.}}
* ''jessie'' is the name of the debian version we want to get (latest stable one). ''rootfs'' is the name of the subfolder where debootstrap will work. Finally we give the URL of the debian mirror we want to use (you can use another one which sits in your country, to make it faster).
* This process may take a while: it will download all the debian base packages from the mirror and unpack them in the ''rootfs/'' folder.

== second stage of debootstrap ==
* The next step is to run the second stage of debootstrap. That stage consists in finalizing the installation of the package by running the configuration scripts we mentionned earlier. Since these scripts will be executed using the interpreter who is in the new filesystem, and not by the interpreter from your development PC, we are now facing a problem : the interpreter in that new filesystem is an ARM program, and won't run on an x86 system. To overcome this, we will make use of ''qemu'', who allows to run foreign architecture Linux programs through emulation.
* First, we need to copy the qemu binary into the new filesystem :
<pre class="host">
# cp /usr/bin/qemu-arm-static rootfs/usr/bin/
</pre>
* Then we can launch the second stage of debootstrap; qemu will automatically run the ARM binaries :
<pre class="host">
# DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true LC_ALL=C LANGUAGE=C LANG=C chroot rootfs debootstrap/debootstrap --second-stage
</pre>
* This process may also take a while: it will run the scripts of each package, in order to finalize the package installation.
<pre class="host">
...
I: Base system installed successfully.
</pre>

==Tweaking the filesystem==

* After the file system has been generated by debootstrap, some adjustments need to be done.
* First, we need to have debian run a getty on the console serial port (replace ''ttyXXX'' with ''ttymxc2'' on [[APF51]], ''ttySMX0'' on [[APF27]], ''ttymxc3'' on [[APF6]], ''ttymxc0'' on [[OPOS6UL]]), otherwise no login prompt will be available on the console port :
<pre class="host">
# echo 'T0:23:respawn:/sbin/getty -L ttyXXX 115200 vt100' >> rootfs/etc/inittab
</pre>

* 'If not already done', the debian mirror also has to be specified in the APT configuration, in order to install new debian packages later :
<pre class="host">
# echo 'deb http://ftp.debian.org/debian bookworm main' > rootfs/etc/apt/sources.list
</pre>

* The hostname of the debian system has to be set properly (here ''apf6'', change it accordingly to your board):
<pre class="host">
# echo 'apf6' > rootfs/etc/hostname
# echo '127.0.1.1 apf6' >> rootfs/etc/hosts
</pre>
* Remove root password (for first login):
<pre class="host">
# sed -i -e 's/root:\*:/root::/' rootfs/etc/shadow
</pre>
* Add ''eth0'' network interface configuration:
<pre class="host">
# echo -e "\nauto eth0\nallow-hotplug eth0\niface eth0 inet dhcp\n" >> rootfs/etc/network/interfaces
</pre>
* Copy kernel image and modules:
<pre class="host">
# export ARMADEUS_BSP_PATH=your_armadeus_bsp_path
# cp -r ${ARMADEUS_BSP_PATH}/buildroot/output/target/boot rootfs/
# cp -r ${ARMADEUS_BSP_PATH}/buildroot/output/target/lib/modules rootfs/lib/
</pre>
* Finally we can clean the APT cache (we no longer need the deb files, and that will save quite some disk space):
<pre class="host">
# chroot rootfs apt-get clean
</pre>

==Copying the filesystem on the APF==
* Now that the debian filesystem is ready, it must be transferred to the APF. You have 2 solutions:

===1] Overwriting default rootfs on Flash (APF6/OPOS6UL)===
* The [[APF6]]/[[OPOS6UL]] eMMC has enough space to run debian directly on it.
* To finalize installation you will need ''resize2fs'' tool (recent version of Armadeus BSP), so copy it to Debian rootfs (Armadeus binaries for [[APF6]]/[[OPOS6UL]] are compatible with Debian armhf port):
<pre class="host">
# cp $ARMADEUS_BSP_PATH/buildroot/output/target/sbin/resize2fs rootfs/sbin/
</pre>
* To generate a .ext4 image from the ''rootfs/'' directory:
<pre class="host">
# PATH=$PATH:$ARMADEUS_BSP_PATH/buildroot/output/host/usr/bin/:$ARMADEUS_BSP_PATH/buildroot/output/host/usr/sbin/ \
mke2img -G 4 -R 1 -d ./rootfs/ -o apf_debian_jessie_rootfs.ext4
# cp apf_debian_jessie_rootfs.ext4 /tftpboot/XXX-rootfs.ext4 (where XXX is the name of your module)
# chmod a+rw /tftpboot/opos6ul-rootfs.ext4
</pre>
* Now on your board, boot into U-Boot and:
<pre class="apf">
BIOS> run update_rootfs
</pre>
* If the rootfs image is too big for your SoM RAM size, you can also use [[U-Boot_UMS_on_APF_%26_OPOS|UMS]] USB mode of U-Boot to flash this image.
* Congratulations, you can go to [[Debian_on_APF#First_login|first login]]

===2] Using Debian on Flash while keeping default rootfs (APF6/APF51)===

* This tutorial will describe a method that will allow to keep the original Armadeus system on the board, and that will permit to choose which system to boot very easily. It is not the only way to run Debian on the APF, but it is quite convenient.

* You need to have an [[APF51]] or an [[APF6]] running the Buildroot based original system.

* The first step is to pack the debian filesystem that has been created on the development PC:
<pre class="host">
# tar cvf debian_arm_rootfs.tar rootfs/
</pre>
* You will end up with a ~150 MBytes tarball
* Then this archive should be transferred to the APF board. You can use a USB key or a microSD for example. (or TFTP if you have a lot of free space on your APF NAND; then put the file in ''/root'' on the APF)

* Now, on the APF, the archive should be extracted (from the media holding it to the APF NAND FLASH). '''Don't forget the p option of tar''', which is required to properly extract permissions on files :
<pre class="apf">
# cd /root
# tar xvpf debian_arm_rootfs.tar
</pre>

* We will boot this distribution using ''chroot''. We need to write a script that will be run by the kernel on startup and that will do the chroot at an early stage of the boot process, so that nothing from the original rootfs is started when we want to boot Debian. To do this, create a file called ''/debinit'' that contains the following lines :
<pre class="apf">
#!/bin/sh
mount -t proc none /root/rootfs/proc
exec chroot /root/rootfs /sbin/init
</pre>

* This script needs to be executable :
<pre class="apf">
# chmod 755 /debinit
</pre>

* Kernel modules and firmware files need to be copied from the default filesystem to the Debian filesystem :
<pre class="apf">
# cp -r /lib/modules/* /root/rootfs/lib/modules
# cp -r /lib/firmware /root/rootfs/lib/firmware
# chroot /root/rootfs /sbin/depmod -a
</pre>
==== Configure U-Boot to boot debian ====
* Finally, we need to configure U-Boot so it tells the kernel to use that script on bootup. Reboot your board, press a key to interrupt the automatic boot in U-Boot, then do :
{| border="1" cellpadding="10" cellspacing="0" summary="depboot definition depending on board" class="wikitable"
|- style="background:#efefef;" align="center"
! APF51 || APF6
|---
|<pre class="apf">
BIOS> setenv debboot 'setenv extrabootargs ${extrabootargs} init=/debinit; run ubifsboot'
BIOS> saveenv
</pre>
|<pre class="apf">
BIOS> setenv debboot 'setenv extrabootargs ${extrabootargs} init=/debinit; run emmcboot'
BIOS> saveenv
</pre>
|}

* That's all. Now you board will keep booting the original system but if you want to boot debian instead, you can interrupt the autoboot of U-Boot and run the command :

<pre class="apf">
BIOS> run debboot
</pre>

* In case you want the board to boot debian automatically, you can do so by running :
<pre class="apf">
BIOS> setenv bootcmd run debboot
BIOS> saveenv
</pre>

* You can then switch back to the original Armadeus system by running :
<pre class="apf">
BIOS> setenv bootcmd run ubifsboot
BIOS> saveenv
</pre>

==First login==
Whaoouh ! It booted ! ;-)

<pre class="apf">
Debian GNU/Linux 8 apfxx/opos6ul ttySMX0/ttymxc2|0

apfxx/opos6ul login:
</pre>

* Login as root with no password

* If rootfs is mounted read-only, then remount it rw:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# mount -o remount,rw /dev/mmcblk2p2
</pre>
||
<pre class="apf">
root@opos6ul:~# mount -o remount,rw /dev/mmcblk0p2
</pre>
|}

* You might also definitely change this behavior (rootfs mounted read-only), by modifying U-Boot's ''mmcroot'' variable: replace ro with rw:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# reboot
BIOS> setenv mmcroot /dev/mmcblk2p2 rw
BIOS> saveenv
</pre>
||
<pre class="apf">
root@opos6ul:~# reboot
BIOS> setenv mmcroot /dev/mmcblk0p2 rw
BIOS> saveenv
</pre>
|}

* On modules with eMMC '''only''', if you replaced the default rootfs, you might want to use all eMMC space for debian:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# /usr/sbin/resize2fs /dev/mmcblk2p2
</pre>
||
<pre class="apf">
root@opos6ul:~# /usr/sbin/resize2fs /dev/mmcblk0p2
</pre>
|}

* If ''/etc/mtab'' is absent, regenerate it:
<pre class="apf">
root@opos6ul:~# grep -v rootfs /proc/mounts > /etc/mtab
</pre>

* Update packages (network should be up and running):
<pre class="apf">
root@apfxx:~# apt-get update
root@apfxx:~# apt-get upgrade
...
</pre>

* If the keyboard layout doesn't suite yours, you can change it with (keyboard type, then keymap):
<pre class="apf">
root@apfxx:~# dpkg-reconfigure keyboard-configuration
</pre>

* Setup system and RTC date:
<pre class="apf">
root@apfxx:~# date 012011552010
Wed Jan 20 11:55:00 UTC 2010
root@apfxx:~# hwclock -wu
</pre>

* If you don't have any RTC chip (or no RTC backup cell) on your development board but have Internet access, then it could be a good idea to install ''ntpdate'' and use it:
<pre class="apf">
root@apfxx:~# apt-get install ntpdate
...
root@apfxx:~# ntpdate-debian
</pre>

* To configure TimeZone:
<pre class="apf">
root@apfxx:~# dpkg-reconfigure tzdata
</pre>

* Change root password:
<pre class="apf">
root@apfxx:~# passwd
</pre>

* Add a user (''armadeus''):
<pre class="apf">
root@apfxx:~# adduser armadeus
</pre>

* Remove x86 qemu used during installation to get some free space:
<pre class="apf">
root@apfxx:/tmp# rm /usr/bin/qemu-arm-static
</pre>

* If you want remote network/SSH access to your board:
<pre class="apf">
root@apf|oposxx:~# apt-get install dropbear
</pre>

* Other packages that may also be useful (for development):
<pre class="apf">
root@apfxx:~# apt-get install build-essential gcc-4.8 tftp vim strace i2c-tools iw psmisc
</pre>

* If you want an X server (requires ~60 MBytes of free space):
<pre class="apf">
root@apfxx:~# apt-get install xserver-xorg (xserver-xfbdev ?)
</pre>
* If you want some apps for X (requires ~20 MBytes of free space):
<pre class="apf">
root@apfxx:~# apt-get install x11-apps
</pre>
* If you want a graphical login manager:
<pre class="apf">
root@apfxx:~# apt-get install xdm
</pre>
* if you want a touchscreen calibrator and a virtual keyboard:
<pre class="apf">
root@apfxx:~# apt-get install xinput-calibrator xvkbd
</pre>
* if you want a lightweight Web browser:
<pre class="apf">
root@apfxx:~# apt-get install netsurf
</pre>
* If you want a desktop manager (requires >300 MBytes o_O):
<pre class="apf">
root@apfxx:~# apt-get install xfce4
</pre>
* You might also want to try another "lightweight" desktop manager (>600 MBytes o_O<):
<pre class="apf">
root@apfxx:~# apt-get install lxde
</pre>

==Known issues==
===APF27===
* Xorg won't start. (compatibility problem with framebuffer driver)

===APF51===
* There's a kernel oops during the boot process. This is related to the SPI driver.
* Booting takes quite some time because udev has an issue with the SPI port and it takes some time before it timeouts and continues the boot.

===APF6===
* ''hcitool lescan'' command is reported to not work. Use ''bluetoothctl'' instead.

===OPOS6UL===
* onboard Wi-Fi chip doesn't seem operational.
* to have Wi-Fi firmware on Debian Jessie:
<pre class="apf">
root@opos6ul:~# vim /etc/apt/sources.list
add non-free
root@opos6ul:~# apt-get update
root@opos6ul:~# apt-get install firmware-brcm80211
</pre>

===Console Port Issues===
In some cases the boot crashes and errors like these appear
<pre class="host">
init: Id "T0" respawning too fast: disabled for 5 minutes
</pre>
It means that the /dev folder haven't been populated with your console serial port.

To fix this, you need to reboot the apf and run armadeus system, then you need to do the following commands :
<pre class="apf">
# cp -r /dev/ttymxc0 /root/rootfs/dev/ttymxc0 (for apf51)
# cp -r /dev/ttySMX0 /root/rootfs/dev/ttySMX0 (for apf27)
</pre>

You also need to check that the file /root/rootfs/etc/securetty contains the console serial port (ttymxc0 for APF51 and ttySMX0 for APF27) if not :
<pre class="apf">
# echo 'ttymxc0' >> /root/rootfs/etc/securetty (for apf51)
# echo 'ttySMX0' >> /root/rootfs/etc/securetty (for apf27)
</pre>
It will allow the root user to login via this serial console.

It could also affects other ports and you will need to do the same procedure for them (ttyX, fbX, input, ttymxcX, ttySMXX, etc.)

==Automatically starts your custom application==
* Edit a shell script named ''/etc/init.d/myapp'', here we suppose your application is named ''/root/myapp'':
<source lang="bash">
#!/bin/sh

### BEGIN INIT INFO
# Provides: myapp
# Required-Start: $network $remote_fs $syslog
# Required-Stop: $network $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop:
# Short-Description: Start my application
### END INIT INFO

PATH=/sbin:/bin:/usr/sbin:/usr/bin

. /lib/lsb/init-functions

MY_APP=/root/myapp

test -x $MY_APP || exit 5

case $1 in
start)
log_daemon_msg "Starting my app"
$MY_APP &
;;
stop)
log_daemon_msg "Stopping my app"
;;
restart)
$0 stop && sleep 2 && $0 start
;;
*)
echo "Usage: $0 {start|stop|restart}"
exit 2
;;
esac
</source>
* make it executable:
<pre class="apf">
root@opos6ul:~# chmod a+x /etc/init.d/myapp
</pre>
* create a symlink to start the previous script in runlevel 5:
<pre class="apf">
root@opos6ul:~# ln -sf /etc/init.d/myapp /etc/rc5.d/S99myapp
</pre>
* reboot and check that you application is successfully started ;-)

==Links==
* [http://www.debian.org/releases/stable/i386/apds03.html.en Installing Debian GNU/Linux from a Unix/Linux System]
* http://free-electrons.com/blog/embdebian-with-multistrap/
* http://wiki.debian.org/Xfce
* [http://fr.scribd.com/doc/123130564/Installation-de-Debian-sur-la-carte-Armadeus-APF28 Enhanced french tutorial to install Debian on an APF28 board]
* [[Buildroot_inside_Debian_on_APF]]

[[Category:Distribution]]

Debian on APF

2025-01-16T17:03:51Z

JulienB: /* Requirements */

This page details how to install Debian on an [[APF27]] / [[APF28]] / [[APF51]] / [[APF6]] / [[OPOS6UL]].

==Requirements==
* an APF/OPOS SOM (with corresponding docking/devt board)
* a development PC running linux
* the debootstrap program installed on the development PC
* the ARM qemu-user, statically linked on the development PC
* about an hour of free time

==Lazy guys==
* For the lazy one and also beholder of an [[APF6]], you can find an image here: [http://dl.free.fr/j283bzIbH apf6_debian_wheezy_rootfs.ext4].
* For the lazy one and also beholder of an [[OPOS6UL]], you can find an image here: [http://dl.free.fr/onh3mtEbn opos6ul_debian_jessie_rootfs.ext4].
* Download it and put it in your TFTP directory:
<pre class="host">
# cp xxx_debian_wheezy_rootfs.ext4 /tftpboot/xxx-rootfs.ext4 (where xxx is the name of you module)
</pre>
* reflash your rootfs from U-Boot (if you have 512 Mbytes of RAM):
<pre class="apf">
BIOS> run update_rootfs
</pre>
* or use [[U-Boot_UMS_on_APF_%26_OPOS|UMS mode]] otherwise.
* Then you can reset your board and directly skip to [[Debian_on_APF#First_login| "First login"]].

==Preparing the development PC==
* In this tutorial, we use Ubuntu on the development PC. Any other distribution can be used with some adjustments but of course, Debian based distributions are recommended.

* Let's first install all the packages that will be used :
<pre class="host">
$ sudo apt-get install debootstrap qemu-user-static
</pre>

* then get in a root shell and prepare a work folder:
<pre class="host">
$ sudo su
# cd anywhere_you_have_free_space
# mkdir apf_debian
# cd apf_debian
</pre>

==Bootstrapping the Debian filesystem==

* The debootstrap command is generating a base debian filesystem by downloading all debian base packages and unpacking them in a folder, in order to build a fresh debian root filesystem.
* Installing deb packages is not only extracting archive files, it also consists in running scripts after unpacking the files. Running these scripts is handled by the script interpreters that have been unpacked in the generated folders. Therefore generating an ARM debian filesystem on an x86 based computer requires to do this in two steps.
* Let's run the first step. That one consists in downloading all the deb packages and unpacking the files, but without running the scripts :
<pre class="host">
# debootstrap --foreign --arch=armel jessie rootfs http://ftp.debian.org/debian
</pre>
* The ''--foreign'' option makes debootstrap stop right after unpacking.
* The ''--arch'' option specifies the architecture we want to make a rootfs for, ''armel'' is the name of the ARM port of debian for processors without FPU.
{{Note|On [[APF6]] & [[OPOS6UL]] you might want to use ''armhf'' (i.MX6 has an FPU) instead of ''armel''.}}
* ''jessie'' is the name of the debian version we want to get (latest stable one). ''rootfs'' is the name of the subfolder where debootstrap will work. Finally we give the URL of the debian mirror we want to use (you can use another one which sits in your country, to make it faster).
* This process may take a while: it will download all the debian base packages from the mirror and unpack them in the ''rootfs/'' folder.

== second stage of debootstrap ==
* The next step is to run the second stage of debootstrap. That stage consists in finalizing the installation of the package by running the configuration scripts we mentionned earlier. Since these scripts will be executed using the interpreter who is in the new filesystem, and not by the interpreter from your development PC, we are now facing a problem : the interpreter in that new filesystem is an ARM program, and won't run on an x86 system. To overcome this, we will make use of ''qemu'', who allows to run foreign architecture Linux programs through emulation.
* First, we need to copy the qemu binary into the new filesystem :
<pre class="host">
# cp /usr/bin/qemu-arm-static rootfs/usr/bin/
</pre>
* Then we can launch the second stage of debootstrap; qemu will automatically run the ARM binaries :
<pre class="host">
# DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true LC_ALL=C LANGUAGE=C LANG=C chroot rootfs debootstrap/debootstrap --second-stage
</pre>
* This process may also take a while: it will run the scripts of each package, in order to finalize the package installation.
<pre class="host">
...
I: Base system installed successfully.
</pre>

==Tweaking the filesystem==

* After the file system has been generated by debootstrap, some adjustments need to be done.
* First, we need to have debian run a getty on the console serial port (replace ''ttyXXX'' with ''ttymxc2'' on [[APF51]], ''ttySMX0'' on [[APF27]], ''ttymxc3'' on [[APF6]], ''ttymxc0'' on [[OPOS6UL]]), otherwise no login prompt will be available on the console port :
<pre class="host">
# echo 'T0:23:respawn:/sbin/getty -L ttyXXX 115200 vt100' >> rootfs/etc/inittab
</pre>

* The debian mirror also has to be specified in the APT configuration, in order to install new debian packages later :
<pre class="host">
# echo 'deb http://ftp.debian.org/debian jessie main' > rootfs/etc/apt/sources.list
</pre>

* The hostname of the debian system has to be set properly (here ''apf6'', change it accordingly to your board):
<pre class="host">
# echo 'apf6' > rootfs/etc/hostname
# echo '127.0.1.1 apf6' >> rootfs/etc/hosts
</pre>
* Remove root password (for first login):
<pre class="host">
# sed -i -e 's/root:\*:/root::/' rootfs/etc/shadow
</pre>
* Add ''eth0'' network interface configuration:
<pre class="host">
# echo -e "\nauto eth0\nallow-hotplug eth0\niface eth0 inet dhcp\n" >> rootfs/etc/network/interfaces
</pre>
* Copy kernel image and modules:
<pre class="host">
# export YOUR_BSP_PATH=your_armadeus_bsp_path
# cp -r ${YOUR_BSP_PATH}/buildroot/output/target/boot rootfs/
# cp -r ${YOUR_BSP_PATH}/buildroot/output/target/lib/modules rootfs/lib/
</pre>
* Finally we can clean the APT cache (we no longer need the deb files, and that will save quite some disk space):
<pre class="host">
# chroot rootfs apt-get clean
</pre>

==Copying the filesystem on the APF==
* Now that the debian filesystem is ready, it must be transferred to the APF. You have 2 solutions:

===1] Overwriting default rootfs on Flash (APF6/OPOS6UL)===
* The [[APF6]]/[[OPOS6UL]] eMMC has enough space to run debian directly on it.
* To finalize installation you will need ''resize2fs'' tool (recent version of Armadeus BSP), so copy it to Debian rootfs (Armadeus binaries for [[APF6]]/[[OPOS6UL]] are compatible with Debian armhf port):
<pre class="host">
# YOUR_BSP_PATH=your_armadeus_bsp_path
# cp $YOUR_BSP_PATH/buildroot/output/target/sbin/resize2fs rootfs/sbin/
</pre>
* To generate a .ext4 image from the ''rootfs/'' directory:
<pre class="host">
# YOUR_BSP_PATH=your_armadeus_bsp_path
# PATH=$PATH:$YOUR_BSP_PATH/buildroot/output/host/usr/bin/:$YOUR_BSP_PATH/buildroot/output/host/usr/sbin/ \
mke2img -G 4 -R 1 -d ./rootfs/ -o apf_debian_jessie_rootfs.ext4
# cp apf_debian_jessie_rootfs.ext4 /tftpboot/XXX-rootfs.ext4 (where XXX is the name of your module)
# chmod a+rw /tftpboot/opos6ul-rootfs.ext4
</pre>
* Now on your board, boot into U-Boot and:
<pre class="apf">
BIOS> run update_rootfs
</pre>
* If the rootfs image is too big for your SoM RAM size, you can also use [[U-Boot_UMS_on_APF_%26_OPOS|UMS]] USB mode of U-Boot to flash this image.
* Congratulations, you can go to [[Debian_on_APF#First_login|first login]]

===2] Using Debian on Flash while keeping default rootfs (APF6/APF51)===

* This tutorial will describe a method that will allow to keep the original Armadeus system on the board, and that will permit to choose which system to boot very easily. It is not the only way to run Debian on the APF, but it is quite convenient.

* You need to have an [[APF51]] or an [[APF6]] running the Buildroot based original system.

* The first step is to pack the debian filesystem that has been created on the development PC:
<pre class="host">
# tar cvf debian_arm_rootfs.tar rootfs/
</pre>
* You will end up with a ~150 MBytes tarball
* Then this archive should be transferred to the APF board. You can use a USB key or a microSD for example. (or TFTP if you have a lot of free space on your APF NAND; then put the file in ''/root'' on the APF)

* Now, on the APF, the archive should be extracted (from the media holding it to the APF NAND FLASH). '''Don't forget the p option of tar''', which is required to properly extract permissions on files :
<pre class="apf">
# cd /root
# tar xvpf debian_arm_rootfs.tar
</pre>

* We will boot this distribution using ''chroot''. We need to write a script that will be run by the kernel on startup and that will do the chroot at an early stage of the boot process, so that nothing from the original rootfs is started when we want to boot Debian. To do this, create a file called ''/debinit'' that contains the following lines :
<pre class="apf">
#!/bin/sh
mount -t proc none /root/rootfs/proc
exec chroot /root/rootfs /sbin/init
</pre>

* This script needs to be executable :
<pre class="apf">
# chmod 755 /debinit
</pre>

* Kernel modules and firmware files need to be copied from the default filesystem to the Debian filesystem :
<pre class="apf">
# cp -r /lib/modules/* /root/rootfs/lib/modules
# cp -r /lib/firmware /root/rootfs/lib/firmware
# chroot /root/rootfs /sbin/depmod -a
</pre>
==== Configure U-Boot to boot debian ====
* Finally, we need to configure U-Boot so it tells the kernel to use that script on bootup. Reboot your board, press a key to interrupt the automatic boot in U-Boot, then do :
{| border="1" cellpadding="10" cellspacing="0" summary="depboot definition depending on board" class="wikitable"
|- style="background:#efefef;" align="center"
! APF51 || APF6
|---
|<pre class="apf">
BIOS> setenv debboot 'setenv extrabootargs ${extrabootargs} init=/debinit; run ubifsboot'
BIOS> saveenv
</pre>
|<pre class="apf">
BIOS> setenv debboot 'setenv extrabootargs ${extrabootargs} init=/debinit; run emmcboot'
BIOS> saveenv
</pre>
|}

* That's all. Now you board will keep booting the original system but if you want to boot debian instead, you can interrupt the autoboot of U-Boot and run the command :

<pre class="apf">
BIOS> run debboot
</pre>

* In case you want the board to boot debian automatically, you can do so by running :
<pre class="apf">
BIOS> setenv bootcmd run debboot
BIOS> saveenv
</pre>

* You can then switch back to the original Armadeus system by running :
<pre class="apf">
BIOS> setenv bootcmd run ubifsboot
BIOS> saveenv
</pre>

==First login==
Whaoouh ! It booted ! ;-)

<pre class="apf">
Debian GNU/Linux 8 apfxx/opos6ul ttySMX0/ttymxc2|0

apfxx/opos6ul login:
</pre>

* Login as root with no password

* If rootfs is mounted read-only, then remount it rw:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# mount -o remount,rw /dev/mmcblk2p2
</pre>
||
<pre class="apf">
root@opos6ul:~# mount -o remount,rw /dev/mmcblk0p2
</pre>
|}

* You might also definitely change this behavior (rootfs mounted read-only), by modifying U-Boot's ''mmcroot'' variable: replace ro with rw:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# reboot
BIOS> setenv mmcroot /dev/mmcblk2p2 rw
BIOS> saveenv
</pre>
||
<pre class="apf">
root@opos6ul:~# reboot
BIOS> setenv mmcroot /dev/mmcblk0p2 rw
BIOS> saveenv
</pre>
|}

* On modules with eMMC '''only''', if you replaced the default rootfs, you might want to use all eMMC space for debian:
{| class="wikitable sortable"
|-
! [[APF6]] !! [[OPOS6UL]]
|-
|
<pre class="apf">
root@apf6:~# /usr/sbin/resize2fs /dev/mmcblk2p2
</pre>
||
<pre class="apf">
root@opos6ul:~# /usr/sbin/resize2fs /dev/mmcblk0p2
</pre>
|}

* If ''/etc/mtab'' is absent, regenerate it:
<pre class="apf">
root@opos6ul:~# grep -v rootfs /proc/mounts > /etc/mtab
</pre>

* Update packages (network should be up and running):
<pre class="apf">
root@apfxx:~# apt-get update
root@apfxx:~# apt-get upgrade
...
</pre>

* If the keyboard layout doesn't suite yours, you can change it with (keyboard type, then keymap):
<pre class="apf">
root@apfxx:~# dpkg-reconfigure keyboard-configuration
</pre>

* Setup system and RTC date:
<pre class="apf">
root@apfxx:~# date 012011552010
Wed Jan 20 11:55:00 UTC 2010
root@apfxx:~# hwclock -wu
</pre>

* If you don't have any RTC chip (or no RTC backup cell) on your development board but have Internet access, then it could be a good idea to install ''ntpdate'' and use it:
<pre class="apf">
root@apfxx:~# apt-get install ntpdate
...
root@apfxx:~# ntpdate-debian
</pre>

* To configure TimeZone:
<pre class="apf">
root@apfxx:~# dpkg-reconfigure tzdata
</pre>

* Change root password:
<pre class="apf">
root@apfxx:~# passwd
</pre>

* Add a user (''armadeus''):
<pre class="apf">
root@apfxx:~# adduser armadeus
</pre>

* Remove x86 qemu used during installation to get some free space:
<pre class="apf">
root@apfxx:/tmp# rm /usr/bin/qemu-arm-static
</pre>

* If you want remote network/SSH access to your board:
<pre class="apf">
root@apf|oposxx:~# apt-get install dropbear
</pre>

* Other packages that may also be useful (for development):
<pre class="apf">
root@apfxx:~# apt-get install build-essential gcc-4.8 tftp vim strace i2c-tools iw psmisc
</pre>

* If you want an X server (requires ~60 MBytes of free space):
<pre class="apf">
root@apfxx:~# apt-get install xserver-xorg (xserver-xfbdev ?)
</pre>
* If you want some apps for X (requires ~20 MBytes of free space):
<pre class="apf">
root@apfxx:~# apt-get install x11-apps
</pre>
* If you want a graphical login manager:
<pre class="apf">
root@apfxx:~# apt-get install xdm
</pre>
* if you want a touchscreen calibrator and a virtual keyboard:
<pre class="apf">
root@apfxx:~# apt-get install xinput-calibrator xvkbd
</pre>
* if you want a lightweight Web browser:
<pre class="apf">
root@apfxx:~# apt-get install netsurf
</pre>
* If you want a desktop manager (requires >300 MBytes o_O):
<pre class="apf">
root@apfxx:~# apt-get install xfce4
</pre>
* You might also want to try another "lightweight" desktop manager (>600 MBytes o_O<):
<pre class="apf">
root@apfxx:~# apt-get install lxde
</pre>

==Known issues==
===APF27===
* Xorg won't start. (compatibility problem with framebuffer driver)

===APF51===
* There's a kernel oops during the boot process. This is related to the SPI driver.
* Booting takes quite some time because udev has an issue with the SPI port and it takes some time before it timeouts and continues the boot.

===APF6===
* ''hcitool lescan'' command is reported to not work. Use ''bluetoothctl'' instead.

===OPOS6UL===
* onboard Wi-Fi chip doesn't seem operational.
* to have Wi-Fi firmware on Debian Jessie:
<pre class="apf">
root@opos6ul:~# vim /etc/apt/sources.list
add non-free
root@opos6ul:~# apt-get update
root@opos6ul:~# apt-get install firmware-brcm80211
</pre>

===Console Port Issues===
In some cases the boot crashes and errors like these appear
<pre class="host">
init: Id "T0" respawning too fast: disabled for 5 minutes
</pre>
It means that the /dev folder haven't been populated with your console serial port.

To fix this, you need to reboot the apf and run armadeus system, then you need to do the following commands :
<pre class="apf">
# cp -r /dev/ttymxc0 /root/rootfs/dev/ttymxc0 (for apf51)
# cp -r /dev/ttySMX0 /root/rootfs/dev/ttySMX0 (for apf27)
</pre>

You also need to check that the file /root/rootfs/etc/securetty contains the console serial port (ttymxc0 for APF51 and ttySMX0 for APF27) if not :
<pre class="apf">
# echo 'ttymxc0' >> /root/rootfs/etc/securetty (for apf51)
# echo 'ttySMX0' >> /root/rootfs/etc/securetty (for apf27)
</pre>
It will allow the root user to login via this serial console.

It could also affects other ports and you will need to do the same procedure for them (ttyX, fbX, input, ttymxcX, ttySMXX, etc.)

==Automatically starts your custom application==
* Edit a shell script named ''/etc/init.d/myapp'', here we suppose your application is named ''/root/myapp'':
<source lang="bash">
#!/bin/sh

### BEGIN INIT INFO
# Provides: myapp
# Required-Start: $network $remote_fs $syslog
# Required-Stop: $network $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop:
# Short-Description: Start my application
### END INIT INFO

PATH=/sbin:/bin:/usr/sbin:/usr/bin

. /lib/lsb/init-functions

MY_APP=/root/myapp

test -x $MY_APP || exit 5

case $1 in
start)
log_daemon_msg "Starting my app"
$MY_APP &
;;
stop)
log_daemon_msg "Stopping my app"
;;
restart)
$0 stop && sleep 2 && $0 start
;;
*)
echo "Usage: $0 {start|stop|restart}"
exit 2
;;
esac
</source>
* make it executable:
<pre class="apf">
root@opos6ul:~# chmod a+x /etc/init.d/myapp
</pre>
* create a symlink to start the previous script in runlevel 5:
<pre class="apf">
root@opos6ul:~# ln -sf /etc/init.d/myapp /etc/rc5.d/S99myapp
</pre>
* reboot and check that you application is successfully started ;-)

==Links==
* [http://www.debian.org/releases/stable/i386/apds03.html.en Installing Debian GNU/Linux from a Unix/Linux System]
* http://free-electrons.com/blog/embdebian-with-multistrap/
* http://wiki.debian.org/Xfce
* [http://fr.scribd.com/doc/123130564/Installation-de-Debian-sur-la-carte-Armadeus-APF28 Enhanced french tutorial to install Debian on an APF28 board]
* [[Buildroot_inside_Debian_on_APF]]

[[Category:Distribution]]

Power management

2024-12-10T17:43:37Z

JulienB: /* Links */

==APF9328==
===APF9328 alone===
Power consumption measurements have been done on an APF9328 board.
The results are available in the [[APF9328]] datasheet.
 

===APF9328 connected to a DevLight board===
{| border="1" cellpadding="5" cellspacing="0" summary="How to reduce chips power consumption"
|- style="background:#efefef;"
! '''Functionnality''' || ''' power needed @ 5V''' || '''how to reduce it'''
|----------------
| FPGA || xxxmA || don't configure it
|----------------
| Ethernet || || ifconfig eth0 down
|----------------
| i.MXL (proc + SDRAM + Flash) || ||
|----------------
| LCD || ||
|----------------
| || ||
|----------------
|}

==APF27/APF28/APF51==

===Linux configuration===
{{Note| now done by default in latest apf kernel configs}}
<pre class="config">
[*] Power management options --->
[*] Power Management support
[*] Power Management Debug Support
[*] Verbose Power Management debugging
[*] Suspend to RAM and standby
[ ] Test suspend/resume and wakealarm during bootup
< > Advanced Power Management Emulation
[ ] Use D14 LED of the APF27Dev for suspend signaling
[ ] Use S1 switch of the APF27Dev to resume after a suspend
</pre>

For the apf27, power management handling is done in ''arch/arm/mach-mx2/pm_imx27.c''

* if you put the APF27 in suspend mode, it could be interesting to be able to wake it with the "User button":
<pre class="host">
$ make linux-menuconfig
</pre>
<pre class="config">
[*] Power management options --->
[*] Power Management support
[*] Power Management Debug Support
[*] Verbose Power Management debugging
[*] Suspend to RAM and standby
[ ] Test suspend/resume and wakealarm during bootup
< > Advanced Power Management Emulation
[ ] Use D14 LED of the APF27Dev for suspend signaling
[*] Use S1 switch of the APF27Dev to resume after a suspend
</pre>

* if you put the [[APF28]] in suspend mode, you can use the power button to wake up the board.

===To know if driver is launched===
<pre class="apf">
# dmesg | grep Power
Power Management for Freescale i.MX2x
</pre>

==Ethernet==
for the [[APF27]] the ''fec_old'' driver currently do not implement CONFIG_PM stuff...

===Power-up===
<pre class="apf">
# ifconfig eth0 up
</pre>

===Power-down===
<pre class="apf">
# ifconfig eth0 down -->> ~ -400 mW
</pre>

==Other devices==
Should comply to suspend/resume device drive mechanism.

===List available suspend modes===
<pre class="apf">
# cat /sys/power/state
standby mem
</pre>

===Enter standby mode (i.MX in Doze mode)===
<pre class="apf">
# echo standby > /sys/power/state
PM: Syncing filesystems ... done.
PM: Preparing system for standby sleep
Freezing user space processes ... (elapsed 0.00 seconds) done.
Freezing remaining freezable tasks ... (elapsed 0.00 seconds) done.
PM: Entering standby sleep
Suspending console(s) (use no_console_suspend to debug)
imx-uart imx-uart.0: preparing suspend
imx-uart imx-uart.2: preparing suspend
mxc_nand mxc_nand.0: preparing suspend
...
</pre>

===Enter suspend to memory mode (i.MX in Sleep mode)===
<pre class="apf">
# echo mem > /sys/power/state
</pre>
only an external interrupt can now wake up the i.MX27

{{Warning| The mode 'mem' is not implemented in the kernel 2.6.35 for the [[APF28]]. please use the 'standby' mode}}

Only few interrupts can wake up the i.MX51 from this mode. please check the mx51 reference manual for further information.

===Wake up the board from sleep mode===

* For the [[APF28]] you can use the power button, any active interrupt or the RTC.
* For the [[APF27]] you will have to use an external interrupt.
* For the [[APF51]] the RTC or an external interrupt can wake up the board.

===Debugging suspend/resume===
* pass '''no_console_suspend''' as boot parameter:
<pre class="apf">
BIOS> setenv extrabootargs no_console_suspend
BIOS> boot
</pre>

== Known problems ==

* [[APF27]] USB: usb cause system warning :
<pre class="apf">
# echo standby > /sys/power/state
PM: Syncing filesystems ... done.
Freezing user space processes ... (elapsed 0.01 seconds) done.
Freezing remaining freezable tasks ... (elapsed 0.00 seconds) done.
___ apf27_pm_suspend
___ apf27_pm_resume
------------[ cut here ]------------
WARNING: at kernel/hrtimer.c:625 hres_timers_resume+0x3c/0x60()
hres_timers_resume() called with IRQs enabled!Modules linked in: gpio
[<c002c0d8>] (dump_stack+0x0/0x14) from [<c003c148>] (warn_slowpath+0x70/0x8c)
[<c003c0d8>] (warn_slowpath+0x0/0x8c) from [<c0055dfc>] (hres_timers_resume+0x3c/0x60)
</pre>

==Suspend to disk==

Another solution to spare energy, if your board has an ON/OFF functionality, would be to activate suspend to disk mode. In this mode all currently used memory is copied by the Linux kernel to a swap partition (preferably on a eMMC). Consumption in this mode is like in OFF mode and boot-up is then faster that normal power-down/up sequence.

Prerequisites are:
* a lot of RAM (at least double of maximum used as time of suspend launch)
* a storage device big/resilient enough to have a swap partition

===Swap partition===
* Create a spare partition on your SOM with fdisk and set it to type 0x82 (SWAP)
<pre class="apf">
# ...
</pre>
* Format this partition as swap
<pre class="apf">
# ...
</pre>

==Links==
* [[Linux_Dynamic_Frequency_Scaling| Another good way of decreasing mA is to use frequency scaling]]
* [http://www.linuxjournal.com/article/6699 Power Management in Linux-Based Systems (Linux Journal)]
* [http://wiki.davincidsp.com/index.php?title=Startup_shutdown_and_power_management BlackFin way of doing]

[[Category:Power Management]]

Power management

2024-12-10T17:33:22Z

JulienB: /* Wake up the board from sleep mode */

==APF9328==
===APF9328 alone===
Power consumption measurements have been done on an APF9328 board.
The results are available in the [[APF9328]] datasheet.
 

===APF9328 connected to a DevLight board===
{| border="1" cellpadding="5" cellspacing="0" summary="How to reduce chips power consumption"
|- style="background:#efefef;"
! '''Functionnality''' || ''' power needed @ 5V''' || '''how to reduce it'''
|----------------
| FPGA || xxxmA || don't configure it
|----------------
| Ethernet || || ifconfig eth0 down
|----------------
| i.MXL (proc + SDRAM + Flash) || ||
|----------------
| LCD || ||
|----------------
| || ||
|----------------
|}

==APF27/APF28/APF51==

===Linux configuration===
{{Note| now done by default in latest apf kernel configs}}
<pre class="config">
[*] Power management options --->
[*] Power Management support
[*] Power Management Debug Support
[*] Verbose Power Management debugging
[*] Suspend to RAM and standby
[ ] Test suspend/resume and wakealarm during bootup
< > Advanced Power Management Emulation
[ ] Use D14 LED of the APF27Dev for suspend signaling
[ ] Use S1 switch of the APF27Dev to resume after a suspend
</pre>

For the apf27, power management handling is done in ''arch/arm/mach-mx2/pm_imx27.c''

* if you put the APF27 in suspend mode, it could be interesting to be able to wake it with the "User button":
<pre class="host">
$ make linux-menuconfig
</pre>
<pre class="config">
[*] Power management options --->
[*] Power Management support
[*] Power Management Debug Support
[*] Verbose Power Management debugging
[*] Suspend to RAM and standby
[ ] Test suspend/resume and wakealarm during bootup
< > Advanced Power Management Emulation
[ ] Use D14 LED of the APF27Dev for suspend signaling
[*] Use S1 switch of the APF27Dev to resume after a suspend
</pre>

* if you put the [[APF28]] in suspend mode, you can use the power button to wake up the board.

===To know if driver is launched===
<pre class="apf">
# dmesg | grep Power
Power Management for Freescale i.MX2x
</pre>

==Ethernet==
for the [[APF27]] the ''fec_old'' driver currently do not implement CONFIG_PM stuff...

===Power-up===
<pre class="apf">
# ifconfig eth0 up
</pre>

===Power-down===
<pre class="apf">
# ifconfig eth0 down -->> ~ -400 mW
</pre>

==Other devices==
Should comply to suspend/resume device drive mechanism.

===List available suspend modes===
<pre class="apf">
# cat /sys/power/state
standby mem
</pre>

===Enter standby mode (i.MX in Doze mode)===
<pre class="apf">
# echo standby > /sys/power/state
PM: Syncing filesystems ... done.
PM: Preparing system for standby sleep
Freezing user space processes ... (elapsed 0.00 seconds) done.
Freezing remaining freezable tasks ... (elapsed 0.00 seconds) done.
PM: Entering standby sleep
Suspending console(s) (use no_console_suspend to debug)
imx-uart imx-uart.0: preparing suspend
imx-uart imx-uart.2: preparing suspend
mxc_nand mxc_nand.0: preparing suspend
...
</pre>

===Enter suspend to memory mode (i.MX in Sleep mode)===
<pre class="apf">
# echo mem > /sys/power/state
</pre>
only an external interrupt can now wake up the i.MX27

{{Warning| The mode 'mem' is not implemented in the kernel 2.6.35 for the [[APF28]]. please use the 'standby' mode}}

Only few interrupts can wake up the i.MX51 from this mode. please check the mx51 reference manual for further information.

===Wake up the board from sleep mode===

* For the [[APF28]] you can use the power button, any active interrupt or the RTC.
* For the [[APF27]] you will have to use an external interrupt.
* For the [[APF51]] the RTC or an external interrupt can wake up the board.

===Debugging suspend/resume===
* pass '''no_console_suspend''' as boot parameter:
<pre class="apf">
BIOS> setenv extrabootargs no_console_suspend
BIOS> boot
</pre>

== Known problems ==

* [[APF27]] USB: usb cause system warning :
<pre class="apf">
# echo standby > /sys/power/state
PM: Syncing filesystems ... done.
Freezing user space processes ... (elapsed 0.01 seconds) done.
Freezing remaining freezable tasks ... (elapsed 0.00 seconds) done.
___ apf27_pm_suspend
___ apf27_pm_resume
------------[ cut here ]------------
WARNING: at kernel/hrtimer.c:625 hres_timers_resume+0x3c/0x60()
hres_timers_resume() called with IRQs enabled!Modules linked in: gpio
[<c002c0d8>] (dump_stack+0x0/0x14) from [<c003c148>] (warn_slowpath+0x70/0x8c)
[<c003c0d8>] (warn_slowpath+0x0/0x8c) from [<c0055dfc>] (hres_timers_resume+0x3c/0x60)
</pre>

==Links==
* [[Linux_Dynamic_Frequency_Scaling| Another good way of decreasing mA is to use frequency scaling]]
* [http://www.linuxjournal.com/article/6699 Power Management in Linux-Based Systems (Linux Journal)]
* [http://wiki.davincidsp.com/index.php?title=Startup_shutdown_and_power_management BlackFin way of doing]

[[Category:Power Management]]

LinuxInstall

2024-01-30T14:12:12Z

JulienB: /* Get Armadeus software */

<noinclude>
<big>How-To install Armadeus Software Development Kit (SDK) on Linux systems. This SDK is currently based on the (excellent) [http://buildroot.net/ Buildroot].</big>
</noinclude>

The installation was successfully tested on the following distributions:
* Debian Lenny (5.0), Squeeze (6.0.x), Wheezy (7.2), Jessie (8.0)
* X/KUbuntu Edgy Eft (6.10), Gutsy Gibbon (7.10), Hardy Heron (8.04) & Jaunty Jackalope (9.04)
* Ubuntu Lucid Lynx (10.04) (32 & 64bits), 12.04 LTS (32 & 64bits), 13.10 (32 & 64bits), 14.04, 15.04 & 16.04
* LUbuntu 17.10
* Mandriva 2006
* Fedora Core 3 & 4, Fedora 10, Laughlin (14)
* Red Hat Enterprise 5.2
* Gentoo 10.0 (32 & 64 bits)
* SuSE 10.1, OpenSUSE 11.3 - 12.3

'''The installation may fail on:'''
* Ubuntu Karmic Koala (9.10): tslib fails to build

'''APF28 requirements:'''
* APF28 board requires a Linux distribution with (GNU) tar version 1.20 or later to compile the Linux Kernel - Please update or upgrade your Linux distribution.

==Prerequisites for Linux installation==
{{Note|From here we assume that your Linux system has a ''make'' version '''greater or equal to''' 3.81. To check it:
<pre class="host">
$ make -v
GNU Make 3.81
...
</pre>
}}
For armadeus up to 3.4, make should be '''strictly''' make-3.81 (make-3.82 is too strict). A Fedora (14 and 15) -specific solution can be found later; other recent distributions such as mageia1 also have make-3.82, and a generic solution, based on configure&& make&& sudo make install can be used to install make-3.81 (which can be retrieved from http://ftp.gnu.org/gnu/make/make-6.81.tar.gz) in /usr/local/bin (and , according to one's PATH, make 3-81 can be invoked directly or as /usr/local/bin/make).

Depending on your distribution, some additional packages are required:

===Debian/Ubuntu based systems===
[[Ubuntu/Debian installation prerequisites]]

===Mandriva based systems===
[[Mandriva installation prerequisites]]

===RPM-based systems (RedHat, Fedora, CentOS)===
[[RedHat/Fedora installation prerequisites]]

===OpenSuse based systems===
[[OpenSuse installation prerequisites]]

===Gentoo based systems===
[[Gentoo installation prerequisites]]

==Get Armadeus software==
* '''If you are a "careful" user''', then download [https://gitlab.com/armadeus/armadeus-bsp/-/tags the latest stable installation tarball from gitlab] and detar it wherever you want:
<pre class="host">
$ tar xjvf armadeus-7.0.tar.bz2
</pre>
* '''If you want the latest snapshot or if you have a recent SOM ([[OPOS6UL]]/[[OPOS8MM]])''', the whole development tree can be checked out from our [[GIT]] repository.
<pre class="host">
$ git clone git@gitlab.com:armadeus/armadeus-bsp.git armadeus
</pre>

* depending on your previous choice, a directory named ''armadeus/'' or ''armadeus-7.0/'' will be created on your hard-disk and will contain all the files you need.

'''Remarks''':
* '''Do not use spaces''' in the directory name !
* '''Do not use a directory path beginning with /usr.''' It is a known bug of Buildroot (until BR2012.11, at 2012-12).
* GIT write/push accesses are limited to the integrators ([[User:JulienB|JulienB]], [[User:SebastienSz|SebastienSz]], [[User:Jorasse|Jorasse]], [[User:FabienM|FabienM]], [[User:SebastienR|SebastienR]])

==Configure SDK/BSP options==
{{Note|If you are new to Armadeus and have troubles compiling armadeus-5.x/armadeus-6.x using the following instructions, you may find some hints here: [[Releases]]}}
*Go to the directory where you put the Armadeus sources:
<pre class="host">
$ cd armadeus/ (or armadeus-7.0/)
</pre>
*The first time you compile an Armadeus distribution you have to specify the target (here the [[APF9328]]) to work with.
<pre class="host">
$ make apf9328_defconfig
</pre>
This command reloads the default configuration to support your target and automatically start a Buildroot's configuration menu.

* Current valid default configurations are:
<pre class="host">
apf9328_defconfig apf27_defconfig pps_defconfig apf28_defconfig apf51_defconfig pps51_defconfig apf6_defconfig apf6legacy_defconfig opos6ul_defconfig opos6ulnano_defconfig
</pre>
{{Note| To get the full list of available config just type make, it will download buildroot and print following message :
<pre class="host">
$ make
[...]
System not configured. Use make <board>_defconfig
armadeus valid configurations are:
opos6ul_legacy_defconfig opos6ulnano-preempt-rt_defconfig apf6_defconfig pps_defconfig opos6ultest_defconfig apf51_defconfig opos6ulsp_defconfig apf6dawnsmalllinux_defconfig apf27preempt-rt_defconfig apf27test_defconfig apf27_defconfig apf28legacytest_defconfig opos6ullegacy-4.14_defconfig opos6ulnano_defconfig apf28legacy_defconfig apf6mainline-4.19_defconfig opos6ul_defconfig apf6legacy_defconfig apf6xenomai_defconfig apf51test_defconfig opos6ul-preempt-rt_defconfig apf6legacy-preempt-rt_defconfig apf6legacy-4.1_defconfig pps51_defconfig apf6mainline-4.9_defconfig apf28test_defconfig apf28_defconfig apf6mediacenter_defconfig opos6ullegacy-4.9_defconfig opos6ul_recovery_defconfig apf6failsafe_defconfig apf6test_defconfig opos6ullegacy-4.1_defconfig apf27xenomai_defconfig

Makefile:129: recipe for target '/usr/local/projects/apf6_sp_419/buildroot/.configured' failed
make: *** [/usr/local/projects/apf6_sp_419/buildroot/.configured] Error 1
</pre>
}}

For PPS boards, please see [[APF27_PPS]] or [[PPS51]] Wiki pages, as these boards have specific build.

* After some downloads, you will get the Buildroot configuration interface:

{{Note|If you ever made changes during the following steps, at any time, you can reload the default configuration with:
$ make xxx_defconfig (xxx depending on your module name)}}

[[Image:Menuconfig3.png]] 
*If you are not familiar with Buildroot here are some tips:
*# you can move the highlighted item with the "up"/"down" arrow keys
*# with the "left"/"right" arrow keys you can choose between "Select", "Exit" or "Help" buttons
*# "space"/"enter":
*#* selects the currently highlighted item if you are on the "Select" button
*#* go back in previous menu if you are on "Exit" button
*#* show you some Help for current item if you are on "Help" button
*# for more Help about Buildroot commands, select "Help" in the main configuration screen

* Update the memory configuration of your board ('''if needed'''; by default BSP is configured for the minimal memory configuration available on the corresponding board):

:In menu:
:<pre class="config">System configuration ---> [*] Armadeus Device Support ---></pre>

:you can check and change the quantity of RAM available on your Armadeus board:
:[[Image:Build_config_memory.png]]
:For [[APF9328]] the memory can be either 16 or 32MiB (be sure to select 1 RAM chip)
:For [[APF27]] it could be either 64MiB or 128MiB (2 x 64MiB) (in that case be sure to select 2 chips of 64MiB instead of 1 chip of 128MiB).
:For [[APF51]] it could be either 256MiB or 512MiB (2x256MiB) (in such case be sure to select 2 chips of 256MiB instead of 1 chip of 512).
:For [[APF28]] The memory can be 128, 256, 512 or 1024MiB (be sure to select 1 RAM chip).
:For [[APF6]]/[[APF6SP]] The memory can be 512 Mbytes or 1Gbytes with ram chip size of 512Mbytes.
:For [[OPOS6UL]]/[[OPOS6UL_NANO]] The memory size is automatically detected so you don't care ;-)

* You may decrease the compilation time by increasing the number of parallel jobs running simultaneously on your system (the result is not guaranteed). This option is located in:
:<pre class="config">Build Options ---> (0) Number of jobs to run simultaneously</pre>
0 means that Buildroot will try to guess automatically how much parallel jobs it can launch.

* During the SDK/BSP build, a lot of software archives are downloaded from Internet. The downloaded files are put by default in the ''armadeus/downloads/'' directory. '''If you have several views or plan to build the toolchain several times''', we advise you to put all the downloaded files in ''/local/downloads'' (for example). This is done by configuring Buildroot to use this directory for all your views. Nevertheless, Buildroot will be downloaded separately for each build environment you set up.
:<pre class="config">Build options ---> (...) Download dir</pre>
:[[Image:Build_config_download.png]]
{{Note|Of course, ''/local/downloads'' should exists on your system and you should have writing rights on it !}}
* In recent Buildroot you can also use the following method:
export BR2_DL_DIR=/local/downloads

* After the build, we advise you to copy all the files in ''downloads/'' / ''/local/downloads'' on a removable medium, in case you want to install the development tools on other systems, without to have to reload all the archives.

* Now, Exit the configuration tool and save your configuration

* You can come back to this configuration menu, by typing (your changes will be kept):
<pre class="host">
make menuconfig
</pre>

==Launch build==
$ make
The toolchain and the full distribution are automatically built. During this procedure, several files are downloaded from Internet. 
'''Please wait for a while.... it takes at least one hour for the first run!''' 
By default, the downloaded files/tarball are put in the ''armadeus/downloads/'' directory. Please see the previous chapter to know how to optimize that if you plan to build several views or want to build faster.

==Enjoy the result==
The generated binary files can be found in the subdirectory ''buildroot/output/images'':
*''apf9328-u-boot.brec'' (only on [[APF9328]]): BRecord image that can be used with the bootstrap, if U-Boot is not installed or not working (see [[BootLoader]] page)
*''xxx-u-boot.bin'': U-Boot image file to be used with U-Boot itself, (see [[BootLoader#Update_U-Boot | updating U-Boot]])
*''xxx-linux.bin'': Linux image to use with U-Boot, (see [[Target_Software_Installation#Linux_kernel_installation | updating Linux]])
*''xxx-rootfs.jffs2'': JFFS2 filesystem/rootfs image to use with U-Boot, (see [[Target_Software_Installation#Linux_rootfs_installation | updating rootfs]])
*''xxx-rootfs.ubi'' (not supported on [[APF9328]]): [[UBIFS|UBI]] filesystem/rootfs image to use with U-Boot, (see [[Target_Software_Installation#Linux_rootfs_installation | updating rootfs]])
*''xxx-rootfs.ext4'': EXT4 filesystem/rootfs image to use with U-Boot, (on [[APF6]] and [[OPOS6UL]])
*''xxx-rootfs.tar'': for an NFS/MMC based rootfs, (see [[Network_Configuration#Boot_from_NFS | Booting from NFS]] & [[MultiMediaCard#Booting_from_MMC.2FSD | Booting from a MMC/SD]])

'''Please note the new naming convention of binary files and directories (since Armadeus 4.0)'''

*''buildroot/output/build'': contains all the build results for target root filesystem, Linux, Busybox and U-Boot...
*''buildroot/output/toolchain/'': cross compilation toolchain's build dir. Binaries usable for cross-compilation are in ''buildroot/output/host/usr/bin''.
*''buildroot/output/target/'': target filessytem before generating rootfs images

More information is available in the [http://buildroot.uclibc.org/buildroot.html Buildroot's documentation]

* Note: Previous versions (3.x) of Armadeus SDK stored the generated binary files at a different place: '' ''buildroot/binaries/XX/'' (where XX was the name of your board).

<noinclude>

You then copy the binary image to your server directory:
<pre class="host">
$ cp buildroot/output/images/* /tftpboot
</pre>

==To keep your local copy/repository up-to-date with the armadeus GIT repository==
<pre class="host">
$ git pull
</pre>
This will update your working directory to the latest release.

Note: if "git pull" fails because a directory or a file already exists, then do:
$ rm -rf <this-directory/file>
$ git pull

You can do a:
$ make apfXX_defconfig
to have the latest features automatically activated.

You have to do a '''make''' to rebuild binary files and then upload the binary files to your target.

Note: if definitively everything goes wrong while it worked before the last update.
You can apply the following procedure (all your modifications in buildroot will be lost):
$ rm -rf buildroot/
$ rm Makefile
$ git pull
$ make apfXX_defconfig
$ make
$ cp buildroot/output/images/* /tftpboot

Enjoy!
</noinclude>

WiFi

2024-01-30T13:24:16Z

JulienB: /* Common operations */

==Pre-requites==
{{Note| To configure Wi-Fi you need to [[Wireless Tools| install wireless tools]] first (done by default for APF27 / PPS / APF51 / APF6 / OPOS6UL) and of course also need to have a running Wi-Fi interface like: the [[Libertas_driver|one on APW extension board, APF51Dev or PPS devt boards]], the [[Wl12xx_driver|one on APF6]], the one on [[OPOS6UL]] or a [[USB_to_WiFi_adapter|USB to Wi-Fi adapter]], with corresponding Linux drivers loaded.}}

==Common operations==
====List network interfaces supporting Wi-Fi====
{|
! Old BSPs !! New BSPs
|-
|<pre class=apf>
# iwconfig
lo no wireless extensions.

eth0 no wireless extensions.

sit0 no wireless extensions.

wmaster0 no wireless extensions.

wlan0 IEEE 802.11bg ESSID:""
Mode:Managed Frequency:2.412 GHz Access Point: Not-Associated
Tx-Power=0 dBm
Retry min limit:7 RTS thr:off Fragment thr=2352 B
Encryption key:off
Power Management:off
Link Quality:0/100 Signal level:112/146 Noise level:0/0
Rx invalid nwid:0 Rx invalid crypt:0 Rx invalid frag:0
Tx excessive retries:0 Invalid misc:0 Missed beacon:0
</pre>
| <pre class=apf># iw dev
phy#0
Interface wlan0
ifindex 3
wdev 0x1
addr 74:7a:90:e7:e0:d5
type managed
channel 34 (5170 MHz), width: 20 MHz, center1: 5170 MHz</pre>
|}

{{Note|Here our Wi-Fi network interface is called ''wlan0''. Depending on the number of your network interfaces or their model, this name could change. For example if using the Libertas drivers, the interface may be called ''eth1'' (if ''eth0'' is already used). In that case replace ''wlan0'' with your interface name.}}

====Activate the WLAN interface====
{|
! Old BSPs !! New BSPs
|-
|<pre class=apf>
# ifconfig wlan0 up
</pre>
|<pre class=apf>
# ip link set wlan0 up
</pre>
|}

==== Show all Access Points (AP) available for your APF (here with wlan0 interface) ====
{|
! Old BSPs !! New BSPs
|-
|<pre class=apf>
# iwlist wlan0 scan

wlan0 Scan completed :
Cell 01 - Address: XX:XX:XX:66:47:48
ESSID:"TOTO"
Mode:Master
Channel:1
Frequency:2.412 GHz (Channel 1)
Quality=88/100 Signal level:25/100
Encryption key:on
Bit Rates:1 Mb/s; 2 Mb/s; 5.5 Mb/s; 11 Mb/s; 6 Mb/s
9 Mb/s; 12 Mb/s; 18 Mb/s; 24 Mb/s; 36 Mb/s
48 Mb/s; 54 Mb/s
Extra:tsf=00000009d398fec8
Extra: Last beacon: 1390ms ago
...
</pre>
|<pre class=apf>
# iw wlan0 scan

BSS XX:XX:XX:ed:c5:b0(on wlan0)
last seen: 1805.540s [boottime]
TSF: 0 usec (0d, 00:00:00)
freq: 2462
beacon interval: 120 TUs
capability: ESS Privacy ShortSlotTime RadioMeasure (0x1411)
signal: -90.00 dBm
last seen: 0 ms ago
SSID: TOTO
Supported rates: 1.0* 2.0* 5.5* 11.0* 6.0 9.0 12.0 18.0
DS Parameter set: channel 11
...</pre>
|}

==== Connect to an unencrypted AP ====
{|
! Old BSPs !! New BSPs
|-
|<pre class=apf>
# iwconfig wlan0 essid AP_NAME
</pre>
* Check it:
<pre class=apf>
# iwconfig wlan0
</pre>

|<pre class=apf>
# iw dev wlan0 connect AP_NAME
</pre>
* Check it:
<pre class=apf>
# iw dev wlan0 link
</pre>
|}

==== Get an IP address ====
<pre class=apf>
# udhcpc -i wlan0
</pre>

==Encryption settings==
When configuring Wi-Fi cryptography, only WEP can be setup easily from a terminal with single commands. For a Wi-Fi network with a WPA/WPA2 protection system, you should install and configure [[WPA supplicant|wpa_supplicant]].

{{Warning| The Wi-Fi Alliance defined WPA/WPA2 protection protocol in response to serious weaknesses researchers had found in the previous system, WEP (Wired Equivalent Privacy). Therefore, we strongly recommend you to use WPA/WPA2 to protect your network. Our [[WPA supplicant|wpa_supplicant]] wiki page provides the procedure to configure a WPA/WPA2 access to your network
}}

==== WEP configuration ====

This example is given for a Wi-Fi Access Point named ''armadeus'', the encoding key used here is not recommended, of course ;) :

<pre class=apf>
# iwconfig wlan0 essid armadeus
# iwconfig wlan0 key 12345678901234567890
# ifconfig wlan0 up (if interface is not already up)
ADDRCONF(NETDEV_UP): wlan0: link is not ready
# ADDRCONF(NETDEV_CHANGE): wlan0: link becomes ready
</pre>

Now, the Wi-Fi adapter is ready and attached :
<pre class=apf>
# iwconfig
lo no wireless extensions.

eth0 no wireless extensions.

sit0 no wireless extensions.

wmaster0 no wireless extensions.

wlan0 IEEE 802.11bg ESSID:"armadeus"
Mode:Managed Frequency:2.437 GHz Access Point: 00:1B:2F:E7:E4:08
Bit Rate=2 Mb/s Tx-Power=7 dBm
Retry min limit:7 RTS thr:off Fragment thr=2352 B
Encryption key:XXXXXXXXXXXXXXXXXXXXXXXXXX Security mode:restricted
Power Management:off
Link Quality:0/100 Signal level:73/146 Noise level:0/0
Rx invalid nwid:0 Rx invalid crypt:0 Rx invalid frag:0
Tx excessive retries:0 Invalid misc:0 Missed beacon:0

</pre>

==Accessing outside world==
We can manually configure the network to access Internet via the Wi-Fi interface instead of the Ethernet one:

<pre class=apf>
# ifconfig eth0 down
# ifconfig wlan0 192.168.0.212
# route add default gw 192.168.0.1 dev wlan0
</pre>

And configure the nameserver in /etc/resolv.conf
<pre class=apf>
domain dev.null
nameserver 192.168.0.207
~
~
~
</pre>

If you have a DHCP server on your network, you can also use it and previous steps (route+resolv.conf) will be done automatically:
<pre class=apf>
# udhcpc -i wlan0
</pre>

We can now ping the best website in the world :
<pre class=apf>
# ping www.armadeus.org
PING www.armadeus.org (213.186.33.5): 56 data bytes
64 bytes from 213.186.33.5: seq=0 ttl=122 time=66.735 ms
64 bytes from 213.186.33.5: seq=1 ttl=122 time=50.392 ms
^C
--- www.armadeus.org ping statistics ---
2 packets transmitted, 2 packets received, 0% packet loss
round-trip min/avg/max = 50.392/58.563/66.735 ms
</pre>

== Surf on the net ==

To surf on the web, you can use (for example) ''links'' software :
<pre class=apf>
# links www.armadeus.org
</pre>

It's an ASCII internet browser. [[Links| For more informations about Links]].

==Links==
* [[Wireless_Tools|Wireless Tools installation]]
* [[USB_to_WiFi_adapter|USB to Wi-Fi adapters tested with Armadeus boards]]
* [[Network_interface_bandwidth_measurement| Measure the bandwidth of your network interface]]
* [[WPA_supplicant|WPA_supplicant]]
* [[APF as Wi-Fi Access Point]]

[[Category:WiFi]]
[[Category:Wireless]]

WiFi

2024-01-30T12:11:50Z

JulienB: /* Common operations */

==Pre-requites==
{{Note| To configure Wi-Fi you need to [[Wireless Tools| install wireless tools]] first (done by default for APF27 / PPS / APF51 / APF6 / OPOS6UL) and of course also need to have a running Wi-Fi interface like: the [[Libertas_driver|one on APW extension board, APF51Dev or PPS devt boards]], the [[Wl12xx_driver|one on APF6]], the one on [[OPOS6UL]] or a [[USB_to_WiFi_adapter|USB to Wi-Fi adapter]], with corresponding Linux drivers loaded.}}

==Common operations==
====List network interfaces supporting Wi-Fi====
{|
! Old BSPs !! New BSPs
|-
|<pre class=apf>
# iwconfig
lo no wireless extensions.

eth0 no wireless extensions.

sit0 no wireless extensions.

wmaster0 no wireless extensions.

wlan0 IEEE 802.11bg ESSID:""
Mode:Managed Frequency:2.412 GHz Access Point: Not-Associated
Tx-Power=0 dBm
Retry min limit:7 RTS thr:off Fragment thr=2352 B
Encryption key:off
Power Management:off
Link Quality:0/100 Signal level:112/146 Noise level:0/0
Rx invalid nwid:0 Rx invalid crypt:0 Rx invalid frag:0
Tx excessive retries:0 Invalid misc:0 Missed beacon:0
</pre>
| <pre class=apf># iw dev
phy#0
Interface wlan0
ifindex 3
wdev 0x1
addr 74:7a:90:e7:e0:d5
type managed
channel 34 (5170 MHz), width: 20 MHz, center1: 5170 MHz</pre>
|}

{{Note|Here our Wi-Fi network interface is called ''wlan0''. Depending on the number of your network interfaces or their model, this name could change. For example if using the Libertas drivers, the interface may be called ''eth1'' (if ''eth0'' is already used). In that case replace ''wlan0'' with your interface name.}}

====Activate the WLAN interface====
{|
! Old BSPs !! New BSPs
|-
|<pre class=apf>
# ifconfig wlan0 up
</pre>
|<pre class=apf>
# ip link set wlan0 up
</pre>
|}

==== Show all Access Points (AP) available for your APF (here with wlan0 interface) ====
{|
! Old BSPs !! New BSPs
|-
|<pre class=apf>
# iwlist wlan0 scan

wlan0 Scan completed :
Cell 01 - Address: XX:XX:XX:66:47:48
ESSID:"TOTO"
Mode:Master
Channel:1
Frequency:2.412 GHz (Channel 1)
Quality=88/100 Signal level:25/100
Encryption key:on
Bit Rates:1 Mb/s; 2 Mb/s; 5.5 Mb/s; 11 Mb/s; 6 Mb/s
9 Mb/s; 12 Mb/s; 18 Mb/s; 24 Mb/s; 36 Mb/s
48 Mb/s; 54 Mb/s
Extra:tsf=00000009d398fec8
Extra: Last beacon: 1390ms ago
...
</pre>
|<pre class=apf>
# iw wlan0 scan

BSS XX:XX:XX:ed:c5:b0(on wlan0)
last seen: 1805.540s [boottime]
TSF: 0 usec (0d, 00:00:00)
freq: 2462
beacon interval: 120 TUs
capability: ESS Privacy ShortSlotTime RadioMeasure (0x1411)
signal: -90.00 dBm
last seen: 0 ms ago
SSID: TOTO
Supported rates: 1.0* 2.0* 5.5* 11.0* 6.0 9.0 12.0 18.0
DS Parameter set: channel 11
...</pre>
|}

==== Connect to an unencrypted AP ====
<pre class=apf>
# iwconfig wlan0 essid AP_NAME
</pre>
* Check it:
<pre class=apf>
# iwconfig wlan0
</pre>

==== Get an IP address ====
<pre class=apf>
# udhcpc -i wlan0
</pre>

==Encryption settings==
When configuring Wi-Fi cryptography, only WEP can be setup easily from a terminal with single commands. For a Wi-Fi network with a WPA/WPA2 protection system, you should install and configure [[WPA supplicant|wpa_supplicant]].

{{Warning| The Wi-Fi Alliance defined WPA/WPA2 protection protocol in response to serious weaknesses researchers had found in the previous system, WEP (Wired Equivalent Privacy). Therefore, we strongly recommend you to use WPA/WPA2 to protect your network. Our [[WPA supplicant|wpa_supplicant]] wiki page provides the procedure to configure a WPA/WPA2 access to your network
}}

==== WEP configuration ====

This example is given for a Wi-Fi Access Point named ''armadeus'', the encoding key used here is not recommended, of course ;) :

<pre class=apf>
# iwconfig wlan0 essid armadeus
# iwconfig wlan0 key 12345678901234567890
# ifconfig wlan0 up (if interface is not already up)
ADDRCONF(NETDEV_UP): wlan0: link is not ready
# ADDRCONF(NETDEV_CHANGE): wlan0: link becomes ready
</pre>

Now, the Wi-Fi adapter is ready and attached :
<pre class=apf>
# iwconfig
lo no wireless extensions.

eth0 no wireless extensions.

sit0 no wireless extensions.

wmaster0 no wireless extensions.

wlan0 IEEE 802.11bg ESSID:"armadeus"
Mode:Managed Frequency:2.437 GHz Access Point: 00:1B:2F:E7:E4:08
Bit Rate=2 Mb/s Tx-Power=7 dBm
Retry min limit:7 RTS thr:off Fragment thr=2352 B
Encryption key:XXXXXXXXXXXXXXXXXXXXXXXXXX Security mode:restricted
Power Management:off
Link Quality:0/100 Signal level:73/146 Noise level:0/0
Rx invalid nwid:0 Rx invalid crypt:0 Rx invalid frag:0
Tx excessive retries:0 Invalid misc:0 Missed beacon:0

</pre>

==Accessing outside world==
We can manually configure the network to access Internet via the Wi-Fi interface instead of the Ethernet one:

<pre class=apf>
# ifconfig eth0 down
# ifconfig wlan0 192.168.0.212
# route add default gw 192.168.0.1 dev wlan0
</pre>

And configure the nameserver in /etc/resolv.conf
<pre class=apf>
domain dev.null
nameserver 192.168.0.207
~
~
~
</pre>

If you have a DHCP server on your network, you can also use it and previous steps (route+resolv.conf) will be done automatically:
<pre class=apf>
# udhcpc -i wlan0
</pre>

We can now ping the best website in the world :
<pre class=apf>
# ping www.armadeus.org
PING www.armadeus.org (213.186.33.5): 56 data bytes
64 bytes from 213.186.33.5: seq=0 ttl=122 time=66.735 ms
64 bytes from 213.186.33.5: seq=1 ttl=122 time=50.392 ms
^C
--- www.armadeus.org ping statistics ---
2 packets transmitted, 2 packets received, 0% packet loss
round-trip min/avg/max = 50.392/58.563/66.735 ms
</pre>

== Surf on the net ==

To surf on the web, you can use (for example) ''links'' software :
<pre class=apf>
# links www.armadeus.org
</pre>

It's an ASCII internet browser. [[Links| For more informations about Links]].

==Links==
* [[Wireless_Tools|Wireless Tools installation]]
* [[USB_to_WiFi_adapter|USB to Wi-Fi adapters tested with Armadeus boards]]
* [[Network_interface_bandwidth_measurement| Measure the bandwidth of your network interface]]
* [[WPA_supplicant|WPA_supplicant]]
* [[APF as Wi-Fi Access Point]]

[[Category:WiFi]]
[[Category:Wireless]]

Microcom

2023-12-07T11:20:12Z

JulienB: /* Usage */

== Introduction ==

Microcom is an embedded terminal that can be installed on APF/OPOS SOMs.

== Installation ==

Installed by default on recent Armadeus BSPs.

== Usage ==

To connect a tty do this :
<pre class="apf">
# microcom -s 115200 /dev/ttymxc1
</pre>

Press Ctrl-X to quit the terminal.

[[Category: terminal]]

Microcom

2023-12-07T11:19:48Z

JulienB:

== Introduction ==

Microcom is an embedded terminal that can be installed on APF/OPOS SOMs.

== Installation ==

Installed by default on recent Armadeus BSPs.

== Usage ==

To connect a tty do this :
<pre class="apf">
$ microcom -s 115200 /dev/ttymxc1
</pre>

Press Ctrl-X to quit the terminal.

[[Category: terminal]]

Microcom

2023-12-07T11:19:14Z

JulienB:

[[Category: terminal]]

== Introduction ==

Microcom is an embedded terminal that can be installed on APF/OPOS SOMs.

== Installation ==

Installed by default on recent Armadeus BSPs.

== Usage ==

To connect a tty do this :
<pre class="apf">
$ microcom -s 115200 /dev/ttymxc1
</pre>

Press Ctrl-X to quit the terminal.

GSM/GPRS

2023-08-17T13:23:31Z

JulienB: /* Introduction */

This page will summarize informations to use the GSM/GPRS/3G module of the [[Wireless_extension_board|APF27Wireless board]], [[APF51Dev]] (optional), the [[APF6Dev]] (optional) or the RPi compatible Hats connected to OPOSxxDev RPi connector.

==Introduction==
GSM/GPRS are generally driven through the RS-232 bus. AT commands are used to dialog with the module.
* GSM MODEM of the [[Wireless_extension_board|APF27Wireless extension board (APW)]] is connected to the UART2 (/dev/ttySMX1) of the [[APF27]].
* GSM/3G MODEM of the [[APF51Dev]] is connected to the i.MX processor through an UART implemented in the FPGA. So the corresponding bitfile has to loaded before trying to access the MODEM.
* GSM/3G MODEM of the [[APF6Dev]] is connected to the UART3 of the i.MX6 processor.
They are all using a Sagem's Hilo module. Hilo AT commands can be found [http://support.sagemcom.com/site/livret/URD1_OTL_5725_1_008_72807_-_AT_Command_Set_for_SAGEMCOM_Modules__Ed_14_06_dated_11_May_2012.pdf here]
* RPi Hats with dedicated module (mostly SIMCOM one's) are connected through UART2 of RPi connector of OPOSxxDev boards.

==Linux configuration (APF27Dev only)==
* Linux will have to be configured in order to tell that an APW is connected to your [[APF27Dev]]:
<pre class="host">
$ make linux-menuconfig
</pre>
<pre class="config">
System Type --->
Freescale MXC Implementations --->
...
Extension board (Wireless (APW)) --->
[*] GSM/GPRS Modem (NEW)
[ ] Bluetooth & WiFi module (NEW)
[ ] CSI (Camera) pass-through (NEW)
[ ] GPS module (NEW)
</pre>

<pre class="host">
$ make linux
</pre>
* reflash you Linux kernel

==Configure serial port==
====APF27====
<pre class="apf">
# export GSM_DEVICE=/dev/ttySMX1 (or /dev/ttymxc1 on recent kernels)
# stty -F $GSM_DEVICE raw -echo -echoe -echok 115200
</pre>

====APF51Dev====

{{Note|Don't forget to put "Wireless" J42 jumper (near microSD connector) '''AND''' power on FPGA Bank 3 (with corresponding J39 jumper).}}
* On APF51Dev, GSM/3G module is accessed through serial ports synthetized in APF51's FPGA. So we have to load it first. (Needed dual UARTs FPGA firmware can be found under armadeus-4.0 distribution in ''firmware/pod_scripts'' directory, with the [[POD]] script needed to regenerate it, and is by default installed in rootfs).
<pre class="apf">
# load_fpga /lib/firmware/fpga/apf51_gsm_gps_firmware.bin
</pre>
* Once firmware loaded, drivers related to FPGA can be used :
<pre class="apf">
# modprobe irq_ocore
# modprobe 8250
Serial: 8250/16550 driver, 4 ports, IRQ sharing disabled
# modprobe twin_uarts_irq_mng
# modprobe twin_uarts_16750
serial8250.0: ttyS0 at MMIO 0xb8000020 (irq = 320) is a TI16750
serial8250.0: ttyS1 at MMIO 0xb8000040 (irq = 321) is a TI16750
</pre>
* Bring MODEM out of reset state (POK_IN/PWON pin, connected to [[APF51_PMIC#GPIO|PMIC GPIO6]]):
<pre class="apf">
# modprobe wm831x-gpio
# echo 245 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio245/direction
# echo 1 > /sys/class/gpio/gpio245/value
</pre>
* Configure serial port:
<pre class="apf">
# ls /dev/ttyS*
/dev/ttyS0 /dev/ttyS1 /dev/ttyS2 /dev/ttyS3
</pre>

* If the /dev/ttyS[0-1] files don't exist, create it/them with ''mknod'' :
<pre class="apf">
# mknod /dev/ttyS0 c 4 64
# mknod /dev/ttyS1 c 4 65
</pre>
Then :
<pre class="apf">
# export GSM_DEVICE=/dev/ttyS0
# stty -F $GSM_DEVICE -echo -echoe -echok 115200 crtscts
</pre>

====APF6Dev====
* Power up the chip. (GSM_PWR_EN is connected to the GPIO7_13)
<pre class="apf">
# echo 205 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio205/direction
# echo 1 > /sys/class/gpio/gpio205/value
</pre>

* Start it by setting a low level pulse during about 2 seconds on the POKIN line (POKIN is connected to the GPIO1_4).
<pre class="apf">
# echo 4 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio4/direction
# echo 1 > /sys/class/gpio/gpio4/value
# sleep 2
# echo 0 > /sys/class/gpio/gpio4/value
</pre>

* Configure the serial port
<pre class="apf">
# export GSM_DEVICE=/dev/ttymxc2
# stty -F $GSM_DEVICE -echo -echoe -echok 115200
</pre>

====OPOSxxDev with RPi connector====
* Configure the serial port
<pre class="apf">
# export GSM_DEVICE=/dev/ttymxc1
# stty -F $GSM_DEVICE -echo -echoe -echok 115200
</pre>

==Basic Usage==
===Sending AT commands "manually"===
* Sending AT commands with ''minicom/microcom'' utility (one of the command coming with [[busybox]]):

{{Note|minicom has been removed in recent BSP, so use microcom instead}}

<pre class="apf">
# microcom $GSM_DEVICE
</pre>
( To exit ''microcom'' you will have to type '''<CTRL-x>''' )
* Check module presence:
<pre class="apf">
ATI3
SAGEM HiC,A.005.00

OK
</pre>

{{Note| If no echo are printed on serial console: you can't see what you're typing. In that case, to reactivate the echo, use:
<pre class="apf">
ATE1
</pre>
}}

{{Note| By default, the module starts in auto baudrate. This mays result in loss of communication with baud rate higher than 19200 bauds. To avoid problems, the baud rate has to be fixed (here to 115200 bauds):
<pre class="apf">
AT+IPR=115200
</pre>
}}

* Get constructor name:
<pre class="apf">
AT+CGMI
SAGEM

OK
</pre>
* Get model name:
<pre class="apf">
AT+CGMM
HILO GPRS

OK
</pre>
* Enter PIN code (here 0000). '''!! Use your own and beware that you will only get 3 tries !!:'''
<pre class="apf">
AT+CPIN="0000"

OK
</pre>
* Check PIN code status:
<pre class="apf">
AT+CPIN?
+CPIN: READY

OK
</pre>
{{Note|Don't launch further AT commands if PIN code wasn't entered successfully}}

* Check module status (0 Ready, 1 Unavailable, 2 Status unknown, 3 Ringing, 4 Call in progress, 5 Asleep):
<pre class="apf">
AT+CPAS
+CPAS: 0

OK
</pre>
* Get Indicator control (<battchg>[0-4],<signal>[0-4],<service>0/1,<message>0/1,<call>0/1,<smsfull>0/1):
<pre class="apf">
AT+CIND?
+CIND: 0,4,1,0,0,0,1

OK
</pre>
* Get signal quality (should be better than 12/99):
<pre class="apf">
AT+CSQ
+CSQ: 24,99

OK
</pre>
* Voice call "123456789" (; is important here to signify a voice call, otherwise a data call is tried and may fail if you don't have the right subscribe)
<pre class="apf">
ATD"123456789";
OK
</pre>
* Terminate current call:
<pre class="apf">
ATH
OK
</pre>

===Sending AT commands in shell scripts===

<source lang="bash">
GSM_DEVICE=/dev/ttyXXX
send_at_cmd()
{
echo -e -n "$1\015" > $GSM_DEVICE
sleep 1 # Adjustable ! (usleep)
}

send_at_cmd AT
</source>

* See ''target/test/test_gsm.sh'' for more details

==Sending SMS==
* Supposing you are already connected to the modem with cu
* Check if you can send SMS with your SIM card (you should get +CMGF: (0,1))
<pre class="apf">
AT+CMGF=?
</pre>
* If OK, switch to SMS sending mode:
<pre class="apf">
AT+CMGF=1
</pre>
* Write a message for 0661234567 phone number:
<pre class="apf">
AT+CMGW="0661326109"

> Hey ! How are you doing ??
> <-- Ctrl+z to end SMS here

+CMGW: 8
</pre>
* +CMGW give you the number of your SMS saved in SIM card or phone memory
* Then, at anytime, you can send your SMS with (pass previous number as parameter):
<pre class="apf">
AT+CMSS=8
</pre>

==Tools to look at==
* http://www.developershome.com/sms/freeLibForSMS.asp
* http://www.gnokii.org/
* http://www.alamin.org/en/index.html
* http://www.gammu.org/wiki/index.php?title=Gammu:Main_Page
* http://gatling.ikk.sztaki.hu/~kissg/gsm/index.html

==Data tranfers (EDGE/3G)==

===PPP installation (done by default on APF51)===
<pre class="host">
$ make linux-menuconfig
</pre>

<pre class="config">
Device Drivers --->
[*] Network device support --->
<M> PPP (point-to-point protocol) support
[ ] PPP multilink support (EXPERIMENTAL)
[ ] PPP filtering
<M> PPP support for async serial ports
< > PPP support for sync tty ports
< > PPP Deflate compression
< > PPP BSD-Compress compression
< > PPP MPPE compression (encryption) (EXPERIMENTAL)
< > PPP over Ethernet (EXPERIMENTAL)
</pre>

<pre class="host">
$ make menuconfig
</pre>

<pre class="config">
Package Selection for the target --->
Networking applications --->
[*] pppd
[ ] filtering
[ ] radius
</pre>

<pre class="host">
$ make linux && make
</pre>

* reflash kernel & rootfs

===PPP configuration===
{{Note|Following instructions are given for the French operator "Bouygtel" and may need to be ajusted accordingly, depending on your operator/country}}

* Create a "chat" script that will be used to initiate MODEM dialup (here we use the "cat > xxxx << EOF trick" to automatically create the file, but you can also manually edit it with ''vi'' or ''nano''):
<pre class="apf">
# mkdir -p /etc/chatscripts/
# cat > /etc/chatscripts/bouygtel <<EOF
ABORT BUSY ABORT 'NO CARRIER' ABORT VOICE ABORT 'NO DIALTONE' ABORT 'NO ANSWER' ABORT DELAYED ABORT ERROR
'' AT
OK AT+IPR=115200
OK AT+CPIN="0000"
OK AT+CFUN=1
OK AT+COPS?
OK AT+CSQ
OK 'AT+CGDCONT=1,"IP","ebouygtel.com","",0,0'
OK 'AT&FE0Q0V1'
OK 'ATD*99#'
CONNECT ""
EOF
</pre>
* Don't forget to set the baudrate (default: 115200) to have a stable communication between the modem and the processor
* Don't forget to update "AT+CPIN=" with your real PIN code and "AT+CGDCONT" and "ATD*99#" with your operator parameters.
* If you want to test your chat script (verbose mode -v, on console -s, with 5 second timeout by default for commands -t 5), then launch:
<pre class="apf">
# /usr/sbin/chat -v -s -t 5 -f /etc/chatscripts/bouygtel > $GSM_DEVICE < $GSM_DEVICE
</pre>
* If this test was OK, you may have to poweroff/poweron the MODEM to bring it to its initial state and go further.

====For '''APF51'''====
* create the PPPd config files (''/etc/ppp/peers/bouygtel'' and ''/etc/ppp/options.ttyS0''):
<pre class="apf">
# mkdir -p /etc/ppp/peers/
# cat > /etc/ppp/peers/bouygtel <<EOF
noauth
connect "/usr/sbin/chat -v -t 5 -f /etc/chatscripts/bouygtel"
debug
ttyS0
defaultroute
noipdefault
usepeerdns
EOF

# cat > /etc/ppp/options.ttyS0 <<EOF
115200
EOF
</pre>

====For '''APF27'''====
{{Note| Check if /dev/ttySMX1 exists, if not create it with :
<pre class="apf">
mknod /dev/ttySMX1 c 204 42
</pre>
}}
* create the PPPd config files (''/etc/ppp/peers/bouygtel'' and ''/etc/ppp/options.ttySMX1''):
<pre class="apf">
# mkdir -p /etc/ppp/peers/
# cat > /etc/ppp/peers/bouygtel <<EOF
noauth
connect "/usr/sbin/chat -v -t 5 -f /etc/chatscripts/bouygtel"
debug
ttySMX1
defaultroute
noipdefault
usepeerdns
EOF

# cat > /etc/ppp/options.ttySMX1 <<EOF
115200
EOF
</pre>

===PPP Usage===
* Load PPP module:
<pre class="apf">
# modprobe ppp (APF27)
or
# modprobe ppp_async (APF51)
</pre>
* Setup serial port name depending on your platform (''/dev/ttyS0'' on APF51, ''/dev/ttySMX1'' on APF27)
<pre class="apf">
# export GSM_DEVICE=/dev/ttyS0
or
# export GSM_DEVICE=/dev/ttySMX1
</pre>

* Launch the beast:
<pre class="apf">
# pppd $GSM_DEVICE 115200 call bouygtel
</pre>

===Test===
<pre class="apf">
# ping www.google.fr
</pre>

=== Troubleshots ===
* Might be needed after a successful IP setup:
<pre class="apf">
# cp /etc/ppp/resolv.conf /etc/resolv.conf
# route add default ppp0 (due to defaultroute option in ppp ?)
</pre>

* To see what happened after having launched ''pppd'' or ''chat'':
<pre class="apf">
# tail -f /var/log/messages
</pre>

==GSM Muxing==
===Why ?===
* By default AT commands usage is single threaded, ie only one program can open MODEM serial port and send AT commands at a given time. However it could be interesting to be able to send multiple AT commands from multiple programs at the same time, for example in order to: have a PPP link, send SMS and monitor network signal quality.
* This can be done by a "GSM mux", if your MODEM support the GSM 07.10 muxing norm (which is the case with our HiLo modules).
===Build gsmmux===
* To build GSM mux (if not already done):
<pre class="host">
$ make menuconfig
</pre>
<pre class="config">
Package Selection for the target --->
Hardware handling --->
[*] gsmmux
Version to use (sagem) --->
</pre>
<pre class="host">
$ make
</pre>

===Use it===
* If you have access to Sagem's version (you will get as much as virtual serial port as times you pass ''/dev/ptmx'' to the daemon):
<pre class="apf">
# gsmMuxd -p $GSM_DEVICE -b 115200 -x /dev/ptmx /dev/ptmx /dev/ptmx
</pre>
* Virtual serial ports will be created in ''/dev/pts/'':
<pre class="apf">
/dev/pts/0 /dev/pts/1 /dev/pts/2
</pre>
* to know how ''/dev/ptmx'' & ''/dev/pts/x'' is working: [http://linux.die.net/man/4/ptmx]
* If you have telnet or SSH sessions running ''/dev/pts/0'' may already be used ans so virtual serial ports will be allocated from ''/dev/pts/1'', etc...

===Going further===
* In recent Linux kernels, there is also a driver to hanlde GSM muxing: n_gsm
* People wanting to do a "real" phone can take a look at [http://ofono.org/documentation ofono]

==SMS using SMS server tools 3==
Simple AT commands can be used to send SMS. If you need more flexibility or advanced management of your SMS, you can use SMS Server Tools 3.
SMS Server Tools 3 is a SMS Gateway software which can send and receive short messages through GSM modems and mobile phones.

===Build SMS Server Tools3===
* To build SMS Server Tools 3:
<pre class="host">
$ make menuconfig
</pre>
<pre class="config">
Package Selection for the target --->
Networking applications --->
[*] smstools3
(1) Number of modems to support
[*] Start SMS Server Tools at system boot
</pre>
<pre class="host">
$ make
</pre>

=== Configuration ===
The SMS server can be configured by using a configuration file ''/etc/smsd.conf''.
The following parameters have to be verified:
* device: UART port used to communicate with the modem. If GSMUX is used, then this parameter is of form ''/dev/pts/x'' where is x is the number of the virtual port
* baudrate: baudrate of the UART port
* rtscts: must be yes if your modem needs CTS/RTS controls
* incoming: say yes if you want to receive SMS

=== Usage ===
Start the smsd deamon (if not already done at boot):
<pre class="host">
# /etc/init.d/S50smsd start
</pre>
Then put a SMS file in the ''/var/spool/sms/outgoing/'' directory. Once placed a SMS will be sent. SMS file should be of the format defined [http://smstools3.kekekasvi.com/index.php?p=fileformat here].

Incoming SMS can be read in the ''/var/spool/sms/incoming/'' directory.

Reports and logs are also generated (''/var/log/smsd.log'').

==SMS using gnokii==

[[Gnokii | See gnokii page]].

==Links==
* [http://support.sagemcom.com/site/modele_fax.php?page=produit&numero_type=22&produit=877 HiLo 3G documentation at Sagem]
* [http://www.libelium.com/tienda/catalog/images/arduino/AT_Commands.pdf HiLo AT Commands]
* [http://www.developershome.com/sms/ SMS tutorial]
* http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem
* [http://www.anotherurl.com/library/at_test.htm AT Test commands]
* http://www.gsm-modem.de/gsm-faq.html
* [http://www.technologuepro.com/gsm/commande_at.htm Les commandes AT]
* [http://smstools3.kekekasvi.com SMS Server Tools 3]

[[Category:Wireless]]
[[Category:Telephony]]

GSM/GPRS

2023-08-17T13:21:35Z

JulienB:

This page will summarize informations to use the GSM/GPRS/3G module of the [[Wireless_extension_board|APF27Wireless board]], [[APF51Dev]] (optional), the [[APF6Dev]] (optional) or the RPi compatible Hats connected to OPOSxxDev RPi connector.

==Introduction==
GSM/GPRS are generally driven through the RS-232 bus. AT commands are used to dialog with the module.
* GSM MODEM of the [[Wireless_extension_board|APF27Wireless extension board (APW)]] is connected to the UART2 (/dev/ttySMX1) of the [[APF27]].
* GSM/3G MODEM of the [[APF51Dev]] is connected to the i.MX processor through an UART implemented in the FPGA. So the corresponding bitfile has to loaded before trying to access the MODEM.
* GSM/3G MODEM of the [[APF6Dev]] is connected to the UART3 of the i.MX6 processor.
They are all using a Sagem's Hilo module. Hilo AT commands can be found [http://support.sagemcom.com/site/livret/URD1_OTL_5725_1_008_72807_-_AT_Command_Set_for_SAGEMCOM_Modules__Ed_14_06_dated_11_May_2012.pdf here]

==Linux configuration (APF27Dev only)==
* Linux will have to be configured in order to tell that an APW is connected to your [[APF27Dev]]:
<pre class="host">
$ make linux-menuconfig
</pre>
<pre class="config">
System Type --->
Freescale MXC Implementations --->
...
Extension board (Wireless (APW)) --->
[*] GSM/GPRS Modem (NEW)
[ ] Bluetooth & WiFi module (NEW)
[ ] CSI (Camera) pass-through (NEW)
[ ] GPS module (NEW)
</pre>

<pre class="host">
$ make linux
</pre>
* reflash you Linux kernel

==Configure serial port==
====APF27====
<pre class="apf">
# export GSM_DEVICE=/dev/ttySMX1 (or /dev/ttymxc1 on recent kernels)
# stty -F $GSM_DEVICE raw -echo -echoe -echok 115200
</pre>

====APF51Dev====

{{Note|Don't forget to put "Wireless" J42 jumper (near microSD connector) '''AND''' power on FPGA Bank 3 (with corresponding J39 jumper).}}
* On APF51Dev, GSM/3G module is accessed through serial ports synthetized in APF51's FPGA. So we have to load it first. (Needed dual UARTs FPGA firmware can be found under armadeus-4.0 distribution in ''firmware/pod_scripts'' directory, with the [[POD]] script needed to regenerate it, and is by default installed in rootfs).
<pre class="apf">
# load_fpga /lib/firmware/fpga/apf51_gsm_gps_firmware.bin
</pre>
* Once firmware loaded, drivers related to FPGA can be used :
<pre class="apf">
# modprobe irq_ocore
# modprobe 8250
Serial: 8250/16550 driver, 4 ports, IRQ sharing disabled
# modprobe twin_uarts_irq_mng
# modprobe twin_uarts_16750
serial8250.0: ttyS0 at MMIO 0xb8000020 (irq = 320) is a TI16750
serial8250.0: ttyS1 at MMIO 0xb8000040 (irq = 321) is a TI16750
</pre>
* Bring MODEM out of reset state (POK_IN/PWON pin, connected to [[APF51_PMIC#GPIO|PMIC GPIO6]]):
<pre class="apf">
# modprobe wm831x-gpio
# echo 245 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio245/direction
# echo 1 > /sys/class/gpio/gpio245/value
</pre>
* Configure serial port:
<pre class="apf">
# ls /dev/ttyS*
/dev/ttyS0 /dev/ttyS1 /dev/ttyS2 /dev/ttyS3
</pre>

* If the /dev/ttyS[0-1] files don't exist, create it/them with ''mknod'' :
<pre class="apf">
# mknod /dev/ttyS0 c 4 64
# mknod /dev/ttyS1 c 4 65
</pre>
Then :
<pre class="apf">
# export GSM_DEVICE=/dev/ttyS0
# stty -F $GSM_DEVICE -echo -echoe -echok 115200 crtscts
</pre>

====APF6Dev====
* Power up the chip. (GSM_PWR_EN is connected to the GPIO7_13)
<pre class="apf">
# echo 205 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio205/direction
# echo 1 > /sys/class/gpio/gpio205/value
</pre>

* Start it by setting a low level pulse during about 2 seconds on the POKIN line (POKIN is connected to the GPIO1_4).
<pre class="apf">
# echo 4 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio4/direction
# echo 1 > /sys/class/gpio/gpio4/value
# sleep 2
# echo 0 > /sys/class/gpio/gpio4/value
</pre>

* Configure the serial port
<pre class="apf">
# export GSM_DEVICE=/dev/ttymxc2
# stty -F $GSM_DEVICE -echo -echoe -echok 115200
</pre>

====OPOSxxDev with RPi connector====
* Configure the serial port
<pre class="apf">
# export GSM_DEVICE=/dev/ttymxc1
# stty -F $GSM_DEVICE -echo -echoe -echok 115200
</pre>

==Basic Usage==
===Sending AT commands "manually"===
* Sending AT commands with ''minicom/microcom'' utility (one of the command coming with [[busybox]]):

{{Note|minicom has been removed in recent BSP, so use microcom instead}}

<pre class="apf">
# microcom $GSM_DEVICE
</pre>
( To exit ''microcom'' you will have to type '''<CTRL-x>''' )
* Check module presence:
<pre class="apf">
ATI3
SAGEM HiC,A.005.00

OK
</pre>

{{Note| If no echo are printed on serial console: you can't see what you're typing. In that case, to reactivate the echo, use:
<pre class="apf">
ATE1
</pre>
}}

{{Note| By default, the module starts in auto baudrate. This mays result in loss of communication with baud rate higher than 19200 bauds. To avoid problems, the baud rate has to be fixed (here to 115200 bauds):
<pre class="apf">
AT+IPR=115200
</pre>
}}

* Get constructor name:
<pre class="apf">
AT+CGMI
SAGEM

OK
</pre>
* Get model name:
<pre class="apf">
AT+CGMM
HILO GPRS

OK
</pre>
* Enter PIN code (here 0000). '''!! Use your own and beware that you will only get 3 tries !!:'''
<pre class="apf">
AT+CPIN="0000"

OK
</pre>
* Check PIN code status:
<pre class="apf">
AT+CPIN?
+CPIN: READY

OK
</pre>
{{Note|Don't launch further AT commands if PIN code wasn't entered successfully}}

* Check module status (0 Ready, 1 Unavailable, 2 Status unknown, 3 Ringing, 4 Call in progress, 5 Asleep):
<pre class="apf">
AT+CPAS
+CPAS: 0

OK
</pre>
* Get Indicator control (<battchg>[0-4],<signal>[0-4],<service>0/1,<message>0/1,<call>0/1,<smsfull>0/1):
<pre class="apf">
AT+CIND?
+CIND: 0,4,1,0,0,0,1

OK
</pre>
* Get signal quality (should be better than 12/99):
<pre class="apf">
AT+CSQ
+CSQ: 24,99

OK
</pre>
* Voice call "123456789" (; is important here to signify a voice call, otherwise a data call is tried and may fail if you don't have the right subscribe)
<pre class="apf">
ATD"123456789";
OK
</pre>
* Terminate current call:
<pre class="apf">
ATH
OK
</pre>

===Sending AT commands in shell scripts===

<source lang="bash">
GSM_DEVICE=/dev/ttyXXX
send_at_cmd()
{
echo -e -n "$1\015" > $GSM_DEVICE
sleep 1 # Adjustable ! (usleep)
}

send_at_cmd AT
</source>

* See ''target/test/test_gsm.sh'' for more details

==Sending SMS==
* Supposing you are already connected to the modem with cu
* Check if you can send SMS with your SIM card (you should get +CMGF: (0,1))
<pre class="apf">
AT+CMGF=?
</pre>
* If OK, switch to SMS sending mode:
<pre class="apf">
AT+CMGF=1
</pre>
* Write a message for 0661234567 phone number:
<pre class="apf">
AT+CMGW="0661326109"

> Hey ! How are you doing ??
> <-- Ctrl+z to end SMS here

+CMGW: 8
</pre>
* +CMGW give you the number of your SMS saved in SIM card or phone memory
* Then, at anytime, you can send your SMS with (pass previous number as parameter):
<pre class="apf">
AT+CMSS=8
</pre>

==Tools to look at==
* http://www.developershome.com/sms/freeLibForSMS.asp
* http://www.gnokii.org/
* http://www.alamin.org/en/index.html
* http://www.gammu.org/wiki/index.php?title=Gammu:Main_Page
* http://gatling.ikk.sztaki.hu/~kissg/gsm/index.html

==Data tranfers (EDGE/3G)==

===PPP installation (done by default on APF51)===
<pre class="host">
$ make linux-menuconfig
</pre>

<pre class="config">
Device Drivers --->
[*] Network device support --->
<M> PPP (point-to-point protocol) support
[ ] PPP multilink support (EXPERIMENTAL)
[ ] PPP filtering
<M> PPP support for async serial ports
< > PPP support for sync tty ports
< > PPP Deflate compression
< > PPP BSD-Compress compression
< > PPP MPPE compression (encryption) (EXPERIMENTAL)
< > PPP over Ethernet (EXPERIMENTAL)
</pre>

<pre class="host">
$ make menuconfig
</pre>

<pre class="config">
Package Selection for the target --->
Networking applications --->
[*] pppd
[ ] filtering
[ ] radius
</pre>

<pre class="host">
$ make linux && make
</pre>

* reflash kernel & rootfs

===PPP configuration===
{{Note|Following instructions are given for the French operator "Bouygtel" and may need to be ajusted accordingly, depending on your operator/country}}

* Create a "chat" script that will be used to initiate MODEM dialup (here we use the "cat > xxxx << EOF trick" to automatically create the file, but you can also manually edit it with ''vi'' or ''nano''):
<pre class="apf">
# mkdir -p /etc/chatscripts/
# cat > /etc/chatscripts/bouygtel <<EOF
ABORT BUSY ABORT 'NO CARRIER' ABORT VOICE ABORT 'NO DIALTONE' ABORT 'NO ANSWER' ABORT DELAYED ABORT ERROR
'' AT
OK AT+IPR=115200
OK AT+CPIN="0000"
OK AT+CFUN=1
OK AT+COPS?
OK AT+CSQ
OK 'AT+CGDCONT=1,"IP","ebouygtel.com","",0,0'
OK 'AT&FE0Q0V1'
OK 'ATD*99#'
CONNECT ""
EOF
</pre>
* Don't forget to set the baudrate (default: 115200) to have a stable communication between the modem and the processor
* Don't forget to update "AT+CPIN=" with your real PIN code and "AT+CGDCONT" and "ATD*99#" with your operator parameters.
* If you want to test your chat script (verbose mode -v, on console -s, with 5 second timeout by default for commands -t 5), then launch:
<pre class="apf">
# /usr/sbin/chat -v -s -t 5 -f /etc/chatscripts/bouygtel > $GSM_DEVICE < $GSM_DEVICE
</pre>
* If this test was OK, you may have to poweroff/poweron the MODEM to bring it to its initial state and go further.

====For '''APF51'''====
* create the PPPd config files (''/etc/ppp/peers/bouygtel'' and ''/etc/ppp/options.ttyS0''):
<pre class="apf">
# mkdir -p /etc/ppp/peers/
# cat > /etc/ppp/peers/bouygtel <<EOF
noauth
connect "/usr/sbin/chat -v -t 5 -f /etc/chatscripts/bouygtel"
debug
ttyS0
defaultroute
noipdefault
usepeerdns
EOF

# cat > /etc/ppp/options.ttyS0 <<EOF
115200
EOF
</pre>

====For '''APF27'''====
{{Note| Check if /dev/ttySMX1 exists, if not create it with :
<pre class="apf">
mknod /dev/ttySMX1 c 204 42
</pre>
}}
* create the PPPd config files (''/etc/ppp/peers/bouygtel'' and ''/etc/ppp/options.ttySMX1''):
<pre class="apf">
# mkdir -p /etc/ppp/peers/
# cat > /etc/ppp/peers/bouygtel <<EOF
noauth
connect "/usr/sbin/chat -v -t 5 -f /etc/chatscripts/bouygtel"
debug
ttySMX1
defaultroute
noipdefault
usepeerdns
EOF

# cat > /etc/ppp/options.ttySMX1 <<EOF
115200
EOF
</pre>

===PPP Usage===
* Load PPP module:
<pre class="apf">
# modprobe ppp (APF27)
or
# modprobe ppp_async (APF51)
</pre>
* Setup serial port name depending on your platform (''/dev/ttyS0'' on APF51, ''/dev/ttySMX1'' on APF27)
<pre class="apf">
# export GSM_DEVICE=/dev/ttyS0
or
# export GSM_DEVICE=/dev/ttySMX1
</pre>

* Launch the beast:
<pre class="apf">
# pppd $GSM_DEVICE 115200 call bouygtel
</pre>

===Test===
<pre class="apf">
# ping www.google.fr
</pre>

=== Troubleshots ===
* Might be needed after a successful IP setup:
<pre class="apf">
# cp /etc/ppp/resolv.conf /etc/resolv.conf
# route add default ppp0 (due to defaultroute option in ppp ?)
</pre>

* To see what happened after having launched ''pppd'' or ''chat'':
<pre class="apf">
# tail -f /var/log/messages
</pre>

==GSM Muxing==
===Why ?===
* By default AT commands usage is single threaded, ie only one program can open MODEM serial port and send AT commands at a given time. However it could be interesting to be able to send multiple AT commands from multiple programs at the same time, for example in order to: have a PPP link, send SMS and monitor network signal quality.
* This can be done by a "GSM mux", if your MODEM support the GSM 07.10 muxing norm (which is the case with our HiLo modules).
===Build gsmmux===
* To build GSM mux (if not already done):
<pre class="host">
$ make menuconfig
</pre>
<pre class="config">
Package Selection for the target --->
Hardware handling --->
[*] gsmmux
Version to use (sagem) --->
</pre>
<pre class="host">
$ make
</pre>

===Use it===
* If you have access to Sagem's version (you will get as much as virtual serial port as times you pass ''/dev/ptmx'' to the daemon):
<pre class="apf">
# gsmMuxd -p $GSM_DEVICE -b 115200 -x /dev/ptmx /dev/ptmx /dev/ptmx
</pre>
* Virtual serial ports will be created in ''/dev/pts/'':
<pre class="apf">
/dev/pts/0 /dev/pts/1 /dev/pts/2
</pre>
* to know how ''/dev/ptmx'' & ''/dev/pts/x'' is working: [http://linux.die.net/man/4/ptmx]
* If you have telnet or SSH sessions running ''/dev/pts/0'' may already be used ans so virtual serial ports will be allocated from ''/dev/pts/1'', etc...

===Going further===
* In recent Linux kernels, there is also a driver to hanlde GSM muxing: n_gsm
* People wanting to do a "real" phone can take a look at [http://ofono.org/documentation ofono]

==SMS using SMS server tools 3==
Simple AT commands can be used to send SMS. If you need more flexibility or advanced management of your SMS, you can use SMS Server Tools 3.
SMS Server Tools 3 is a SMS Gateway software which can send and receive short messages through GSM modems and mobile phones.

===Build SMS Server Tools3===
* To build SMS Server Tools 3:
<pre class="host">
$ make menuconfig
</pre>
<pre class="config">
Package Selection for the target --->
Networking applications --->
[*] smstools3
(1) Number of modems to support
[*] Start SMS Server Tools at system boot
</pre>
<pre class="host">
$ make
</pre>

=== Configuration ===
The SMS server can be configured by using a configuration file ''/etc/smsd.conf''.
The following parameters have to be verified:
* device: UART port used to communicate with the modem. If GSMUX is used, then this parameter is of form ''/dev/pts/x'' where is x is the number of the virtual port
* baudrate: baudrate of the UART port
* rtscts: must be yes if your modem needs CTS/RTS controls
* incoming: say yes if you want to receive SMS

=== Usage ===
Start the smsd deamon (if not already done at boot):
<pre class="host">
# /etc/init.d/S50smsd start
</pre>
Then put a SMS file in the ''/var/spool/sms/outgoing/'' directory. Once placed a SMS will be sent. SMS file should be of the format defined [http://smstools3.kekekasvi.com/index.php?p=fileformat here].

Incoming SMS can be read in the ''/var/spool/sms/incoming/'' directory.

Reports and logs are also generated (''/var/log/smsd.log'').

==SMS using gnokii==

[[Gnokii | See gnokii page]].

==Links==
* [http://support.sagemcom.com/site/modele_fax.php?page=produit&numero_type=22&produit=877 HiLo 3G documentation at Sagem]
* [http://www.libelium.com/tienda/catalog/images/arduino/AT_Commands.pdf HiLo AT Commands]
* [http://www.developershome.com/sms/ SMS tutorial]
* http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem
* [http://www.anotherurl.com/library/at_test.htm AT Test commands]
* http://www.gsm-modem.de/gsm-faq.html
* [http://www.technologuepro.com/gsm/commande_at.htm Les commandes AT]
* [http://smstools3.kekekasvi.com SMS Server Tools 3]

[[Category:Wireless]]
[[Category:Telephony]]

GSM/GPRS

2023-08-17T13:20:24Z

JulienB: /* APF6Dev */

This page will summarize informations to use the GSM/GPRS/3G module of the [[Wireless_extension_board|APF27Wireless board]], [[APF51Dev]] (optional) and the [[APF6Dev]] (optional).

==Introduction==
GSM/GPRS are generally driven through the RS-232 bus. AT commands are used to dialog with the module.
* GSM MODEM of the [[Wireless_extension_board|APF27Wireless extension board (APW)]] is connected to the UART2 (/dev/ttySMX1) of the [[APF27]].
* GSM/3G MODEM of the [[APF51Dev]] is connected to the i.MX processor through an UART implemented in the FPGA. So the corresponding bitfile has to loaded before trying to access the MODEM.
* GSM/3G MODEM of the [[APF6Dev]] is connected to the UART3 of the i.MX6 processor.
They are all using a Sagem's Hilo module. Hilo AT commands can be found [http://support.sagemcom.com/site/livret/URD1_OTL_5725_1_008_72807_-_AT_Command_Set_for_SAGEMCOM_Modules__Ed_14_06_dated_11_May_2012.pdf here]

==Linux configuration (APF27Dev only)==
* Linux will have to be configured in order to tell that an APW is connected to your [[APF27Dev]]:
<pre class="host">
$ make linux-menuconfig
</pre>
<pre class="config">
System Type --->
Freescale MXC Implementations --->
...
Extension board (Wireless (APW)) --->
[*] GSM/GPRS Modem (NEW)
[ ] Bluetooth & WiFi module (NEW)
[ ] CSI (Camera) pass-through (NEW)
[ ] GPS module (NEW)
</pre>

<pre class="host">
$ make linux
</pre>
* reflash you Linux kernel

==Configure serial port==
====APF27====
<pre class="apf">
# export GSM_DEVICE=/dev/ttySMX1 (or /dev/ttymxc1 on recent kernels)
# stty -F $GSM_DEVICE raw -echo -echoe -echok 115200
</pre>

====APF51Dev====

{{Note|Don't forget to put "Wireless" J42 jumper (near microSD connector) '''AND''' power on FPGA Bank 3 (with corresponding J39 jumper).}}
* On APF51Dev, GSM/3G module is accessed through serial ports synthetized in APF51's FPGA. So we have to load it first. (Needed dual UARTs FPGA firmware can be found under armadeus-4.0 distribution in ''firmware/pod_scripts'' directory, with the [[POD]] script needed to regenerate it, and is by default installed in rootfs).
<pre class="apf">
# load_fpga /lib/firmware/fpga/apf51_gsm_gps_firmware.bin
</pre>
* Once firmware loaded, drivers related to FPGA can be used :
<pre class="apf">
# modprobe irq_ocore
# modprobe 8250
Serial: 8250/16550 driver, 4 ports, IRQ sharing disabled
# modprobe twin_uarts_irq_mng
# modprobe twin_uarts_16750
serial8250.0: ttyS0 at MMIO 0xb8000020 (irq = 320) is a TI16750
serial8250.0: ttyS1 at MMIO 0xb8000040 (irq = 321) is a TI16750
</pre>
* Bring MODEM out of reset state (POK_IN/PWON pin, connected to [[APF51_PMIC#GPIO|PMIC GPIO6]]):
<pre class="apf">
# modprobe wm831x-gpio
# echo 245 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio245/direction
# echo 1 > /sys/class/gpio/gpio245/value
</pre>
* Configure serial port:
<pre class="apf">
# ls /dev/ttyS*
/dev/ttyS0 /dev/ttyS1 /dev/ttyS2 /dev/ttyS3
</pre>

* If the /dev/ttyS[0-1] files don't exist, create it/them with ''mknod'' :
<pre class="apf">
# mknod /dev/ttyS0 c 4 64
# mknod /dev/ttyS1 c 4 65
</pre>
Then :
<pre class="apf">
# export GSM_DEVICE=/dev/ttyS0
# stty -F $GSM_DEVICE -echo -echoe -echok 115200 crtscts
</pre>

====APF6Dev====
* Power up the chip. (GSM_PWR_EN is connected to the GPIO7_13)
<pre class="apf">
# echo 205 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio205/direction
# echo 1 > /sys/class/gpio/gpio205/value
</pre>

* Start it by setting a low level pulse during about 2 seconds on the POKIN line (POKIN is connected to the GPIO1_4).
<pre class="apf">
# echo 4 > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio4/direction
# echo 1 > /sys/class/gpio/gpio4/value
# sleep 2
# echo 0 > /sys/class/gpio/gpio4/value
</pre>

* Configure the serial port
<pre class="apf">
# export GSM_DEVICE=/dev/ttymxc2
# stty -F $GSM_DEVICE -echo -echoe -echok 115200
</pre>

====OPOSxxDev with RPi connector====
* Configure the serial port
<pre class="apf">
# export GSM_DEVICE=/dev/ttymxc1
# stty -F $GSM_DEVICE -echo -echoe -echok 115200
</pre>

==Basic Usage==
===Sending AT commands "manually"===
* Sending AT commands with ''minicom/microcom'' utility (one of the command coming with [[busybox]]):

{{Note|minicom has been removed in recent BSP, so use microcom instead}}

<pre class="apf">
# microcom $GSM_DEVICE
</pre>
( To exit ''microcom'' you will have to type '''<CTRL-x>''' )
* Check module presence:
<pre class="apf">
ATI3
SAGEM HiC,A.005.00

OK
</pre>

{{Note| If no echo are printed on serial console: you can't see what you're typing. In that case, to reactivate the echo, use:
<pre class="apf">
ATE1
</pre>
}}

{{Note| By default, the module starts in auto baudrate. This mays result in loss of communication with baud rate higher than 19200 bauds. To avoid problems, the baud rate has to be fixed (here to 115200 bauds):
<pre class="apf">
AT+IPR=115200
</pre>
}}

* Get constructor name:
<pre class="apf">
AT+CGMI
SAGEM

OK
</pre>
* Get model name:
<pre class="apf">
AT+CGMM
HILO GPRS

OK
</pre>
* Enter PIN code (here 0000). '''!! Use your own and beware that you will only get 3 tries !!:'''
<pre class="apf">
AT+CPIN="0000"

OK
</pre>
* Check PIN code status:
<pre class="apf">
AT+CPIN?
+CPIN: READY

OK
</pre>
{{Note|Don't launch further AT commands if PIN code wasn't entered successfully}}

* Check module status (0 Ready, 1 Unavailable, 2 Status unknown, 3 Ringing, 4 Call in progress, 5 Asleep):
<pre class="apf">
AT+CPAS
+CPAS: 0

OK
</pre>
* Get Indicator control (<battchg>[0-4],<signal>[0-4],<service>0/1,<message>0/1,<call>0/1,<smsfull>0/1):
<pre class="apf">
AT+CIND?
+CIND: 0,4,1,0,0,0,1

OK
</pre>
* Get signal quality (should be better than 12/99):
<pre class="apf">
AT+CSQ
+CSQ: 24,99

OK
</pre>
* Voice call "123456789" (; is important here to signify a voice call, otherwise a data call is tried and may fail if you don't have the right subscribe)
<pre class="apf">
ATD"123456789";
OK
</pre>
* Terminate current call:
<pre class="apf">
ATH
OK
</pre>

===Sending AT commands in shell scripts===

<source lang="bash">
GSM_DEVICE=/dev/ttyXXX
send_at_cmd()
{
echo -e -n "$1\015" > $GSM_DEVICE
sleep 1 # Adjustable ! (usleep)
}

send_at_cmd AT
</source>

* See ''target/test/test_gsm.sh'' for more details

==Sending SMS==
* Supposing you are already connected to the modem with cu
* Check if you can send SMS with your SIM card (you should get +CMGF: (0,1))
<pre class="apf">
AT+CMGF=?
</pre>
* If OK, switch to SMS sending mode:
<pre class="apf">
AT+CMGF=1
</pre>
* Write a message for 0661234567 phone number:
<pre class="apf">
AT+CMGW="0661326109"

> Hey ! How are you doing ??
> <-- Ctrl+z to end SMS here

+CMGW: 8
</pre>
* +CMGW give you the number of your SMS saved in SIM card or phone memory
* Then, at anytime, you can send your SMS with (pass previous number as parameter):
<pre class="apf">
AT+CMSS=8
</pre>

==Tools to look at==
* http://www.developershome.com/sms/freeLibForSMS.asp
* http://www.gnokii.org/
* http://www.alamin.org/en/index.html
* http://www.gammu.org/wiki/index.php?title=Gammu:Main_Page
* http://gatling.ikk.sztaki.hu/~kissg/gsm/index.html

==Data tranfers (EDGE/3G)==

===PPP installation (done by default on APF51)===
<pre class="host">
$ make linux-menuconfig
</pre>

<pre class="config">
Device Drivers --->
[*] Network device support --->
<M> PPP (point-to-point protocol) support
[ ] PPP multilink support (EXPERIMENTAL)
[ ] PPP filtering
<M> PPP support for async serial ports
< > PPP support for sync tty ports
< > PPP Deflate compression
< > PPP BSD-Compress compression
< > PPP MPPE compression (encryption) (EXPERIMENTAL)
< > PPP over Ethernet (EXPERIMENTAL)
</pre>

<pre class="host">
$ make menuconfig
</pre>

<pre class="config">
Package Selection for the target --->
Networking applications --->
[*] pppd
[ ] filtering
[ ] radius
</pre>

<pre class="host">
$ make linux && make
</pre>

* reflash kernel & rootfs

===PPP configuration===
{{Note|Following instructions are given for the French operator "Bouygtel" and may need to be ajusted accordingly, depending on your operator/country}}

* Create a "chat" script that will be used to initiate MODEM dialup (here we use the "cat > xxxx << EOF trick" to automatically create the file, but you can also manually edit it with ''vi'' or ''nano''):
<pre class="apf">
# mkdir -p /etc/chatscripts/
# cat > /etc/chatscripts/bouygtel <<EOF
ABORT BUSY ABORT 'NO CARRIER' ABORT VOICE ABORT 'NO DIALTONE' ABORT 'NO ANSWER' ABORT DELAYED ABORT ERROR
'' AT
OK AT+IPR=115200
OK AT+CPIN="0000"
OK AT+CFUN=1
OK AT+COPS?
OK AT+CSQ
OK 'AT+CGDCONT=1,"IP","ebouygtel.com","",0,0'
OK 'AT&FE0Q0V1'
OK 'ATD*99#'
CONNECT ""
EOF
</pre>
* Don't forget to set the baudrate (default: 115200) to have a stable communication between the modem and the processor
* Don't forget to update "AT+CPIN=" with your real PIN code and "AT+CGDCONT" and "ATD*99#" with your operator parameters.
* If you want to test your chat script (verbose mode -v, on console -s, with 5 second timeout by default for commands -t 5), then launch:
<pre class="apf">
# /usr/sbin/chat -v -s -t 5 -f /etc/chatscripts/bouygtel > $GSM_DEVICE < $GSM_DEVICE
</pre>
* If this test was OK, you may have to poweroff/poweron the MODEM to bring it to its initial state and go further.

====For '''APF51'''====
* create the PPPd config files (''/etc/ppp/peers/bouygtel'' and ''/etc/ppp/options.ttyS0''):
<pre class="apf">
# mkdir -p /etc/ppp/peers/
# cat > /etc/ppp/peers/bouygtel <<EOF
noauth
connect "/usr/sbin/chat -v -t 5 -f /etc/chatscripts/bouygtel"
debug
ttyS0
defaultroute
noipdefault
usepeerdns
EOF

# cat > /etc/ppp/options.ttyS0 <<EOF
115200
EOF
</pre>

====For '''APF27'''====
{{Note| Check if /dev/ttySMX1 exists, if not create it with :
<pre class="apf">
mknod /dev/ttySMX1 c 204 42
</pre>
}}
* create the PPPd config files (''/etc/ppp/peers/bouygtel'' and ''/etc/ppp/options.ttySMX1''):
<pre class="apf">
# mkdir -p /etc/ppp/peers/
# cat > /etc/ppp/peers/bouygtel <<EOF
noauth
connect "/usr/sbin/chat -v -t 5 -f /etc/chatscripts/bouygtel"
debug
ttySMX1
defaultroute
noipdefault
usepeerdns
EOF

# cat > /etc/ppp/options.ttySMX1 <<EOF
115200
EOF
</pre>

===PPP Usage===
* Load PPP module:
<pre class="apf">
# modprobe ppp (APF27)
or
# modprobe ppp_async (APF51)
</pre>
* Setup serial port name depending on your platform (''/dev/ttyS0'' on APF51, ''/dev/ttySMX1'' on APF27)
<pre class="apf">
# export GSM_DEVICE=/dev/ttyS0
or
# export GSM_DEVICE=/dev/ttySMX1
</pre>

* Launch the beast:
<pre class="apf">
# pppd $GSM_DEVICE 115200 call bouygtel
</pre>

===Test===
<pre class="apf">
# ping www.google.fr
</pre>

=== Troubleshots ===
* Might be needed after a successful IP setup:
<pre class="apf">
# cp /etc/ppp/resolv.conf /etc/resolv.conf
# route add default ppp0 (due to defaultroute option in ppp ?)
</pre>

* To see what happened after having launched ''pppd'' or ''chat'':
<pre class="apf">
# tail -f /var/log/messages
</pre>

==GSM Muxing==
===Why ?===
* By default AT commands usage is single threaded, ie only one program can open MODEM serial port and send AT commands at a given time. However it could be interesting to be able to send multiple AT commands from multiple programs at the same time, for example in order to: have a PPP link, send SMS and monitor network signal quality.
* This can be done by a "GSM mux", if your MODEM support the GSM 07.10 muxing norm (which is the case with our HiLo modules).
===Build gsmmux===
* To build GSM mux (if not already done):
<pre class="host">
$ make menuconfig
</pre>
<pre class="config">
Package Selection for the target --->
Hardware handling --->
[*] gsmmux
Version to use (sagem) --->
</pre>
<pre class="host">
$ make
</pre>

===Use it===
* If you have access to Sagem's version (you will get as much as virtual serial port as times you pass ''/dev/ptmx'' to the daemon):
<pre class="apf">
# gsmMuxd -p $GSM_DEVICE -b 115200 -x /dev/ptmx /dev/ptmx /dev/ptmx
</pre>
* Virtual serial ports will be created in ''/dev/pts/'':
<pre class="apf">
/dev/pts/0 /dev/pts/1 /dev/pts/2
</pre>
* to know how ''/dev/ptmx'' & ''/dev/pts/x'' is working: [http://linux.die.net/man/4/ptmx]
* If you have telnet or SSH sessions running ''/dev/pts/0'' may already be used ans so virtual serial ports will be allocated from ''/dev/pts/1'', etc...

===Going further===
* In recent Linux kernels, there is also a driver to hanlde GSM muxing: n_gsm
* People wanting to do a "real" phone can take a look at [http://ofono.org/documentation ofono]

==SMS using SMS server tools 3==
Simple AT commands can be used to send SMS. If you need more flexibility or advanced management of your SMS, you can use SMS Server Tools 3.
SMS Server Tools 3 is a SMS Gateway software which can send and receive short messages through GSM modems and mobile phones.

===Build SMS Server Tools3===
* To build SMS Server Tools 3:
<pre class="host">
$ make menuconfig
</pre>
<pre class="config">
Package Selection for the target --->
Networking applications --->
[*] smstools3
(1) Number of modems to support
[*] Start SMS Server Tools at system boot
</pre>
<pre class="host">
$ make
</pre>

=== Configuration ===
The SMS server can be configured by using a configuration file ''/etc/smsd.conf''.
The following parameters have to be verified:
* device: UART port used to communicate with the modem. If GSMUX is used, then this parameter is of form ''/dev/pts/x'' where is x is the number of the virtual port
* baudrate: baudrate of the UART port
* rtscts: must be yes if your modem needs CTS/RTS controls
* incoming: say yes if you want to receive SMS

=== Usage ===
Start the smsd deamon (if not already done at boot):
<pre class="host">
# /etc/init.d/S50smsd start
</pre>
Then put a SMS file in the ''/var/spool/sms/outgoing/'' directory. Once placed a SMS will be sent. SMS file should be of the format defined [http://smstools3.kekekasvi.com/index.php?p=fileformat here].

Incoming SMS can be read in the ''/var/spool/sms/incoming/'' directory.

Reports and logs are also generated (''/var/log/smsd.log'').

==SMS using gnokii==

[[Gnokii | See gnokii page]].

==Links==
* [http://support.sagemcom.com/site/modele_fax.php?page=produit&numero_type=22&produit=877 HiLo 3G documentation at Sagem]
* [http://www.libelium.com/tienda/catalog/images/arduino/AT_Commands.pdf HiLo AT Commands]
* [http://www.developershome.com/sms/ SMS tutorial]
* http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem
* [http://www.anotherurl.com/library/at_test.htm AT Test commands]
* http://www.gsm-modem.de/gsm-faq.html
* [http://www.technologuepro.com/gsm/commande_at.htm Les commandes AT]
* [http://smstools3.kekekasvi.com SMS Server Tools 3]

[[Category:Wireless]]
[[Category:Telephony]]

WPA supplicant

2023-05-04T21:33:58Z

JulienB: /* Usage */

When dealing with "strong" encryption of Wi-Fi networks, you have to setup a WPA or WPA2 configuration.
To handle the requirements of these protocols during association, a userspace daemon is needed: it is called a "WPA supplicant".
The most used one on Linux is ''wpa_supplicant''; we will see here how to install and configure it.

{{Note|''wpa_supplicant'' is also able to handle WEP or unencrypted connections}}

==Installation==
* Done by default if your board supports Wi-Fi connectivity. Otherwise:
<pre class="host">
$ make menuconfig
</pre>

<pre class="config">
Package Selection for the target --->
Networking --->
[*] wpa_supplicant
[ ] Enable WPA with EAP
[*] Install wpa_cli binary
[*] Install wpa_passphrase binary
</pre>

EAP is only needed if you plan to use WPA in Enterprise mode == with a Radius server.

==Usage==
''wpa_supplicant'' needs a configuration file in ''/etc/wpa_supplicant.conf''.
For your convience a generic ''/etc/wpa_supplicant.conf'' is already installed in the Armadeus BSP (releases > 5.2).
Here is an example (WPA pre-shared key (TKIP)):
<pre class="host">
ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=wheel
update_config=1
network={
ssid="''SSID''"
scan_ssid=1 # only if ssid is hidden
proto=WPA
key_mgmt=WPA-PSK
pairwise=TKIP
psk="''PASSPHRASE''"
}
</pre>
You can adapt ''/etc/wpa_supplicant.conf'' manually.
* If your key needs to be encrypted, use the ''wpa_passphrase'' tool to add your network (SSID/PASSPHRASE) automatically:
<pre class="apf">
# wpa_passphrase "mynetworkSSID" "mynetworkPASSPHRASE" >> /etc/wpa_supplicant.conf
</pre>
* Be sure to have your Wi-Fi chipset driver loaded:
<pre class="apf">
# modprobe libertas_sdio
or
# modprobe wlcore_sdio
or
# modprobe rt73usb
# modprobe rt2800_usb
# modprobe zd1211rw
# modprobe rtl8187
# modprobe r8712u
...
</pre>
* Bring up the wireless interface:
<pre class="apf">
# ip link set dev wlan0 up
</pre>
or (as you prefer):
<pre class="apf">
# ifconfig wlan0 up
</pre>
* Then you can create the Wi-Fi connection with WPA Supplicant:
<pre class="apf">
# wpa_supplicant -Dnl80211 -i wlan0 -c /etc/wpa_supplicant.conf -B
</pre>
* If you want a script executed each time Wi-Fi Association is done:
<pre class="apf">
# wpa_cli -B -a /etc/wpa_supplicant/wpa_cli-action.sh
# /etc/wpa_supplicant/wpa_cli-action.sh wlan0 CONNECTED # to force ip renewal if needed (first time)
</pre>
* Then you can check your Wi-Fi interface is available:
<pre class="apf">
# iwconfig wlan0
wlan0 IEEE 802.11abgn ESSID:"xxxx_xxxx"
Mode:Managed Frequency:5.2 GHz Access Point: 00:xx:xx:xx:xx:xx
Bit Rate=24 Mb/s Tx-Power=20 dBm
Retry long limit:7 RTS thr:off Fragment thr:off
Encryption key:off
Power Management:on
Link Quality=29/70 Signal level=-81 dBm
Rx invalid nwid:0 Rx invalid crypt:0 Rx invalid frag:0
Tx excessive retries:0 Invalid misc:0 Missed beacon:0

# ifconfig wlan0
wlan0 Link encap:Ethernet HWaddr 00:xx:xx:xx:xx:xx
inet addr:192.168.0.20 Bcast:192.168.0.255 Mask:255.255.255.0
inet6 addr: 2a01:e35:2e35:f60:219:88ff:fe15:4237/64 Scope:Global
inet6 addr: fe80::219:88ff:fe15:4237/64 Scope:Link
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
RX packets:80 errors:0 dropped:0 overruns:0 frame:0
TX packets:14 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:1000
RX bytes:14238 (13.9 KiB) TX bytes:2797 (2.7 KiB)
</pre>

==Automate things at startup==
===Standard method===
* In default BSP you have a ''/etc/init.d/S40Network'' script which will automatically starts all network interfaces configured in ''/etc/network/interfaces''.
* All you have to do is to add your Wi-Fi interface configuration in ''/etc/network/interfaces'', like for example on [[OPOS6UL]]:
<pre class="apf">
auto wlan0
iface wlan0 inet dhcp
pre-up modprobe brcmfmac
pre-up sleep 3
pre-up wpa_supplicant -Dwext -i wlan0 -c /etc/wpa_supplicant.conf -B
</pre>

===Other methods===
* You can also choose to use a custom startup script. Here is an init script example, to adapt to your Wi-Fi driver (update WIFIDRIVERS in the source) and to place into ''/etc/init.d/S61wifi'' (do not forget to give it execution rigths with ''chmod a+x /etc/init.d/S61wifi''):
<source lang="bash">
#!/bin/sh
#
# Starts Wi-Fi services
#
# do not forget to update your wpa_supplicant configuration
# wpa_passphrase "mynetworrssid" "mynetworkpassphrase" >> /etc/wpa_supplicant.conf
#
export WIFIDRIVERS=libertas_sdio
case "$1" in
start)
echo "Starting Wi-Fi"
modprobe $WIFIDRIVERS
ip link set dev wlan0 up
wpa_supplicant -Dwext -i wlan0 -c /etc/wpa_supplicant.conf -B
wpa_cli -B -a /etc/wpa_supplicant/wpa_cli-action.sh
;;

stop)
echo "Stoping Wi-Fi"
wpa_cli -i wlan0 disconnect
wpa_cli -i wlan0 terminate
ip link set dev wlan0 down
rmmod -a $WIFIDRIVERS
;;

restart)
$0 stop
sleep 1
$0 start
;;

*)
echo "Usage: $0 {start|stop|restart}"
exit 1
;;
esac

exit 0

</source>

==Stop it==
To stop WPA Supplicant daemon and switch off the connexion, you can use this command:
<pre class="apf">
# wpa_cli terminate
</pre>
or by using the S61wifi script here above:

<pre class="apf">
# /etc/init.d/S61wifi stop
</pre>

==Links==
* [http://hostap.epitest.fi/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/README wpa_supplicant README]
* [http://hostap.epitest.fi/wpa_supplicant/ wpa_supplicant Webpage]

[[Category:Wireless]]
[[Category:Security]]
[[Category:WiFi]]
[[Category:Network]]

APF6Dev

2023-01-20T12:48:26Z

JulienB: /* Linux */

[[Category: APF6]]

==Description==
This is the Armadeus System's standard development board/baseboard for the [[APF6]] module.

The following options are available:
* [[GPS]]
* [[Gsm|GSM]]

==Errata==
* As the board is also used for [[APF6_SP]] module (APF6+FPGA), you might experience some miscellaneous FPGA LED blinking (beside "FPGA_SW" button) when no FPGA is present.

==Resources==

* [[Datasheet#APF6Dev | Datasheet and schematics]]
* [http://www.armadeus.com/english/products-development_boards-apf6_dev.html Product page on Armadeus Systems website]

==Feature list==

{| border="0" cellpadding="5" cellspacing="5" summary="Hardware Add-Ons by functionnalities"
|----------------
|- style="background:#f4f4f4; color:black; -moz-border-radius:18px;"
|

===Audio===
* [[SGTL5000]]: audio in/out
* [[ALSA]]

===Video Out===
* [[LCD]]
* [[BackLight]]
* [[FrameBuffer]]
* HDMI

===Video In===
*[[Camera interface]]
||
===User Input===
* [[Tslib|Touchscreen]] (SX8654)

===Wired communication===
* [[Uart|UART]]
* [[SPI]]
* [[I2C]]
* [[USB Host]]
* [[USB_OTG]]
* [[USB_Gadget]]
* [[CAN_bus_Linux_driver|CAN bus]]
* [[PCIE]]

===Storage===
* [[MultiMediaCard]]
* [[SATA]]
||
===Realtime clock===
* [[RTC]]

===Wireless communication===
* [[Wifi|WiFi usage on Linux]]
* [[Bluetooth|Bluetooth usage on Linux]]

=== FPGA connections ===

* [[HSMC | HSMC connector]]
* [[JTAG]]
* [[Button]]
* [[Led]]

===Other===
* [[PWM]]: PWM3 output is on J2 pin 26 (2.8V output), but also used by LCD backlight !
* [[GPIOlib]]
* [[JTAG]]

|}

==Connectors==
{| cellpadding="5" cellspacing="0"
|-

[[File:APF6Dev.jpeg| align=left]]

||

{| border="1" cellpadding="5" cellspacing="0" summary="APF6Dev connectors"
|- style="background:#efefef;" align="center"
! Name !! Function
|- align="center"
| J17 || Gigabit Ethernet
|- align="center"
| J15 || HDMI
|- align="center"
| J33 || Audio (Out/Up, In/Down)
|- align="center"
| J29 || Power (12V)
|- align="center"
| J36 || JTAG
|- align="center"
| J5 || Extension 1
|- align="center"
| J18 || Extension 2
|}

|}

==Tips==
===U-Boot===
* To use 7" 800x480 LCD with 3.10/3.14/4.1 legacy kernels:
<pre class="apf">
BIOS> setenv extrabootargs video=mxcfb0:dev=lcd,800x480@60,if=RGB666,bpp=32
</pre>
then, after having booted Linux, do:
<pre class="apf">
root@apf6 ~ # fbset > /etc/fb.modes
</pre>

* Activating HDMI console with USB keyboard in U-Boot (since armadeus-6.0):
<pre class="apf">
BIOS> usb start
BIOS> setenv stdout serial,vga
BIOS> setenv stderr serial,vga
BIOS> setenv stdin serial,usbkbd
</pre>
keyboard map is english one and it seems not possible to change it (U-Boot 2014.07) ?

* Use APF6Dev "User" LED in U-Boot scripts:
If you have a recent U-Boot, supporting gpio command:
<pre class="apf">
BIOS> gpio set 204
...
BIOS> gpio clear 204
</pre>
Otherwise, you can do it 'the old way'; declare GPIO Port 7 Pin 12 (connected to the LED) as GPIO:
<pre class="apf">
BIOS> md.l 0x020b4004 1
020b4004: 00000100
BIOS> mw.l 0x020b4004 0x00001100 (set bit 12)
</pre>
Switch LED on:
<pre class="apf">
BIOS> md.l 0x020b4000 1
020b4000: 00000f04
BIOS> mw.l 0x020b4000 0x00001f04 (set bit 12)
</pre>
Switch LED off:
<pre class="apf">
BIOS> mw.l 0x020b4000 0x00000f04 (clear bit 12)
</pre>

* Use APF6Dev "User" Button (GPIO Port 1 Pin 9) in U-Boot scripts:
If you have a recent U-Boot, supporting ''gpio'' command:
<pre class="apf">
BIOS> setenv user_button 'gpio input 204'
BIOS> if run user_button; then echo "Button pressed"; fi
gpio: pin 9 (gpio 9) value is 0 (if pressed)
Button pressed
</pre>
Otherwise, you can do it 'the old way':
<pre class="apf">
BIOS> setenv user_button 'setexpr.l toto *0x0209c000 \\& 0x200; if itest ${toto} -eq 0; then true; else false; fi'
BIOS> if run user_button; then echo "Button pressed"; fi
</pre>

* Detect USB OTG cable presence:

<pre class="apf">
BIOS> setenv usb_cable 'setexpr.l toto *0x020c81c0 \\& 0xf; if itest ${toto} -eq 0xe; then true; else false; fi'
BIOS> if run usb_cable; then echo "USB detected"; fi
</pre>

===Linux===
* to activate login in Framebuffer console, please uncomment (or add) ''/etc/inittab'' line 35 this way:
<pre class="apf">
# Set up a getty on LCD
tty1::respawn:/sbin/getty 38400 tty1
</pre>

[[Category:DevelopmentBoards]]
[[Category:Hardware]]

APF6Dev

2023-01-20T12:47:18Z

JulienB: /* Connectors */

[[Category: APF6]]

==Description==
This is the Armadeus System's standard development board/baseboard for the [[APF6]] module.

The following options are available:
* [[GPS]]
* [[Gsm|GSM]]

==Errata==
* As the board is also used for [[APF6_SP]] module (APF6+FPGA), you might experience some miscellaneous FPGA LED blinking (beside "FPGA_SW" button) when no FPGA is present.

==Resources==

* [[Datasheet#APF6Dev | Datasheet and schematics]]
* [http://www.armadeus.com/english/products-development_boards-apf6_dev.html Product page on Armadeus Systems website]

==Feature list==

{| border="0" cellpadding="5" cellspacing="5" summary="Hardware Add-Ons by functionnalities"
|----------------
|- style="background:#f4f4f4; color:black; -moz-border-radius:18px;"
|

===Audio===
* [[SGTL5000]]: audio in/out
* [[ALSA]]

===Video Out===
* [[LCD]]
* [[BackLight]]
* [[FrameBuffer]]
* HDMI

===Video In===
*[[Camera interface]]
||
===User Input===
* [[Tslib|Touchscreen]] (SX8654)

===Wired communication===
* [[Uart|UART]]
* [[SPI]]
* [[I2C]]
* [[USB Host]]
* [[USB_OTG]]
* [[USB_Gadget]]
* [[CAN_bus_Linux_driver|CAN bus]]
* [[PCIE]]

===Storage===
* [[MultiMediaCard]]
* [[SATA]]
||
===Realtime clock===
* [[RTC]]

===Wireless communication===
* [[Wifi|WiFi usage on Linux]]
* [[Bluetooth|Bluetooth usage on Linux]]

=== FPGA connections ===

* [[HSMC | HSMC connector]]
* [[JTAG]]
* [[Button]]
* [[Led]]

===Other===
* [[PWM]]: PWM3 output is on J2 pin 26 (2.8V output), but also used by LCD backlight !
* [[GPIOlib]]
* [[JTAG]]

|}

==Connectors==
{| cellpadding="5" cellspacing="0"
|-

[[File:APF6Dev.jpeg| align=left]]

||

{| border="1" cellpadding="5" cellspacing="0" summary="APF6Dev connectors"
|- style="background:#efefef;" align="center"
! Name !! Function
|- align="center"
| J17 || Gigabit Ethernet
|- align="center"
| J15 || HDMI
|- align="center"
| J33 || Audio (Out/Up, In/Down)
|- align="center"
| J29 || Power (12V)
|- align="center"
| J36 || JTAG
|- align="center"
| J5 || Extension 1
|- align="center"
| J18 || Extension 2
|}

|}

==Tips==
===U-Boot===
* To use 7" 800x480 LCD with 3.10/3.14/4.1 legacy kernels:
<pre class="apf">
BIOS> setenv extrabootargs video=mxcfb0:dev=lcd,800x480@60,if=RGB666,bpp=32
</pre>
then, after having booted Linux, do:
<pre class="apf">
root@apf6 ~ # fbset > /etc/fb.modes
</pre>

* Activating HDMI console with USB keyboard in U-Boot (since armadeus-6.0):
<pre class="apf">
BIOS> usb start
BIOS> setenv stdout serial,vga
BIOS> setenv stderr serial,vga
BIOS> setenv stdin serial,usbkbd
</pre>
keyboard map is english one and it seems not possible to change it (U-Boot 2014.07) ?

* Use APF6Dev "User" LED in U-Boot scripts:
If you have a recent U-Boot, supporting gpio command:
<pre class="apf">
BIOS> gpio set 204
...
BIOS> gpio clear 204
</pre>
Otherwise, you can do it 'the old way'; declare GPIO Port 7 Pin 12 (connected to the LED) as GPIO:
<pre class="apf">
BIOS> md.l 0x020b4004 1
020b4004: 00000100
BIOS> mw.l 0x020b4004 0x00001100 (set bit 12)
</pre>
Switch LED on:
<pre class="apf">
BIOS> md.l 0x020b4000 1
020b4000: 00000f04
BIOS> mw.l 0x020b4000 0x00001f04 (set bit 12)
</pre>
Switch LED off:
<pre class="apf">
BIOS> mw.l 0x020b4000 0x00000f04 (clear bit 12)
</pre>

* Use APF6Dev "User" Button (GPIO Port 1 Pin 9) in U-Boot scripts:
If you have a recent U-Boot, supporting ''gpio'' command:
<pre class="apf">
BIOS> setenv user_button 'gpio input 204'
BIOS> if run user_button; then echo "Button pressed"; fi
gpio: pin 9 (gpio 9) value is 0 (if pressed)
Button pressed
</pre>
Otherwise, you can do it 'the old way':
<pre class="apf">
BIOS> setenv user_button 'setexpr.l toto *0x0209c000 \\& 0x200; if itest ${toto} -eq 0; then true; else false; fi'
BIOS> if run user_button; then echo "Button pressed"; fi
</pre>

* Detect USB OTG cable presence:

<pre class="apf">
BIOS> setenv usb_cable 'setexpr.l toto *0x020c81c0 \\& 0xf; if itest ${toto} -eq 0xe; then true; else false; fi'
BIOS> if run usb_cable; then echo "USB detected"; fi
</pre>

===Linux===
* to activate login in Framebuffer console, please uncomment ''/etc/inittab'' line 35 this way:
<pre class="apf">
# Set up a getty on LCD
tty1::respawn:/sbin/getty 38400 tty1
</pre>

[[Category:DevelopmentBoards]]
[[Category:Hardware]]