ArmadeusWiki - User contributions [en]

Bluetooth

2019-01-22T14:18:25Z

SebastienR: /* OPOS6UL */

This page will give you all the informations needed to have a running Bluetooth configuration on your Armadeus board.

==Hardware==
First you have to get a compatible hardware. Currently there are 5 solutions:
* You have an [[OPOS6UL]] board with the Wi-Fi/Bluetooth chip integrated.
* You have an [[APF6]] board with the Wi-Fi/Bluetooth chip integrated. The chip is on the [[APF6]] Dual and Quad boards by default.
* You have an [[APF51Dev]] board, then you're a lucky man because Bluetooth is integrated on the board ;-)
* If you have an [[APF27Dev]], then you can get a [[Wireless extension board]] with Wi-Fi/Bluetooth option from Armadeus Systems
* Otherwise: get a cheap USB<->Bluetooth adapter (requires an USB Host port) or a RS232<->Bluetooth adapter

===Tested USB adapters===
{| border="1" cellpadding="5" cellspacing="0" summary="Supported USB<->Bluetooth dongle"
|- style="background:#efefef;"
!'''Model''' || colspan="2" | '''Status APF9328 / APF27''' ||'''Chipset''' || '''Comments'''
|----------------
|'''BELKIN - Mini Bluetooth Adapter''' [[Image:Belkin_Mini_Bluetooth.jpg]] || style="background:#ffff00;" | TBT || style="background:#ff0000;" | KO || Product: BLUETOOTH USB +EDR ADAPTER v2.1 UHE Manufacturer: Broadcom Corp
|| # hciconfig hci1 up piscan
btusb_submit_intr_urb: hci1 urb c3bdac40 submission failed (28) 
Can't init device hci1: Input/output error (5)

|----------------
|'''TRUST - Bluetooth 2.1 USB Adapter''' [[Image:Trust_Small_Bluetooth.jpg]] || style="background:#ffff00;" | TBT || style="background:#ff0000;" | KO || Product: BCM2046B1 Manufacturer: Broadcom || # hciconfig hci1 up piscan
btusb_submit_intr_urb: hci1 urb c3bdac40 submission failed (28) 
Can't init device hci1: Input/output error (5)
|----------------
|'''[http://www.rueducommerce.fr/Peripheriques-Reseaux-wifi/Adaptateur-USB-Bluetooth/Adaptateur-USB-Bluetooth/RUEDUCOMMERCE/2848164-Mini-adaptateur-USB-Bluetooth-portee-100m-19x15x5-39-mm.htm RUEDUCOMMERCE - Mini adaptateur USB Bluetooth'''] [[Image:RDC_USB_Bluetooth.jpg]]|| style="background:#ffff00;" | TBT || style="background:#00ff00;" | OK || Manufacturer: Cambridge Silicon Radio ||
|----------------
|'''GIGABYTE - GN-BTD01''' [[Image:Gigabyte_gn-btd01.jpg]]|| style="background:#ffff00;" | TBT || style="background:#00ff00;" | OK || Manufacturer: Cambridge Silicon Radio || Bluetooth 1.1 ?
|----------------
|'''BELKIN - F8T003 v2''' || style="background:#ffff00;" | TBT || style="background:#00ff00;" | OK || Manufacturer: Cambridge Silicon Radio ||
|----------------
|'''D-LINK - DBT-122''' || style="background:#ffff00;" | TBT || style="background:#00ff00;" | OK || Product: BCM2035 Manufacturer: Broadcom ||
|----------------
|}
 

==Software==
Bluetooth Linux stack is divided into several parts:
* kernel drivers
* userland libraries/daemon (bluez)

===Driver installation===
* (Done by default on [[APF27]], [[APF51]], [[APF6]] and [[OPOS6UL]])
<pre class="host">
$ make linux-menuconfig
</pre>
<pre class="config">
[*] Networking support --->
<M> Bluetooth subsystem support --->
--- Bluetooth subsystem support
<M> L2CAP protocol support
<M> SCO links support
<M> RFCOMM protocol support
[*] RFCOMM TTY support
<M> BNEP protocol support
[ ] Multicast filter support (NEW)
[ ] Protocol filter support (NEW)
<M> HIDP protocol support
Bluetooth device drivers --->
<M> HCI USB driver
< > HCI SDIO driver (NEW)
<M> HCI UART driver
[*] UART (H4) protocol support
[*] BCSP protocol support
[ ] HCILL protocol support (NEW)
< > HCI BCM203x USB driver (NEW)
< > HCI BPA10x USB driver (NEW)
< > HCI BlueFRITZ! USB driver (NEW)
< > HCI VHCI (Virtual HCI device) driver (NEW)
</pre>
<pre class="host">
$ make
</pre>

===Bluez installation===
(Done by default on [[APF51]], [[APF6]] and [[OPOS6UL]])
<pre class="host">
$ make menuconfig
</pre>
<pre class="config">
Package Selection for the target --->
...
[*] XML handling --->
[*] libxml2
...
[*] Hardware handling --->
[*] dbus
XML library to use (libxml2)
...
Networking applications --->
[*] bluez
[*] bluez-utils
</pre>
<pre class="host">
$ make
</pre>

==Custom Bring up (each hardware may have a different init sequence)==

===OPOS6UL===
{| border="1" cellpadding="5" cellspacing="0" summary="put summary here"
|- style="background:#efefef;" align="center"
! width="50%" | OPOS6UL !! width="50%" | OPOS6ULNANO
|-
| OPOS6UL has a CM-43438 chip (based on BCM43438), connected to the i.MX6UL UART8 (''/dev/ttymxc7'')
| OPOS6ULNANO has a Murata module with CYM4343 chipset, connected to the i.MX6UL UART3 (''/dev/ttymxc2'')
|-
| <pre class="apf"># export BTRESET=42</pre> <pre class="apf"># export BTDEV=/dev/ttymxc7</pre>
| <pre class="apf"># export BTRESET=99</pre> <pre class="apf"># export BTDEV=/dev/ttymxc2</pre>
|}

* Start the bluetooth deamon and attach your chipset to the kernel bluez UART driver:
<pre class="apf">
# /usr/libexec/bluetooth/bluetoothd &
#
</pre>

* Wake up the chip
<pre class="apf">
# echo $BTRESET > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio$BTRESET/direction
# echo 0 > /sys/class/gpio/gpio$BTRESET/value
# sleep 1
# echo 1 > /sys/class/gpio/gpio$BTRESET/value
# sleep 1
</pre>

