Developing SIP Phone with GUI on STM32 MCU

When should you use MCUs? The answer to this question is obvious when you want to have a cheaper, more reliable, or less power-consuming solution. But it seems in this case It is necessary to greatly reduce the functionality because the MCUs have a maximum of a couple of megabytes of internal memory. And they certainly do not work at gigahertz. We in the Embox project do not agree that the functionality is available only on large platforms. Since hundreds of kilobytes of memory are enough for a lot of complex tasks if you use fit tools.

We have an STM32F769I-Disco board. In our mind, it is almost a smartphone. There is an 800x480 touchscreen, an audio interface, a network interface (even if it is not wireless). There are 2 MB flash and 512 RAM on-chip memory, and also 64 MB QSPI Flash, and 16 MB SDRAM on the board. So we decided to try how much time it takes us with Embox to develop a SIP-phone with GUI. This article contains two parts. First, we will show how to fit a VoIP phone into the on-chip memory of the STM32F769I MCU. And in the second part, we will tell how to design the SIP-phone with GUI on a host fast and run it on an MCU.

Embox is a configurable OS for embedded systems. A distinctive feature is that it allows the use of Linux software without changing the source code on systems with restricted resources including MCUs.

One of the most popular VoIP phone projects is PJSIP. We will use it for our purpose.

Build PJSIP on Linux

Then, you need to build the project. It’s easy to do for your host OS. In my case, it’s Linux.

$ ./configure --prefix=~/pj_build

I did not specify any options except ‘prefix’, it is the paths where the compiled libraries and header files will be installed.

Let’s build

$ make dep
$ make

Launch PJSIP on Linux

#define SIP_DOMAIN     "example.com"
#define SIP_USER "alice"
#define SIP_PASSWD "secret"

Rebuild the PJSIP and launch the demo:

$ ./pjsip-apps/bin/samples/x86_64-unknown-linux-gnu/simple_pjsua

You have to see something like this:

15:21:22.181            pjsua_acc.c  ....SIP outbound status for acc 0 is not active
15:21:22.181 pjsua_acc.c ....sip:bob@sip.linphone.org: registration success, status=200 (Registration successful), will re-register in 300 seconds
15:21:22.181 pjsua_acc.c ....Keep-alive timer started for acc 0, destination:91.121.209.194:5060, interval:15s

Now you can receive incoming calls.

Build PJSIP in Embox

Embox has a mechanism for the usage of external projects. It allows to set a download link, apply patches if required, and set rules for three stages: configure, build, install.

To use this mechanism, it is enough to indicate that in the ‘@Build’ annotation ‘script = $ (EXTERNAL_MAKE)’ should be used:

@Build(stage=2,script="$(EXTERNAL_MAKE) PJSIP_ENABLE_CXX=false")
@BuildArtifactPath(cppflags="-I$(abspath $(EXTERNAL_BUILD_DIR))/third_party/pjproject/core/install/include/")module core_c extends core {
depends pjsip_dependencies
}

The following Makefile is used to build PJSIP for Embox:

As you can see, these are the same ‘configure’, ‘make dep’, ‘make’ as for Linux. Of course, when configuring, we indicate that you need to use cross-compilation (‘ — host’, ‘ — target’, ‘CC’, ‘CXX’) for the target platform.

In addition, you can notice another difference. We specify ‘ — with-external-pa’, that is, we say that for audio it needs to use external drivers (from Embox). The audio drivers in Embox provide a ‘portaudio’ interface, which is also available on Linux.

We also modify a bit the code, extract the SIP account settings from the C- file to a ‘simple_pjsua_sip_account.inc’ file, and place it in a configuration folder ( ‘conf/’ folder). That is, to build the application with a different SIP account, you only need to change this file. Content is kept the same.

#define SIP_DOMAIN  <sip_domain>
#define SIP_USER <sip_user>
#define SIP_PASSWD <sip_passwd>

We just need to create Mybuild file with a new Embox command:

package project.pjsip.cmd@AutoCmd
@Cmd(name="simple_pjsua_imported", help="", man="")
@BuildDepends(third_party.pjproject.libpj_all)
@Build(stage=2)
module simple_pjsua_imported {
option boolean use_extern_mem = false
@IncludePath("$(CONF_DIR)")
@DefineMacro("PJ_AUTOCONF=1")
source "simple_pjsua_imported.c"
@NoRuntime depends third_party.pjproject.libpj_all
}

