patmos and s4noc support

.gitignore

@@ -11,3 +11,6 @@ cmake-build-release
 doc/html
 doc/latex
 doc/markdown/platform
+*.o
+*.bc
+*.elf

README.md

@@ -16,8 +16,19 @@ information on reactor-uc see our [docs](https://www.lf-lang.org/reactor-uc/)
 - Java 17
 - Additional requirements depend on the target platform
 
+### Installation & Quick Start
+
+
+Clone the repository and set REACTOR_UC_PATH:
+```sh
+git clone https://github.com/lf-lang/reactor-uc.git --recursive
+cd reactor-uc
+export REACTOR_UC_PATH=$(pwd)
+```
+
+
 ## Supported Platforms
-`reactor-uc` can run on top of Zephyr, RIOT, Raspberry Pi Pico and POSIX-compliant OSes.
+`reactor-uc` can run on top of Zephyr, RIOT, Raspberry Pi Pico, Patmos, and POSIX-compliant OSes.
 
 ### Native (macOS and Linux)
 `reactor-uc` can also run natively on a host system based on Linux or macOS. This is very useful for developing and testing applications
@@ -87,6 +98,19 @@ cd build
 make
 ```
 
+### Patmos
+
+To install Patmos, follow instructions in [https://github.com/t-crest/patmos/](https://github.com/t-crest/patmos) readme file.
+
+To compile and run patmos examples, navigate to their folders inside `exmaples/patmos` folder and run `./build.sh`.
+
+To compile and run all examples together, run the following lines:
+
+```shell
+cd examples/patmos
+./buildAll.sh
+```
+
 ## Contributing
 
 ### Code organization
@@ -125,6 +149,16 @@ make lf-test
 
 This depends on having the `timeout` utility installed. For macOS users run `brew install coreutils`.
 
+Run platform related tests with 
+```sh
+make platform-test
+```
+
+Run all examples with
+```sh 
+make examples
+```
+
 Compute unit test coverage
 ```sh
 make coverage

examples/fed-template/buildAll.sh

@@ -10,8 +10,11 @@ cmake -Bbuild
 cmake --build build
 popd
 
-pushd MyFed/dest
-./run_lfc.sh
-west build
-popd
-
+if ! command -v west &> /dev/null; then
+    echo "Error: 'west' is not installed."
+else
+    pushd MyFed/dest
+    ./run_lfc.sh
+    west build
+    popd
+fi

examples/flexpret/buildAll.sh

@@ -1,5 +1,9 @@
 set -e
-${REACTOR_UC_PATH}/lfc/bin/lfc-dev src/Smoke.lf
-cmake -Bbuild
-make -C build
-bin/fp-smoke
+if [ -z "$FP_SDK_PATH" ]; then
+  echo "Error: FP_SDK_PATH is not defined. Please set it before running this script."
+else
+    ${REACTOR_UC_PATH}/lfc/bin/lfc-dev src/Smoke.lf
+    cmake -Bbuild
+    make -C build
+    bin/fp-smoke
+fi

examples/patmos/buildAll.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e
+
+if ! command -v pasim &> /dev/null; then
+  echo "Error: pasim command not found. Please ensure it is installed and available in your PATH."
+else
+    # Iterate over each folder and execute the command
+    for dir in ./*; do
+        if [ -d $dir ]; then
+            echo "Entering $dir"
+            pushd $dir
+            chmod +x build.sh
+            ./build.sh
+            popd
+        fi
+    done
+fi

examples/patmos/hello/Makefile

@@ -0,0 +1,27 @@
+# Makefile for building a simple Hello World program for the Patmos platform
+
+# Compiler and tools for PATMOS
+CC = patmos-clang
+
+# Paths
+SRC_DIR = $(CURDIR)
+BUILD_DIR = $(CURDIR)/build
+
+# Source files
+SOURCES = $(SRC_DIR)/hello.c
+
+# Compiler flags
+CFLAGS = -O2 -Wall -Wextra -Werror
+
+# Output binary
+OUTPUT = $(BUILD_DIR)/hello.elf
+all : $(OUTPUT)
+# Build rule
+$(OUTPUT): $(SOURCES)
+	mkdir -p $(BUILD_DIR)
+	$(CC) $(CFLAGS) $(SOURCES) -o $(OUTPUT)
+
+clean:
+	rm -rf $(BUILD_DIR)
+
+.PHONY: all clean

examples/patmos/hello/build.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+rm -rf build
+make all
+pasim ./build/hello.elf

examples/patmos/hello/hello.c

@@ -0,0 +1,5 @@
+#include <stdio.h>
+int main () {
+    printf("Hello Patmos!\n");
+    return 0;
+}

examples/patmos/hello_lf/Makefile

@@ -0,0 +1,33 @@
+REACTOR_UC_PATH ?= $(CURDIR)/../../../
+LF_MAIN ?= HelloLF
+
+# The name of the LF application inside "./src" to build/run/flash etc.
+SRC_GEN_PATH ?= ./src-gen/$(LF_MAIN)
+
+# Execute the LF compiler if build target is "all"
+ifeq ($(firstword $(MAKECMDGOALS)),all)
+  _ :=  $(shell $(REACTOR_UC_PATH)/lfc/bin/lfc-dev src/$(LF_MAIN).lf)
+endif
+
+# ---- Patmos specific configuration ----
+include $(REACTOR_UC_PATH)/make/patmos/patmos-lfc.mk 
+
+CFLAGS += -DEVENT_QUEUE_SIZE=$(EVENT_QUEUE_SIZE) 
+CFLAGS += -DREACTION_QUEUE_SIZE=$(REACTION_QUEUE_SIZE) 
+
+# Output directory
+BIN_DIR = $(CURDIR)/bin
+OUTPUT = $(BIN_DIR)/$(LF_MAIN)
+
+all: $(OUTPUT)
+
+# Build rule
+$(OUTPUT): $(SOURCES)
+	mkdir -p $(BIN_DIR)
+	$(CC) $(SOURCES) $(CFLAGS) -o $(OUTPUT)
+
+clean:
+	rm -rf $(BIN_DIR) ./src-gen
+
+.PHONY: all clean
+

examples/patmos/hello_lf/build.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+rm -rf bin src-gen
+make all
+pasim ./bin/HelloLF

examples/patmos/hello_lf/src/HelloLF.lf

@@ -0,0 +1,9 @@
+target uC {
+  platform: Patmos
+}
+
+main reactor {
+  reaction(startup) {=
+    printf("Hello LF on PATMOS!\n");
+  =}
+}

examples/patmos/s4noc_fed/Makefile

@@ -0,0 +1,20 @@
+include $(REACTOR_UC_PATH)/make/patmos/patmos.mk
+
+OUTPUT = s4noc_fed.elf
+BIN_DIR = $(CURDIR)/bin
+
+SOURCES += $(CURDIR)/main.c
+SOURCES += $(CURDIR)/sender/build/sender.a 
+SOURCES += $(CURDIR)/receiver/build/receiver.a
+
+all: $(OUTPUT)
+
+$(OUTPUT): $(SOURCES)
+	@echo "BUILDING $(notdir $@) from $^"
+	mkdir -p $(BIN_DIR)
+	$(CC) $(CFLAGS) $(SOURCES) -o $(BIN_DIR)/$(OUTPUT)
+
+clean:
+	rm -rf $(BIN_DIR)
+
+.PHONY: all clean

examples/patmos/s4noc_fed/build.sh

@@ -0,0 +1,31 @@
+# !/bin/bash
+
+LF_MAIN=s4noc_fed
+BIN_DIR=bin
+CC=patmos-clang
+
+make clean -C ./sender
+make clean -C ./receiver
+
+make all -C ./sender
+make all -C ./receiver
+
+echo "Linking sender and receiver to create executable"
+make clean 
+make all
+
+read -n 1 -t 10 -p "Choose action: [e]mulate or [f]pga? (default: e) " action
+action=${action:-e}
+if [[ "$action" == "e" ]]; then
+    patemu $BIN_DIR/$LF_MAIN.elf
+elif [[ "$action" == "f" ]]; then
+    if jtagconfig | grep -q "USB-Blaster"; then
+        mv $BIN_DIR/$LF_MAIN.elf ~/t-crest/patmos/tmp/$LF_MAIN.elf
+        make -C ~/t-crest/patmos APP=$LF_MAIN config download
+    else
+        echo "JTAG not connected. Please connect USB-Blaster."
+    fi 
+else
+    echo "Invalid option. Please choose 'e' for emulate or 'f' for fpga."
+fi
+

examples/patmos/s4noc_fed/main.c

@@ -0,0 +1,33 @@
+#include <stdio.h>
+#include <pthread.h>
+#include "sender/sender.h"
+#include "receiver/receiver.h"
+
+static void* receiver_thread(void* arg) {
+    (void)arg;
+    // printf("Starting receiver federate on core/thread 1\n");
+    lf_start_receiver();
+    return NULL;
+}
+
+static void* sender_thread(void* arg) {
+    (void)arg;
+    printf("Starting sender federate on core/thread 2\n");
+    lf_start_sender();
+    return NULL;
+}
+
+int main(void) {
+    pthread_t threads[2]; 
+    printf("Starting S4NOC Federated Example\n");
+    pthread_create(&threads[0], NULL, receiver_thread, NULL);
+    pthread_create(&threads[1], NULL, sender_thread, NULL);
+
+    printf("Threads created for federates.\n");
+
+    pthread_join(threads[0], NULL);
+    pthread_join(threads[1], NULL);
+
+    printf("All federates finished.\n");
+    return 0;
+}

examples/patmos/s4noc_fed/receiver/Makefile

@@ -0,0 +1,34 @@
+include $(REACTOR_UC_PATH)/make/patmos/patmos.mk
+
+FED = receiver
+
+# Paths
+SRC_DIR = $(CURDIR)
+BUILD_DIR = $(CURDIR)/build
+
+# Source files
+SOURCES = $(FED).c
+
+OBJECTS ?= $(SOURCES:.c=.bc)
+
+# Output binary
+OUTPUT = $(FED).a
+
+all: $(OUTPUT)
+
+# Build rule
+$(OUTPUT): $(OBJECTS) 
+	@echo "BUILDING $(notdir $@) from $^"
+	mkdir -p $(BUILD_DIR)
+	llvm-ar  rcsv $(BUILD_DIR)/$(OUTPUT) $^;
+
+%.bc: %.c
+	@echo "$(notdir $^) COMPILED TO $(notdir $@)"
+	mkdir -p $(BUILD_DIR)
+	$(CC) $(CFLAGS) -emit-llvm -c $^ -o $@ 
+
+clean:
+	rm -rf $(BUILD_DIR)
+	rm -f $(FED).bc
+
+.PHONY: all clean