* Attach the chip. Before running the following command, be sure that the file ''/etc/firmware/BCM43430A1.hcd'' exists (if not, it can be obtained (wget) [https://github.com/OpenELEC/misc-firmware/blob/master/firmware/brcm/BCM43430A1.hcd here ?] or [https://aur.archlinux.org/cgit/aur.git/plain/BCM43430A1.hcd?h=pi-bluetooth here]) !
<pre class="apf">
# hciattach -t 30 $BTDEV bcm43xx 921600 flow
bcm43xx_init
Set Controller UART speed to 921600 bit/s
Flash firmware /etc/firmware/BCM43430A1.hcd
Set Controller UART speed to 921600 bit/s
Device setup complete
#
</pre>
* To choose bluetooth MAC address, add it to ''hciattach'' command
<pre class="apf">
# hciattach -t 30 $BTDEV bcm43xx 921600 flow bdaddr 11:22:33:44:55:66
</pre>
* [[Bluetooth#Common Bring up|Go to "Common Bring up" section]]

===APF6===
* APF6 has a jorjin chip connected to the i.MX6 UART2 (ttymxc1)

* Start the bluetooth deamon and attach your chipset to the kernel bluez UART driver:
<pre class="apf">
# /usr/sbin/bluetoothd
NET: Registered protocol family 31
Bluetooth: HCI device and connection manager initialized
Bluetooth: HCI socket layer initialized
Bluetooth: L2CAP socket layer initialized
Bluetooth: SCO socket layer initialized
Bluetooth: BNEP (Ethernet Emulation) ver 1.3
Bluetooth: BNEP socket layer initialized
</pre>

or if you are using BlueZ 5
<pre class="apf">
# /usr/libexec/bluetooth/bluetoothd &
</pre>

* Wake up the chip
<pre class="apf">
# export BTRESET=43
# echo $BTRESET > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio$BTRESET/direction
# echo 0 > /sys/class/gpio/gpio$BTRESET/value
# sleep 1
# echo 1 > /sys/class/gpio/gpio$BTRESET/value
# sleep 1
</pre>

* Attach the chip. Before running the following command, be sure that the file ''/lib/firmware/TIInit_7.6.15.bts'' exists ! You can download it [https://github.com/TI-ECS/bt-firmware/blob/master/TIInit_7.6.15.bts here] (click on the 'Raw' button)
<pre class="apf">
# /usr/sbin/hciattach -s 115200 ttymxc1 texas 115200
Found a Texas Instruments' chip!
Firmware file : /lib/firmware/TIInit_7.6.15.bts
Loaded BTS script version 1
Device setup complete

#
</pre>

* [[Bluetooth#Common Bring up|Go to "Common Bring up" section]]

===APF51Dev===
* [[APF51Dev]] has a CSR BlueCore 4 chipset connected to the i.MX51 UART3 (ttymxc1)

* On recent kernel using device tree, you have to "wake up" the chip:
<pre class="apf">
# export BTRESET=60
# echo $BTRESET > /sys/class/gpio/export
# echo out > /sys/class/gpio/gpio$BTRESET/direction
# echo 0 > /sys/class/gpio/gpio$BTRESET/value
# sleep 1
# echo 1 > /sys/class/gpio/gpio$BTRESET/value
# sleep 1
</pre>

* Start the bluetooth deamon and attach your chipset to the kernel bluez UART driver:
<pre class="apf">
# /usr/sbin/bluetoothd
# /usr/sbin/hciattach -s 115200 ttymxc1 csr 115200

CSR build ID 0x00-0x37
Bluetooth: Core ver 2.15
NET: Registered protocol family 31
Bluetooth: HCI device and connection manager initialized
Bluetooth: HCI socket layer initialized
Bluetooth: HCI UART driver ver 2.2
Bluetooth: HCI H4 protocol initialized
Bluetooth: HCI BCSP protocol initialized
</pre>

* [[Bluetooth#Common Bring up|Go to "Common Bring up" section]]

===APF27Dev + APW===
* [[Wireless extension board|APW]] has a CSR BlueCore 4 chipset connected to the i.MX27 serial port ttySMX5 (UART6)
* Reset it:
<pre class="apf">
# source /usr/bin/gpio_helpers.sh
# gpio_mode PB14 1
# gpio_set_value PB14 0; sleep 1; gpio_set_value PB14 1; sleep 1
</pre>
* Attach it to the kernel bluez UART driver:
<pre class="apf">
# /usr/sbin/hciattach -s 921600 ttySMX5 csr 921600
</pre>
* [[Bluetooth#Common Bring up|Go to "Common Bring up" section]]

===USB module===
* Make sure your hardware is connected to the APF. '''If using an USB dongle''', load corresponding driver:
<pre class="apf">
# modprobe btusb
Bluetooth: Core ver 2.14
NET: Registered protocol family 31
Bluetooth: HCI device and connection manager initialized
Bluetooth: HCI socket layer initialized
Bluetooth: Generic Bluetooth USB driver ver 0.4
usbcore: registered new interface driver btusb
</pre>

==Common Bring up==
* Now that your hardware Bluetooth interface is up, check if it was correctly detected by BlueZ:
<pre class="apf">
# hciconfig
hci0: Type: USB or UART
BD Address: 00:00:00:00:00:00 ACL MTU: 0:0 SCO MTU: 0:0
DOWN
RX bytes:0 acl:0 sco:0 events:0 errors:0
TX bytes:0 acl:0 sco:0 commands:0 errors:0
</pre>
* If interface is DOWN, bring it up:
<pre class="apf">
# hciconfig hci0 up piscan
</pre>
* Check your Bluetooth device is correctly initialized:
<pre class="apf">
# hcitool dev
Devices:
hci0 00:10:60:D1:92:0F
</pre>
* From Bluez5, everything can now be done with ''bluetoohctl'' interactive command:
<pre class="apf">
# bluetoothctl
[NEW] Controller 5C:F3:70:34:D6:66 BlueZ 5.43 [default]
[bluetooth]# power on
Changing power on succeeded
[CHG] Controller 5C:F3:70:34:D6:66 Powered: yes

[bluetooth]# scan on
Discovery started
[CHG] Controller 5C:F3:70:34:D6:66 Discovering: yes

[bluetooth]# agent on
Agent registered
</pre>

==Usage==
===Scanning network===
* To get surrounding devices addresses and names:
<pre class="apf">
# hcitool scan
Scanning ...
</pre>
* To get surrounding devices addresses and classes:
<pre class="apf">
# hcitool inq
Inquiring ...
</pre>

===Get info on a given device===
<pre class="apf">
# hcitool info 00:19:0E:xx:xx:xx
...
</pre>

===Pinging other devices===
<pre class="apf">
# l2ping 00:19:0E:xx:xx:xx
Ping: 00:19:0E:xx:xx:xx from 00:19:88:xx:xx:xx (data size 44) ...
44 bytes from 00:19:0E:xx:xx:xx id 0 time 38.05ms
44 bytes from 00:19:0E:xx:xx:xx id 1 time 37.09ms
...
</pre>
Here 00:19:0E:xx:xx:xx is the Bluetooth MAC address of the Host.

===Change advertising name===
* to change your module's name on Bluetooth network:
<pre class="apf">
# hciconfig hci0 name ARMADEUS
</pre>
* From bluez5, you can also specify advertising name in ''/etc/bluetooth/main.conf'' file (%h = hostname, %d = device number):
<pre class="apf">
[General]
Name = OPOS
</pre>

==Advanced usages: Setup a Terminal between a PC and your APF through Bluetooth==
===On the APF===
* the first step is to create the corresponding node for the future connection:
<pre class="apf">
# mknod /dev/rfcomm0 c 216 0
</pre>
* then, listen to an incoming connection, on the ''rfcomm0'' (here channel 7 is chosen):
<pre class="apf">
# rfcomm -i hci0 listen /dev/rfcomm0 7 &
</pre>
{{Note|If RFCOMM protocol is not built statically in your kernel, you might need to load it before use with: <pre class="apf"># modprobe rfcomm </pre>}}

{{Note|If you plan to connect from your smartphone, don't specify a channel number as most apps will try to connect to channel 1: <pre class="apf"># rfcomm -i hci0 listen /dev/rfcomm0 &</pre>}}
* and the last step, when the connection is open, is to connect a terminal (through getty) to the device ''/dev/rfcomm0'':
<pre class="apf">
# getty 38400 /dev/rfcomm0
</pre>

===On your Host PC===
* after the two first steps on the APF, you need to connect the PC to the APF with the same channel (7):
<pre class="host">
$ rfcomm connect 0 00:19:88:2B:xx:xx 7 (replace 00:19:88:2B:xx:xx with the Bluetooth @ of your APF)
</pre>
* and configure ''minicom'' (''$HOME/.minirc.dfl''):
pu port /dev/rfcomm0
pu baudrate 38400
pu bits 8
pu parity N
pu stopbits 1
* when ''getty'' is running on the APF/OPOS, you could you connect with ''minicom'':
<pre class="host">
$ minicom -o
</pre>
* it could be a good idea to create an additional user account for remotely login through Bluetooth, by following [[Adding_users|these instructions]].

===On your Android smartphone===
* install BlueTerm app
* connect to right Bluetooth device... that's it ;-)

==Advanced usages: Using a Bluetooth keyboard on your APF==
The only thing needed after having a Bluetooth correctly configured is to use this command :
<pre class="apf">
# hidd --connect keyboard_bdaddr
</pre>

==Advanced usages: Controlling your board from an android device (using rfcomm)==

===With your own App===
The following section shows how to send commands to the board from an android device via Bluetooth. The goal is to control the two LEDs present on the board. An [[APF51Dev]] and a Samsung Galaxy Tab 2 are used in this example.

On the APF:

* Enable the SPP profile. Here, it is using the channel 1.
<pre class="apf">
# sdptool add --channel=1 SP
Serial Port service registered
#
</pre>

* Listen incoming connections on the channel 1. The script ''serial-server.sh'' is located in ''demos/android/android_remote_controller''.
<pre class="apf">
# rfcomm listen hci0 1 ./serial-server.sh {}
Waiting for connection on channel 1
</pre>

On the android device:

* Deploy the app on your device. The app is available [ftp://ftp2.armadeus.com/armadeusw/apf-remote-controller.tar.gz here as source] or [ftp://ftp2.armadeus.com/armadeusw/apf-remote-controller.apk here as apk].
* Start the app.
* Enjoy :-)

===With Bluetooth Electronics App===
* This application from [http://www.keuwl.com/apps/bluetoothelectronics/ keuwl.com], can be found on Google store and is very practical to design control panel on your Android device and make then control your Bluetooh device). It is generally used with Arduino and HC-06 Bluetooth module but we will see it works perfectly on APF/OPOS SoM.
* Bluetooth Electronics uses RFCOMM to talk with device and so communication can be seen as a serial port
* Again, use ''rfcomm'' command line tool to listen for your Android device connection:
<pre class="apf">
[bluetooth]# power on
...
# rfcomm -i hci0 listen /dev/rfcomm0 &
</pre>
* Discover/pair/connect the APF/OPOS SoM from Bluetooth Electronics app
* Then configure ''/dev/rfcomm0'' created by rfcomm:
<pre class="apf">
# stty -F /dev/rfcomm0 raw -echo -echoe -echok 9600
</pre>
* and use this new serial port from your application...
* here a sample application is given; it runs on [[OPOS6UL]] and allows to light on/off the user LED, get processor temperature, get CPU usage and send text to LCD from Bluetooth Electronics panel. Serial protocol is very simple and can be guessed from [https://sourceforge.net/p/armadeus/code/ci/master/tree/target/demos/android/bluetooth-electronics/opos6ul-server.py source code].

[[File:Bluetooth_Electronics.png]]

==Advanced usages: Others==
* [[TCP/IP with Bluetooth]]
* [[OBEX]] transfers
* [[Wiimote]]

{{Note|On iOS, it is '''not''' possible to use standard Bluetooth devices that are not registered through [https://developer.apple.com/programs/mfi/ MFi Program]. The only way to communicate with your modules is to have a Bluetooth Low Energy interface and corresponding iOS software}}

==Bluetooth Low Energy (BLE)==
* This protocol enhancement for low energy networks is only available on [[APF6]], [[OPOS6UL]] and [[OPOS6UL_NANO]] modules with corresponding Wi-Fi+BLE hardware option.

* To scan for BLE devices (''hci0'' interface should be up):
<pre class="apf">
# hcitool hci0 lescan
</pre>

* Most operations can then be done with ''bluetoothctl'':
<pre class="apf">
# bluetoothctl
</pre>

===APF/OPOS as BLE device===
* Most of the job consist in developing a GATT server implementing desired functionalities/characteristics. Some examples are given in Bluez sources. For example (''python'' is needed and ''bluetoothd'' should have been launched with ''--experimental'' option):
<pre class="apf">
# hciconfig hci0 up
# /root/example-gatt-server
# hciconfig hci0 leadv (to start BLE Advertising)
</pre>
* You can then use ''BLE Scanner'' or ''LightBlue'' Android/iOS app.
* For "iBeacon" stuff, [http://www.wadewegner.com/2014/05/create-an-ibeacon-transmitter-with-the-raspberry-pi/ this tutorial] may serve as a starting example.

==Links==
* http://www.bluez.org/
* http://www.hanscees.com/bluezhowto.html
* [http://doc.ubuntu-fr.org/bluetooth_materiel-soutenu Dongle USB<->Bluetooth supportés sous Ubuntu]
* [http://www.unixgarden.com/index.php/comprendre/bluetooth-installation-et-utilisation GLMF n°88 - Bluetooth, installation et utilisation]
* [http://www.unixgarden.com/index.php/embarque/communication-de-donnees-et-d’images-issues-de-la-carte-fox-par-bluetooth GLMF n°95 - Communication de données et d'images issues de la carte Fox par Bluetooth]

[[Category:Wireless]]
[[Category:Bluetooth]]

Debian on APF

2015-02-04T09:07:03Z

SebastienR:

{{Under_Construction}}

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

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

==Preparing the development PC==
* In this tutorial, we have used Ubuntu 11.10 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
# mkdir /root/apf_debian
# cd /root/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 squeeze 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. Then in order we have squeeze, which is the name of the debian version we want to get, currently squeeze is the stable version. Then rootfs is the name of the subfolder where debootstrap will work. Finally 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 takes a while, it will download all the debian base packages from the mirror and unpack them in the rootfs folder.
* The next step is to run the second stage of debootstrap. That stage consists in finalizing the installation of the package by running the scripts I mentionned. 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 by doing 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 let it run the ARM binaries through qemu :
<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 also takes a while, it will run the scripts of each package, in order to finalize the packages installation.

==Tweaking the filesystem==

* After the filesystem 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 (ttymxc2 on APF51, ttySMX0 on APF27, ttymxc3 on APF6), 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 squeeze main' > rootfs/etc/apt/sources.list
</pre>

* The hostname of the debian system has to be set properly (here apf51, change it accordingly to your board):
<pre class="host">
# echo 'apf51' > rootfs/etc/hostname
# echo '127.0.1.1 apf51' >> rootfs/etc/hosts
</pre>
* Remove root password (for first logins):
<pre class="host">
# sed -i -e 's/root:\*:/root::/' rootfs/etc/shadow
</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.

* 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 convinient.

* You need to have an APF51 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 transfered to the APF51 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 Pput 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 armadeus system 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 Armadeus system 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>

* 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 :
<pre class="apf">
BIOS> setenv debboot 'setenv addubifsargs ${addubifsargs} init=/debinit; run ubifsboot'
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 6.0 apfxx ttySMX0/ttymxc2

apfxx login:
</pre>

* Login as root with no password

* Update packages:
<pre class="apf">
root@apfxx:~# apt-get update
</pre>

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

* If you don't have any RTC chip on your development board then it could be a good idea to install ntpdate and use it:
<pre class="apf">
root@apf51:~# apt-get install ntpdate
...
root@apf51:~# ntpdate-debian
</pre>

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

* If you want an X server (requires ~90MBytes of free space):
<pre class="apf">
root@apf51:~# aptitude install xserver-xfbdev
</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.

===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.)

==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 APF board]

[[Category:Distribution]]

Members

2014-06-17T11:38:35Z

SebastienR:

==Google Map==

<googlemap lat="47" lon="6" width=640 height=480 zoom=4>
47.270377, 6.025314, [[User:JulienB]] Besancon
47.752598,7.301788, ARMadeus Systems
47.760791, 7.339897, [[User:Salocin68]] Mulhouse
47.734392,7.316975, [[User:FabienM]] Mulhouse
46.946161,7.517052, [[User:Jorasse]] Gümligen
47.681108, 7.390366, [[User:Carbure]] Helfranzkirch
47.436448, 8.429947, [[User:SonZerro]] Baden
44.653992, 6.176672, [[User:JulienN]] Chabottes
48.573342, 7.911476, [[User:KroMignon]] Legelshurst
42.734405, 2.894211, ELIAUS Perpignan
47.653363, 6.862335, UTBM Belfort
45.689589, 5.026395, [[User:OlivierT]] St Bonnet de Mure
48.879619, 2.351074, Paris - 21 members
43.622159, 1.442642, Toulouse - 2 members
-21.115141, 55.536384, La Réunion - 1 member
14.551684, -60.912323, La Martinique - 1 member
48.682805, 2.169186, [[User:BrunoL]] Les Ulis
47.399744, 8.53775, Zurich - 1 member
46.810282, 7.151241, Fribourg
47.574904, 7.580566, Basel
48.839250, 2.392584, [[User:jmn12]] Paris
60.187238, 24.819231, [[User:EemeliA]] Espoo
53.371859, -6.2677, Dublin - 1 member
50.637704, 5.608521, Liège - 1 member
50.67, 3.48, Velaines - 1 member
48.199964, 11.57959, Munich - 1 member
48.109588, -1.678752, Rennes - 1 member
47.750109, -3.366339, [[User:MatthieuT]] Lorient
48.70,2.03, [[User:JulienPeeters]] Chevreuse
45.190325, 5.700316, [[User:NicolasL]] Fontaine
49.279296, 2.472973 [[User:DavidC]] Nogent sur Oise
46.208644, 6.130027, [[User:EugeneR]] Genève
48.667158, 2.706585, [[User:BernardR]] Soignolles en Brie, France
45.188963, 5.709822, [[User:OlivierS]], [[User:HugoP|Hugo Petit]] - Grenoble, France
47.214613, -0.737329, [[User:BrunoS]] Chemillé, France
47.225164, -1.556625, [[User:KevinP]] Nantes, France
43.609234, 1.442642, [[User:PierreBa]] Toulouse, France
41.668809, -0.87616, [[User:AntonioMB]] Zaragoza, España
49.200145, 0.407136, [[User:JeanFrancoisR]] - Asnières
48.109588, -1.678752, [[User:MichelTe]] - Rennes
49.163073, 2.550201, [[User:JulienBa]] - Pontarmé
43.488299, 5.494709, [[User:FrankA]] - Meyreuil
43.622159, 1.442642, [[User:PierreAlexandreS]] - Toulouse, France
51.46513, -0.9692, [[User:AlexG]] - Reading, UK
43.312439, 10.517693, [[User:PaoloB]] - Cecina, Italy
52.63, 4.75, Alkmaar - 1 member
50.776093, 14.632759, [[User:PetrD]] - Cvikov, ČR
48.42097, -4.471693, [[User:OlivierR]] - Brest, France
48.575244, -4.563446, [[User:JeanChristopheL]] - Brest, France
49.417767, 2.826945, [[User:PhilippeL]] - Compiègne, France
48.806044, 2.347512, [[User:PierreDe]] - Arcueil, France
50.803050, 4.358533, [[User:SebastienVC]] - Bruxelles, Belgique
45.535213, -73.668823, [[User:PhilBB]] - Montreal, Canada
48.830759, 2.359204, [[User:Théo179]] - Arcueil, France
48.694563, 2.184605, [[User:IdrissB|Idriss]] - Courbevoie, France
41.563161, 2.020814, [[User:JaumeF|Jaume Figueras]] - Terrassa, Catalunya, Spain
35.415303,139.595332, [[User:HiroshiM]] - Yokohama, Japan
45.203191,5.716288, [[User:GaelV|Gaël Vanderbruggen]] - St Martin le Vinoux, France
48.700223, 2.22766, [[User:JeanMarcM| pieddemamouth/ Jean-Marc Montanier]] - Villebon-sur-Yvette, France
48.419351, -4.469765, [[User:MohamedS]] - Brest, FRANCE
47.319276, 0.285645, [[User:StephaneD]] - Joué les Tours, FRANCE
49.183274,-0.37096,[[User:ArnaudB]] - Caen, France
40.416691,-3.700345, [[User:AntonioD]] - Madrid, Spain
49.674442,-1.736793, [[User:FrancoisL]] - Urville-Nacqueville, France
-1.45502,-48.502368, [[User:MarcusF]] - Belém-PA, Brazil
47.219335,-1.555939, [[User:PhilippeLe]] - Nantes, France
49.652024,3.28098, [[User:JeremieG|Jeremie Girouard]] - Vouel
49.119666,6.176905, [[User:PierreB]] - Metz, France
38.895308,-77.036133, [[User:KennethM]] - Washington DC, United States
45.35510,6.30504, [[User:VincentC]] - Saint-Avre, France
47.0667,6.75,[[User:FlorianM]] - Le Locle, Suisse
50.063606,19.943039,[[User:VascoB]] - Kraków, Poland
39.656225,-8.575344,[[User:VascoB]] - Ourém, Portugal
47.49772,19.039993,[[User:JanosA]] - Budapest, Hungary
43.592576,7.194328,[[User:JiyanA]] - Antibes, France
47.6456311,6.8411555,[[User:SebastienR]] - Belfort, France
</googlemap>
 

===How to add your position===
* go to http://maps.google.com/
* type in the name of your town and launch "Search Google Maps", for example:
[[Image:Google_maps_search.png]]
* right click on "Get URL of this page" and copy the URL
[[Image:Google_maps_url.png]]
* you should get something like that:
<pre>
http://maps.google.com/maps?f=q&hl=fr&geocode=&q=besan%C3%A7on&ie=UTF8&ll=47.257796,6.025314&spn=0.216236,0.601501&z=11&iwloc=addr
</pre>
* the data between ''&ll='' and ''&spn'' are the needed one (latitude/longitude)
* extract them and copy them in the "Edit" of this wiki page. Add it you wiki name and your town. For example:
<pre>
<googlemap lat="47" lon="6" width=640 height=480 zoom=4>
...
Others coordinates
...
47.257796, 6.025314, [[User:YourID|YourName]] - Your Town
</googlemap>
</pre>

[[Category:Association]]

AsDevices

2013-03-13T14:06:50Z

SebastienR: /* Development planning */

{{Under_Construction}}

AsDevices is an ARMadeus specific library that simplify APF-board devices usage for developers. This library is written to be used with C, C++, Python, (Java?) languages.
The core is written in C and other languages support is done with "wrappers".

{{Note| This library is under development, see the [[AsDevices#Development_planning | Development planning.]] to know which functionality is finished.}}

== Install AsDevices on target ==

The library is included in Buildroot menu, to use it just select it:
<pre class="host">
$ make menuconfig
</pre>

<pre class="config">
Package Selection for the target --->
*** Armadeus specific packages ***
Armadeus specific tools/utilities --->
[*] as_devices
</pre>

The base library is in C, to use it with C++ or Python, select the wrapper you need. (For Python you will need to select Python interpreter before as_devices wrapper).

== Generate doxygen documentation ==
* If '''doxygen''' isn't installed on your Linux distribution, you have to install the correct package:
<pre>
$ sudo apt-get install doxygen
</pre>

* Then go in '''As Devices''' root directory.
* Generate the documentation with Doxygen:
<pre>
$ doxygen Doxyfile
</pre>
* Documentation has been generated in ''documentation''.
** Open documentation with:
<pre>
$ firefox documentation/index.html
</pre>

== Using library in C ==

All functions in AsDevices library are constructed on the same way. An as_*_open() function return a device structure or an int that represent the device used. All function take this device structure in first parameter, and a function as_*_close() close the device :

<source lang="C">
struct as_devicename_dev * as_devicename_open(<some parameters>);

as_devicename_do-something-with-device(struct as_devicename_dev *aDev, <some parameters>);

int as_devicename_close(struct as_devicename_dev *aDev);
</source>

For each library, full documentation can be found in C header in directory ''target/packages/as_devices/c''.

=== I²C ===

as_i2c_* functions are used to access devices on i²c bus that doesn't have/need a Linux driver. If you want to access an i²c device, please find out if a driver is not already existing before using this method.

To open the bus, you have to know its number. On [[APF9328]] and [[APF27]] only two busses are present: number 0 and number 1. The ''open()'' function returns an int (file descriptor of the opened ''/dec/i2c-x''), that have to be passed to all other as_i2c_* functions :

<source lang="C">
int as_i2c_open(unsigned int i2c_id);
</source>

Then depending on the complexity of the I2C device communication protocol, you can either use read()/write() (simple frames) or ioctl() with complex "read then write"/"write then read" messages.

* Example (simple write()):

<source lang="C">
#include <stdlib.h>
#include <stdio.h>

#include <as_devices/as_i2c.h>

int my_device = 0;
#define MY_DEV_ADDR 0x23
#define MY_I2C_BUS 1
unsigned char buf[10];
int ret;

...

my_device = as_i2c_open(MY_I2C_BUS);
if (my_device < 0) {
printf("Can't init I2C port %d!!\n", MY_I2C_BUS);
return -1;
}
as_i2c_set_slave(my_device, MY_DEV_ADDR);

...

buf[0] = (unsigned char) my_val;
ret = write(my_device, buf, 1);
if (ret < 0)
printf("Error while sending data to device !!\n");

...
</source>

=== SPI ===

==== Usage ====
To use as_spi_* function, the ''spidev'' kernel module/interface is required. See [[SPI]]
page to know how to configure it.

Once the device file ''/dev/spidevx.x'' is available from the kernel, as_spi library can be used by including the ''as_spi.h'' header in your C source code:

<source lang="C">
#include <as_devices/as_spi.h>
</source>

Full description of the API can be found in this header (target/packages/as_devices/c/as_spi.h), available on
[http://sourceforge.net/p/armadeus/code sourceforge repository].

==== Example ====

The three mains useful functions used to communicate with a slave SPI device
are :

<source lang="C">
int as_spi_open(const unsigned char *aSpidev_name);
</source>

To open the ''/dev/spidevx.x'' special spi file. This function return a file
handler that will be used for all othes as_spi_* function.

<source lang="C">
void as_spi_close(int aFd);
</source>

As its name said, to close the device.

<source lang="C">
uint32_t as_spi_msg(int aFd,
uint32_t aMsg,
size_t aLen,
uint32_t aSpeed);
</source>

This function forge spi messages on MOSI pin and return MISO message.

=== GPIO ===

==== Usage ====

To use as_gpio_* functions, the ''gpio'' kernel module is required. See [[GPIO_Driver]] page to know how to configure it.

Once the device files ''/dev/gpio/*'' are available , as_gpio library can be use by including ''as_gpio.h'' header in the C source code of your application.

<source lang="C">
#include <as_devices/as_gpio.h>
</source>

==== Example ====

Two examples are given, one for lightening led D14 and one to use blocking read on switch S1. This two example are made for [[APF27Dev]] daughter card.

* '''Lightening led'''
With as_gpio, each pin port can be openned separately. The as_gpio_open() function returns a pointer on gpio pin structure declared like this:

<source lang="C">
int ret; /* for returning value */
struct as_gpio_device *pf14;
</source>

On APF27Dev, D14 is plugged on port F pin 14, then to open it :

<source lang="C">
pf14 = as_gpio_open('F', 14);
</source>

GPIO must be configured in ouput mode :

<source lang="C">
ret = as_gpio_set_pin_direction(pf14, "out");
</source>

Then to switch LED value, just use ''as_gpio_set_pin_value()'' function:

<source lang="C">
ret = as_gpio_set_pin_value(pf14, 1); /* led off */
...
ret = as_gpio_set_pin_value(pf14, 0); /* led on */
</source>

Note that because off led wiring, led polarity is inverted (to light on set 0).

Once gpio pin usage is terminated, it must be closed :

<source lang="C">
as_gpio_close(pf14);
</source>

* '''Pressing button'''

The button S1 can be used to test interrupt capability of gpio. The button is plugged on gpio port F pin 13.
After declaring the ''as_gpio_device'' structure, the pin port can be opened :

<source lang="C">
struct as_gpio_device *pf13;
[...]

pf13 = as_gpio_open('F', 13);
</source>

To stuff must be configured before using it as interruption source, direction and IRQ mode.

'''direction'''
<source lang="C">
ret = as_gpio_set_pin_direction(pf13, "in"); /* set switch as input */
</source>

'''IRQ mode'''
There is four IRQ mode :
* '''GPIO_IRQ_MODE_NOINT ''': No interrupt, the processor will ignore event on this gpio.
* '''GPIO_IRQ_MODE_RISING ''': rising edge, the processor will generate an interruption on rising edge of gpio pin.
* '''GPIO_IRQ_MODE_FALLING''': falling edge, the processor will generate an interruption on falling edge of gpio pin.
* '''GPIO_IRQ_MODE_BOTH ''': both, the processor will generate an interruption on both rising or falling edge of gpio.

<source lang="C">
ret = as_gpio_set_irq_mode(pf13, GPIO_IRQ_MODE_FALLING); /* interrupt will be generated on pushed button */
</source>

To capture interruption, the blocking read function can be used with a timeout. If no interruption is raised after the timeout time, read function end with error value -10.

<source lang="C">
ret = as_gpio_blocking_get_pin_value(pf13, 3, 0); /* wait for interruption for 3 seconds and 0 µs) */
if(ret == -10)
printf("Timeout\n");
</source>

=== ADC ===
==== MAX1027 ====
==== AS1531 ====
=== DAC ===
==== MAX5821 ====
==== MCP4912 ====
=== 93LCXX ===
=== PWM ===
==== Usage ====

To use as_pwm_* functions, the kernel module ''imx_pwm'' needs to be loaded. See [[PWM]] page to know how to configure it.

Once the special files ''/sys/class/pwm/pwmX/*'' are available , as_pwm_* functions can be use by including ''as_pwm.h'' header in the C source code of your application.

<source lang="C">
#include <as_devices/as_pwm.h>
</source>

==== Example ====

<source lang="C">
#include <as_devices/as_pwm.h>
...

int main(int argc, char *argv[])
{
struct as_pwm_device *my_pwm;
...
my_pwm = as_pwm_open(0);
if (!my_pwm)
printf("Can't init PWM !!\n");
as_pwm_set_frequency(my_pwm, 150);
as_pwm_set_duty(my_pwm, 500);
...
as_pwm_set_state(my_pwm, 1);
}
</source>

=== LED ===

== Using library in Python ==

To use AsDevices in Python, select the python wrapper in menuconfig as follow :

<pre class="config">
Package Selection for the target --->
*** Armadeus specific packages ***
Armadeus specific tools/utilities --->
[*] as_devices
[*] wrapper Python
</pre>

And keep all .py file on target :
<pre class="config">
Package Selection for the target --->
Interpreter languages and scripting --->
python module format to install (.py sources and .pyc compiled) --->
(X) .py sources and .pyc compiled
</pre>
then compile bsp and flash it on your board.

Once done, just import the module AsDevices to use all function available in library:

<source lang="python">
import AsDevices
from AsDevices import AsGpio

gpio = AsGpio(3)
gpio.setPinDirection('out')
gpio.setPinValue(1)
...
</source>

== Using library in C++ ==

'''TODO'''

== Development planning ==

AsDevices is not finished, following table indicates the remaining work:

{| border="1" cellpadding="5" cellspacing="0" summary="Development planning of AsDevices"
|- style="background:#efefef;" align="center"
! Name !! Component !! C functions !! C++ wrapper !! Python wrapper !! Python class !! description
|- align="center"
| [[I2C | i2c]] || || bgcolor="green"| Ok || bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK || Drive I2C
|- align="center"
| [[SPI | spi]] || || bgcolor="green" | Ok, but not fully tested || bgcolor="green"| Ok, but not fully tested ||bgcolor="green"| Ok, but not fully tested || bgcolor="green"| Ok, but not fully tested || Drive SPI
|- align="center"
| [[Gpio | gpio]] || || bgcolor="green"| Ok || bgcolor="green"| Ok ||bgcolor="green" | Ok ||bgcolor="green" | Ok || Drive GPIO
|- align="center"
| rowspan="3" | ADC
| [[ADC_max1027 | max1027]] || bgcolor="green"| Ok for SLOW mode ||bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| [[as1531 | as1531]] || bgcolor="green"| Ok for SLOW mode ||bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| [[lradc | lradc]] || bgcolor="green"| Ok for SLOW mode ||bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| rowspan="2" | DAC
| [[Max5821 | max5821]] || bgcolor="green"| OK ||bgcolor="green"| Ok, but not fully tested ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| [[Mcp4912 | mcp4912]] || bgcolor="red"| NOK ||bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| eeprom || 93LCxx ||bgcolor="green"| OK ||bgcolor="green"| OK ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| [[PWM]] || ||bgcolor="green" | OK || bgcolor="green" | OK || bgcolor="red" | NOK || bgcolor="red" | NOK || Drive imx27 pwm |
|- align="center"
| [[Backlight]] || ||bgcolor="green" | OK || bgcolor="green" | OK || bgcolor="red" | NOK || bgcolor="red" | NOK ||
|- align="center"
| [[Led | led]] || || bgcolor="green"| Ok || bgcolor=#FF0000 | NOk ||bgcolor=#FF0000 | NOk ||bgcolor=#FF0000 | NOk || Drive LED
|- align="center"
|}

AsDevices

2013-03-13T08:05:00Z

SebastienR:

{{Under_Construction}}

AsDevices is an ARMadeus specific library that simplify APF-board devices usage for developers. This library is written to be used with C, C++, Python, (Java?) languages.
The core is written in C and other languages support is done with "wrappers".

{{Note| This library is under development, see the [[AsDevices#Development_planning | Development planning.]] to know which functionality is finished.}}

== Install AsDevices on target ==

The library is included in Buildroot menu, to use it just select it:
<pre class="host">
$ make menuconfig
</pre>

<pre class="config">
Package Selection for the target --->
*** Armadeus specific packages ***
Armadeus specific tools/utilities --->
[*] as_devices
</pre>

The base library is in C, to use it with C++ or Python, select the wrapper you need. (For Python you will need to select Python interpreter before as_devices wrapper).

== Generate doxygen documentation ==
* If '''doxygen''' isn't installed on your Linux distribution, you have to install the correct package:
<pre>
$ sudo apt-get install doxygen
</pre>

* Then go in '''As Devices''' root directory.
* Generate the documentation with Doxygen:
<pre>
$ doxygen Doxyfile
</pre>
* Documentation has been generated in ''documentation''.
** Open documentation with:
<pre>
$ firefox documentation/index.html
</pre>

== Using library in C ==

All functions in AsDevices library are constructed on the same way. An as_*_open() function return a device structure or an int that represent the device used. All function take this device structure in first parameter, and a function as_*_close() close the device :

<source lang="C">
struct as_devicename_dev * as_devicename_open(<some parameters>);

as_devicename_do-something-with-device(struct as_devicename_dev *aDev, <some parameters>);

int as_devicename_close(struct as_devicename_dev *aDev);
</source>

For each library, full documentation can be found in C header in directory ''target/packages/as_devices/c''.

=== I²C ===

as_i2c_* functions are used to access devices on i²c bus that doesn't have/need a Linux driver. If you want to access an i²c device, please find out if a driver is not already existing before using this method.

To open the bus, you have to know its number. On [[APF9328]] and [[APF27]] only two busses are present: number 0 and number 1. The ''open()'' function returns an int (file descriptor of the opened ''/dec/i2c-x''), that have to be passed to all other as_i2c_* functions :

<source lang="C">
int as_i2c_open(unsigned int i2c_id);
</source>

Then depending on the complexity of the I2C device communication protocol, you can either use read()/write() (simple frames) or ioctl() with complex "read then write"/"write then read" messages.

* Example (simple write()):

<source lang="C">
#include <stdlib.h>
#include <stdio.h>

#include <as_devices/as_i2c.h>

int my_device = 0;
#define MY_DEV_ADDR 0x23
#define MY_I2C_BUS 1
unsigned char buf[10];
int ret;

...

my_device = as_i2c_open(MY_I2C_BUS);
if (my_device < 0) {
printf("Can't init I2C port %d!!\n", MY_I2C_BUS);
return -1;
}
as_i2c_set_slave(my_device, MY_DEV_ADDR);

...

buf[0] = (unsigned char) my_val;
ret = write(my_device, buf, 1);
if (ret < 0)
printf("Error while sending data to device !!\n");

...
</source>

=== SPI ===

==== Usage ====
To use as_spi_* function, the ''spidev'' kernel module/interface is required. See [[SPI]]
page to know how to configure it.

Once the device file ''/dev/spidevx.x'' is available from the kernel, as_spi library can be used by including the ''as_spi.h'' header in your C source code:

<source lang="C">
#include <as_devices/as_spi.h>
</source>

Full description of the API can be found in this header (target/packages/as_devices/c/as_spi.h), available on
[http://sourceforge.net/p/armadeus/code sourceforge repository].

==== Example ====

The three mains useful functions used to communicate with a slave SPI device
are :

<source lang="C">
int as_spi_open(const unsigned char *aSpidev_name);
</source>

To open the ''/dev/spidevx.x'' special spi file. This function return a file
handler that will be used for all othes as_spi_* function.

<source lang="C">
void as_spi_close(int aFd);
</source>

As its name said, to close the device.

<source lang="C">
uint32_t as_spi_msg(int aFd,
uint32_t aMsg,
size_t aLen,
uint32_t aSpeed);
</source>

This function forge spi messages on MOSI pin and return MISO message.

=== GPIO ===

==== Usage ====

To use as_gpio_* functions, the ''gpio'' kernel module is required. See [[GPIO_Driver]] page to know how to configure it.

Once the device files ''/dev/gpio/*'' are available , as_gpio library can be use by including ''as_gpio.h'' header in the C source code of your application.

<source lang="C">
#include <as_devices/as_gpio.h>
</source>

==== Example ====

Two examples are given, one for lightening led D14 and one to use blocking read on switch S1. This two example are made for [[APF27Dev]] daughter card.

* '''Lightening led'''
With as_gpio, each pin port can be openned separately. The as_gpio_open() function returns a pointer on gpio pin structure declared like this:

<source lang="C">
int ret; /* for returning value */
struct as_gpio_device *pf14;
</source>

On APF27Dev, D14 is plugged on port F pin 14, then to open it :

<source lang="C">
pf14 = as_gpio_open('F', 14);
</source>

GPIO must be configured in ouput mode :

<source lang="C">
ret = as_gpio_set_pin_direction(pf14, "out");
</source>

Then to switch LED value, just use ''as_gpio_set_pin_value()'' function:

<source lang="C">
ret = as_gpio_set_pin_value(pf14, 1); /* led off */
...
ret = as_gpio_set_pin_value(pf14, 0); /* led on */
</source>

Note that because off led wiring, led polarity is inverted (to light on set 0).

Once gpio pin usage is terminated, it must be closed :

<source lang="C">
as_gpio_close(pf14);
</source>

* '''Pressing button'''

The button S1 can be used to test interrupt capability of gpio. The button is plugged on gpio port F pin 13.
After declaring the ''as_gpio_device'' structure, the pin port can be opened :

<source lang="C">
struct as_gpio_device *pf13;
[...]

pf13 = as_gpio_open('F', 13);
</source>

To stuff must be configured before using it as interruption source, direction and IRQ mode.

'''direction'''
<source lang="C">
ret = as_gpio_set_pin_direction(pf13, "in"); /* set switch as input */
</source>

'''IRQ mode'''
There is four IRQ mode :
* '''GPIO_IRQ_MODE_NOINT ''': No interrupt, the processor will ignore event on this gpio.
* '''GPIO_IRQ_MODE_RISING ''': rising edge, the processor will generate an interruption on rising edge of gpio pin.
* '''GPIO_IRQ_MODE_FALLING''': falling edge, the processor will generate an interruption on falling edge of gpio pin.
* '''GPIO_IRQ_MODE_BOTH ''': both, the processor will generate an interruption on both rising or falling edge of gpio.

<source lang="C">
ret = as_gpio_set_irq_mode(pf13, GPIO_IRQ_MODE_FALLING); /* interrupt will be generated on pushed button */
</source>

To capture interruption, the blocking read function can be used with a timeout. If no interruption is raised after the timeout time, read function end with error value -10.

<source lang="C">
ret = as_gpio_blocking_get_pin_value(pf13, 3, 0); /* wait for interruption for 3 seconds and 0 µs) */
if(ret == -10)
printf("Timeout\n");
</source>

=== ADC ===
==== MAX1027 ====
==== AS1531 ====
=== DAC ===
==== MAX5821 ====
==== MCP4912 ====
=== 93LCXX ===
=== PWM ===
==== Usage ====

To use as_pwm_* functions, the kernel module ''imx_pwm'' needs to be loaded. See [[PWM]] page to know how to configure it.

Once the special files ''/sys/class/pwm/pwmX/*'' are available , as_pwm_* functions can be use by including ''as_pwm.h'' header in the C source code of your application.

<source lang="C">
#include <as_devices/as_pwm.h>
</source>

==== Example ====

<source lang="C">
#include <as_devices/as_pwm.h>
...

int main(int argc, char *argv[])
{
struct as_pwm_device *my_pwm;
...
my_pwm = as_pwm_open(0);
if (!my_pwm)
printf("Can't init PWM !!\n");
as_pwm_set_frequency(my_pwm, 150);
as_pwm_set_duty(my_pwm, 500);
...
as_pwm_set_state(my_pwm, 1);
}
</source>

=== LED ===

== Using library in Python ==

To use AsDevices in Python, select the python wrapper in menuconfig as follow :

<pre class="config">
Package Selection for the target --->
*** Armadeus specific packages ***
Armadeus specific tools/utilities --->
[*] as_devices
[*] wrapper Python
</pre>

And keep all .py file on target :
<pre class="config">
Package Selection for the target --->
Interpreter languages and scripting --->
python module format to install (.py sources and .pyc compiled) --->
(X) .py sources and .pyc compiled
</pre>
then compile bsp and flash it on your board.

Once done, just import the module AsDevices to use all function available in library:

<source lang="python">
import AsDevices
from AsDevices import AsGpio

gpio = AsGpio(3)
gpio.setPinDirection('out')
gpio.setPinValue(1)
...
</source>

== Using library in C++ ==

'''TODO'''

== Development planning ==

AsDevices is not finished, following table indicates the remaining work:

{| border="1" cellpadding="5" cellspacing="0" summary="Development planning of AsDevices"
|- style="background:#efefef;" align="center"
! Name !! Component !! C functions !! C++ wrapper !! Python wrapper !! Python class !! description
|- align="center"
| [[I2C | i2c]] || || bgcolor="green"| Ok || bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK || Drive I2C
|- align="center"
| [[SPI | spi]] || || bgcolor="green" | Ok, but not fully tested || bgcolor="green"| Ok, but not fully tested ||bgcolor="green"| Ok, but not fully tested || bgcolor="green"| Ok, but not fully tested || Drive SPI
|- align="center"
| [[Gpio | gpio]] || || bgcolor="green"| Ok || bgcolor="green"| Ok ||bgcolor="green" | Ok ||bgcolor="green" | Ok || Drive GPIO
|- align="center"
| rowspan="2" | ADC
| [[ADC_max1027 | max1027]] || bgcolor="green"| Ok for SLOW mode ||bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| [[as1531 | as1531]] || bgcolor="green"| Ok for SLOW mode ||bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| rowspan="2" | DAC
| [[Max5821 | max5821]] || bgcolor="green"| OK ||bgcolor="green"| Ok, but not fully tested ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| [[Mcp4912 | mcp4912]] || bgcolor="red"| NOK ||bgcolor="green"| Ok ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| eeprom || 93LCxx ||bgcolor="green"| OK ||bgcolor="green"| OK ||bgcolor=#FF0000| NOK ||bgcolor=#FF0000| NOK ||
|- align="center"
| [[PWM]] || ||bgcolor="green" | OK || bgcolor="green" | OK || bgcolor="red" | NOK || bgcolor="red" | NOK || Drive imx27 pwm |
|- align="center"
| [[Backlight]] || ||bgcolor="green" | OK || bgcolor="green" | OK || bgcolor="red" | NOK || bgcolor="red" | NOK ||
|- align="center"
| [[Led | led]] || || bgcolor="green"| Ok || bgcolor=#FF0000 | NOk ||bgcolor=#FF0000 | NOk ||bgcolor=#FF0000 | NOk || Drive LED
|- align="center"
|}

Kernel-with-device-tree

2012-09-26T18:54:29Z

SebastienR: /* dtb */

=Background=

The idea behind device tree is quite simple. When the kernel starts, it needs to initialize the drivers for the devices on the board. But often on embedded systems, devices can't be discover at running time. In this case, the Linux kernel has a c file that initialize the devices for the board. So the kernel must be modified/compiled for each board.

Another way is to provide a small file that describe the board to the Linux kernel. When the kernel start, it reads this file (called dtb for Device Tree Binary) to know the devices on the board, and initialize usefull drivers.

Some information on device tree may be found here:
* http://elinux.org/Device_Trees
* http://devicetree.org/Main_Page
* https://wiki.linaro.org/Boards/Origen/DeviceTree
* http://elinux.org/images/4/48/Experiences_With_Device_Tree_Support_Development_For_ARM-Based_SOC%27s.pdf

=Compilation=

To use device tree on arm, both bootloader (U-Boot) and kernel should be compiled with the support of device tree.

==U-Boot==
{{Note|The APF27/U-boot 2012.04.01 patch 3.6, APF28/U-Boot 2012.04.01 patch 1.5 and APF51/U-Boot 2012.04.01 patch 1.5 are already configured to support device tree.}}

To enable device tree on u-boot, it's quite simple:
* add "#define CONFIG_OF_LIBFDT" in the u-boot configuration file (include/configs/<board>.h).

On armadeus SDK, this file is in this directory: buildroot/target/device/armadeus/<board>/<board>-u-boot-<version>.h

For example, for u-boot 2012.04 on apf27, it's: buildroot/target/device/armadeus/apf27/apf27-u-boot-2012.04.h

Nothing else needs to be done, because the u-boot image is build by the armadeus SDK with the command "make".

NOTE: on u-boot 2012.04, the command bootm with device tree is broken. If you want to use it,

you need to fix it with the following patch: http://git.denx.de/?p=u-boot.git;a=commit;h=1723997610ace497252d6f9a44ec76c06951ae43

NOTE2: it's fixed on u-boot 2012.04.01 that's the current (since June 2012) release used on all the APF boards.

==Linux==

The kernel > 3.4 have already the support of some arm SoC.
* imxl (apf9328) : no
* imx27 (apf27) : yes
* imx51 (apf51) : yes
* imx28 (apf28) : yes

The configuration file should have (should be done by default):
* CONFIG_MACH_IMX27_DT (on APF27)
* CONFIG_MACH_IMX51_DT (on APF51)
* CONFIG_MACH_MXS_DT (on APF28)
* CONFIG_SERIAL_IMX
* CONFIG_SERIAL_IMX_CONSOLE

Nothing else needs to be done, because the kernel image is build by the armadeus SDK with the "make" command.

==dtb==

A dtb (Device Tree Binary) file is created from a dts (Device Tree Source) file.

The kernel has already the support of device tree for imx27 ([[APF27]]), imx28 ([[APF28]]) and imx51 ([[APF51]]).

But both board (apf28 and apf51) hasn't a dts file. So a file <board>.dts must be added
to in the directory arch/arm/boot/dts of the linux kernel.

The armadeus SDK don't have support for dtb image generation. So you have to do it yourself.
* go to the directory ''buildroot/output/build/linux-<version>''
* add the file <soc>-<board>.dts the directory ''arch/arm/boot/dts/''
* build the dtb with the command:
<pre class=host>
$ make ARCH=arm CROSS_COMPILE=../../host/usr/bin/arm-linux- <soc>-<board>.dtb
</pre>

The file <soc>-<board>.dtb should appear in ''arch/arm/boot/''
<pre class=host>
$ cp buildroot/output/build/linux-3.5-rc5/arch/arm/boot/imx28-apf28.dtb /tftpboot/
</pre>

=Running=

Start the U-Boot previously compiled, and then :

* load the kernel in memory
* load the dtb in memory
* run the command bootm with 3 arguments: <kernel addr> - <dtb addr>

The second argument is "-", it means that there isn't an initrd to load.

For example, on [[APF27]], it should be something like this:
<pre class="apf">
BIOS> setenv consoledev ttymxc0
BIOS> setenv baudrate 115200
BIOS> setenv dtbaddr 0xa0800000
BIOS> tftp $loadaddr apf27-linux.bin
BIOS> tftp $dtbaddr imx27-apf27.dtb
BIOS> setenv consoledev ttymxc0
BIOS> setenv console console=$consoledev,115200
BIOS> setenv bootargs ${console} earlyprintk
BIOS> run addnfsargs addipargs
BIOS> bootm $loadaddr - $dtbaddr
</pre>

On the APF27, 28 and 51 with the latest U-Boot version things are even simpler:
* Device Tree can be loaded from the Flash memory
* The variable fdt_addr_r defines the RAM address to load the DTB structure and will be used to notify the kernel of the DT location in RAM
* APF27: Set the fdt_addr_r to A1000000 - APF28: set the fdt_addr_r to 41000000
* Some scripts are availaible to update the dtb partition: download_dtb (download the dtb in RAM from your local network) - flash_dtb (tranfert a dtb from RAM to flash) - update_dtb (download and flash a dtb)
* the boot scripts ''ubifsboot'', ''nfsboot'' and ''mmcboot'' support booting a kernel with a DT

Here is the example on the [[APF27]]:
<pre class="apf">
BIOS> setenv consoledev ttymxc0
BIOS> setenv fdt_addr_r a1000000 (with the apf27 - 41000000 with an apf28 - 91000000 with an apf51 )
BIOS> run update_kernel
BIOS> run update_dtb
BIOS> boot (on the APF27 that now supports the NAND in DTS - use run nfsboot on the other boards)
</pre>

Here is the NFSboot example on the [[APF28]] (For the time being boot crash while trying to attach eth0 PHY ):
<pre class="apf">
BIOS> setenv consoledev ttyAMA0
BIOS> setenv fdt_addr_r 41000000
BIOS> run update_dtb
BIOS> saveenv
BIOS> run nfsboot
</pre>

===Remove DT boot===
* just in case you want to come back to normal boot:
<pre class="apf">
BIOS> setenv fdt_addr_r
BIOS> saveenv
</pre>

UsingSyslog

2012-09-19T16:53:04Z

SebastienR:

==Calling syslog method from your C source code==
This part is quiet 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.

UsingSyslog

2012-09-19T16:50:53Z

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

==Calling syslog method from your C source code==
This part is quiet 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 you're 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.

Development

2012-09-19T16:19:18Z

SebastienR: /* Tutorials / Tips */

On this page you will find useful information to develop software for your Armadeus board
 
==Project==
* [[Sources organisation | Armadeus project sources organisation]]
* [[GIT#Providing_modifications | How to submit patches with your modifications]]
* [[Buildroot Packages | Adding packages to Buildroot]]
* [[GIT|GIT usage on Armadeus]] and the way to inform us about your changes
* [[APF9328_and_APF27_migration_to_Linux_2.6.36 | APF9328 and APF27 migration to Linux 2.6.36]]

==Tools/Debug==
* [[Toolchain|C/C++ Cross Compiler (Toolchain) installation]]
* [[GDB|Debugging with GDB and GDBserver]]
* [[QEMU | Simulate an Armadeus system under QEMU]]
* [[Eclipse| Eclipse IDE with GDB debugger]]
* [[ JTAG | Support JTAGKey and BDI2000 JTAG probes]]

==Bootloader / U-Boot==
* [[U-boot patches|Description of U-boot's patches]]
* [[Functionalities#Bootloader|description of some U-Boot functionnalities]]

==Linux==
* [[kernel drivers status list|Kernel driver status list for the APF boards]]
* [[Linux Debug |Tips to debug under Linux]]
* [[Linux drivers development|Instructions to develop Linux drivers for Armadeus]]
* [[Linux on i.MXL|Resources available on i.MXL Linux kernel development]]
* [[Oops, Linux crashes | Interpreting Linux kernel Oops (crashes)]]

==Userland==
{| border="0" cellpadding="5" cellspacing="5" summary="Hardware Add-Ons by functionnalities"
|----------------
|
===Tutorials / Tips===
* [[HelloWorld | How to create your first Linux C application for your board]]
* [[HelloWorldCpp |How to create your first Linux C++ application for your board]]
* [[Automatically launch your application]]
* [[UsingSyslog |How to log using syslog]]
* [[Floating Point usage]]
||

=== Libraries ===
* [[AsDevices | Armadeus specific library]]

|----------------
|

===Graphical User Interface / Games===
* [[Qt/Embedded]]
* [[EFL|Enlightenment Foundation Libraries]]
* [[SDL Development|SDL]]
* [[Allegro|Allegro]]
* [[Mesa| Mesa 3D graphics library (OpenGL compatible)]]
* [[pygame]]
* [[Entertainment]]
||

===Scripts / Languages===
* [[Java package | Java]]
* [[Perl development | Perl]]
* [[Python development | Python]]
* [[Lua development | Lua]]
* [[Flot]] : Javascript plotting library for jQuery
|----------------
|

===Realtime applications===
* [[Real time on APF]]
** Linux shared time
** Linux real time
** [[Xenomai | Hard real time with Xenomai]]

||

=== Web ===
* [[Boa|Boa (Embedded Webserver)]]
* [[Links]]: lightweight textual mode Web browser
* [[Flot]] : Javascript plotting library for jQuery
|----------------
|

=== Network ===
* [[Ngircd]] : an IRC server
* [[tftpd]] : adding a tftpboot server on apf
|----------------
|

===Robotics/Domotic===
* [[Robotic]]
* [[Domos Project]]
|----------------
|

===Third party non free ===
* [[Straton]]
|----------------
|}

==Examples of projects==
* [[Applications]]

==Miscellaneous==
* [[NEON HelloWorld | Hello World example in NEON]]

==Links==
* Things to know when porting x86 software to ARM: http://www.handhelds.org/minihowto/porting-software.html
* [http://free-electrons.com Some nice presentations on Linux Embedded]