Here in Mybuild we specify the source files (the code is not modified). After this to enable our util in a final image it is enough to include the module to Embox mods.conf:

include project.pjsip.cmd.simple_pjsua_imported

Run the ‘simple_pjsua’ as before on Linux. Now it is possible to accept incoming calls.

Launch PJSIP on STM32F769I-Discovery

  • A file with compiler flags (build.conf)
  • A linker file, where memory segments are described (lds.conf).
  • A file with modules list or a system description (mods.conf)
  • The ‘simple_pjsua_sip_account.inc’ file. The SIP account specification

The first two points are usually easy to figure out. These are compiler and linker options, and they rarely change for the same board. Except perhaps for optimization flags. The main work on the setting of the final system will be done in the third and fourth points.

First, let’s take a look at the Embox configuration. How is this different from running on Linux? On Linux we had an almost infinite amount of memory, we didn’t care about a number of tasks, memory allocations, etc. Now we have only 2MB of ROM and 512KB of RAM, excluding external memory. Accordingly, it is necessary to set how many resources it requires for our purposes.

For example, PJSIP runs on its own ‘thread’. For each new calling connection, there is another ‘thread’. And it is required one more ‘thread’ for working with audio. Thus, even with the one connection, we need at least 3 ‘threads’. Also, we want to add DHCP — so adding one more ‘thread’. In total, we need 4 ‘threads’. That have to specify in the configuration (mods.conf):

include embox.kernel.thread.core(thread_pool_size=5,thread_stack_size=12000)

We have set the fixed-size stacks. But it is possible to use the threads with different stack sizes. It depends on a task requirement.

Next, we specify the number of required network frames:

include embox.net.skbuff(amount_skb=28)
include embox.net.skbuff_data(amount_skb_data=28)

Set the heap size (where malloc () works from):

include embox.mem.heap_bm
include embox.mem.static_heap(heap_size=0x3C000)

The configuration related to the PJSIP remains the same as on QEMU.

Finding out the heap size

Launch Valgrind with our application:

$ valgrind --tool=massif --time-unit=B --massif-out-file=pjsip.massif ./pjsip-apps/bin/samples/x86_64-unknown-linux-gnu/simple_pjsua

After the application finished, we visualize the data using the massif-visualizer:

$ massif-visualizer pjsip.massif

It can be seen that memory is spent not only on PJSIP, but also on a standard library, as well as ‘libasound’ (this is the host sound — ALSA). PJSIP is presented in the bottom red subplot. And at the peak, it uses 600 KB, while during the connection about 320 KB. Our target board has only 512KB on-chip RAM, therefore, it is necessary to configure PJSIP to reduce memory consumption.

I prepared the following configuration:

We copied it to PJSIP into a ‘pjlib/include/pj/config_site.h’ file, rebuilt it and ran again. The result:

Now it uses about 300KB, so it can fit on the board.

Also, I set the heap size 300KB in Embox (but the final heap size was reduced to 240KB). I made PJSIP pools debuggable to see if something overflows. The debugging of the pools is enabled in the same ‘pjlib/include/pj/config_site.h’ with the option “#define PJ_POOL_DEBUG 1”.

It also needs to configure the thread stacks and the number of network packets (so-called, “skbuf”). It is important to correctly distribute the remaining resources. For example, if there are too few network packets, then the sound will simply “choke”, that is you will hear only scraps of the incoming sound. If you allocate too many packages, then there will be not enough memory for the stacks. The stacks are certainly more important. If the stack overflows, everything is gone.

Therefore, we start with the maximum possible stack size and then reduce it until the software breaks or the stack sizes do not become small enough. If we catch damage to the stack, we stop. Except for this, we will use a separate stack for interrupts handling.

@Runlevel(0) include embox.arch.arm.armmlib.exception_entry(irq_stack_size=1024)

After that, we give the remaining resources to the network packets. As I mentioned above, we can use 28 packets.

This is enough to ‘simple_pjsia’ works successfully on 512KB internal memory.

Adding GUI

Design GUI on Linux

To do this, let’s take two examples. The first example is ‘simple_pjsua ‘from PJSIP. The second example is ‘demo/x11_rawfb/’ from Nuklear. We should make them work together under Linux.

