Merge pull request #6082 from AriParkkila/master

Mbed OS cellular connectivity

Author: adbridge

.travis.yml

@@ -111,7 +111,7 @@ matrix:
         - python tools/make.py -t GCC_ARM -m K64F --source=. --build=BUILD/K64F/GCC_ARM -j0
         # Check that example compiles without rtos
         - sed -n '/``` cpp/,/```/{/```$/Q;/```/d;p;}' $EVENTS/README.md > main.cpp
-        - rm -r rtos features/netsocket features/frameworks BUILD
+        - rm -r rtos features/cellular features/netsocket features/frameworks BUILD
         - python tools/make.py -t GCC_ARM -m DISCO_F401VC --source=. --build=BUILD/DISCO_F401VC/GCC_ARM -j0
         # Run local equeue tests
         - make -C $EVENTS/equeue test

features/cellular/.gitignore

@@ -0,0 +1,12 @@
+lcov/
+results/
+coverages/
+gcov/
+*.exe
+*.o
+*.d
+*.a
+*.gcda
+*.gcno
+cpputest_*.xml
+*_unit_tests*

features/cellular/.mbedignore

@@ -0,0 +1 @@
+UNITTESTS/*

features/cellular/Makefile.test

@@ -0,0 +1,56 @@
+#
+# Makefile.test for CIot library unit tests
+#
+
+
+# List of subdirectories to build
+TEST_FOLDER_NAME := UNITTESTS
+TEST_FOLDER := ./UNITTESTS/
+# List of unit test directories for libraries
+UNITTESTS := $(sort $(dir $(wildcard $(TEST_FOLDER)*)))
+TESTDIRS := $(UNITTESTS:%=build-%)
+CLEANTESTDIRS := $(UNITTESTS:%=clean-%)
+COVERAGEFILE := ./lcov/coverage.info
+
+.PHONY: test
+test: $(TESTDIRS)
+	@rm -rf ./lcov
+	@rm -rf ./coverage
+	@mkdir -p lcov
+	@mkdir -p lcov/results
+	@mkdir coverage
+	@find $(TEST_FOLDER) -name '*.xml' | xargs cp -t ./lcov/results/
+	@rm -f lcov/index.xml
+	@./xsl_script.sh
+	@cp junit_xsl.xslt lcov/.
+	@xsltproc -o lcov/testresults.html lcov/junit_xsl.xslt lcov/index.xml
+	@rm -f lcov/junit_xsl.xslt
+	@rm -f lcov/index.xml
+	@find ./ -name '*.gcno' | xargs cp --backup=numbered -t ./coverage/
+	@find ./ -name '*.gcda' | xargs cp --backup=numbered -t ./coverage/
+	@gcovr --object-directory ./coverage  --exclude-unreachable-branches -e '.*/builds/.*' -e '.*/$(TEST_FOLDER_NAME)/.*' -e '.*/yotta_modules/.*' -e '.*/stubs/.*' -e '.*/mbed-coap/.*' -x -o ./lcov/gcovr.xml
+	@lcov -d $(TEST_FOLDER_NAME)/. -c -o $(COVERAGEFILE)
+	@lcov -q -r $(COVERAGEFILE) "/usr*" -o $(COVERAGEFILE)
+	@lcov -q -r $(COVERAGEFILE) "/$(TEST_FOLDER_NAME)*" -o $(COVERAGEFILE)
+	@lcov -q -r $(COVERAGEFILE) "/mbed-client-libservice*" -o $(COVERAGEFILE)
+	@lcov -q -r $(COVERAGEFILE) "/mbed-client*" -o $(COVERAGEFILE)
+	@lcov -q -r $(COVERAGEFILE) "/mbed-os/events*" -o $(COVERAGEFILE)
+	@lcov -q -r $(COVERAGEFILE) "/mbed-os/features/netsocket*" -o $(COVERAGEFILE)
+	@lcov -q -r $(COVERAGEFILE) "/mbed-os/platform*" -o $(COVERAGEFILE)
+	@genhtml -q $(COVERAGEFILE) --output-directory lcov/html
+	@echo mbed-ciot module unit tests built
+
+$(TESTDIRS):
+	@make -C $(@:build-%=%)
+
+$(CLEANDIRS):
+	@make -C $(@:clean-%=%) clean
+
+$(CLEANTESTDIRS):
+	@make -C $(@:clean-%=%) clean
+
+# Extend default clean rule
+clean: clean-extra
+
+clean-extra: $(CLEANDIRS) \
+	$(CLEANTESTDIRS)

