Ci test

examples/ci-tests/ble/Makefile

@@ -0,0 +1,17 @@
+# Makefile for user application
+
+# Specify this directory relative to the current application.
+TOCK_USERLAND_BASE_DIR = ../../..
+
+# Which files to compile.
+C_SRCS := $(wildcard *.c)
+
+# External libraries used
+EXTERN_LIBS += $(TOCK_USERLAND_BASE_DIR)/simple-ble
+
+# Include userland master makefile. Contains rules and flags for actually
+# building the application.
+include $(TOCK_USERLAND_BASE_DIR)/AppMakefile.mk
+
+# Include simple-ble's Makefile so it's rebuilt automatically
+include $(TOCK_USERLAND_BASE_DIR)/simple-ble/Makefile

examples/ci-tests/ble/README.md

@@ -0,0 +1,15 @@
+# Hardware CI Tests
+
+## Run Python Test
+
+To run the test,
+```bash
+sudo python3 test.py Nrf52840GpioTest
+```
+
+Switch board name to the test you intend to run. Otherwise, python unittest
+will attempt to run all tests.
+
+Board | Test Name
+------|----------
+nrf52840dk | Nrf52840Test

examples/ci-tests/ble/main.c

@@ -0,0 +1,74 @@
+#include <ble.h>
+#include <gap.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <tock.h>
+
+// Sizes in bytes
+#define DEVICE_NAME_SIZE 6
+#define UUIDS_SIZE 4
+#define MANUFACTURER_DATA_SIZE 2
+#define FAKE_TEMPERATURE_DATA_SIZE 2
+
+/*******************************************************************************
+ * MAIN
+ ******************************************************************************/
+
+int main(void) {
+  int err;
+  printf("[Tutorial] BLE Advertising\n");
+
+  // declarations of variables to be used in this BLE example application
+  uint16_t advertising_interval_ms = 20;
+  uint8_t device_name[]            = "TockOS";
+  uint16_t uuids[]                 = {0x1800, 0x1809};
+  uint8_t manufacturer_data[]      = {0x13, 0x37};
+  uint8_t fake_temperature_data[]  = {0x00, 0x00};
+
+  static uint8_t adv_data_buf[ADV_DATA_MAX_SIZE];
+
+  // configure advertisement interval to 300ms
+  // configure LE only and discoverable
+  printf(" - Initializing BLE... %s\n", device_name);
+  AdvData_t adv_data = gap_adv_data_new(adv_data_buf, sizeof(adv_data_buf));
+
+  gap_add_flags(&adv_data, LE_GENERAL_DISCOVERABLE | BREDR_NOT_SUPPORTED);
+
+  // configure device name as TockOS
+  printf(" - Setting the device name... %s\n", device_name);
+  err = gap_add_device_name(&adv_data, device_name, DEVICE_NAME_SIZE);
+  if (err < RETURNCODE_SUCCESS)
+    printf("ble_advertise_name, error: %s\r\n", tock_strrcode(err));
+
+  // configure list of UUIDs */
+  printf(" - Setting the device UUID...\n");
+  err = gap_add_service_uuid16(&adv_data, uuids, UUIDS_SIZE);
+  if (err < RETURNCODE_SUCCESS)
+    printf("ble_advertise_uuid16, error: %s\r\n", tock_strrcode(err));
+
+  // configure manufacturer data
+  printf(" - Setting manufacturer data...\n");
+  err = gap_add_manufacturer_specific_data(&adv_data, manufacturer_data,
+                                           MANUFACTURER_DATA_SIZE);
+  if (err < RETURNCODE_SUCCESS)
+    printf("ble_advertise_manufacturer_specific_data, error: %s\r\n",
+           tock_strrcode(err));
+
+  // configure service data
+  printf(" - Setting service data...\n");
+  err = gap_add_service_data(&adv_data, uuids[1], fake_temperature_data,
+                             FAKE_TEMPERATURE_DATA_SIZE);
+  if (err < RETURNCODE_SUCCESS)
+    printf("ble_advertise_service_data, error: %s\r\n", tock_strrcode(err));
+
+  // start advertising
+  printf(" - Begin advertising! %s\n", device_name);
+  err = ble_start_advertising(ADV_NONCONN_IND, adv_data.buf, adv_data.offset, advertising_interval_ms);
+  if (err < RETURNCODE_SUCCESS)
+    printf("ble_start_advertising, error: %s\r\n", tock_strrcode(err));
+
+  // configuration complete
+  printf("Now advertising every %d ms as '%s'\n", advertising_interval_ms,
+         device_name);
+  return 0;
+}

examples/ci-tests/ble/test.py

