pytest: add pytests for monimod

For main_fw and bootloader Signed-off-by: Adam Wujek <dev_public@wujek.eu>

pytest: add pytests for monimod
For main_fw and bootloader Signed-off-by: Adam Wujek <dev_public@wujek.eu>
b414abec · Adam Wujek · 9ce110df · b414abec · b414abec · b414abec
Commit b414abec authored May 31, 2022 by Adam Wujek
Showing with 619 additions and 0 deletions

conftest.py pytest/conftest.py +139 -0

pytest.ini pytest/pytest.ini +5 -0

test_bootloader.py pytest/test-00-basic/test_bootloader.py +175 -0

test_fw_main.py pytest/test-00-basic/test_fw_main.py +300 -0

No files found.
--- a/pytest/conftest.py
+++ b/pytest/conftest.py
+"""
+SPDX-License-Identifier: GPL-3.0-or-later
+SPDX-FileCopyrightText: 2022 CERN
+"""
+
+import pytest
+import subprocess
+import time
+import re
+import os
+import smbus
+
+MONIMOD_ADDRESS = 0x12
+MONIMOD_BUS = 0x9
+MONIMOD_MFR_MODEL_BOOTLOADER = "DI/OT MoniMod (bl)"
+MONIMOD_MFR_MODEL_MAIN = "DI/OT MoniMod"
+MONIMOD_UPTIME_ADDR = 0xd7
+MONIMOD_UPTIME_SIZE = 4
+MONIMOD_TMR_ADDR = 0xd8
+MONIMOD_TMR_SIZE = 4
+
+class monimod:
+    FW_UNKNOWN = 0
+    FW_BOOTLOADER = 1
+    FW_MAIN = 2
+
+    cmd_ids = {
+        "PAGE"               : 0x00,
+        "CAPABILITY"         : 0x19,
+        "QUERY"              : 0x1A,
+        "VOUT_MODE"          : 0x20,
+        "FAN_CONFIG_1_2"     : 0x3A,
+        "FAN_COMMAND_1"      : 0x3B,
+        "FAN_COMMAND_2"      : 0x3C,
+        "FAN_CONFIG_3_4"     : 0x3D,
+        "FAN_COMMAND_3"      : 0x3E,
+        "STATUS_BYTE"        : 0x78,
+        "STATUS_CML"         : 0x7E,
+        "READ_VOUT"          : 0x8B,
+        "READ_IOUT"          : 0x8C,
+        "READ_TEMPERATURE_1" : 0x8D,
+        "READ_TEMPERATURE_2" : 0x8E,
+        "READ_TEMPERATURE_3" : 0x8F,
+        "READ_FAN_SPEED_1"   : 0x90,
+        "READ_FAN_SPEED_2"   : 0x91,
+        "READ_FAN_SPEED_3"   : 0x92,
+        "READ_POUT"          : 0x96,
+        "MFR_ID"             : 0x99,
+        "MFR_MODEL"          : 0x9A,
+        "MFR_REVISION"       : 0x9B,
+        "MFR_LOCATION"       : 0x9C,
+        "MFR_DATE"           : 0x9D,
+        "MFR_SERIAL"         : 0x9E,
+        "IC_DEVICE_REV"      : 0xAE,
+        # manufacturer specific commands
+        "WRITTEN_FW_SIZE"    : 0xD1,
+        "WRITTEN_FW_BLOCK"   : 0xD2,
+        "WRITTEN_FW_CHKSUM"  : 0xD3,
+        "LOCAL_FW_CHKSUM"    : 0xD4,
+        "BOOT_NEW_FW"        : 0xD5,
+        "UC_RESET"           : 0xD6,
+        "UPTIME_SECS"        : 0xD7,
+        "TMR_ERROR_CNT"      : 0xD8,
+        "USE_PEC"            : 0xD9,
+        "TEMP_CURVE_POINTS"  : 0xE0,
+        "TEMP_MATRIX_ROW"    : 0xE1,
+        "TC_ONOFF"           : 0xE2,
+
+        "DUMMY"              : 0xfe,
+        "PMBUS_COMMAND_EXT"  : 0xFF,
+    }
+
+    def __init__(self):
+        self.bus = smbus.SMBus(MONIMOD_BUS)
+
+    def var_to_str(self, var_as_ints):
+        return "".join([chr(x) for x in var_as_ints])
+
+    def pmbus_read_byte_cmd(self, cmd):
+        return self.bus.read_byte_data(MONIMOD_ADDRESS, cmd)
+
+    def pmbus_read_word_cmd(self, cmd):
+        return self.bus.read_word_data(MONIMOD_ADDRESS, cmd)
+
+    def pmbus_read_block_cmd(self, cmd):
+        return self.bus.read_block_data(MONIMOD_ADDRESS, cmd)
+
+    def read_i2c_block_data(self, cmd, read_size):
+        return self.bus.read_i2c_block_data(MONIMOD_ADDRESS, cmd, read_size)
+
+    def pmbus_block_process_call(self, cmd, vals):
+        return self.bus.block_process_call(MONIMOD_ADDRESS, cmd, vals)
+
+    def pmbus_write_byte_cmd(self, cmd, data):
+        return self.bus.write_byte_data(MONIMOD_ADDRESS, cmd, data)
+
+    def pmbus_write_word_cmd(self, cmd, data):
+        return self.bus.write_word_data(MONIMOD_ADDRESS, cmd, data)
+
+    def write_i2c_block_data(self, cmd, data):
+        return self.bus.write_i2c_block_data(MONIMOD_ADDRESS, cmd, data)
+
+
+    def get_fw_mode(self):
+        fw_model = self.pmbus_read_block_cmd(self.cmd_ids["MFR_MODEL"])
+        if self.var_to_str(fw_model) == MONIMOD_MFR_MODEL_BOOTLOADER:
+            return self.FW_BOOTLOADER
+        if self.var_to_str(fw_model) == MONIMOD_MFR_MODEL_MAIN:
+            return self.FW_MAIN
+
+        return self.FW_UNKNOWN
+
+    def switch_fw_mode(self):
+        return self.pmbus_write_byte_cmd(self.cmd_ids["BOOT_NEW_FW"], 1)
+
+    def set_page(self, page):
+        pass
+
+    def get_uptime(self):
+        data = self.read_i2c_block_data(self.cmd_ids["UPTIME_SECS"],
+                                        MONIMOD_UPTIME_SIZE)
+        return int.from_bytes(bytes(data), "little")
+
+    def get_tmr(self):
+        data = self.read_i2c_block_data(self.cmd_ids["TMR_ERROR_CNT"],
+                                        MONIMOD_TMR_SIZE)
+        return int.from_bytes(bytes(data), "little")
+
+@pytest.fixture(scope="session")
+def monimod_bus():
+    monimod_instance = monimod()
+    yield monimod_instance
+
+def pytest_addoption(parser):
+    pass
+
+def pytest_configure(config):
+    pass
+
--- a/pytest/pytest.ini
+++ b/pytest/pytest.ini
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2020 CERN
+
+[pytest]
+addopts = -v -p no:cacheprovider
--- a/pytest/test-00-basic/test_bootloader.py
+++ b/pytest/test-00-basic/test_bootloader.py
+"""
+SPDX-License-Identifier: GPL-3.0-or-later
+SPDX-FileCopyrightText: 2022 CERN
+"""
+
+import pytest
+import random
+import smbus
+import time
+import warnings
+
+
+QUERY_SUP      = 0x80
+QUERY_WR       = 0x40
+QUERY_RD       = 0x20
+QUERY_FMT_LIN  = 0x00
+QUERY_FMT_16B  = 0x04
+QUERY_FMT_DIR  = 0x0c
+QUERY_FMT_8B   = 0x10
+QUERY_FMT_VID  = 0x14
+QUERY_FMT_MAN  = 0x18
+QUERY_FMT_NAN  = 0x1c
+
+cmd_query = {
+"PAGE"               : QUERY_SUP | QUERY_WR | QUERY_RD | QUERY_FMT_8B,
+"CAPABILITY"         : QUERY_SUP | QUERY_RD,
+"QUERY"              : QUERY_SUP | QUERY_WR,
+"VOUT_MODE"          : QUERY_SUP | QUERY_RD,
+"FAN_CONFIG_1_2"     : QUERY_SUP | QUERY_WR | QUERY_RD | QUERY_FMT_NAN,
+"FAN_COMMAND_1"      : QUERY_SUP | QUERY_WR | QUERY_RD | QUERY_FMT_LIN,
+"FAN_COMMAND_2"      : QUERY_SUP | QUERY_WR | QUERY_RD | QUERY_FMT_LIN,
+"FAN_CONFIG_3_4"     : QUERY_SUP | QUERY_WR | QUERY_RD | QUERY_FMT_NAN,
+"FAN_COMMAND_3"      : QUERY_SUP | QUERY_WR | QUERY_RD | QUERY_FMT_LIN,
+"STATUS_BYTE"        : QUERY_SUP | QUERY_RD,
+"STATUS_CML"         : QUERY_SUP | QUERY_WR | QUERY_RD,
+"READ_VOUT"          : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"READ_IOUT"          : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"READ_TEMPERATURE_1" : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"READ_TEMPERATURE_2" : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"READ_TEMPERATURE_3" : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"READ_FAN_SPEED_1"   : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"READ_FAN_SPEED_2"   : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"READ_FAN_SPEED_3"   : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"READ_POUT"          : QUERY_SUP | QUERY_RD | QUERY_FMT_LIN,
+"MFR_ID"             : QUERY_SUP | QUERY_RD | QUERY_FMT_NAN,
+"MFR_MODEL"          : QUERY_SUP | QUERY_RD | QUERY_FMT_NAN,
+"MFR_REVISION"       : QUERY_SUP | QUERY_RD | QUERY_FMT_NAN,
+"MFR_LOCATION"       : QUERY_SUP | QUERY_RD | QUERY_FMT_NAN,
+"MFR_DATE"           : QUERY_SUP | QUERY_RD | QUERY_FMT_NAN,
+"MFR_SERIAL"         : QUERY_SUP | QUERY_RD | QUERY_FMT_NAN,
+"IC_DEVICE_REV"      : QUERY_SUP | QUERY_RD | QUERY_FMT_NAN,
+# manufacturer specific commands
+"WRITTEN_FW_SIZE"    : QUERY_SUP | QUERY_WR | QUERY_RD,
+"WRITTEN_FW_BLOCK"   : QUERY_SUP | QUERY_WR | QUERY_RD,
+"WRITTEN_FW_CHKSUM"  : QUERY_SUP | QUERY_WR | QUERY_RD,
+"LOCAL_FW_CHKSUM"    : QUERY_SUP | QUERY_RD,
+"BOOT_NEW_FW"        : QUERY_SUP | QUERY_WR | QUERY_RD,
+"UC_RESET"           : QUERY_SUP | QUERY_WR,
+"UPTIME_SECS"        : QUERY_SUP | QUERY_RD,
+"TMR_ERROR_CNT"      : QUERY_SUP | QUERY_WR | QUERY_RD,
+"USE_PEC"            : QUERY_SUP | QUERY_WR | QUERY_RD,
+"TEMP_CURVE_POINTS"  : QUERY_SUP | QUERY_WR | QUERY_RD,
+"TEMP_MATRIX_ROW"    : QUERY_SUP | QUERY_WR | QUERY_RD,
+"TC_ONOFF"           : QUERY_SUP | QUERY_WR | QUERY_RD,
+}
+
+
+MFR_ID = "CERN (BE/CEM)"
+MFR_MODEL = "DI/OT MoniMod (bl)"
+
+@pytest.fixture(scope="module", autouse=True)
+def check_boot_mode(monimod_bus):
+    restore_boot_mode = 0
+
+    if monimod_bus.get_fw_mode() != monimod_bus.FW_BOOTLOADER:
+        restore_boot_mode = 1
+        monimod_bus.switch_fw_mode()
+        time.sleep(1)
+        if monimod_bus.get_fw_mode() != monimod_bus.FW_BOOTLOADER:
+            pytest.skip("Monimod not in bootloader mode! Unable to switch to bootloader!")
+    yield
+    if restore_boot_mode == 1:
+        monimod_bus.switch_fw_mode()
+        time.sleep(1)
+        if monimod_bus.get_fw_mode() != monimod_bus.FW_MAIN:
+            warnings.warn(UserWarning("Monimod not in main mode! Unable to switch to main mode."))
+
+
+class TestBootloaderRegAccess(object):
+
+    @pytest.mark.check_uptime
+    @pytest.mark.parametrize("cmds", ["BOOT_NEW_FW",
+                                      "UC_RESET",
+        ]
+    )
+    def test_byte_read(self, monimod_bus, cmds):
+        monimod_bus.pmbus_read_byte_cmd(monimod_bus.cmd_ids[cmds])
+
+    @pytest.mark.parametrize("cmds", ["WRITTEN_FW_SIZE"  ,
+                                      "WRITTEN_FW_CHKSUM",
+                                      "LOCAL_FW_CHKSUM"  ,
+                                      ]
+    )
+    def test_word_read(self, monimod_bus, cmds):
+        monimod_bus.pmbus_read_word_cmd(monimod_bus.cmd_ids[cmds])
+
+    @pytest.mark.parametrize("cmds", ["MFR_ID",
+                                      "MFR_MODEL",
+                                      "MFR_REVISION",
+                                      "MFR_LOCATION",
+                                      "MFR_DATE",
+                                      "MFR_SERIAL",
+                                      "IC_DEVICE_REV"
+                                      ]
+    )
+    def test_block_read(self, monimod_bus, cmds):
+        monimod_bus.pmbus_read_block_cmd(monimod_bus.cmd_ids[cmds])
+
+    @pytest.mark.parametrize("cmds", ["MFR_ID"            ,
+                                      "MFR_MODEL"         ,
+                                      "MFR_REVISION"      ,
+                                      "MFR_LOCATION"      ,
+                                      "MFR_DATE"          ,
+                                      "MFR_SERIAL"        ,
+                                      "IC_DEVICE_REV"     ,
+        ]
+    )
+    def test_write_fail(self, monimod_bus, cmds):
+        try:
+            monimod_bus.pmbus_write_byte_cmd(monimod_bus.cmd_ids[cmds], 0xFa)
+        except OSError:
+            return
+        pytest.fail("{:s} register should be read only! Is read-write.".format(cmds))
+
+    @pytest.mark.parametrize("cmds", ["QUERY"             ,
+                                      "MFR_ID"            ,
+                                      "MFR_MODEL"         ,
+                                      "MFR_REVISION"      ,
+                                      "MFR_LOCATION"      ,
+                                      "MFR_DATE"          ,
+                                      "MFR_SERIAL"        ,
+                                      "IC_DEVICE_REV"     ,
+                                      "WRITTEN_FW_SIZE"   ,
+                                      "WRITTEN_FW_CHKSUM" ,
+                                      "LOCAL_FW_CHKSUM"   ,
+                                      "BOOT_NEW_FW"       ,
+                                      "UC_RESET"          ,
+                                      ]
+    )
+    def test_query(self, monimod_bus, cmds):
+        ret = monimod_bus.pmbus_block_process_call(monimod_bus.cmd_ids["QUERY"], [monimod_bus.cmd_ids[cmds]])
+        assert cmd_query[cmds] == ret[0], ("Read 0x{:X}, expected 0x{:X}".format(ret[0], cmd_query[cmds]))
+
+class TestBootloaderRegValues(object):
+    def test_mfr_id(self, monimod_bus):
+        fw_id = monimod_bus.pmbus_read_block_cmd(monimod_bus.cmd_ids["MFR_ID"])
+
+        assert monimod_bus.var_to_str(fw_id) == MFR_ID
+
+    def test_mfr_model(self, monimod_bus):
+        fw_model = monimod_bus.pmbus_read_block_cmd(monimod_bus.cmd_ids["MFR_MODEL"])
+
+        assert monimod_bus.var_to_str(fw_model) == MFR_MODEL
+
+
+@pytest.mark.check_uptime
+class TestBootloaderOther(object):
+    def test_switch_to_bootloader(self, monimod_bus):
+        assert monimod_bus.get_fw_mode() == monimod_bus.FW_BOOTLOADER, "Monimod not in bootloader mode!"
+        monimod_bus.switch_fw_mode()
+        time.sleep(2)
+        assert monimod_bus.get_fw_mode() == monimod_bus.FW_MAIN, "Failed to switch to main mode!"
+        monimod_bus.switch_fw_mode()
+        time.sleep(2)
+        assert monimod_bus.get_fw_mode() == monimod_bus.FW_BOOTLOADER, "Failed to switch to bootloader mode!"
--- a/pytest/test-00-basic/test_fw_main.py
+++ b/pytest/test-00-basic/test_fw_main.py