features/cellular/README.md

@@ -0,0 +1,73 @@
+# Mbed cellular connectivity
+
+This is the Github repo for Mbed cellular connectivity:
+
+    easy_cellular/
+        EasyCellularConnection  Simplified cellular usage based on `CellularBase.h`
+        CellularConnectionUtil  A utility class for cellular connection
+
+    framework/
+        API         Application Programming Interface for cellular connectivity
+        AT          AT implementation based on 3GPP TS 27.007 specification
+        common      Common and utility sources
+        targets     Vendor specific cellular module adaptations
+
+## Known limitations
+
+**Please note that this is a first release of Cellular framework and is subject to further development in future.**
+
+Only UDP is supported when using AT commands to control sockets in an IP stack built into the cellular modem. If TCP is required, use the PPP/LWIP stack.
+
+## Supported modules
+
+You can find currently supported cellular modules in the `framework/targets/` folder, where we also add support for new cellular modules.
+
+## Cellular configuration
+
+You can change cellular defaults in the `mbed_app.json` configuration file:
+
+    "config": {
+        "cellular_plmn": {
+            "help": "PLMN selection, 0=auto",
+            "value": 0
+        },
+        "apn": {
+            "help": "Access point name, e.g. internet",
+            "value": "\"internet\""
+        },
+        "cellular_sim_pin": {
+            "help": "PIN code",
+            "value": "\"1234\""
+        }
+    }
+
+## Debug traces
+
+You can define the debug tracing level in the `mbed_app.json` configuration file:
+
+    "target_overrides": {
+        "*": {
+            "target.features_add": ["COMMON_PAL"],
+            "mbed-trace.enable": true,
+            "platform.stdio-convert-newlines": true,
+            "platform.stdio-baud-rate": 115200,
+            "platform.default-serial-baud-rate": 115200
+        }
+    },
+    "config": {
+        "trace-level": {
+            "help": "Options are TRACE_LEVEL_ERROR,TRACE_LEVEL_WARN,TRACE_LEVEL_INFO,TRACE_LEVEL_DEBUG",
+            "macro_name": "MBED_TRACE_MAX_LEVEL",
+            "value": "TRACE_LEVEL_INFO"
+        }
+    }
+
+## Unit tests
+
+The `UNITTESTS` folder contains unit tests for cellular specific classes. Unit tests are based on the stubbing method.
+
+You can run those tests locally by running `./run_tests` script under the `UNITTESTS/` folder.
+
+You need the following applications: `cpputest`, `gcov` and `lcov` (genhtml) for running the tests.
+
+After you have run the `run_tests` script, you can find test results under `UNITTESTS/results` folder and line and function coverages under the `UNITTESTS/coverages` folder.

features/cellular/TESTS/cellular/cellular_all/CellularTests.h

@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2017, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef CELLULAR_TESTS_H
+#define CELLULAR_TESTS_H
+
+#include "CellularUtil.h" // for CELLULAR_ helper macros
+#include "CellularTargets.h"
+
+#ifdef CELLULAR_DEVICE
+
+#include "mbed_events.h"
+
+#include "greentea-client/test_env.h"
+#include "unity.h"
+#include "utest.h"
+
+#include "CellularLog.h"
+
+#include CELLULAR_STRINGIFY(CELLULAR_DEVICE.h)
+extern EventQueue queue;
+extern CELLULAR_DEVICE cellularDevice;
+
+extern UARTSerial serial;
+extern CellularNetwork *network;
+
+extern CellularSMS *sms;
+extern CellularPower *pwr;
+extern CellularSIM *sim;
+
+
+/**
+ * TEST CASES DEFINED HERE AND in main.cpp
+ */
+
+// power
+void test_create_power(void);
+
+// SIM
+void test_get_sim_state(void);
+void test_set_pin(void);
+void test_change_pin(void);
+
+// sms
+void test_sms_init(void);
+
+// network
+void test_attach(void);
+void test_connect(void);
+void test_get_ip_address(void);
+void test_disconnect(void);
+
+// stack
+void test_socket_open(void);
+void test_socket_bind(void);
+/*
+void test_socket_set_blocking();
+void test_socket_send_receive_blocking();
+*/
+void test_socket_set_non_blocking();
+void test_socket_send_receive_non_blocking();
+void test_socket_close(void);
+
+// Test closing all interface via device
+void test_close_interfaces(void);
+
+#endif // CELLULAR_DEVICE
+
+#endif // CELLULAR_TESTS_H

