ekfsm 0.11.0b1.post3__py3-none-any.whl

ekfsm/__init__.py

@@ -0,0 +1,13 @@
+from .core.slots import Slot
+from .system import System
+from .core import HwModule
+from .core.slots import SlotType
+from .exceptions import ConfigError
+
+__all__ = (
+    "System",
+    "ConfigError",
+    "HwModule",
+    "Slot",
+    "SlotType",
+)

ekfsm/boards/oem/ekf/ccu.yaml

@@ -0,0 +1,68 @@
+id: 206
+name: "EKF CCU"
+slot_type: CPCI_S0_UTILITY
+children:
+    - device_type: I2CMux
+      name: "MUX"
+      addr: 0x70
+      slot_coding_mask: 0x07
+      children:
+        - device_type: MuxChannel
+          name: "CH00"
+          channel_id: 0
+          children:
+            - device_type: EKFIdentificationIOExpander
+              name: "GPIO"
+              addr: 0x3D
+              provides:
+                inventory:
+                  - revision
+            - device_type: EKF_CCU_EEPROM
+              name: "EEPROM"
+              addr: 0x55
+              provides:
+                inventory:
+                  - vendor
+                  - serial
+                  - model
+                  - repaired_at
+                  - manufactured_at
+                chassis_inventory:
+                  - revision: crevision
+                  - write_revision: write_crevision
+                  - vendor: cvendor
+                  - write_vendor: write_cvendor
+                  - serial: cserial
+                  - write_serial: write_cserial
+                  - model: cmodel
+                  - write_model: write_cmodel
+                  - unit
+                  - write_unit
+                custom_eeprom:
+                  - write: write_customer_area
+                  - read: customer_area
+        - device_type: MuxChannel
+          name: "CH01"
+          channel_id: 1
+          children:
+            - device_type: EKFCcuUc
+              name: "UC"
+              addr: 0x28
+              provides:
+                management:
+                  - identify_firmware
+                  - load_firmware
+                  - load_parameterset
+                  - get_parameterset
+                  - restart
+                vin:
+                  - voltage: vin_voltage
+                th:
+                  - temperature
+                  - humidity
+                fan:
+                  - fan_status
+                  - push_temperature
+                sysstate:
+                  - wd_trigger
+                  - sw_shutdown

ekfsm/boards/oem/ekf/sc5-festival.yaml

@@ -0,0 +1,30 @@
+id: "SC5-FESTIVAL"
+name: "EKF SC5-Festival"
+slot_type: CPCI_S0_SYS
+children:
+    - device_type: EKF_EEPROM
+      name: "EEPROM"
+      addr: 0x57
+      provides:
+        inventory:
+          - vendor
+          - serial
+          - model
+          - repaired_at
+          - manufactured_at
+    - device_type: SMBIOS
+      name: "SMBIOS"
+      provides:
+        inventory:
+          - revision
+    - device_type: HWMON
+      name: "HWMON"
+      provides:
+        th:
+          - cputemp
+bus_masters:
+  i2c:
+    CPCI_S0_PSU: "devices/pci0000:00/0000:00:15.1/i2c_designware.1"
+    CPCI_S0_PER: "devices/pci0000:00/0000:00:15.1/i2c_designware.1"
+    CPCI_S0_UTILITY: "devices/pci0000:00/0000:00:15.1/i2c_designware.1"
+    MASTER_LOCAL_DEFAULT: "devices/pci0000:00/0000:00:1f.4"

ekfsm/boards/oem/ekf/sc9-toccata.yaml

