Osek_pi_crunch_cm3

This repository uses an OSEK-like OS on bare-metal ARM(R) Cortex(R)-M3 to calculate $\pi$ with a spigot algorithm.

Osek_pi_crunch_cm3 is a fascinating, educational and fun project that computes up to $100,001$ decimal digits of $\pi$ on a bare-metal ARM(R) Cortex(R)-M3 system.

The backbone real-time operating system is taken directly from the OSEK-like OS implemented in Chalandi/OSEK

Software Details

To compute $\pi$, we use a (slow) quadratic pi-spigot algorithm of order $N^2$ in this project. The spigot calculation (having quadratic order) is slower than other well-known algorithms such as AGM or fast series.

The required memory grows linearly with the digit count. Approximately 1.4 Mbyte RAM are needed for the full $10^{5}$ decimal-digit calculation. Since this is significantly more RAM than is available on-chip, a slow external serial SPI SRAM is used for storage.

GNU/GCC gcc-arm-non-eabi is used for target system development on *nix. The build system is based on Standard GNUmake/shell-script.

Building the Application

Build with GNUmake on *nix

Build on *nix* is easy using an installed gcc-arm-none-eabi

cd Osek_pi_crunch_cm3
./Build.sh

The build results including ELF-file, HEX-mask, MAP-file can be found in the Output directory following the GNUmake build.

If gcc-arm-none-eabi is not present, then it can be installed (if needed).

sudo apt install gcc-arm-none-eabi

Prototype Project

This repo features a fully-worked-out prototype example project. The prototype runs on an ARM(R) Cortex(R)-M3 controller fitted on the SMT32F100RB-NUCLEO board. The board is driven in OS-less, bare-metal mode.

The $\pi$-spigot calculation runs continuously and successively in the low-priority idle task (Idle). Upon successful calculation completion, pin PB9 is toggled. This provides a measure of success viewable with a digital oscilloscope.

Simultaneously task T1 exercises a perpetual, simple blinky show featuring the two user LEDs (green and blue) toggling at $\frac{1}{2}~\text{Hz}$. This provides clear visual indication of both system-OK as well as numerical correctness of the most-recently finished spigot calculation.

Hardware Setup

The hardware setup is pictured in the image below.

Bit banging is used to implement an all-software, SPI-compatible driver which controls the external SRAM memory chip. A significant amount of external SRAM is needed to hold the potentially very large data array used for intermediate storage in the $\pi$ calculation.

The output pin connections from the board to the SRAM chip are shown in the table below.

Generic Serial SPI SRAM Bonus Driver

The serial SRAM driver is a nice by-product of this project. This driver can be found in the file mcal_memory_sram_generic_spi.h. It has been written in C++14 utilizing a fully generic, multi-chip, variable-page-size, template form.

The serial SRAM driver provides a simple interface having functions read()/write() and read_n()/write_n() for reading and writing single-byte or multiple-byte streams.

Using this SRAM driver requires providing an independent SPI driver having particular interface functions such as send()/send_n() and recv().

Licensing

The operating system OSEK and timer files in the MCAL are licensed under GPL. This is consistent with the licensing found in and adopted from Chalandi/OSEK.

The supporting files in ref_app and the pi_spigot application itself are licensed under BSL.

Win*-ported *nix tools in wbin originate from UnxTools and include their own distribution statements.

The Win*-ported GNUmake is taken from ckormanyos/make-4.2.1-msvc-build.