Merge pull request #546 from tock/api-folders

apis: organize into folders
tock · Jun 12, 2024 · fd2f66d · fd2f66d
2 parents fc7c132 + a17d179
commit fd2f66d
Show file tree

Hide file tree

Showing 56 changed files with 74 additions and 74 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -23,28 +23,28 @@ rust_embedded = [
 ]
 
 [dependencies]
-libtock_adc = { path = "apis/adc" }
-libtock_air_quality = { path = "apis/air_quality" }
-libtock_alarm = { path = "apis/alarm" }
-libtock_ambient_light = { path = "apis/ambient_light" }
-libtock_buttons = { path = "apis/buttons" }
-libtock_buzzer = { path = "apis/buzzer" }
-libtock_console = { path = "apis/console" }
+libtock_adc = { path = "apis/peripherals/adc" }
+libtock_air_quality = { path = "apis/sensors/air_quality" }
+libtock_alarm = { path = "apis/peripherals/alarm" }
+libtock_ambient_light = { path = "apis/sensors/ambient_light" }
+libtock_buttons = { path = "apis/interface/buttons" }
+libtock_buzzer = { path = "apis/interface/buzzer" }
+libtock_console = { path = "apis/interface/console" }
 libtock_debug_panic = { path = "panic_handlers/debug_panic" }
-libtock_gpio = { path = "apis/gpio" }
-libtock_i2c_master = { path = "apis/i2c_master" }
-libtock_i2c_master_slave = { path = "apis/i2c_master_slave" }
-libtock_key_value = { path = "apis/key_value" }
-libtock_leds = { path = "apis/leds" }
-libtock_low_level_debug = { path = "apis/low_level_debug" }
-libtock_ninedof = { path = "apis/ninedof" }
+libtock_gpio = { path = "apis/peripherals/gpio" }
+libtock_i2c_master = { path = "apis/peripherals/i2c_master" }
+libtock_i2c_master_slave = { path = "apis/peripherals/i2c_master_slave" }
+libtock_key_value = { path = "apis/storage/key_value" }
+libtock_leds = { path = "apis/interface/leds" }
+libtock_low_level_debug = { path = "apis/kernel/low_level_debug" }
+libtock_ninedof = { path = "apis/sensors/ninedof" }
 libtock_platform = { path = "platform" }
-libtock_proximity = { path = "apis/proximity" }
-libtock_rng = { path = "apis/rng" }
+libtock_proximity = { path = "apis/sensors/proximity" }
+libtock_rng = { path = "apis/peripherals/rng" }
 libtock_runtime = { path = "runtime" }
-libtock_sound_pressure = { path = "apis/sound_pressure" }
-libtock_spi_controller = { path = "apis/spi_controller" }
-libtock_temperature = { path = "apis/temperature" }
+libtock_sound_pressure = { path = "apis/sensors/sound_pressure" }
+libtock_spi_controller = { path = "apis/peripherals/spi_controller" }
+libtock_temperature = { path = "apis/sensors/temperature" }
 
 embedded-hal = { version = "1.0", optional = true }
 