@@ -0,0 +1,31 @@
+id: "SC9-TOCCATA"
+name: "EKF SC9-TOCCATA"
+slot_type: CPCI_S0_SYS
+children:
+    - device_type: EKF_EEPROM
+      name: "EEPROM"
+      addr: 0x57
+      provides:
+        inventory:
+          - vendor
+          - serial
+          - model
+          - repaired_at
+          - manufactured_at
+    - device_type: SMBIOS
+      name: "SMBIOS"
+      provides:
+        inventory:
+          - revision
+    - device_type: HWMON
+      name: "HWMON"
+      provides:
+        th:
+          - cputemp
+
+bus_masters:
+  i2c:
+    CPCI_S0_PSU: "devices/pci0000:00/0000:00:15.1/i2c_designware.2"
+    CPCI_S0_PER: "devices/pci0000:00/0000:00:15.1/i2c_designware.2"
+    CPCI_S0_UTILITY: "devices/pci0000:00/0000:00:15.1/i2c_designware.2"
+    MASTER_LOCAL_DEFAULT: "devices/pci0000:00/0000:00:1f.4"

ekfsm/boards/oem/ekf/spv-mystic.yaml

@@ -0,0 +1,68 @@
+id: 62
+name: "EKF SPV-MYSTIC"
+slot_type: CPCI_S0_PER
+children:
+    - device_type: I2CMux
+      name: "MUX"
+      addr: 0x70
+      slot_coding_mask: 0x07
+      children:
+        - device_type: MuxChannel
+          name: "CH00"
+          channel_id: 0
+          children:
+            - device_type: EKFIdentificationIOExpander
+              name: "GPIO"
+              addr: 0x3D
+              provides:
+                inventory:
+                  - revision
+            - device_type: EKF_EEPROM
+              name: "EEPROM"
+              addr: 0x55
+              provides:
+                inventory:
+                  - vendor
+                  - serial
+                  - model
+                  - repaired_at
+                  - manufactured_at
+        - device_type: MuxChannel
+          name: "CH01"
+          channel_id: 1
+          children:
+            - device_type: GPIO
+              name: "GPIO"
+              addr: 0x3D
+              provides:
+                gpio0:
+                  - num_lines
+                  - set_pin
+                  - get_pin
+                  - set_direction
+        - device_type: MuxChannel
+          name: "CH02"
+          channel_id: 2
+          children:
+            - device_type: GPIO
+              name: "GPIO"
+              addr: 0x3D
+              provides:
+                gpio1:
+                  - num_lines
+                  - set_pin
+                  - get_pin
+                  - set_direction
+        - device_type: MuxChannel
+          name: "CH03"
+          channel_id: 3
+          children:
+            - device_type: GPIO
+              name: "GPIO"
+              addr: 0x3D
+              provides:
+                gpio2:
+                  - num_lines
+                  - set_pin
+                  - get_pin
+                  - set_direction

ekfsm/boards/oem/ekf/sq1-track.yaml

@@ -0,0 +1,41 @@
+id: 68
+name: "EKF SQ1-TRACK"
+slot_type: CPCI_S0_PER
+children:
+    - device_type: I2CMux
+      name: "MUX"
+      addr: 0x70
+      slot_coding_mask: 0x07
+      children:
+        - device_type: MuxChannel
+          name: "CH00"
+          channel_id: 0
+          children:
+            - device_type: EKFIdentificationIOExpander
+              name: "GPIO"
+              addr: 0x3D
+              provides:
+                inventory:
+                  - revision
+            - device_type: EKF_EEPROM
+              name: "EEPROM"
+              addr: 0x55
+              provides:
+                inventory:
+                  - vendor
+                  - serial
+                  - model
+                  - repaired_at
+                  - manufactured_at
+        - device_type: MuxChannel
+          name: "CH01"
+          channel_id: 1
+          children:
+        - device_type: MuxChannel
+          name: "CH02"
+          channel_id: 2
+          children:
+        - device_type: MuxChannel
+          name: "CH03"
+          channel_id: 3
+          children:

ekfsm/boards/oem/ekf/srf-fan.yaml

