Created an examples directory

In the future, we will seperate out the examples into their own subdirectories.
lowRISC · Jun 14, 2024 · 1efabe0 · 1efabe0
1 parent 3fe42fe
commit 1efabe0
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -124,7 +124,7 @@ cd sonata-software
 Configure and run build:
 
 ```sh
-xmake
+xmake -P examples
 ```
 
 After running this you should see the build run to completion and report success, the critical lines indicating a successful build are:

diff --git a/compartments/echo.cc → examples/all/echo.cc b/compartments/echo.cc → examples/all/echo.cc
diff --git a/compartments/gpiolib.cc → examples/all/gpiolib.cc b/compartments/gpiolib.cc → examples/all/gpiolib.cc
diff --git a/compartments/gpiolib.hh → examples/all/gpiolib.hh b/compartments/gpiolib.hh → examples/all/gpiolib.hh
diff --git a/compartments/i2c_example.cc → examples/all/i2c_example.cc b/compartments/i2c_example.cc → examples/all/i2c_example.cc
diff --git a/compartments/lcd_test.cc → examples/all/lcd_test.cc b/compartments/lcd_test.cc → examples/all/lcd_test.cc
@@ -4,7 +4,7 @@
 #include <compartment.h>
 #include <thread.h>
 
-#include "../libraries/lcd.hh"
+#include "../../libraries/lcd.hh"
 #include "lowrisc_logo.h"
 
 /// Thread entry point.

diff --git a/compartments/led_walk.cc → examples/all/led_walk.cc b/compartments/led_walk.cc → examples/all/led_walk.cc
diff --git a/compartments/led_walk_raw.cc → examples/all/led_walk_raw.cc b/compartments/led_walk_raw.cc → examples/all/led_walk_raw.cc
diff --git a/compartments/lowrisc_logo.h → examples/all/lowrisc_logo.h b/compartments/lowrisc_logo.h → examples/all/lowrisc_logo.h
diff --git a/compartments/proximity_sensor_example.cc → examples/all/proximity_sensor_example.cc b/compartments/proximity_sensor_example.cc → examples/all/proximity_sensor_example.cc
diff --git a/examples/all/xmake.lua b/examples/all/xmake.lua
@@ -0,0 +1,30 @@
+-- Copyright lowRISC Contributors.
+-- SPDX-License-Identifier: Apache-2.0
+
+compartment("led_walk_raw")
+    add_deps("debug")
+    add_files("led_walk_raw.cc")
+
+compartment("echo")
+    add_files("echo.cc")
+
+compartment("lcd_test")
+    add_deps("lcd")
+    add_files("lcd_test.cc")
+
+compartment("i2c_example")
+    add_deps("debug")
+    add_files("i2c_example.cc")
+
+compartment("gpiolib")
+    -- This compartment uses C++ thread-safe static initialisation and so
+    -- depends on the C++ runtime.
+    add_deps("cxxrt")
+    add_files("gpiolib.cc")
+
+compartment("led_walk")
+    add_files("led_walk.cc")
+
+compartment("proximity_sensor_example")
+    add_deps("debug")
+    add_files("proximity_sensor_example.cc")
diff --git a/xmake.lua → examples/xmake.lua b/xmake.lua → examples/xmake.lua
@@ -2,12 +2,12 @@
 -- SPDX-License-Identifier: Apache-2.0
 
 set_project("Sonata Software")
-sdkdir = "cheriot-rtos/sdk"
+sdkdir = "../cheriot-rtos/sdk"
 includes(sdkdir)
 set_toolchains("cheriot-clang")
 
 includes(path.join(sdkdir, "lib"))
-includes("libraries")
+includes("../libraries")
 
 option("board")
     set_default("sonata")
@@ -20,34 +20,7 @@ function convert_to_uf2(target)
     os.execv("uf2conv", { binary_file, "-b0x00101000", "-co", firmware .. ".uf2" })
 end
 
-
-compartment("led_walk_raw")
-    add_deps("debug")
-    add_files("compartments/led_walk_raw.cc")
-
-compartment("echo")
-    add_files("compartments/echo.cc")
-
-compartment("lcd_test")
-    add_deps("lcd")
-    add_files("compartments/lcd_test.cc")
-
-compartment("i2c_example")
-    add_deps("debug")
-    add_files("compartments/i2c_example.cc")
-
-compartment("gpiolib")
-    -- This compartment uses C++ thread-safe static initialisation and so
-    -- depends on the C++ runtime.
-    add_deps("cxxrt")
-    add_files("compartments/gpiolib.cc")
-
-compartment("led_walk")
-    add_files("compartments/led_walk.cc")
-
-compartment("proximity_sensor_example")
-    add_deps("debug")
-    add_files("compartments/proximity_sensor_example.cc")
+includes("all")
 
 -- A simple demo using only devices on the Sonata board
 firmware("sonata_simple_demo")

diff --git a/flake.nix b/flake.nix
@@ -30,7 +30,7 @@
       getExe = pkgs.lib.getExe;
 
       clang-lint = let
-        srcGlob = "{compartments/*,libraries/*.{cc,hh}}";
+        srcGlob = "{examples/**/*.{h,hh,cc},libraries/*.{cc,hh}}";
       in
         pkgs.writeShellApplication {
           name = "clang-lint";