features/cellular/TESTS/cellular/cellular_all/main.cpp

@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2017, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "CellularTests.h"
+
+#if !defined(MBED_CONF_NSAPI_PRESENT)
+#error [NOT_SUPPORTED] A json configuration file is needed. Skipping this build.
+#endif
+
+#ifndef CELLULAR_DEVICE
+#error [NOT_SUPPORTED] CELLULAR_DEVICE must be defined for this test
+#endif
+
+EventQueue queue(32 * EVENTS_EVENT_SIZE);
+Thread t;
+CELLULAR_DEVICE cellularDevice(queue);
+
+UARTSerial serial(MDMTXD, MDMRXD, MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
+CellularNetwork *network = NULL;
+CellularPower *pwr = NULL;
+CellularSIM *sim = NULL;
+CellularSMS *sms = NULL;
+
+using namespace utest::v1;
+
+// using namespace mbed;
+utest::v1::status_t greentea_failure_handler(const Case *const source, const failure_t reason)
+{
+    greentea_case_failure_abort_handler(source, reason);
+    return STATUS_CONTINUE;
+}
+
+Case cases[] = {
+    // power test
+    Case("Create power", test_create_power, greentea_failure_handler),
+#ifdef MBED_CONF_APP_CELLULAR_SIM_PIN
+    // sim test
+    Case("test get SIM state", test_get_sim_state, greentea_failure_handler),
+    Case("SIM set pin", test_set_pin, greentea_failure_handler),
+    Case("SIM change pin", test_change_pin, greentea_failure_handler),
+#endif
+    // network tests
+    Case("attach", test_attach, greentea_failure_handler),
+    // SMS tests
+    Case("SMS init", test_sms_init, greentea_failure_handler),
+    // network tests
+    Case("connect", test_connect, greentea_failure_handler),
+    Case("get_ip_address", test_get_ip_address, greentea_failure_handler),
+    // stack tests
+    Case("open", test_socket_open, greentea_failure_handler),
+    Case("bind", test_socket_bind, greentea_failure_handler),
+//    Case("set socket blocking", test_socket_set_blocking, greentea_failure_handler),
+//    Case("socket send receive in blocking mode", test_socket_send_receive_blocking, greentea_failure_handler),
+    Case("set socket non blocking", test_socket_set_non_blocking, greentea_failure_handler),
+    Case("socket send receive in non blocking mode", test_socket_send_receive_non_blocking, greentea_failure_handler),
+    Case("close", test_socket_close, greentea_failure_handler),
+    // network tests
+    Case("disconnect", test_disconnect, greentea_failure_handler),
+
+    // test closing of all interface, must be the last test case
+    Case("Close all Interfaces", test_close_interfaces, greentea_failure_handler)
+};
+
+utest::v1::status_t test_setup(const size_t number_of_cases)
+{
+    GREENTEA_SETUP(300, "default_auto");
+
+    return verbose_test_setup_handler(number_of_cases);
+}
+
+Specification specification(test_setup, cases);
+
+void test_close_interfaces()
+{
+    // SMS is already closed in it's test
+    cellularDevice.close_network();
+    cellularDevice.close_sim();
+    cellularDevice.close_power();
+}
+
+int main()
+{
+#if defined (MDMRTS) && defined (MDMCTS)
+    serial.set_flow_control(SerialBase::RTSCTS, MDMRTS, MDMCTS);
+#endif
+    pwr = cellularDevice.open_power(&serial);
+    sim = cellularDevice.open_sim(&serial);
+    sms = cellularDevice.open_sms(&serial);
+    network = cellularDevice.open_network(&serial);
+
+    t.start(callback(&queue, &EventQueue::dispatch_forever));
+    return Harness::run(specification);
+}