@@ -0,0 +1,48 @@
+id: 43
+name: "EKF SRF-FAN"
+slot_type: CPCI_S0_PER
+children:
+    - device_type: I2CMux
+      name: "MUX"
+      addr: 0x70
+      slot_coding_mask: 0x07
+      children:
+        - device_type: MuxChannel
+          name: "CH00"
+          channel_id: 0
+          children:
+            - device_type: EKFIdentificationIOExpander
+              name: "GPIO"
+              addr: 0x3D
+              provides:
+                inventory:
+                  - revision
+            - device_type: EKF_EEPROM
+              name: "EEPROM"
+              addr: 0x55
+              provides:
+                inventory:
+                  - vendor
+                  - serial
+                  - model
+                  - repaired_at
+                  - manufactured_at
+                custom:
+                  - serial: custom_serial
+                  - content: custom_board_data
+                  - raw: custom_raw_data
+                  - write_serial: write_custom_serial
+                  - write_content: write_custom_board_data
+                  - write_raw: write_custom_raw_data
+        - device_type: MuxChannel
+          name: "CH01"
+          channel_id: 1
+          children:
+        - device_type: MuxChannel
+          name: "CH02"
+          channel_id: 2
+          children:
+        - device_type: MuxChannel
+          name: "CH03"
+          channel_id: 3
+          children:

ekfsm/boards/oem/ekf/sur-uart.yaml

@@ -0,0 +1,72 @@
+id: 67
+name: "EKF SUR-UART"
+slot_type: CPCI_S0_PER
+children:
+    - device_type: I2CMux
+      name: "MUX"
+      addr: 0x70
+      slot_coding_mask: 0x07
+      children:
+        - device_type: MuxChannel
+          name: "CH00"
+          channel_id: 0
+          children:
+            - device_type: EKFIdentificationIOExpander
+              name: "GPIO"
+              addr: 0x3D
+              provides:
+                inventory:
+                  - revision
+            - device_type: EKF_EEPROM
+              name: "EEPROM"
+              addr: 0x55
+              provides:
+                inventory:
+                  - vendor
+                  - serial
+                  - model
+                  - repaired_at
+                  - manufactured_at
+        - device_type: MuxChannel
+          name: "CH01"
+          channel_id: 1
+          children:
+            - device_type: IIOThermalHumidity
+              name: "TH"
+              addr: 0x40
+              provides:
+                th:
+                  - temperature
+                  - humidity
+        - device_type: MuxChannel
+          name: "CH02"
+          channel_id: 2
+          children:
+            - device_type: EKFSurLed
+              name: "LEDA"
+              addr: 0x3D
+              provides:
+                led_a:
+                  - set
+            - device_type: EKFSurLed
+              name: "LEDB"
+              addr: 0x3E
+              provides:
+                led_b:
+                  - set
+        - device_type: MuxChannel
+          name: "CH03"
+          channel_id: 3
+          children:
+            - device_type: EKFSurLed
+              name: "LEDC"
+              addr: 0x3D
+              provides:
+                led_c:
+                  - set
+            - device_type: EKFSurLed
+              name: "LEDD"
+              addr: 0x3E
+              provides:
+                led_d:
+                  - set

ekfsm/boards/oem/hitron/hdrc-300.yaml

@@ -0,0 +1,20 @@
+id: HDRC300
+name: "HITRON HDRC-300"
+slot_type: CPCI_S0_PSU
+children:
+    - device_type: PmBus
+      name: "PMBUS"
+      addr: 0x18
+      slot_coding_mask: 0x07
+      provides:
+        inventory:
+          - vendor
+          - model
+          - revision
+          - serial
+        main:
+          - voltage: in1_input
+          - current: curr1_input
+        sby:
+          - voltage: in2_input
+          - current: curr2_input

ekfsm/cli.py