@@ -64,23 +64,23 @@ panic = "abort"
 [workspace]
 exclude = ["tock"]
 members = [
-    "apis/adc",
-    "apis/air_quality",
-    "apis/alarm",
-    "apis/ambient_light",
-    "apis/buttons",
-    "apis/buzzer",
-    "apis/console",
-    "apis/gpio",
-    "apis/i2c_master",
-    "apis/i2c_master_slave",
-    "apis/key_value",
-    "apis/leds",
-    "apis/low_level_debug",
-    "apis/ninedof",
-    "apis/proximity",
-    "apis/rng",
-    "apis/temperature",
+    "apis/interface/buttons",
+    "apis/interface/buzzer",
+    "apis/interface/console",
+    "apis/interface/leds",
+    "apis/kernel/low_level_debug",
+    "apis/peripherals/adc",
+    "apis/peripherals/alarm",
+    "apis/peripherals/gpio",
+    "apis/peripherals/i2c_master",
+    "apis/peripherals/i2c_master_slave",
+    "apis/peripherals/rng",
+    "apis/sensors/air_quality",
+    "apis/sensors/ambient_light",
+    "apis/sensors/ninedof",
+    "apis/sensors/proximity",
+    "apis/sensors/temperature",
+    "apis/storage/key_value",
     "panic_handlers/debug_panic",
     "panic_handlers/small_panic",
     "platform",

diff --git a/apis/buttons/Cargo.toml → apis/interface/buttons/Cargo.toml b/apis/buttons/Cargo.toml → apis/interface/buttons/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock buttons driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/buttons/src/lib.rs → apis/interface/buttons/src/lib.rs b/apis/buttons/src/lib.rs → apis/interface/buttons/src/lib.rs
diff --git a/apis/buttons/src/tests.rs → apis/interface/buttons/src/tests.rs b/apis/buttons/src/tests.rs → apis/interface/buttons/src/tests.rs
diff --git a/apis/buzzer/Cargo.toml → apis/interface/buzzer/Cargo.toml b/apis/buzzer/Cargo.toml → apis/interface/buzzer/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock buzzer driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/buzzer/src/lib.rs → apis/interface/buzzer/src/lib.rs b/apis/buzzer/src/lib.rs → apis/interface/buzzer/src/lib.rs
diff --git a/apis/buzzer/src/tests.rs → apis/interface/buzzer/src/tests.rs b/apis/buzzer/src/tests.rs → apis/interface/buzzer/src/tests.rs
diff --git a/apis/console/Cargo.toml → apis/interface/console/Cargo.toml b/apis/console/Cargo.toml → apis/interface/console/Cargo.toml
@@ -12,7 +12,7 @@ rust-version.workspace = true
 description = "libtock console driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/console/src/lib.rs → apis/interface/console/src/lib.rs b/apis/console/src/lib.rs → apis/interface/console/src/lib.rs
diff --git a/apis/console/src/tests.rs → apis/interface/console/src/tests.rs b/apis/console/src/tests.rs → apis/interface/console/src/tests.rs
diff --git a/apis/leds/Cargo.toml → apis/interface/leds/Cargo.toml b/apis/leds/Cargo.toml → apis/interface/leds/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock leds driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/leds/src/lib.rs → apis/interface/leds/src/lib.rs b/apis/leds/src/lib.rs → apis/interface/leds/src/lib.rs
diff --git a/apis/leds/src/tests.rs → apis/interface/leds/src/tests.rs b/apis/leds/src/tests.rs → apis/interface/leds/src/tests.rs
diff --git a/apis/low_level_debug/Cargo.toml → apis/kernel/low_level_debug/Cargo.toml b/apis/low_level_debug/Cargo.toml → apis/kernel/low_level_debug/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock low-level debug drivers"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/low_level_debug/src/lib.rs → apis/kernel/low_level_debug/src/lib.rs b/apis/low_level_debug/src/lib.rs → apis/kernel/low_level_debug/src/lib.rs
diff --git a/apis/low_level_debug/src/tests.rs → apis/kernel/low_level_debug/src/tests.rs b/apis/low_level_debug/src/tests.rs → apis/kernel/low_level_debug/src/tests.rs
diff --git a/apis/adc/Cargo.toml → apis/peripherals/adc/Cargo.toml b/apis/adc/Cargo.toml → apis/peripherals/adc/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock adc driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/adc/src/lib.rs → apis/peripherals/adc/src/lib.rs b/apis/adc/src/lib.rs → apis/peripherals/adc/src/lib.rs
diff --git a/apis/adc/src/tests.rs → apis/peripherals/adc/src/tests.rs b/apis/adc/src/tests.rs → apis/peripherals/adc/src/tests.rs
diff --git a/apis/alarm/Cargo.toml → apis/peripherals/alarm/Cargo.toml b/apis/alarm/Cargo.toml → apis/peripherals/alarm/Cargo.toml
@@ -12,7 +12,7 @@ rust-version.workspace = true
 description = "libtock alarm driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/alarm/src/lib.rs → apis/peripherals/alarm/src/lib.rs b/apis/alarm/src/lib.rs → apis/peripherals/alarm/src/lib.rs
diff --git a/apis/alarm/src/tests.rs → apis/peripherals/alarm/src/tests.rs b/apis/alarm/src/tests.rs → apis/peripherals/alarm/src/tests.rs
diff --git a/apis/gpio/Cargo.toml → apis/peripherals/gpio/Cargo.toml b/apis/gpio/Cargo.toml → apis/peripherals/gpio/Cargo.toml
@@ -12,8 +12,8 @@ description = "libtock gpio driver"
 rust_embedded = ["embedded-hal"]
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 embedded-hal = { version = "1.0", optional = true }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/gpio/src/lib.rs → apis/peripherals/gpio/src/lib.rs b/apis/gpio/src/lib.rs → apis/peripherals/gpio/src/lib.rs
diff --git a/apis/gpio/src/tests.rs → apis/peripherals/gpio/src/tests.rs b/apis/gpio/src/tests.rs → apis/peripherals/gpio/src/tests.rs
diff --git a/apis/i2c_master/Cargo.toml → apis/peripherals/i2c_master/Cargo.toml b/apis/i2c_master/Cargo.toml → apis/peripherals/i2c_master/Cargo.toml
@@ -12,5 +12,5 @@ rust-version.workspace = true
 description = "libtock I2C master driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
diff --git a/apis/i2c_master/src/lib.rs → apis/peripherals/i2c_master/src/lib.rs b/apis/i2c_master/src/lib.rs → apis/peripherals/i2c_master/src/lib.rs
diff --git a/apis/i2c_master_slave/Cargo.toml → apis/peripherals/i2c_master_slave/Cargo.toml b/apis/i2c_master_slave/Cargo.toml → apis/peripherals/i2c_master_slave/Cargo.toml
@@ -12,5 +12,5 @@ rust-version.workspace = true
 description = "libtock I2C master-slave driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
diff --git a/apis/i2c_master_slave/src/lib.rs → apis/peripherals/i2c_master_slave/src/lib.rs b/apis/i2c_master_slave/src/lib.rs → apis/peripherals/i2c_master_slave/src/lib.rs
diff --git a/apis/rng/Cargo.toml → apis/peripherals/rng/Cargo.toml b/apis/rng/Cargo.toml → apis/peripherals/rng/Cargo.toml
@@ -12,7 +12,7 @@ rust-version.workspace = true
 description = "libtock rng driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/rng/src/lib.rs → apis/peripherals/rng/src/lib.rs b/apis/rng/src/lib.rs → apis/peripherals/rng/src/lib.rs
diff --git a/apis/spi_controller/Cargo.toml → apis/peripherals/spi_controller/Cargo.toml b/apis/spi_controller/Cargo.toml → apis/peripherals/spi_controller/Cargo.toml
@@ -12,4 +12,4 @@ rust-version.workspace = true
 description = "libtock SPI controller driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
diff --git a/apis/spi_controller/src/lib.rs → apis/peripherals/spi_controller/src/lib.rs b/apis/spi_controller/src/lib.rs → apis/peripherals/spi_controller/src/lib.rs
diff --git a/apis/air_quality/Cargo.toml → apis/sensors/air_quality/Cargo.toml b/apis/air_quality/Cargo.toml → apis/sensors/air_quality/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock air quality driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/air_quality/src/lib.rs → apis/sensors/air_quality/src/lib.rs b/apis/air_quality/src/lib.rs → apis/sensors/air_quality/src/lib.rs
diff --git a/apis/air_quality/src/tests.rs → apis/sensors/air_quality/src/tests.rs b/apis/air_quality/src/tests.rs → apis/sensors/air_quality/src/tests.rs
diff --git a/apis/ambient_light/Cargo.toml → apis/sensors/ambient_light/Cargo.toml b/apis/ambient_light/Cargo.toml → apis/sensors/ambient_light/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock ambient light driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/ambient_light/src/lib.rs → apis/sensors/ambient_light/src/lib.rs b/apis/ambient_light/src/lib.rs → apis/sensors/ambient_light/src/lib.rs
diff --git a/apis/ambient_light/src/tests.rs → apis/sensors/ambient_light/src/tests.rs b/apis/ambient_light/src/tests.rs → apis/sensors/ambient_light/src/tests.rs
diff --git a/apis/ninedof/Cargo.toml → apis/sensors/ninedof/Cargo.toml b/apis/ninedof/Cargo.toml → apis/sensors/ninedof/Cargo.toml
@@ -9,8 +9,8 @@ rust-version.workspace = true
 description = "libtock nine degrees of freedom driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 libm = "0.2.7"
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/ninedof/src/lib.rs → apis/sensors/ninedof/src/lib.rs b/apis/ninedof/src/lib.rs → apis/sensors/ninedof/src/lib.rs
diff --git a/apis/ninedof/src/tests.rs → apis/sensors/ninedof/src/tests.rs b/apis/ninedof/src/tests.rs → apis/sensors/ninedof/src/tests.rs
diff --git a/apis/proximity/Cargo.toml → apis/sensors/proximity/Cargo.toml b/apis/proximity/Cargo.toml → apis/sensors/proximity/Cargo.toml
@@ -9,8 +9,8 @@ rust-version.workspace = true
 description = "libtock proximity driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
 
diff --git a/apis/proximity/src/lib.rs → apis/sensors/proximity/src/lib.rs b/apis/proximity/src/lib.rs → apis/sensors/proximity/src/lib.rs
diff --git a/apis/proximity/src/tests.rs → apis/sensors/proximity/src/tests.rs b/apis/proximity/src/tests.rs → apis/sensors/proximity/src/tests.rs
diff --git a/apis/sound_pressure/Cargo.toml → apis/sensors/sound_pressure/Cargo.toml b/apis/sound_pressure/Cargo.toml → apis/sensors/sound_pressure/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock sound pressure driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/sound_pressure/src/lib.rs → apis/sensors/sound_pressure/src/lib.rs b/apis/sound_pressure/src/lib.rs → apis/sensors/sound_pressure/src/lib.rs
diff --git a/apis/sound_pressure/src/tests.rs → apis/sensors/sound_pressure/src/tests.rs b/apis/sound_pressure/src/tests.rs → apis/sensors/sound_pressure/src/tests.rs
diff --git a/apis/temperature/Cargo.toml → apis/sensors/temperature/Cargo.toml b/apis/temperature/Cargo.toml → apis/sensors/temperature/Cargo.toml
@@ -9,7 +9,7 @@ rust-version.workspace = true
 description = "libtock temperature driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/temperature/src/lib.rs → apis/sensors/temperature/src/lib.rs b/apis/temperature/src/lib.rs → apis/sensors/temperature/src/lib.rs
diff --git a/apis/temperature/src/tests.rs → apis/sensors/temperature/src/tests.rs b/apis/temperature/src/tests.rs → apis/sensors/temperature/src/tests.rs
diff --git a/apis/key_value/Cargo.toml → apis/storage/key_value/Cargo.toml b/apis/key_value/Cargo.toml → apis/storage/key_value/Cargo.toml
@@ -10,7 +10,7 @@ repository = "https://www.github.com/tock/libtock-rs"
 description = "libtock key-value driver"
 
 [dependencies]
-libtock_platform = { path = "../../platform" }
+libtock_platform = { path = "../../../platform" }
 
 [dev-dependencies]
-libtock_unittest = { path = "../../unittest" }
+libtock_unittest = { path = "../../../unittest" }
diff --git a/apis/key_value/src/lib.rs → apis/storage/key_value/src/lib.rs b/apis/key_value/src/lib.rs → apis/storage/key_value/src/lib.rs
diff --git a/apis/key_value/src/tests.rs → apis/storage/key_value/src/tests.rs b/apis/key_value/src/tests.rs → apis/storage/key_value/src/tests.rs
diff --git a/panic_handlers/debug_panic/Cargo.toml b/panic_handlers/debug_panic/Cargo.toml
@@ -9,7 +9,7 @@ repository = "https://www.github.com/tock/libtock-rs"
 rust-version.workspace = true
 
 [dependencies]
-libtock_console = { path = "../../apis/console" }
-libtock_low_level_debug = { path = "../../apis/low_level_debug" }
+libtock_console = { path = "../../apis/interface/console" }
+libtock_low_level_debug = { path = "../../apis/kernel/low_level_debug" }
 libtock_platform = { path = "../../platform" }
 libtock_runtime = { path = "../../runtime" }
diff --git a/panic_handlers/small_panic/Cargo.toml b/panic_handlers/small_panic/Cargo.toml
@@ -9,6 +9,6 @@ repository = "https://www.github.com/tock/libtock-rs"
 rust-version.workspace = true
 
 [dependencies]
-libtock_low_level_debug = { path = "../../apis/low_level_debug" }
+libtock_low_level_debug = { path = "../../apis/kernel/low_level_debug" }
 libtock_platform = { path = "../../platform" }
 libtock_runtime = { path = "../../runtime" }