Update Iris API replace CADI API (#6)

* update IRIS API replace CADI API

* Add GHA CI Test

* update config file

Author: Qinghao Shi

.github/ci_test_settings.json

@@ -0,0 +1,12 @@
+{
+    "COMMON": {
+        "IRIS_path": "/opt/FVP_Corstone_SSE-300_Ethos-U55/Iris/Python/"
+    },
+    "FVP_CS300_U55": {
+        "model_binary": "/opt/FVP_Corstone_SSE-300_Ethos-U55/models/Linux64_GCC-6.4//FVP_Corstone_SSE-300_Ethos-U55",
+        "terminal_component": "component.FVP_MPS3_Corstone_SSE_300.mps3_board.telnetterminal0",
+        "configs": {
+            "MPS3": "MPS3.conf"
+        }
+    }
+}

.github/workflows/PR-Build.yml

@@ -0,0 +1,29 @@
+# Pull-Request Test
+name: PR-Check Build and Run
+
+on:
+  # Triggers the workflow on pull request
+  pull_request:
+
+jobs:
+
+  Corstone300:
+    runs-on: ubuntu-latest
+    # Run this this job inside container
+    container: mbedos/mbed-os-env-fm:corstone300
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Unit Test 
+        run: python setup.py test
+
+      - name: Install Test
+        run: |
+          rm fm_agent/settings.json
+          cp .github/ci_test_settings.json fm_agent/settings.json
+          python setup.py install
+
+      - name: Run Self Test
+        run: mbedfm --self-test

README.md

@@ -11,23 +11,19 @@ If user only need to run mbed OS applications or examples rather than Greentea t
 
 
 ## Requirements
- 1. Make sure you have Arm Fast Models Libraries files installed to your host machines, as well as the Fast Models PyCADI.
+ 1. Make sure you have Arm Fast Models FVPs as well as the Fast Models Iris python modules installed. This Package is not including neither of them. Also a valid license to the Fastmodels could be required.
 
 >please referencing [Fast Models User Guide](https://developer.arm.com/docs/100965/latest)
 
- 2. A valid Fast Models license been set up correctly.
-
->please referencing [Fast Models User Guide](https://developer.arm.com/docs/100965/latest)
-
- 3. Greentea version 1.5.0 or later
+ 2. Use Greentea and mbedhtrun version 1.5.0 or later
 ```
-pip install mbed-greentea -U
+# Check versions
 mbedgt --version
-```
- 4. Htrun version 1.4.1 or later
-```
-pip install mbed-host-tests -U
 mbedhtrun --version
+
+# Update mbedgt and mbedhtrun
+pip install mbed-greentea -U
+pip install mbed-host-tests -U
 ```
 
 ## Download
@@ -36,16 +32,15 @@ git clone https://github.com/ARMmbed/mbed-fastmodel-agent.git
 cd mbed-fastmodel-agent
 ```
 
-## Settings before installation
+## Configurations before installation
 1. Edit the configuration file `fm_agent\settings.json` 
-2. Change `model_lib_path` value in the `GLOBAL` section to your Fast Models installation folder (where contains all fastmodel libs).
-3. Change `PyCADI_path` value to PyCADI folder, alternatively you can have `PVLIB_HOME` environment variable set on your host
-4. Optional: edit individual models if necessary
-5. Optional: add configs to models if necessary
+3. Change `IRIS_path` value to IRIS Python folder
+3. Edit individual models binarys file path
+4. Optional: customize configs to models
 
 ## Installation
 ```
-python setup.py install
+sudo python setup.py install
 ```
 *NOTE. you will need to re-run the install command after you changed the "settings.json" or any config file*
 
@@ -57,29 +52,24 @@ python setup.py install
 ```
 you should be able to see a table like:
 ```
-+--------------+-----------------------------------------------+-------------+--------------+--------------+
-| MODEL NAME   | MODEL LIB full path                           | CONFIG NAME | CONFIG FILE  | AVAILABILITY |
-+--------------+-----------------------------------------------+-------------+--------------+--------------+
-|              |                                               | DEFAULT     | DEFAULT.conf | YES          |
-| FVP_MPS2_M0  | C:\work\model_libs\FVP_MPS2_Cortex-M0.dll     | FAST        | FAST.conf    | YES          |
-|              |                                               | NETWORK     | NETWORK.conf | YES          |
-+--------------+-----------------------------------------------+-------------+--------------+--------------+
-|              |                                               | DEFAULT     | DEFAULT.conf | YES          |
-| FVP_MPS2_M0P | C:\work\model_libs\FVP_MPS2_Cortex-M0plus.dll | FAST        | FAST.conf    | YES          |
-|              |                                               | NETWORK     | NETWORK.conf | YES          |
-+--------------+-----------------------------------------------+-------------+--------------+--------------+
-|              |                                               | DEFAULT     | DEFAULT.conf | YES          |
-| FVP_MPS2_M3  | C:\work\model_libs\FVP_MPS2_Cortex-M3.dll     | FAST        | FAST.conf    | YES          |
-|              |                                               | NETWORK     | NETWORK.conf | YES          |
-+--------------+-----------------------------------------------+-------------+--------------+--------------+
-|              |                                               | DEFAULT     | DEFAULT.conf | YES          |
-| FVP_MPS2_M4  | C:\work\model_libs\FVP_MPS2_Cortex-M4.dll     | FAST        | FAST.conf    | YES          |
-|              |                                               | NETWORK     | NETWORK.conf | YES          |
-+--------------+-----------------------------------------------+-------------+--------------+--------------+
-|              |                                               | DEFAULT     | DEFAULT.conf | YES          |
-| FVP_MPS2_M7  | C:\work\model_libs\FVP_MPS2_Cortex-M7.dll     | FAST        | FAST.conf    | YES          |
-|              |                                               | NETWORK     | NETWORK.conf | YES          |
-+--------------+-----------------------------------------------+-------------+--------------+--------------+
++--------------+-----------------------------------------------+-------------+---------------+--------------+
+| MODEL NAME   | MODEL Binary Full Path                        | CONFIG NAME | CONFIG FILE   | AVAILABILITY |
++--------------+-----------------------------------------------+-------------+---------------+--------------+
+| FVP_MPS2_M0  | C:\work\models\FVP_MPS2_Cortex-M0.exe         | MPS2        | MPS2.conf     | YES          |
+|              |                                               | COVERAGE    | COVERAGE.conf | YES          |
++--------------+-----------------------------------------------+-------------+---------------+--------------+
+| FVP_MPS2_M0P | C:\work\models\FVP_MPS2_Cortex-M0plus.exe     | MPS2        | MPS2.conf     | YES          |
+|              |                                               | COVERAGE    | COVERAGE.conf | YES          |
++--------------+-----------------------------------------------+-------------+---------------+--------------+
+| FVP_MPS2_M3  | C:\work\models\FVP_MPS2_Cortex-M3.exe         | MPS2        | MPS2.conf     | YES          |
+|              |                                               | COVERAGE    | COVERAGE.conf | YES          |
++--------------+-----------------------------------------------+-------------+---------------+--------------+
+| FVP_MPS2_M4  | C:\work\models\FVP_MPS2_Cortex-M4.exe         | MPS2        | MPS2.conf     | YES          |
+|              |                                               | COVERAGE    | COVERAGE.conf | YES          |
++--------------+-----------------------------------------------+-------------+---------------+--------------+
+| FVP_MPS2_M7  | C:\work\models\FVP_MPS2_Cortex-M7.exe         | MPS2        | MPS2.conf     | YES          |
+|              |                                               | COVERAGE    | COVERAGE.conf | YES          |
++--------------+-----------------------------------------------+-------------+---------------+--------------+
 ```
 ### Self test for the settings
 ```
@@ -92,13 +82,13 @@ This will try to launch every model in the above list to verify them, so will ta
 ```
     mbedgt --fm <model_name>:<config_name>
 ```
->e.g. `mbedgt --fm FVP_MPS2_M3:DEFAULT`
+>e.g. `mbedgt --fm FVP_MPS2_M3:MPS2`
 
 ### run mbed test with htrun
 ```
-    mbedhtrun --fm <config_name> -m <model_name> -f <test_image>
+    mbedhtrun --fm <config_name> -m <model_name> -f <test_image> <-e host_test_path>
 ```
->e.g. `mbedhtrun --fm DEFAULT -m FVP_MPS2_M3 -f test.elf`
+>e.g. `mbedhtrun -m FVP_MPS2_M3  --fm MPS2 -f test.elf -e ./host_tests`
 
 *<model_name> : The name to fastmodel target supported in mbed os*
 
@@ -108,9 +98,10 @@ This will try to launch every model in the above list to verify them, so will ta
 
 The mbed fastmodel_agent module allow user to configure each individual module via a config file.
 by default, 3 config files are provided:
-* DEFAULT - default settings
-* FAST - based on default turned off speed limit 
-* NETWORK - based on default enabled Ethernet
+* MPS2 - default settings for MPS2 based platforms
+* MPS3 - default settings for MPS3 based platforms
+* COVERAGE - configuration for MPS2 Code Coverage Test 
+
 
 ## change config files
 
@@ -123,9 +114,9 @@ The config files are standard Fast Models config file. for more detail about det
 
 Users are able to add their own customized config file to the `mbed-fastmodel-agent\fm_agent\configs` directory.
 
-Then users need to edit `mbed-fastmodel-agent\fm_agent\settings.json` file either in `GLOBAL` section or individual models.
+Then users need to edit `mbed-fastmodel-agent\fm_agent\settings.json` file either in `COMMON` section or individual models.
 
-Key `configs_add` can be added for additional config files for each model, Or Key `config` can be added to overwrite `GLOBAL` config files.
+Key `configs_add` can be added for additional config files for each model, Or Key `config` can be added to overwrite `COMMON` config files.
 
 ## Known limitations:
 1. Fast Models normally have 3 or 4 serial terminal ports. But currently only one port is used at moment.

fm_agent/configs/COVERAGE.conf

@@ -19,3 +19,6 @@ fvp_mps2.mps2_visualisation.rate_limit-enable=0
 ## Enable Ethernet Port
 fvp_mps2.hostbridge.userNetworking=1
 fvp_mps2.smsc_91c111.enabled=1
+
+## Turn off GUI windows
+fvp_mps2.mps2_visualisation.disable-visualisation=1

fm_agent/configs/DEFAULT.conf

@@ -2,7 +2,6 @@
 fvp_mps2.telnetterminal1.quiet=1
 fvp_mps2.telnetterminal2.quiet=1
 
-
 ## Control the output format of the telnet terminal
 fvp_mps2.telnetterminal0.mode=raw
 
@@ -16,3 +15,7 @@ fvp_mps2.telnetterminal0.start_telnet=0
 
 ## turn the rate limite off
 fvp_mps2.mps2_visualisation.rate_limit-enable=0
+
+## Enable Ethernet Port
+fvp_mps2.hostbridge.userNetworking=1
+fvp_mps2.smsc_91c111.enabled=1

fm_agent/configs/FAST.conf renamed to fm_agent/configs/MPS2.conf

@@ -0,0 +1,21 @@
+## Turn off terminal1 terminal2 and termimal5, keep terminal0 open
+mps3_board.telnetterminal1.quiet=1
+mps3_board.telnetterminal2.quiet=1
+mps3_board.telnetterminal5.quiet=1
+
+## Control the output format of the telnet terminal
+mps3_board.telnetterminal0.mode=raw
+## Suppress the telnet/xterm to be launched, so that model agent can talk to the port  
+mps3_board.telnetterminal0.start_telnet=0
+
+
+## Turn the rate limite off, make FVP runs as fast as possiable
+mps3_board.visualisation.rate_limit-enable=0
+
+
+## Turn on user Networking
+mps3_board.smsc_91c111.enabled=1
+mps3_board.hostbridge.userNetworking=1
+
+## Turn off GUI windows
+mps3_board.visualisation.disable-visualisation=1

fm_agent/configs/MPS3.conf

@@ -64,22 +64,30 @@ def setup_simulator(self, model_name, model_config):
             self.logger.prn_err("Please provided the name to a fastmodel!!")
             self.__guide()
             raise SimulatorError("fastmodel_name not provided!")
-        self.model_lib = self.configuration.get_model_lib(self.fastmodel_name)
+        self.model_binary = self.configuration.get_model_binary(self.fastmodel_name)
 
-        if not self.model_lib:
-            self.logger.prn_err("NO model_lib available for '%s'"% self.fastmodel_name)
+        if not self.model_binary:
+            self.logger.prn_err("NO model_binary available for '%s'"% self.fastmodel_name)
             self.__guide()
             raise SimulatorError("fastmodel '%s' not available" % (self.fastmodel_name))
 
         config_dict = self.configuration.get_configs(self.fastmodel_name)
 
         if config_dict and self.config_name in config_dict:
-            self.model_params = self.configuration.parse_params_file(config_dict[self.config_name])
+            config_file = config_dict[self.config_name]
+            self.model_config_file = os.path.join( os.path.dirname(__file__) ,"configs" , config_file )
+
         elif os.path.exists(os.path.join( os.getcwd(), self.config_name )):
-            self.model_params = self.configuration.parse_params_file(self.config_name,in_module=False)
+            self.model_config_file = os.path.join( os.getcwd() , config_name )
         else:
             self.__guide()
             raise SimulatorError("No config %s avaliable for fastmodel %s" % (self.config_name,self.fastmodel_name))
+        
+        self.model_terminal = self.configuration.get_model_terminal_comp(self.fastmodel_name)
+
+        if not self.model_terminal:
+            self.logger.prn_err("NO terminal_compoment defined for '%s'"% self.fastmodel_name)
+            raise SimulatorError("fastmodel '%s' not defined terminal compoment" % (self.fastmodel_name))
 
     def __connect_terminal(self):
         """ connect socket terminal to a launched fastmodel"""
@@ -105,13 +113,16 @@ def is_simulator_alive(self):
     def start_simulator(self):
         """ launch given fastmodel with configs """
         if check_import():
-            import fm.debug
-            self.model = fm.debug.LibraryModel(self.model_lib, self.model_params)
+            import iris.debug
+            proc, IRIS_port, outs = launch_FVP_IRIS(self.model_binary, self.model_config_file)
+            print(outs)
+            self.model = iris.debug.NetworkModel('localhost',IRIS_port)
             # check which host socket port is used for terminal0
-            terminal = self.model.get_target('fvp_mps2.telnetterminal0')
-            self.port = terminal.read_register('Port')
+            terminal = self.model.get_target(self.model_terminal)
+            self.port = terminal.read_register('Default.Port')
             self.host = "localhost"
             self.image = None
+
             return True
         else:
             raise SimulatorError("fastmodel product was NOT installed correctly")
@@ -151,11 +162,16 @@ def reset_simulator(self):
             self.__closeConnection()
             self.model.release(shutdown=True)
             time.sleep(1)
-            import fm.debug
-            self.model = fm.debug.LibraryModel(self.model_lib, self.model_params)
+            import iris.debug
+
+            proc, IRIS_port, outs = launch_FVP_IRIS(self.model_binary, self.model_config_file)
+            if IRIS_port==0:
+                print(outs)
+                return False
+            self.model = iris.debug.NetworkModel('localhost',IRIS_port)
             # check which host socket port is used for terminal0
-            terminal = self.model.get_target('fvp_mps2.telnetterminal0')
-            self.port = terminal.read_register('Port')
+            terminal = self.model.get_target(self.model_terminal)
+            self.port = terminal.read_register('Default.Port')
             cpu = self.model.get_cpus()[0]
             if self.image:
                 cpu.load_application(self.image)
@@ -172,12 +188,12 @@ def read(self):
         if not self.__socketConnected():
             return None
 
-        data = str()
+        data = bytearray()
         read_stop = False
 
         while not read_stop:
             try:
-                char=''
+                char=bytearray()
                 char = self.socket.recv(1)
             except socket.timeout as eto:
                 read_stop=True
@@ -205,7 +221,7 @@ def write(self, payload, log=False):
 
         try:
             for char in payload:
-                self.socket.sendall(char)
+                self.socket.sendall(char.encode())
                 time.sleep(0.01)
             if log:
                 self.logger.prn_txd(payload)
@@ -325,16 +341,12 @@ def list_avaliable_models(self):
         """ return a dictionary of models and configs """
         return self.configuration.get_all_configs()
 
-    def list_model_lib(self, model_name):
-        """ return model lib full path of give model_name """
-        return self.configuration.get_model_lib(model_name)
+    def list_model_binary(self, model_name):
+        """ return model binary full path of give model_name """
+        return self.configuration.get_model_binary(model_name)
 
     def check_config_exist(self,filename):
         """ return the presents of give config name
         """
-
         filepath = os.path.join( os.path.dirname(__file__), "configs" , filename )
-
-        return os.path.exists(filepath)
-
-
+        return os.path.exists(filepath)