@@ -0,0 +1,111 @@
+#! /usr/bin/env python3
+# import os
+# import sys
+import click
+import logging
+from pathlib import Path
+
+from ekfsm.system import System
+from ekfsm.log import ekfsm_logger
+from ekfsm.simctrl import enable_simulation
+from ekfsm.simctrl import register_gpio_simulations
+
+
+logging.basicConfig(level=logging.WARNING, format="%(levelname)s: %(message)s")
+logger = ekfsm_logger(__name__)
+
+sm: System | None = None
+
+
+@click.group()
+@click.option("--verbose", "-v", is_flag=True, help="Enable verbose output")
+@click.option("--debug", "-d", is_flag=True, help="Enable debug output")
+@click.option(
+    "--sysfs",
+    "-s",
+    help="Use custom sysfs dir for simulation mode",
+    is_flag=False,
+    flag_value="tests/sim/sys",
+    type=click.Path(exists=True),
+)
+@click.option(
+    "--config",
+    "-c",
+    type=click.Path(exists=True),
+    required=True,
+    help="Path to configuration file",
+)
+def cli(verbose, debug, sysfs, config):
+    global sm
+    """POSIX-compliant CLI tool with subcommands"""
+    if verbose:
+        logging.getLogger().setLevel(logging.INFO)
+        logger.info("Verbose output enabled")
+    if debug:
+        logging.getLogger().setLevel(logging.DEBUG)
+        logger.setLevel(logging.DEBUG)
+        logger.debug("Debug output enabled")
+    if sysfs:
+        logger.warning("Simulation mode enabled")
+        enable_simulation(Path(sysfs))
+        register_gpio_simulations()
+
+    sm = System(config)
+
+
+@cli.command()
+@click.option(
+    "--serial",
+    "-s",
+    is_flag=False,
+    prompt=True,
+    type=int,
+    help="Write chassis serial number",
+)
+@click.option(
+    "--unit", "-u", is_flag=False, prompt=True, type=int, help="Write chassis unit"
+)
+@click.option(
+    "--vendor",
+    "-n",
+    is_flag=False,
+    help="Write chassis vendor",
+    default="EKF Elektronik",
+)
+@click.option("--revision", "-r", is_flag=False, help="Write chassis revision")
+@click.option("--model", "-m", is_flag=False, help="Write chassis model")
+@click.option("--custom", "-c", is_flag=False, help="Write chassis custom information")
+def write(serial, unit, vendor, revision, model, custom):
+    """Write data to the system"""
+    chassis = sm.ccu.chassis_inventory
+    if serial:
+        chassis.write_serial(serial)
+    if unit:
+        chassis.write_unit(unit)
+    if vendor:
+        chassis.write_vendor(vendor)
+    if revision:
+        chassis.write_revision(revision)
+    if model:
+        chassis.write_model(model)
+    if custom:
+        chassis.write_customer_area(custom)
+
+
+@cli.command()
+def show():
+    """Show information about the system"""
+    sm.print()
+
+
+# Attach subgroups to main CLI
+cli.add_command(write)
+cli.add_command(show)
+
+
+def main():
+    cli(auto_envvar_prefix="EKFSM")
+
+
+if __name__ == "__main__":
+    main()

ekfsm/config.py

@@ -0,0 +1,37 @@
+import yamale  # type: ignore
+import yaml
+import munch
+
+from typing import Any, List, Tuple
+
+schema_str = """
+system_config:
+  name: str()
+  slots: list(include('slot'))
+---
+slot:
+  name: str()
+  slot_type: regex('^CPCI_S0_(PER|SYS|PSU|UTILITY)$')
+  desired_hwmodule_type: str()
+  desired_hwmodule_name: str()
+  attributes: map(required=False)
+"""
+
+
+def _validate_config(config_file: str) -> None:
+    schema = yamale.make_schema(content=schema_str)
+    data = yamale.make_data(config_file)
+    yamale.validate(schema, data)
+
+
+def _parse_config(config_file: str) -> Any | munch.Munch | List | Tuple:
+    with open(config_file) as file:
+        config = yaml.safe_load(file)
+        munchified_config = munch.munchify(config)
+    return munchified_config
+
+
+def load_config(config_file: str) -> Any:
+    _validate_config(config_file)
+    config = _parse_config(config_file)
+    return config

ekfsm/core/__init__.py