@@ -0,0 +1,146 @@
+# BLE Test
+# This tester corresponds to libtock-c/examples/ci-tests/ble test.
+
+import logging
+import time
+import unittest
+import os
+import subprocess
+
+TARGET_NAME = 'TockOS'
+
+################################################################################
+# Helper classes and functions
+################################################################################
+
+def time_gap(start_time):
+    """Return time gap between current time and start_time
+    Argument:
+    start_time - Start time
+    """
+    return "{:.6f}".format(time.time() - start_time)
+
+# END
+
+################################################################################
+# Start test and logger
+################################################################################
+
+# Test Start Time
+TEST_START_TIME = time.time()
+
+# Logger set format
+LOG_FORMAT = "%(timegap)s %(levelname)s -- %(message)s"
+logging.basicConfig(format=LOG_FORMAT)
+
+# Logger add formatter
+logger = logging.getLogger('BLE Test')
+logger.setLevel('INFO')
+
+logger.info('Initiating BLE test...',
+            extra={'timegap': time_gap(TEST_START_TIME)})
+
+# END
+
+################################################################################
+# Test Case Module
+################################################################################
+
+class BleTest(unittest.TestCase):
+    def test_ble_advertise(self):
+        """Check if the advertised device name can be found"""
+        # Change line from docs to logging info
+        print()
+
+        logger.info('Bluetooth Status on RPi Harness\n',
+            extra={'timegap': time_gap(TEST_START_TIME)})
+        os.system('sudo systemctl status bluetooth')
+        print() # Line change
+        os.system('sudo systemctl status hciuart')
+        print() # Line change
+        # os.system('sudo timeout 5 stdbuf -oL hcitool lescan')
+        # print() # Line change
+        scan_cmd = 'sudo timeout 5 stdbuf -oL hcitool lescan'
+
+        # BLE scan flag
+        found = False
+
+        try:
+            scan_result = subprocess.check_output(scan_cmd, 
+                                              stderr=subprocess.STDOUT,
+                                              shell=True)
+            scan_result_str = scan_result.decode('ascii')
+            logger.info('Scan result:\n' + scan_result_str,
+                        extra={'timegap': time_gap(TEST_START_TIME)})
+
+            # Search for target board name
+            scan_entries = scan_result_str.split('\n')
+            print(scan_entries)
+
+            for entry in scan_entries:
+                mac_addr, name = entry.split(' ')
+                print(name)
+
+                if name == TARGET_NAME:
+                    found = True
+
+        except subprocess.CalledProcessError as err:
+            # Print error
+            scan_result_str = err.output.decode('ascii')
+
+            logger.info('Scan result error:\n' + scan_result_str,
+                        extra={'timegap': time_gap(TEST_START_TIME)})
+
+            # Search for target board name
+            scan_entries = scan_result_str.split('\n')
+
+            for entry in scan_entries:
+                if entry != '':
+                    mac_addr, name = entry.split(' ', 1)
+
+                    if name == TARGET_NAME:
+                        found = True
+
+        finally:
+            logger.info('BLE scan ended.',
+                extra={'timegap': time_gap(TEST_START_TIME)})
+
+            # Restart bluetooth
+            # Note: the scanning process is corrupted whenever we try to kill it, so
+            #       for now, we resort to restarting bluetooth every test, but if
+            #       there is a better implementation, feel free to change this.
+            logger.info('Restarting test harness bluetooth.',
+                extra={'timegap': time_gap(TEST_START_TIME)})
+            os.system('sudo hciconfig hci0 down; sudo hciconfig hci0 up')
+
+            self.assertTrue(found)
+
+# END
+
+################################################################################
+# Test Case Setup
+################################################################################
+
+class Nrf52840Test(BleTest):
+    def setUp(self):
+        logger.info('Setting up for nrf52840dk BLE test...',
+            extra={'timegap': time_gap(TEST_START_TIME)})
+
+class HailTest(BleTest):
+    def setUp(self):
+        logger.info('Setting up for nrf52840dk BLE test...',
+            extra={'timegap': time_gap(TEST_START_TIME)})
+
+class Nrf52Test(BleTest):
+    def setUp(self):
+        logger.info('Setting up for nrf52dk BLE test...',
+            extra={'timegap': time_gap(TEST_START_TIME)})
+
+# END
+
+################################################################################
+# Main
+################################################################################
+
+if __name__ == '__main__':
+    unittest.main()

examples/ci-tests/boot-up/README.md

@@ -0,0 +1,26 @@
+# On Boot Up Scripts
+
+## Run Python i2cboot
+
+**Important:** This script is used to solve the cold-start problem the raspberry pi has on boot when running as slave. Currently, after booting the pi, the first i2c master test on a board (tests that require the RPi to act as a slave) will have an empty buffer, causing test to fail. However, after the first test script for master rx/tx is executed, the tests will now pass and buffer is filled properly. To solve this issue, we run this script on boot for the RPi whenever logged in from ssh to run the initial transaction for testing scripts to pass when necessary and not be affected by this cold-start issue. 
+
+`i2cboot.py` provides basic test that sends message from slave to master, and waits for master to send message containing the slave message. This is essentially a Rx/Tx test, but we are primarily focusing on the reception of master here. The message sent from master will be printed over a 4 second period. If message sent from master is the exact same from message sent from slave, the script will pass - but this does not matter (Expected to fail)
+
+To run the test,
+```bash
+sudo python3 i2cboot.py
+```
+
+Boards supported.
+
+Board |
+------|
+nrf52840dk |
+
+**NOTE**
+This script requires the Raspberry Pi to be set as slave. Thus, you must use Broadcom Pins 10 & 11 (SDA & SCL resepectively) or GPIO pin 19 and 23. You must also download the open source python library "pigpio" which enables slave access on the Raspberry Pi. How to download the library is done here on **CI Hardware Documentation - Raspberry Pi setup**
+
+This script requires button activation on tested boards. Two jumpers are required for the activation of the reset button and user button on boards. Broadcom Pins on Raspberry PI used are pins 20 & 21 (GPIO Pins 38 & 40) which are used for user button and reset respectively.
+
+This test utilizes the pigpio open source library, but the function utilized, `bsc_i2c` , has a delay when updating the slave buffer being sent to master. This delay, to be specific, is that it takes an i2c transaction between master and slave to update the slave buffer properly. This is a limitation of the RPi slave configuration, not the board being tested i2c configuration. To combat this, we utilize a dummy transaction that runs a i2c transaction of sending messages for 4 seconds to master from slave, then reopens a transaction (the transacton being tested) with the updated slave buffer properly timed. For more information about this delay and what exactly is happening to handle it, check the code `i2cboot.py` and the function `dummy_transaction`.
+