mock: added mraa mock platform infra and GPIO implementation

Mock platform allows one to use mraa without having any real HW.

This commit makes necessary foundational changes and implements
GPIO functionality as well as adds respective tests.

Signed-off-by: Alex Tereschenko <alext.mkrs@gmail.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>

src/CMakeLists.txt

@@ -84,6 +84,11 @@ set (mraa_LIB_ARM_SRCS_NOAUTO
   ${PROJECT_SOURCE_DIR}/src/arm/banana.c
 )
 
+set (mraa_LIB_MOCK_SRCS_NOAUTO
+  ${PROJECT_SOURCE_DIR}/src/mock/mock.c
+  ${PROJECT_SOURCE_DIR}/src/mock/mock_board.c
+)
+
 set (mraa_LIBS ${CMAKE_THREAD_LIBS_INIT})
 
 if (X86PLAT)
@@ -96,6 +101,11 @@ if (ARMPLAT)
   set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DARMPLAT=1")
 endif()
 
+if (MOCKPLAT)
+  add_subdirectory(mock)
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DMOCKPLAT=1")
+endif()
+
 if (USBPLAT)
   message (STATUS "INFO - Adding USB platforms")
   set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSBPLAT=1")

src/gpio/gpio.c

@@ -382,6 +382,10 @@ mraa_gpio_isr(mraa_gpio_context dev, mraa_gpio_edge_t mode, void (*fptr)(void*),
         return MRAA_ERROR_INVALID_HANDLE;
     }
 
+    if (IS_FUNC_DEFINED(dev, gpio_isr_replace)) {
+        return dev->advance_func->gpio_isr_replace(dev, mode, fptr, args);
+    }
+
     // we only allow one isr per mraa_gpio_context
     if (dev->thread_id != 0) {
         return MRAA_ERROR_NO_RESOURCES;
@@ -417,6 +421,10 @@ mraa_gpio_isr_exit(mraa_gpio_context dev)
         return MRAA_ERROR_INVALID_HANDLE;
     }
 
+    if (IS_FUNC_DEFINED(dev, gpio_isr_exit_replace)) {
+        return dev->advance_func->gpio_isr_exit_replace(dev);
+    }
+
     // wasting our time, there is no isr to exit from
     if (dev->thread_id == 0 && dev->isr_value_fp == -1) {
         return ret;
@@ -610,6 +618,10 @@ mraa_gpio_read_dir(mraa_gpio_context dev, mraa_gpio_dir_t *dir)
         return MRAA_ERROR_INVALID_HANDLE;
     }
 