@@ -0,0 +1,4 @@
+from .slots import Slot, SlotType, Slots  # noqa: F401
+from .sysfs import SysFSDevice, SysFSAttribute  # noqa: F401
+from .components import HwModule  # noqa: F401
+from .probe import ProbeableDevice  # noqa: F401

ekfsm/core/components.py

@@ -0,0 +1,120 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from anytree import LevelGroupOrderIter, NodeMixin, RenderTree, findall
+from munch import Munch
+
+if TYPE_CHECKING:
+    from ekfsm.devices.generic import Device
+
+    from .slots import Slot
+
+
+class SystemComponent(NodeMixin):
+    """
+    Base class for all system components including Hardware Modules and Devices.
+    """
+
+    def __init__(self, name: str):
+        from ekfsm.log import ekfsm_logger
+
+        self.logger = ekfsm_logger(name)
+        self.name = name
+
+    def _render_tree(self) -> str:
+        output = ""
+        for pre, _, node in RenderTree(self):
+            output += f"{pre}{repr(node)}" + "\n"
+        return output
+
+    def __str__(self):
+        return self._render_tree()
+
+    def print(self) -> None:
+        print(self)
+
+
+class HwModule(SystemComponent):
+    """
+    A HwModule represents an instantiation of a specifc hw board type,
+    for example an instance of an EKF SC9 board.
+    """
+
+    def __init__(self, instance_name: str, config: dict, slot: Slot) -> None:
+        from ekfsm.core.utils import deserialize_hardware_tree
+
+        from .slots import SlotType
+
+        super().__init__(instance_name)
+        self._slot: Slot = slot
+        self.config = config
+
+        self.id, self.board_type, slot_type, self.children = deserialize_hardware_tree(
+            self.logger, self.config, parent=self
+        )
+
+        self.slot_type = SlotType.from_string(slot_type)
+
+        for children in LevelGroupOrderIter(self):
+            for child in children:
+                for sub_child in child.children:
+                    setattr(child, sub_child.name.lower(), sub_child)
+
+                    # If the device provides functions, add function and corresponding attributes to this hw module
+                    self._create_functions_from_node_providers(sub_child)
+
+    @property
+    def is_master(self) -> bool:
+        slot_attributes = self.slot.attributes
+        if slot_attributes is not None and hasattr(slot_attributes, "is_master"):
+            return slot_attributes.is_master
+        return False
+
+    def _create_functions_from_node_providers(self, device: Device) -> None:
+        providers: Munch | None = getattr(device, "provides", None)
+
+        if providers is not None:
+            for key, value in providers.items():
+                if key not in self.__dict__:
+                    provider = Munch()
+                else:
+                    provider = getattr(self, key)
+
+                provider.update(value)
+
+                setattr(self, key, provider)
+
+    def probe(self, *args, **kwargs) -> bool:
+        from ekfsm.core.probe import ProbeableDevice
+
+        nodes = findall(self, lambda node: isinstance(node, ProbeableDevice))
+        for node in nodes:
+            if node.probe(*args, **kwargs):
+                return True
+
+        return False
+
+    def info(self) -> dict[str, Any]:
+        """
+        Returns a dictionary with information about the hardware module.
+        """
+        return {
+            "name": self.instance_name,
+            "slot": self.slot,
+        }
+
+    @property
+    def instance_name(self) -> str:
+        if self.name is None:
+            raise RuntimeError("instance name not set")
+        return self.name
+
+    @property
+    def slot(self) -> Slot:
+        if self._slot is None:
+            raise RuntimeError("slot not set")
+        return self._slot
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}(name={self.name}, type={self.board_type})"

ekfsm/core/probe.py

@@ -0,0 +1,10 @@
+from abc import ABC, abstractmethod
+
+
+class ProbeableDevice(ABC):
+    @abstractmethod
+    def probe(self, *args, **kwargs) -> bool:
+        """
+        Probe the hardware device to check if it is present and if it is the correct device.
+        """
+        pass