[microTVM][Zephyr] Add 'serial_number' option (#13377)

This commit adds a new option 'serial_number' to allow specifying the   
serial device number in Zephyr, used to flash and to communicate with   
target boards attached to specific serial ports, and adjusts Zephyr      
tests to run with this new option. This is particularly useful in an    
environment where multiple boards are connected to the host.            
                                                                        
It also removes 'west_cmd' in test arguments, as it is not used, and    
refactors Zephyr server API to set the required/optional project options
at the beginning of each API call.

Author: mehrdadh

apps/microtvm/zephyr/template_project/CMakeLists.txt.template

@@ -28,9 +28,7 @@ set(QEMU_PIPE <QEMU_PIPE> CACHE PATH "Path to QEMU pipe")
 find_package(Zephyr HINTS $ENV{ZEPHYR_BASE})
 project(microtvm_autogenerated_project)
 
-if(${ENABLE_CMSIS})
-  set(CMSIS_PATH <CMSIS_PATH>)
-
+if(DEFINED CMSIS_PATH)
   file(GLOB_RECURSE cmsis_lib_srcs
     ${CMSIS_PATH}/CMSIS/NN/Source/ActivationFunctions/*.c
     ${CMSIS_PATH}/CMSIS/NN/Source/BasicMathFunctions/*.c

apps/microtvm/zephyr/template_project/microtvm_api_server.py

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+"""Test Project API in different platforms infrastructure."""

tests/micro/project_api/__init__.py

@@ -24,6 +24,8 @@
 from tvm.relay.backend import Runtime
 from tvm.micro.testing import get_target
 
+from .utils import build_project_api
+
 API_GENERATE_PROJECT = "generate_project"
 API_BUILD = "build"
 API_FLASH = "flash"
@@ -55,37 +57,7 @@ def test_default_options_exist(platform):
 @tvm.testing.requires_micro
 def test_project_minimal_options(platform):
     """Test template project with minimum projectOptions"""
-    shape = (10,)
-    dtype = "int8"
-    x = relay.var("x", relay.TensorType(shape=shape, dtype=dtype))
-    xx = relay.multiply(x, x)
-    z = relay.add(xx, relay.const(np.ones(shape=shape, dtype=dtype)))
-    func = relay.Function([x], z)
-    ir_mod = tvm.IRModule.from_expr(func)
-
-    if platform == "arduino":
-        board = "due"
-    elif platform == "zephyr":
-        board = "qemu_x86"
-
-    runtime = Runtime("crt", {"system-lib": True})
-    target = get_target(platform, board)
-    with tvm.transform.PassContext(opt_level=3, config={"tir.disable_vectorize": True}):
-        mod = tvm.relay.build(ir_mod, target=target, runtime=runtime)
-
-    project_options = {
-        "project_type": "host_driven",
-        "board": board,
-    }
-
-    temp_dir = tvm.contrib.utils.tempdir()
-    project = tvm.micro.generate_project(
-        tvm.micro.get_microtvm_template_projects(platform),
-        mod,
-        temp_dir / "project",
-        project_options,
-    )
-    project.build()
+    build_project_api(platform)
 
 
 if __name__ == "__main__":

tests/micro/project_api/test_project_api.py

@@ -0,0 +1,31 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+import os
+
+import tvm
+
+from .utils import build_project_api
+
+
+@tvm.testing.requires_micro
+def test_option_cmsis_path():
+    """Test project API without CMSIS_PATH environment variable."""
+    cmsis_path = os.environ.get("CMSIS_PATH", None)
+    del os.environ["CMSIS_PATH"]
+    build_project_api("zephyr")
+    os.environ["CMSIS_PATH"] = cmsis_path

tests/micro/project_api/test_zephyr_microtvm_api_server.py

@@ -0,0 +1,58 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+import numpy as np
+
+import tvm
+from tvm import relay
+from tvm.relay.backend import Runtime
+from tvm.micro.testing import get_target
+
+
+def build_project_api(platform: str):
+    """Build a relay module with Project API."""
+    shape = (10,)
+    dtype = "int8"
+    x = relay.var("x", relay.TensorType(shape=shape, dtype=dtype))
+    xx = relay.multiply(x, x)
+    z = relay.add(xx, relay.const(np.ones(shape=shape, dtype=dtype)))
+    func = relay.Function([x], z)
+    ir_mod = tvm.IRModule.from_expr(func)
+
+    if platform == "arduino":
+        board = "due"
+    elif platform == "zephyr":
+        board = "qemu_x86"
+
+    runtime = Runtime("crt", {"system-lib": True})
+    target = get_target(platform, board)
+    with tvm.transform.PassContext(opt_level=3, config={"tir.disable_vectorize": True}):
+        mod = tvm.relay.build(ir_mod, target=target, runtime=runtime)
+
+    project_options = {
+        "project_type": "host_driven",
+        "board": board,
+    }
+
+    temp_dir = tvm.contrib.utils.tempdir()
+    project = tvm.micro.generate_project(
+        tvm.micro.get_microtvm_template_projects(platform),
+        mod,
+        temp_dir / "project",
+        project_options,
+    )
+    project.build()

tests/micro/project_api/utils.py

@@ -40,3 +40,9 @@ To see the list of supported values for `--board`, run:
 ```
 $ pytest test_zephyr.py --help
 ```
+
+If you like to test with a real hardware, you have the option to pass the serial number
+for your development board.
+```
+$ pytest test_zephyr.py --board=nrf5340dk_nrf5340_cpuapp --serial="0672FF5"
+```

tests/micro/zephyr/README.md

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+""" Testing infrastructure for microTVM Zephyr """

tests/micro/zephyr/__init__.py

@@ -23,27 +23,29 @@
 
 
 def pytest_addoption(parser):
-    parser.addoption(
-        "--west-cmd", default="west", help="Path to `west` command for flashing device."
-    )
     parser.addoption(
         "--use-fvp",
         action="store_true",
         default=False,
         help="If set true, use the FVP emulator to run the test",
     )
-
-
-@pytest.fixture(scope="session")
-def west_cmd(request):
-    return request.config.getoption("--west-cmd")
+    parser.addoption(
+        "--serial",
+        default=None,
+        help="If set true, use the FVP emulator to run the test",
+    )
 
 
 @pytest.fixture
 def use_fvp(request):
     return request.config.getoption("--use-fvp")
 
 
+@pytest.fixture
+def serial_number(request):
+    return request.config.getoption("--serial")
+
+
 @pytest.fixture(autouse=True)
 def xfail_on_fvp(request, use_fvp):
     """mark the tests as xfail if running on fvp."""