+    if (IS_FUNC_DEFINED(dev, gpio_read_dir_replace)) {
+        return dev->advance_func->gpio_read_dir_replace(dev, dir);
+    }
+
     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/direction", dev->pin);
     fd = open(filepath, O_RDONLY);
     if (fd == -1) {

src/mock/CMakeLists.txt

@@ -0,0 +1,3 @@
+message (INFO " - Adding mock platform")
+set (mraa_LIB_PLAT_SRCS_NOAUTO ${mraa_LIB_SRCS_NOAUTO}
+     ${mraa_LIB_MOCK_SRCS_NOAUTO} PARENT_SCOPE)

src/mock/mock.c

@@ -0,0 +1,43 @@
+/*
+ * Author: Alex Tereschenko <alext.mkrs@gmail.com>
+ * Copyright (c) 2016 Alex Tereschenko.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <stdlib.h>
+
+#include "mraa_internal.h"
+
+#include "mock/mock_board.h"
+
+mraa_platform_t
+mraa_mock_platform()
+{
+    mraa_platform_t platform_type = MRAA_MOCK_PLATFORM;
+    plat = mraa_mock_board();
+
+    if (plat == NULL) {
+        syslog(LOG_ERR, "Was not able to initialize mock platform");
+        return MRAA_ERROR_PLATFORM_NOT_INITIALISED;
+    }
+
+    return platform_type;
+}

src/mock/mock_board.c

@@ -0,0 +1,193 @@
+/*
+ * Author: Alex Tereschenko <alext.mkrs@gmail.com>
+ * Copyright (c) 2016 Alex Tereschenko.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "common.h"
+#include "mock/mock_board.h"
+
+#define PLATFORM_NAME "MRAA mock platform"
+
+mraa_result_t
+mraa_mock_gpio_init_internal_replace(mraa_gpio_context dev, int pin)
+{
+    dev->value_fp = -1;
+    dev->isr_value_fp = -1;
+    dev->isr_thread_terminating = 0;
+    dev->phy_pin = pin;
+    // We are always the owner
+    dev->owner = 1;
+#ifndef HAVE_PTHREAD_CANCEL
+    dev->isr_control_pipe[0] = dev->isr_control_pipe[1] = -1;
+#endif
+
+    // We start as INPUT and LOW
+    dev->mock_dir = MRAA_GPIO_IN;
+    dev->mock_state = 0;
+
+    return MRAA_SUCCESS;
+}
+
+mraa_result_t
+mraa_mock_gpio_close_replace(mraa_gpio_context dev)
+{
+    free(dev);
+    return MRAA_SUCCESS;
+}
+
+mraa_result_t
+mraa_mock_gpio_dir_replace(mraa_gpio_context dev, mraa_gpio_dir_t dir)
+{
+    switch (dir) {
+        case MRAA_GPIO_OUT_HIGH:
+            dev->mock_dir = MRAA_GPIO_OUT;
+            return mraa_gpio_write(dev, 1);
+        case MRAA_GPIO_OUT_LOW:
+            dev->mock_dir = MRAA_GPIO_OUT;
+            return mraa_gpio_write(dev, 0);
+        case MRAA_GPIO_IN:
+        case MRAA_GPIO_OUT:
+            dev->mock_dir = dir;
+            return MRAA_SUCCESS;
+        default:
+            syslog(LOG_ERR, "gpio: dir: invalid direction '%d' to set", (int) dir);
+            return MRAA_ERROR_INVALID_PARAMETER;
+    }
+}
+
+mraa_result_t
+mraa_mock_gpio_read_dir_replace(mraa_gpio_context dev, mraa_gpio_dir_t* dir)
+{
+    *dir = dev->mock_dir;
+    return MRAA_SUCCESS;
+}
+
+int
+mraa_mock_gpio_read_replace(mraa_gpio_context dev)
+{
+    return dev->mock_state;
+}
+
+mraa_result_t
+mraa_mock_gpio_write_replace(mraa_gpio_context dev, int value)
+{
+    if ((value < 0) || (value > 1)) {
+        syslog(LOG_ERR, "gpio: write: incorrect value '%d' passed to write(), must be 0 or 1", value);
+        return MRAA_ERROR_INVALID_PARAMETER;
+    }
+
+    if (dev->mock_dir == MRAA_GPIO_IN) {
+        syslog(LOG_ERR, "gpio: write: cannot write to pin set to INPUT");
+        return MRAA_ERROR_INVALID_RESOURCE;
+    }
+
+    dev->mock_state = value;
+    return MRAA_SUCCESS;
+}
+
+mraa_result_t
+mraa_mock_gpio_edge_mode_replace(mraa_gpio_context dev, mraa_gpio_edge_t mode)
+{
+    return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
+}
+
+mraa_result_t
+mraa_mock_gpio_isr_replace(mraa_gpio_context dev, mraa_gpio_edge_t mode, void (*fptr)(void*), void* args)
+{
+    return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
+}
+
+mraa_result_t
+mraa_mock_gpio_isr_exit_replace(mraa_gpio_context dev)
+{
+    return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
+}
+
+mraa_result_t
+mraa_mock_gpio_mode_replace(mraa_gpio_context dev, mraa_gpio_mode_t mode)
+{
+    return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
+}
+
+mraa_board_t*
+mraa_mock_board()
+{
+    mraa_board_t* b = (mraa_board_t*) calloc(1, sizeof(mraa_board_t));
+    if (b == NULL) {
+        return NULL;
+    }
+
+    // General board definitions
+    b->platform_name = PLATFORM_NAME;
+    b->phy_pin_count = MRAA_MOCK_PINCOUNT;
+    b->aio_count = 1;
+    b->adc_raw = 12;
+    b->adc_supported = 10;
+    b->i2c_bus_count = 0;
+    b->spi_bus_count = 0;
+
+    b->pwm_default_period = 0;
+    b->pwm_max_period = 0;
+    b->pwm_min_period = 0;
+
+    b->pins = (mraa_pininfo_t*) malloc(sizeof(mraa_pininfo_t) * MRAA_MOCK_PINCOUNT);
+    if (b->pins == NULL) {
+        goto error;
+    }
+
+    b->adv_func = (mraa_adv_func_t*) calloc(1, sizeof(mraa_adv_func_t));
+    if (b->adv_func == NULL) {
+        free(b->pins);
+        goto error;
+    }
+
+    // Replace functions
+    b->adv_func->gpio_init_internal_replace = &mraa_mock_gpio_init_internal_replace;
+    b->adv_func->gpio_close_replace = &mraa_mock_gpio_close_replace;
+    b->adv_func->gpio_dir_replace = &mraa_mock_gpio_dir_replace;
+    b->adv_func->gpio_read_dir_replace = &mraa_mock_gpio_read_dir_replace;
+    b->adv_func->gpio_read_replace = &mraa_mock_gpio_read_replace;
+    b->adv_func->gpio_write_replace = &mraa_mock_gpio_write_replace;
+    b->adv_func->gpio_edge_mode_replace = &mraa_mock_gpio_edge_mode_replace;
+    b->adv_func->gpio_isr_replace = &mraa_mock_gpio_isr_replace;
+    b->adv_func->gpio_isr_exit_replace = &mraa_mock_gpio_isr_exit_replace;
+    b->adv_func->gpio_mode_replace = &mraa_mock_gpio_mode_replace;
+
+    // Pin definitions
+    int pos = 0;
+
+    strncpy(b->pins[pos].name, "GPIO0", 8);
+    b->pins[pos].capabilites = (mraa_pincapabilities_t){ 1, 1, 0, 0, 0, 0, 0, 0 };
+    b->pins[pos].gpio.pinmap = 0;
+    b->pins[pos].gpio.mux_total = 0;
+    pos++;
+
+    return b;
+
+error:
+    syslog(LOG_CRIT, "MRAA mock: Platform failed to initialise");
+    free(b);
+    return NULL;
+}

src/mraa.c

@@ -120,6 +120,9 @@ imraa_init()
 #elif defined(ARMPLAT)
     // Use runtime ARM platform detection
     platform_type = mraa_arm_platform();
+#elif defined(MOCKPLAT)
+    // Use mock platform
+    platform_type = mraa_mock_platform();
 #else
 #error mraa_ARCH NOTHING
 #endif