Merge pull request #542 from tock/syscalls-separate

libtock: Do not include `_syscalls.h` automatically for each driver

Author: alevy

doc/guide.md

@@ -170,13 +170,13 @@ There must be a function to check for syscall driver existence.
 Signature:
 
 ```
-bool libtock_[name]_exists(void);
+bool libtock_[name]_driver_exists(void);
 ```
 
 Example:
 
 ```c
-bool libtock_[name]_exists(void) {
+bool libtock_[name]_driver_exists(void) {
   return driver_exists(DRIVER_NUM_[NAME]);
 }
 ```
@@ -202,7 +202,6 @@ The `[name].h` header file must look like:
 #pragma once
 
 #include "../tock.h"
-#include "syscalls/[name]_syscalls.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -215,7 +214,8 @@ extern "C" {
 #endif
 ```
 
-The `[name].h` header file must include the syscalls header.
+The `[name].h` header file must NOT include the syscalls header. Applications
+wanting to use the syscalls directly must include the syscalls header.
 
 ### Defining a Callback for Asynchronous Operations
 
@@ -236,6 +236,24 @@ they should have the last argument be a callback function pointer.
 returncode_t libtock_[name]_[desc](<arguments>, libtock_[name]_callback_[desc] cb);
 ```
 
+#### Exists
+
+There must be a function to check for syscall driver existence.
+
+Signature:
+
+```
+bool libtock_[name]_exists(void);
+```
+
+Example:
+
+```c
+bool libtock_[name]_exists(void) {
+  return libtock_[name]_driver_exists();
+}
+```
+
 ### Example:
 
 
@@ -309,7 +327,6 @@ file is used in a C++ app.
 #pragma once
 
 #include <libtock/tock.h>
-#include <libtock/[category]/syscalls/[name]_syscalls.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -379,7 +396,6 @@ The libtock-sync `[name].h` header file must look like:
 ```c
 #pragma once
 
-#include "syscalls/temperature_syscalls.h"
 #include <libtock/tock.h>
 
 #ifdef __cplusplus

examples/lvgl/main.c

@@ -4,6 +4,7 @@
 
 #include <libtock-sync/display/screen.h>
 #include <libtock-sync/services/alarm.h>
+#include <libtock/peripherals/syscalls/alarm_syscalls.h>
 
 #include "lvgl_driver.h"
 

examples/sensors/main.c

@@ -72,14 +72,14 @@ int main(void) {
   printf("[Sensors] All available sensors on the platform will be sampled.\n");
 
   /* *INDENT-OFF* */
-  light          = libtock_ambient_light_exists();
-  temperature    = libtock_temperature_exists();
-  humidity       = libtock_humidity_exists();
-  ninedof        = libtock_ninedof_exists();
-  proximity      = libtock_proximity_exists();
-  sound_pressure = libtock_sound_pressure_exists();
-  moisture       = libtock_moisture_exists();
-  rainfall       = libtock_rainfall_exists();
+  light          = libtocksync_ambient_light_exists();
+  temperature    = libtocksync_temperature_exists();
+  humidity       = libtocksync_humidity_exists();
+  ninedof        = libtocksync_ninedof_exists();
+  proximity      = libtocksync_proximity_exists();
+  sound_pressure = libtocksync_sound_pressure_exists();
+  moisture       = libtocksync_moisture_exists();
+  rainfall       = libtocksync_rainfall_exists();
   /* *INDENT-ON* */
 
   if (ninedof) {
@@ -103,7 +103,7 @@ int main(void) {
   /* *INDENT-ON* */
 
   if (sound_pressure) {
-    libtock_sound_pressure_command_enable();
+    libtocksync_sound_pressure_enable();
   }
 
   // Setup periodic alarm to sample the sensors.

examples/services/ble-env-sense/test-with-sensors/main.c

@@ -45,7 +45,7 @@ static void do_sensing_cb(__attribute__ ((unused)) uint32_t now,
   int temp  = 0;
   int humi  = 0;
 
-  if (driver_exists(DRIVER_NUM_AMBIENT_LIGHT)) {
+  if (libtocksync_ambient_light_exists()) {
     libtocksync_ambient_light_read_intensity(&light);
 
     update->type  = SENSOR_IRRADIANCE;
@@ -55,7 +55,7 @@ static void do_sensing_cb(__attribute__ ((unused)) uint32_t now,
     yield_for(&_ipc_done);
   }
 
-  if (driver_exists(DRIVER_NUM_TEMPERATURE)) {
+  if (libtocksync_temperature_exists()) {
     libtocksync_temperature_read(&temp);
 
     update->type  = SENSOR_TEMPERATURE;
@@ -65,7 +65,7 @@ static void do_sensing_cb(__attribute__ ((unused)) uint32_t now,
     yield_for(&_ipc_done);
   }
 
-  if (driver_exists(DRIVER_NUM_HUMIDITY)) {
+  if (libtocksync_humidity_exists()) {
     libtocksync_humidity_read(&humi);
 
     update->type  = SENSOR_HUMIDITY;

examples/servo/main.c

@@ -2,13 +2,13 @@
 #include <stdlib.h>
 
 #include <libtock-sync/services/alarm.h>
+#include <libtock/interface/syscalls/servo_syscalls.h>
 #include <libtock/tock.h>
 
-#include "../../libtock/interface/syscalls/servo_syscalls.h"
 
 int main(void) {
   // Checks if the driver exists and, if not, returns -1.
-  if (!libtock_servo_exists()) {
+  if (!libtock_servo_driver_exists()) {
     printf("There is no available servo\n");
     return -1;
   }

examples/tests/adc/adc/main.c

@@ -6,6 +6,7 @@
 #include <libtock-sync/peripherals/adc.h>
 #include <libtock-sync/services/alarm.h>
 #include <libtock/interface/console.h>
+#include <libtock/peripherals/syscalls/adc_syscalls.h>
 #include <libtock/tock.h>
 
 int reference_voltage;

examples/tests/aes/main.c

@@ -3,6 +3,7 @@
 #include <string.h>
 
 #include <libtock/crypto/aes.h>
+#include <libtock/crypto/syscalls/aes_syscalls.h>
 
 #define KEY_LEN  16
 #define IV_LEN  16

examples/tests/alarms/multi_alarm_simple_overflow_test/main.c

@@ -2,6 +2,7 @@
 #include <stdlib.h>
 
 #include <libtock-sync/services/alarm.h>
+#include <libtock/peripherals/syscalls/alarm_syscalls.h>
 
 static void event_cb(uint32_t now, uint32_t expiration, void* ud) {
   int i = (int)ud;

examples/tests/analog_comparator/main.c

@@ -4,6 +4,7 @@
 
 #include <libtock-sync/services/alarm.h>
 #include <libtock/peripherals/analog_comparator.h>
+#include <libtock/peripherals/syscalls/analog_comparator_syscalls.h>
 #include <libtock/tock.h>
 
 static int callback_channel;

examples/tests/callback_remove_test01/main.c

@@ -2,6 +2,7 @@
 #include <stdlib.h>
 
 #include <libtock-sync/services/alarm.h>
+#include <libtock/peripherals/syscalls/alarm_syscalls.h>
 
 volatile int a = 0;
 int b = 0;