3.2.4. Red Pitaya OS¶
Executable scripts from
||full SD card image build procedure (creates and formats partitions)|
||update existing SD card image with new
||run FSCK on SD card image partitions (for images created from used DS cards)|
Scripts to be used in a
chroot environment only:
If this scripts are executed on the host OS directly, they can cause serious damage.
||Ubuntu bootstrap, locale, apt configuration, timezone, fake HW clock)|
||Debian bootstrap (experimental, WEB applications are not working)|
||tools for compiling software|
||HW support for ZYNQ chip (U-Boot, I2C, EEPROM, dtc, IIO, NE10?, GPIO, groups with HW access rights)|
||systemd-networkd based wired/wireless network configuration and required tools (hostAP, supplicant)|
||libraries required by ecosystem applications (boost, jpeg, json), install and enable services|
||Jupyter with NumPy and SciPy|
||X-server and XFCE|
overlay directory contains configuration files which are individually installed onto the OS by scripts.
A short list of SD card image contents:
- Debian/Ubuntu OS (Ext4 partition): - base operating system files - additional operating system applications and libraries - systemd services - most network configuration files - Jupyter work space
- Ecosystem (Fat32 partition):
- Bare metal:
boot.binfile containing FSBL, FPGA bitstream, U-Boot - Linux kernel image, device tree files - alternative FPGA bitstreams and corresponding device tree overlays
- User space - Bazaar server (Nginx) and WEB applications - Red Pitaya API library - SCPI server
- Bare metal: -
To build a functional OS image the ecosystem is required,
since without the
boot.bin and the Linux kernel, the system will not start.
And to build the ecosystem the OS image is required,
since the user space applications are built inside a
with an emulated ARM CPU.
Therefore the procedure for the first build is as follows:
Build the OS image without the ecosystem. This will create a
redpitaya_OS_*.imgSD card image, but without the ecosystem and therefore non functional. It will also create a
redpitaya_OS_*.tar.gzfile, to be used in the
OS/debian/image-update.sh redpitaya_OS_*.img ecosystem_*.zip
After finishing the bootstrapping procedure, either the ecosystem or the OS image can be built as needed.
The more common procedure would be to build a new ecosystem using an existing
and then replace the ecosystem in an existing SD card image with the new one.
The build procedure for a new SD card OS image can now be done in one step.
If an existing
ecosystem_*.zip file is present in the project root while building the OS image,
it will be integrated and the result will be a fully functional SD card image.
Ubuntu 2016.04.2 was used to build Debian/Ubuntu SD card images for Red Pitaya.
The next two packages need to be installed on the host PC:
$ sudo apt-get install debootstrap qemu-user-static
22.214.171.124.1. Ubuntu bootstrap¶
The next steps should be executed in the root directory of the Red Pitaya Git repository.
$ git clone https://github.com/RedPitaya/RedPitaya.git $ cd RedPitaya
Run the next command to build the OS image. Root or
sudo privileges are needed.
The code should be executed as the
otherwise some configuration files will be placed into the wrong users home directory.
Before you execute next step, the Ecosystem must be built.
$ sudo bash # OS/debian/image.sh # exit
image.sh will create an SD card image with a name containing the current
date and time. Two partitions are created a 128MB FAT32 partition for the ecosystem and a slightly less then 4GB Ext4 partition.
image.sh will call
which installs the base system and some additional packages. It also configures APT (Debian packaging system),
locales, hostname, timezone, file system table, U-boot and users (access to UART console).
ubuntu.sh also executes
network.sh which creates a
systemd-networkd based wired and wireless network setup. And it executes
redpitaya.sh which installs additional Debian packages (mostly libraries)
needed by Red Pitaya applications.
redpitaya.sh also extracts
ecosystem*.zip (if one exists in the current directory) into the FAT partition.
126.96.36.199.2. Red Pitaya ecosystem update¶
In case an
ecosystem*.zip file was not available for the previous step,
it can be extracted later to the FAT partition (128MB) of the SD card.
In addition to Red Pitaya tools, this
ecosystem_*.zip file contains a boot image (containing FPGA code),
a boot script (
u-boot.scr) and the Linux kernel.
image-update.sh is provided for updating an existing image
to a newer
ecosystem_*.zip file without making modifications to the
The script should be run with the image and ecosystem files as arguments:
# ./OS/debian/image-update.sh redpitaya_OS_*.img ecosystem-*.zip
Now you can burn a micro SD card (sized 4GB) e.g.,
# dd bs=4M if=redpitaya_OS_*.img of=/dev/mmcblk0
188.8.131.52.3. File system check¶
If the image creation involved multiple steps performed by the user,
for example some installation/setup procedure performed on a live Red Pitaya,
there is a possibility a file system might be corrupted.
image-fsck.sh script performs a file system check without changing
Use this script on an image before releasing it.
# ./OS/debian/image-fsck.sh redpitaya_OS_*.img
184.108.40.206.4. Reducing image size¶
This steps should only be performed on a live Red Pitaya board. If executed on the host OS, they can and will cause problems.
A cleanup can be performed to reduce the image size. Various things can be done to reduce the image size:
- remove unused software (this could be software which was needed to compile applications)
- remove unused source files (remove source repositories used to compile applications)
- remove temporary files
- zero out empty space on the partition
The next code only removes APT temporary files and zeros out the file system empty space.
$ apt-get clean $ cat /dev/zero > zero.file $ sync $ rm -f zero.file $ history -c
220.127.116.11. Debian Usage¶
Systemd is used as the init system and services are used to start/stop Red Pitaya applications/servers.
Service files are located in
||Jupyter notebbok for Python development|
||SCPI server, is disabled by default, since it conflicts with WEB applications|
||Nginx based server, serving WEB based applications|
To start/stop a service, do one of the following:
$ systemctl start service_name $ systemctl stop service_name
To enable/disable a service, so to determine if it will start at powerup, do one of the following:
$ systemctl enable service_name $ systemctl disable service_name
To see the status of a specific service run:
$ systemd-analyze plot > /opt/redpitaya/www/apps/systemd-plot.svg $ systemd-analyze dot | dot -Tsvg > /opt/redpitaya/www/apps/systemd-dot.svg