Difference between revisions of "BeagleBoard/DSP Howto"

From eLinux.org
Jump to: navigation, search
(warning about the quick pace of the bridgedriver)
(add dsp tools)
 
(31 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
Some of the key features of DSP Bridge are:
 
Some of the key features of DSP Bridge are:
  
* Messaging: Ability to exchange fixed size control messages with DSP
+
* ''Messaging'': Ability to exchange fixed size control messages with DSP
* Dynamic memory management: Ability to dynamically map files to DSP address space
+
* ''Dynamic memory management'': Ability to dynamically map files to DSP address space
* Dynamic loading: Ability to dynamically load new nodes on DSP at run time
+
* ''Dynamic loading'': Ability to dynamically load new nodes on DSP at run time
* Power Management: Static and dynamic power management for DSP
+
* ''Power Management'': Static and dynamic power management for DSP
  
  
 
= Setup =
 
= Setup =
 +
 +
In order to enable the DSP in your OMAP3 the procedure is two-fold:
 +
 +
* GPP side (ARM side): Enable the bridge driver kernel module.
 +
* DSP side: Set the required files in the filesystem.
 +
** Most of these files are, right now, TI's proprietary binaries.
  
 
== Kernel driver ==
 
== Kernel driver ==
  
 +
<div id="deprecated">
 
In order to use the DSP you would need TI's [[BeagleBoard/DSP_Clarification#dsp-bridge|bridgedriver]] module on the kernel. You can use the linux-omap repository's branch at kernel.org:
 
In order to use the DSP you would need TI's [[BeagleBoard/DSP_Clarification#dsp-bridge|bridgedriver]] module on the kernel. You can use the linux-omap repository's branch at kernel.org:
  
Line 23: Line 30:
 
  cd linux-omap-2.6
 
  cd linux-omap-2.6
 
  git checkout -b dspbridge orgin/dspbridge
 
  git checkout -b dspbridge orgin/dspbridge
 +
</div>
 +
 +
Since Jun of 2010 or so, the DSP/Bridge driver development was moved to the linux-staging repository, in order to speed up its integration to the linus's repository:
 +
 +
git clone git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging-next-2.6.git
 +
cd staging-next-2.6
 +
git checkout -b dspbridge origin/staging-next
  
 
Warning: '''This module currently is under heavy development'''. If you want be updated you should pull for changes weekly or so. Besides, this how-to could be already deprecated.
 
Warning: '''This module currently is under heavy development'''. If you want be updated you should pull for changes weekly or so. Besides, this how-to could be already deprecated.
 +
 +
For convenience we could export the architecture environment variable, otherwise we must set it as a <tt>make</tt> argument:
 +
 +
  export ARCH=arm
  
 
The default configuration for the beagle board doesn't enable de bridgedriver. You should build you own using
 
The default configuration for the beagle board doesn't enable de bridgedriver. You should build you own using
Line 45: Line 63:
 
  make INSTALL_MOD_PATH=/media/rootfs modules_install
 
  make INSTALL_MOD_PATH=/media/rootfs modules_install
  
== TI binaries ==
+
== TI's DSP binaries ==
 +
 
 +
In order to get the DSP binaries for multimedia processing you need to download them from [http://omappedia.org/wiki/OpenMAX_Project TI's OpenMAX IL project]. The most important binary is <code>baseimage.dof</code>, which is the BIOS image to be loaded into the DSP.
 +
 
 +
The latests release of these binaries for mainstream Linux is '''v3.09''' for L23.i3.3.
 +
 
 +
Most of the public releases are published in TI's [https://gforge.ti.com/gf/project/openmax/frs/ gforge].
 +
 
 +
=== v3.09 ===
 +
 
 +
Download the binary package and extract its content:
 +
 
 +
wget --no-check-certificate https://gforge.ti.com/gf/download/frsrelease/285/3260/DSPbinaries-3.09-Linux-x86-Install
 +
chmod +x ./DSPbinaries-3.09-Linux-x86-Install
 +
./DSPbinaries-3.09-Linux-x86-Install  --mode console --prefix /tmp
 +
 
 +
Then copy those binaries into the directory <code>lib/dsp</code> in your root filesystem (<code>/media/rootfs</code> is assumed here):
 +
 
 +
mkdir /media/rootfs/lib/dsp
 +
cp /tmp/Binaries/* /media/rootfs/lib/dsp
 +
 
 +
=== v0.3.5 ===
 +
 
 +
wget --no-check-certificate https://gforge.ti.com/gf/download/frsrelease/170/1399/tiopenmax-0.3.5.tar.gz
 +
tar xvf ./tiopenmax-0.3.5.tar.gz
 +
cd tiopenmax-0.3.5
 +
./TI-OMX-Sample-Firmware-0.3.5-Linux-x86-Install
 +
 
 +
Accept the license agreement and copy the binaries into the directory <code>lib/dsp</code> in your root filesystem:
 +
 
 +
mkdir /media/rootfs/lib/dsp
 +
cp ./lib/dsp/* /media/rootfs/lib/dsp
 +
 
 +
=== v0.3 ===
 +
 
 +
wget --no-check-certificate https://gforge.ti.com/gf/download/frsrelease/111/396/tiopenmax-0.3.tar.gz
 +
tar xvf ./tiopenmax-0.3.tar.gz
 +
cd tiopenmax-0.3
 +
./TI-OMX-Sample-Firmware-0.3-Linux-x86-Install
 +
 
 +
Accept the license agreement and copy the binaries into the directory <code>lib/dsp</code> in your root filesystem:
 +
 
 +
mkdir /media/rootfs/lib/dsp
 +
cp ./lib/dsp/* /media/rootfs/lib/dsp
 +
 
 +
= Running =
 +
 
 +
On the board use these commands to load the module:
  
In order to get the DSP binaries for multimedia processing you need to download TI's OpenMAX IL [https://omapzoom.org/gf/download/frsrelease/111/396/tiopenmax-0.3.tar.gz package]. Once you have extracted the tarball you'll have to run the installer ''TI-OMX-Sample-Firmware-0.3-Linux-x86-Install'' and accept the license agreement.
+
modprobe mailbox
 +
modprobe bridgedriver base_img=/lib/dsp/baseimage.dof
  
You would end up with a bunch of binaries in <code>lib/dsp</code>, copy them to your root filesystem at the same location (/lib/dsp).
+
== ping test ==
  
=== ping test ===
+
If you want to test the DSP you can try the simple ping test provided in this [https://omapzoom.org/gf/download/frsrelease/132/632/dspbridge_binaries.tar.bz2 package]. The package provide a set of already compiled tests, either for ARM-side and DSP-side.
  
If you want to test the DSP you can try the simple ping test provided in this [https://omapzoom.org/gf/download/frsrelease/132/632/dspbridge_binaries.tar.bz2 package].
+
Installing shortcut:
 +
 
 +
# ARM-side app
 +
wget "http://dev.omapzoom.org/?p=tidspbridge/userspace-dspbridge.git;a=blob_plain;f=binaries/ping.out;hb=HEAD" -O ping.out
 +
chmod +x ping.out
 +
cp ping.out /media/rootfs
 +
 
 +
# DSP-side socket node
 +
wget "http://dev.omapzoom.org/?p=tidspbridge/userspace-dspbridge.git;a=blob_plain;f=binaries/pingdyn_3430.dll64P;hb=HEAD" -O pingdyn_3430.dll64P
 +
cp pingdyn_3430.dll64P /media/rootfs/lib/dsp
 +
 
 +
In the board just:
  
Just:
 
 
  ./ping.out
 
  ./ping.out
  
Line 65: Line 141:
 
  ./dynreg.out -r pingdyn_3430.dll64P
 
  ./dynreg.out -r pingdyn_3430.dll64P
  
On the other hand, 'ddspbase_tiomap3430.dof64P' has the node statically included, so there's no need to do that.
+
= Developing =
  
= Running =
+
There are two ways to compile your own DSP nodes:
 +
 
 +
* The official one, which requires DSP/BIOS and RTSC/XDC tools
 +
* The simplified one (used by [[User:Felipec|Felipe Contreras]])
 +
 
 +
But either way, you will need the TI's DSP toolchain: [https://www-a.ti.com/downloads/sds_support/TICodegenerationTools/download.htm C6x compiler CGT 6.0.22] (Code Generation Tools). Please note that you might be required to register to gain access to those files.
  
On the board use this to load the module:
+
This HOWTO assumes that the DSP toolchain are installed under <code>/opt/dsp/cgt6x-6.0.22</code>.
  
modprobe bridgedriver base_img=/lib/dsp/baseimage.dof
+
== Official ==
  
= Developing =
+
These instructions are taken from [http://omappedia.org/wiki/DSPBridge_Project#Build_Userspace_Files DSPBridge project] wiki page at [http://omappedia.org/ omapedia].
  
There are two ways to compile your own DSP nodes; the official one which requires XDC tools, and the simplified one (which I prefer).
+
=== Install build dependencies ===
  
== Official ==
+
* [http://software-dl.ti.com/dsps/dsps_registered_sw/sdo_sb/targetcontent/bios/index.html DSP/BIOS] 5.33.04
 +
* [https://www-a.ti.com/downloads/sds_support/targetcontent/index.html RTSC/XDCtools] 3.10.02
  
Download the dsp-bridge examples from the [https://omapzoom.org/gf/download/frsrelease/147/848/dspbridge_LDP_v1.8.tar.gz omapzoom project]. Once you extract the main tarball you'll need to extract the individual tarballs on the same directory, so you have something like:
+
Also, here is assumed that those packages are installed in <code>/opt/dsp</code>.
  
config.bld
+
=== Building the user space binaries ===
documents
 
dsp
 
mpu_api
 
mpu_driver
 
product.mak
 
samplemakefile
 
samples
 
  
=== DSP side ===
+
git clone git://dev.omapzoom.org/pub/scm/tidspbridge/userspace-dspbridge.git
 +
cd userpace-dspbridge
  
You'll need the [https://www-a.ti.com/downloads/sds_support/targetcontent/LinuxDspTools/download.html C6x compiler], extract it in "/opt/dsp/cgt6x-6.0.22". The recommended version is '''v6.0.22'''.
+
Edit "product.mak" to match the version of your tools.  
  
You'll need the "DSP/BIOS" package and "RTSC/XDCtools" in order to compile the dsp-brige examples, you can download them from [https://www-a.ti.com/downloads/sds_support/targetcontent/index.html here]. Here we will assume they are installed in "/opt/dsp".
+
<code>
 +
# DSP BIOS
 +
SABIOS_VER  = 5.33.04
 +
SABIOS_VER_2 = 5_33_04
  
Edit "product.mak" to match the version of your tools. Then run:
+
# CodeGen Tools
  make -f samplemakefile .bridge_samples DD_XDCDIR=/opt/dsp/xdctools_3_10_02 SABIOS_DIR=/opt/dsp/bios_5_33_04/packages DEPOT=/opt/dsp
+
CGT55_VER = 3.2.2
 +
  CGT6X_VER = 6.0.22
 +
</code>
  
=== ARM side ===
+
Then run:
  
You'll need to prepare a '''target''' directory:
+
  make .dsp DD_XDCDIR=/opt/dsp/xdctools_3_10_02 SABIOS_DIR=/opt/dsp/bios_5_33_04/packages DEPOT=/opt/dsp
  export target=/tmp/dsp-target
 
mkdir -p $target/lib
 
  
Also, build libbridge and libqos:
+
Other make options:
cd mpu_api/src
 
make PREFIX=$target/.. CROSS=arm-linux- install
 
  
To build the examples:
+
make clean    # clean all
  cd samples/mpu/src
+
  make all      # clean, compile and install all
  make PREFIX=$target/.. CROSS=arm-linux- LIBINCLUDES=$target/lib LDPATH=$target/lib install
+
make .api      # clean, compile and install API only
 +
make .samples  # clean, compile and install samples only
 +
  make .dsp      # clean, compile and install DSP binaires only
  
All you need will be on '/tmp/dsp-target'.
+
The output will be installed under <code>userpace-dspbridge/source/target</code>
  
 
== Simplified ==
 
== Simplified ==
  
In order to develop dynamic dsp nodes you'll need a [https://www-a.ti.com/downloads/sds_support/targetcontent/LinuxDspTools/download.html C6x compiler] (the recommended version is '''v6.1.7''') and doffbuild tools.
+
In this mode we will only need the DSP toolchains and the doffbuild tools. In this case, the test C6x compiler version is '''v6.1.7''' or greater.
  
 
=== doffbuild tools ===
 
=== doffbuild tools ===
  
The only relevant tool is DLLcreate, which can be found in TI's omapzoom site, on the [http://omapzoom.org/gf/download/frsrelease/108/421/dspbridge_dsp.tar.gz dspbridge_dsp] package.
+
The only relevant tool is DLLcreate, which can be found in the userspace-dpsbridge repository, but we can only extract what we need in this way:
 +
 
 +
mkdir -p /opt/doffbuild/bin
 +
cd /opt
 +
wget -q "http://dev.omapzoom.org/?p=tidspbridge/userspace-dspbridge.git;a=blob_plain;f=source/dsp/bdsptools/bridge-tools.tar;hb=HEAD" -O - \
 +
    | tar xf - --strip-components 3 --wildcards ti/dspbridge/dsp/doffbuild/bin/*
  
mkdir -p tmp
+
=== DSP nodes samples ===
tar -xf dspbridge_dsp.tar.gz -C tmp
 
mv tmp/dsp/bdsptools/packages/ti/dspbridge/dsp/doffbuild /opt/doffbuild
 
rm -rf tmp
 
  
=== Example dsp node ===
+
Here is a couple of [http://gitorious.org/vjaquez-beagleboard/dsp-samples DSP node samples] built using the simplified approach.
  
Here is an [http://github.com/felipec/dsp-dummy example dsp node] that is simply passing buffers back and forth.
+
* '''dummy''' passes buffers back and forth
 +
* '''ping''' sends messages and waits for replies
  
  git clone git://github.com/felipec/dsp-dummy.git
+
  git clone git://gitorious.org/vjaquez-beagleboard/dsp-samples.git
  make DSP_TOOLS=/opt/dsptools DSP_DOFFBUILD=/opt/doffbuild
+
  make DSP_TOOLS=/opt/dsp/cgt6x-6.0.22 DSP_DOFFBUILD=/opt/doffbuild
 +
make install DESTDIR=/media/rootfs
  
As a result you'll have two binaries; '''dummy.dll64P''' for dsp-side, and '''dummy''' for arm-side.
+
Now you can run the '''dummy''' and the '''ping''' test applications.
  
To load the dynamic node:
+
= Further information =
/dspbridge/dynreg.out -r /lib/dsp/dummy.dll64P
 
  
Now you can run the '''dummy''' test application.
+
# [http://omappedia.org/wiki/DSPBridge_Project DSP Bridge wiki page at Omappedia]
 +
# [https://gforge.ti.com/gf/project/omapbridge/docman/?subdir=3 Official OMAP DSP Bridge documentation]
  
= More information =
+
= See also =
  
 +
* [[BeagleBoard/dsp-tools]]
 +
* [[BeagleBoard/gst-dsp]]
 
* [[BeagleBoard/gst-openmax]]
 
* [[BeagleBoard/gst-openmax]]

Latest revision as of 10:33, 13 August 2010


This article explains how to use the DSP in OMAP3 at BeagleBoard using the bridge driver kernel module. For DSP tool chain see C64x+ DSP.

DSP Bridge driver provides features to control and communicate with DSP enabling parallel processing for multimedia acceleration. It enables the applications running on MPU to offload the processing to DSP [1].

Some of the key features of DSP Bridge are:

  • Messaging: Ability to exchange fixed size control messages with DSP
  • Dynamic memory management: Ability to dynamically map files to DSP address space
  • Dynamic loading: Ability to dynamically load new nodes on DSP at run time
  • Power Management: Static and dynamic power management for DSP


Setup

In order to enable the DSP in your OMAP3 the procedure is two-fold:

  • GPP side (ARM side): Enable the bridge driver kernel module.
  • DSP side: Set the required files in the filesystem.
    • Most of these files are, right now, TI's proprietary binaries.

Kernel driver

In order to use the DSP you would need TI's bridgedriver module on the kernel. You can use the linux-omap repository's branch at kernel.org:

git clone git://git.kernel.org/pub/scm/linux/kernel/git/tmlind/linux-omap-2.6.git
cd linux-omap-2.6
git checkout -b dspbridge orgin/dspbridge

Since Jun of 2010 or so, the DSP/Bridge driver development was moved to the linux-staging repository, in order to speed up its integration to the linus's repository:

git clone git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging-next-2.6.git
cd staging-next-2.6
git checkout -b dspbridge origin/staging-next

Warning: This module currently is under heavy development. If you want be updated you should pull for changes weekly or so. Besides, this how-to could be already deprecated.

For convenience we could export the architecture environment variable, otherwise we must set it as a make argument:

 export ARCH=arm 

The default configuration for the beagle board doesn't enable de bridgedriver. You should build you own using

 make menuconfig

or fetching the one used in marmita:

wget http://gitorious.org/vjaquez-beagleboard/marmita/blobs/raw/master/meta-marmita/linux/linux-omap-bridgedriver/defconfig -O .config

If you want DSS2 support for the Beagleboard, you should apply this patch in your kernel code: https://patchwork.kernel.org/patch/94049/

wget -q https://patchwork.kernel.org/patch/94049/mbox/ -O - | git am --3way

Then build the uImage as usual and install the modules on your rootfs:

make oldconfig
make
make uImage
make INSTALL_MOD_PATH=/media/rootfs modules_install

TI's DSP binaries

In order to get the DSP binaries for multimedia processing you need to download them from TI's OpenMAX IL project. The most important binary is baseimage.dof, which is the BIOS image to be loaded into the DSP.

The latests release of these binaries for mainstream Linux is v3.09 for L23.i3.3.

Most of the public releases are published in TI's gforge.

v3.09

Download the binary package and extract its content:

wget --no-check-certificate https://gforge.ti.com/gf/download/frsrelease/285/3260/DSPbinaries-3.09-Linux-x86-Install
chmod +x ./DSPbinaries-3.09-Linux-x86-Install
./DSPbinaries-3.09-Linux-x86-Install  --mode console --prefix /tmp

Then copy those binaries into the directory lib/dsp in your root filesystem (/media/rootfs is assumed here):

mkdir /media/rootfs/lib/dsp
cp /tmp/Binaries/* /media/rootfs/lib/dsp

v0.3.5

wget --no-check-certificate https://gforge.ti.com/gf/download/frsrelease/170/1399/tiopenmax-0.3.5.tar.gz
tar xvf ./tiopenmax-0.3.5.tar.gz
cd tiopenmax-0.3.5
./TI-OMX-Sample-Firmware-0.3.5-Linux-x86-Install

Accept the license agreement and copy the binaries into the directory lib/dsp in your root filesystem:

mkdir /media/rootfs/lib/dsp
cp ./lib/dsp/* /media/rootfs/lib/dsp

v0.3

wget --no-check-certificate https://gforge.ti.com/gf/download/frsrelease/111/396/tiopenmax-0.3.tar.gz
tar xvf ./tiopenmax-0.3.tar.gz
cd tiopenmax-0.3
./TI-OMX-Sample-Firmware-0.3-Linux-x86-Install

Accept the license agreement and copy the binaries into the directory lib/dsp in your root filesystem:

mkdir /media/rootfs/lib/dsp
cp ./lib/dsp/* /media/rootfs/lib/dsp

Running

On the board use these commands to load the module:

modprobe mailbox
modprobe bridgedriver base_img=/lib/dsp/baseimage.dof

ping test

If you want to test the DSP you can try the simple ping test provided in this package. The package provide a set of already compiled tests, either for ARM-side and DSP-side.

Installing shortcut:

# ARM-side app
wget "http://dev.omapzoom.org/?p=tidspbridge/userspace-dspbridge.git;a=blob_plain;f=binaries/ping.out;hb=HEAD" -O ping.out
chmod +x ping.out
cp ping.out /media/rootfs
# DSP-side socket node
wget "http://dev.omapzoom.org/?p=tidspbridge/userspace-dspbridge.git;a=blob_plain;f=binaries/pingdyn_3430.dll64P;hb=HEAD" -O pingdyn_3430.dll64P
cp pingdyn_3430.dll64P /media/rootfs/lib/dsp 

In the board just:

./ping.out

If you get an error like:

DSPNode_Allocate failed: 0x80008008

Then it's possible that the ping DSP socket node is not loaded. If you use 'baseimage.dof' you need to load it dynamically:

./dynreg.out -r pingdyn_3430.dll64P

Developing

There are two ways to compile your own DSP nodes:

  • The official one, which requires DSP/BIOS and RTSC/XDC tools
  • The simplified one (used by Felipe Contreras)

But either way, you will need the TI's DSP toolchain: C6x compiler CGT 6.0.22 (Code Generation Tools). Please note that you might be required to register to gain access to those files.

This HOWTO assumes that the DSP toolchain are installed under /opt/dsp/cgt6x-6.0.22.

Official

These instructions are taken from DSPBridge project wiki page at omapedia.

Install build dependencies

Also, here is assumed that those packages are installed in /opt/dsp.

Building the user space binaries

git clone git://dev.omapzoom.org/pub/scm/tidspbridge/userspace-dspbridge.git
cd userpace-dspbridge

Edit "product.mak" to match the version of your tools.

# DSP BIOS
SABIOS_VER   = 5.33.04
SABIOS_VER_2 = 5_33_04
# CodeGen Tools
CGT55_VER = 3.2.2
CGT6X_VER = 6.0.22

Then run:

make .dsp DD_XDCDIR=/opt/dsp/xdctools_3_10_02 SABIOS_DIR=/opt/dsp/bios_5_33_04/packages DEPOT=/opt/dsp

Other make options:

make clean     # clean all
make all       # clean, compile and install all
make .api      # clean, compile and install API only
make .samples  # clean, compile and install samples only
make .dsp      # clean, compile and install DSP binaires only

The output will be installed under userpace-dspbridge/source/target

Simplified

In this mode we will only need the DSP toolchains and the doffbuild tools. In this case, the test C6x compiler version is v6.1.7 or greater.

doffbuild tools

The only relevant tool is DLLcreate, which can be found in the userspace-dpsbridge repository, but we can only extract what we need in this way:

mkdir -p /opt/doffbuild/bin
cd /opt
wget -q "http://dev.omapzoom.org/?p=tidspbridge/userspace-dspbridge.git;a=blob_plain;f=source/dsp/bdsptools/bridge-tools.tar;hb=HEAD" -O - \
    | tar xf - --strip-components 3 --wildcards ti/dspbridge/dsp/doffbuild/bin/*

DSP nodes samples

Here is a couple of DSP node samples built using the simplified approach.

  • dummy passes buffers back and forth
  • ping sends messages and waits for replies
git clone git://gitorious.org/vjaquez-beagleboard/dsp-samples.git
make DSP_TOOLS=/opt/dsp/cgt6x-6.0.22 DSP_DOFFBUILD=/opt/doffbuild
make install DESTDIR=/media/rootfs

Now you can run the dummy and the ping test applications.

Further information

  1. DSP Bridge wiki page at Omappedia
  2. Official OMAP DSP Bridge documentation

See also