The first thing I did was to replace the automatic answer with an external event (such as a button press). And then, I wrote the logic in Nuklear.

During the development process, it turned out that the icons are not drawn inside the buttons. In the picture below, you can see the phone icons inside the green and red buttons. But this is already a corrected version. Initially, only white squares were drawn. It turned out that the problem was in a ‘rawfb’ plugin implementation. To fix the problem I have added some code that copies the contents of the image to the correct Nuklear memory region.

At the end of a working day, I got the following:

Since the STM32F76I-Discovery has an 800x480 screen, I set the required resolution in Nuklear. The resulting code is as follows:

Launch on the target board (STM32)

@AutoCmd
@Cmd(name="sip_nuklear", help="", man="")
@BuildDepends(third_party.pjproject.libpj_all)
@BuildDepends(third_party.lib.nuklear)
@Build(stage=2)
module sip_nuklear {
@InitFS
source "icons/phone-accept-80.png",
"icons/phone-decline-80.png",
"fonts/Roboto-Regular.ttf"
source "main.c"
source "nuklear_main.c"
@IncludePath("$(CONF_DIR)")
@DefineMacro("PJ_AUTOCONF=1")
source "pjsua.c"
@NoRuntime depends third_party.pjproject.libpj_all
@NoRuntime depends third_party.lib.nuklear
depends embox.driver.input.core
depends rawfb_api
}

The sources are listed. Icons and fonts are placed in an internal file system and will be available as regular read-only files in runtime. Also, we added dependencies on pjsip and nuklear libraries.

After running the application on the board, I noticed that a default font from Nuclear looks terrible on the board screen. Some of the letters were simply lost. For example “1” looked like “|” and “m” looked like “n”. I had to connect fonts from TTF files — ‘Roboto-Regular.ttf’. This font takes up about 150 KB of flash memory, but the text is readable.

After checking on Linux how it looks I tried using different font sizes 32 and 38 but got a segfault. In the end, I gave up the idea of loading multiple font sizes from the file, and only loaded the 32nd font and scaled it.

Specifics of launch on the board

We set the framebuffer address to the beginning of SDRAM (0x60000000):

@Runlevel(1) include embox.driver.video.stm32f7_lcd(
fb_base=0x60000000, width=800, height=480, ltdc_irq=88, bpp=32
)
include embox.driver.video.fb

I have already described the effects of flickering when using one buffer in another article. Therefore, we will take into account that the system uses double buffering, and, therefore, it needs 1.5 MB additional memory. Except for this, the fonts require yet 256 KB. In total, you need to increase the heap by 2 MB. We also place it in the external memory:

include embox.mem.fixed_heap(heap_size=0x200000, heap_start=0x60200000)

There are two heaps in the system now — one in the internal memory for PJSIP, and the other in SDRAM for graphics. It helps us. After all If we merge these heaps into one, in SDRAM, we get a drop in performance. This is due to the fact that SDRAM works very well with sequential calls, but in the case when the framebuffer is being worked in parallel with the continuous sound processing, the SDRAM speed may be insufficient.

Also, add an input device ( touchscreen):

@Runlevel(2) include embox.driver.input.touchscreen.stm32f7cube_ts
@Runlevel(2) include embox.driver.input.input_dev_devfs

The touchscreen will be available as ‘/dev/stm32-ts’ in a ‘devfs’ filesystem in Embox. Therefore, it will be possible to work with it through the usual open ()/read()/… .

For quality work, we still needed to enable caches. We talked about how caches work in the article.

@Runlevel(0) include embox.arch.arm.armmlib.armv7m_cpu_cache( log_level=4,sram_nocache_section_size=0x10000)

The network packet descriptors and data, as well as the audio buffers that DMA operates with, are located in a special section of memory, marked as non-cacheable in the MPU. This is required so that the state of objects in this memory is always in a coherent state.

The memory distribution looks like this

As a result, we get a working SIP phone with GUI that works quite well.

Development process

And it took very little time. One day for the application on Linux and one more day to improve on the target platform. Yes, Embox already had a display, network card, and audio drivers for this board. But the development of these parts also takes a little time, no more than a week for each driver. It takes much more time to develop such features right on the board. In our case, most of the functionality is developed under the convenient host system environment. It is this that allowed us to significantly reduce the development time.

You can see the results in this short video