sdfgen 0.17.0__cp312-cp312-macosx_14_0_arm64.whl → 0.19.0__cp312-cp312-macosx_14_0_arm64.whl

sdfgen/module.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 import ctypes
 import importlib.util
 from ctypes import (
-    cast, c_void_p, c_char_p, c_uint8, c_uint16, c_uint32, c_uint64, c_bool, POINTER, byref
+    cast, c_void_p, c_char_p, c_uint8, c_uint16, c_uint32, c_uint64, c_bool, POINTER, byref, pointer
 )
 from typing import Optional, List, Tuple
 from enum import IntEnum
@@ -60,7 +60,15 @@ libsdfgen.sdfgen_render.restype = c_char_p
 libsdfgen.sdfgen_render.argtypes = [c_void_p]
 
 libsdfgen.sdfgen_channel_create.restype = c_void_p
-libsdfgen.sdfgen_channel_create.argtypes = [c_void_p, c_void_p]
+libsdfgen.sdfgen_channel_create.argtypes = [
+    c_void_p,
+    c_void_p,
+    POINTER(c_uint8),
+    POINTER(c_uint8),
+    POINTER(c_bool),
+    POINTER(c_bool),
+    POINTER(c_uint8),
+]
 libsdfgen.sdfgen_channel_destroy.restype = None
 libsdfgen.sdfgen_channel_destroy.argtypes = [c_void_p]
 libsdfgen.sdfgen_channel_get_pd_a_id.restype = c_uint8
@@ -77,6 +85,9 @@ libsdfgen.sdfgen_mr_create.restype = c_void_p
 libsdfgen.sdfgen_mr_create.argtypes = [c_char_p, c_uint64]
 libsdfgen.sdfgen_mr_create_physical.restype = c_void_p
 libsdfgen.sdfgen_mr_create_physical.argtypes = [c_char_p, c_uint64, c_uint64]
+libsdfgen.sdfgen_mr_get_paddr.restype = c_bool;
+libsdfgen.sdfgen_mr_get_paddr.argtypes = [c_void_p, POINTER(c_uint64)]
+
 libsdfgen.sdfgen_mr_destroy.restype = None
 libsdfgen.sdfgen_mr_destroy.argtypes = [c_void_p]
 
@@ -90,6 +101,9 @@ libsdfgen.sdfgen_vm_create.argtypes = [c_char_p, POINTER(c_void_p), c_uint32]
 libsdfgen.sdfgen_vm_destroy.restype = None
 libsdfgen.sdfgen_vm_destroy.argtypes = [c_void_p]
 
+libsdfgen.sdfgen_vm_set_priority.restype = None
+libsdfgen.sdfgen_vm_set_priority.argtypes = [c_void_p, c_uint8]
+
 libsdfgen.sdfgen_vm_add_map.restype = None
 libsdfgen.sdfgen_vm_add_map.argtypes = [c_void_p, c_void_p]
 
@@ -209,12 +223,20 @@ libsdfgen.sdfgen_vmm.argtypes = [
 libsdfgen.sdfgen_vmm_add_passthrough_device.restype = c_bool
 libsdfgen.sdfgen_vmm_add_passthrough_device.argtypes = [
     c_void_p,
-    c_char_p,
+    c_void_p,
+]
+libsdfgen.sdfgen_vmm_add_passthrough_device_regions.restype = c_bool
+libsdfgen.sdfgen_vmm_add_passthrough_device_regions.argtypes = [
+    c_void_p,
     c_void_p,
     POINTER(c_uint8),
     c_uint8,
+]
+libsdfgen.sdfgen_vmm_add_passthrough_device_irqs.argtypes = [
+    c_void_p,
+    c_void_p,
     POINTER(c_uint8),
-    c_uint8
+    c_uint8,
 ]
 libsdfgen.sdfgen_vmm_add_passthrough_irq.restype = c_bool
 libsdfgen.sdfgen_vmm_add_passthrough_irq.argtypes = [c_void_p, c_void_p]
@@ -260,6 +282,27 @@ libsdfgen.sdfgen_sddf_lwip_connect.argtypes = [c_void_p]
 libsdfgen.sdfgen_sddf_lwip_serialise_config.restype = c_bool
 libsdfgen.sdfgen_sddf_lwip_serialise_config.argtypes = [c_void_p, c_char_p]
 
+def ffi_uint8_ptr(n: Optional[int]):
+    """
+    Convert an int value to a uint8_t pointer for FFI.
+    If 'n' is None then we return None (which acts as a null pointer)
+    """
+    if n is None:
+        return None
+
+    return pointer(c_uint8(n))
+
+
+def ffi_bool_ptr(val: Optional[bool]):
+    """
+    Convert a bool value to a bool pointer for FFI.
+    If 'val' is None then we return None (which acts as a null pointer)
+    """
+    if val is None:
+        return None
+
+    return pointer(c_bool(val))
+
 
 class DeviceTree:
     """
@@ -423,12 +466,14 @@ class SystemDescription:
                 # TODO: error checking
                 self._obj = libsdfgen.sdfgen_vm_vcpu_create(id, cpu)
 
-        def __init__(self, name: str, vcpus: List[Vcpu]):
+        def __init__(self, name: str, vcpus: List[Vcpu], priority: Optional[int] = None):
             vcpus_tuple: Tuple[c_void_p] = tuple([vcpu._obj for vcpu in vcpus])
             c_vcpus = (c_void_p * len(vcpus))(*vcpus_tuple)
             c_name = c_char_p(name.encode("utf-8"))
             self._name = name
             self._obj = libsdfgen.sdfgen_vm_create(c_name, cast(c_vcpus, POINTER(c_void_p)), len(vcpus))
+            if priority is not None:
+                libsdfgen.sdfgen_vm_set_priority(self._obj, priority)
 
         @property
         def name(self) -> str:
@@ -487,6 +532,15 @@ class SystemDescription:
             else:
                 self._obj = libsdfgen.sdfgen_mr_create(c_name, size)
 
+        @property
+        def paddr(self):
+            paddr = c_uint64(0)
+            has_paddr = libsdfgen.sdfgen_mr_get_paddr(self._obj, pointer(paddr))
+            if has_paddr:
+                return paddr
+            else:
+                return None
+
         def __del__(self):
             libsdfgen.sdfgen_mr_destroy(self._obj)
 
@@ -506,18 +560,36 @@ class SystemDescription:
     class Channel:
         _obj: c_void_p
 
-        # TODO: handle options
         def __init__(
             self,
             a: SystemDescription.ProtectionDomain,
             b: SystemDescription.ProtectionDomain,
             *,
-            pp_a=False,
-            pp_b=False,
-            notify_a=True,
-            notify_b=True
+            a_id: Optional[int] = None,
+            b_id: Optional[int] = None,
+            pp_a: Optional[bool] = None,
+            pp_b: Optional[bool] = None,
+            notify_a: Optional[bool] = None,
+            notify_b: Optional[bool] = None,
         ) -> None:
-            self._obj = libsdfgen.sdfgen_channel_create(a._obj, b._obj)
+            c_pp = None
+            if pp_a is not None:
+                c_pp = 0
+            elif pp_b is not None:
+                c_pp = 1
+
+            if pp_a is not None and pp_b is not None:
+                raise Exception("attempting to create channel with PP on both ends")
+
+            self._obj = libsdfgen.sdfgen_channel_create(
+                a._obj,
+                b._obj,
+                ffi_uint8_ptr(a_id),
+                ffi_uint8_ptr(b_id),
+                ffi_bool_ptr(notify_a),
+                ffi_bool_ptr(notify_b),
+                ffi_uint8_ptr(c_pp),
+            )
 
         @property
         def pd_a_id(self) -> int:
@@ -887,28 +959,36 @@ class Vmm:
 
     def add_passthrough_device(
         self,
-        name: str,
         device: DeviceTree.Node,
         *,
         regions: Optional[List[int]] = None,
         irqs: Optional[List[int]] = None
     ):
-        c_name = c_char_p(name.encode("utf-8"))
-        if regions:
-            c_regions = cast((c_uint8 * len(regions))(*regions), POINTER(c_uint8))
-            regions_len = len(c_regions)
-        else:
-            c_regions = None
-            regions_len = 0
-
-        if irqs:
+        """
+        Add pass-through access to a particular device based on its DTB node.
+        :param regions: list of indices into the 'reg' field of the device to be mapped in. If None
+                        then every region passed through.
+        :param irqs: list of indices into the 'interrupts' field of the device to be created. If None
+                        then every IRQ is passed through.
+        """
+        if regions is None and irqs is None:
+            # If the user passed None, that means we need to map everything in
+            return libsdfgen.sdfgen_vmm_add_passthrough_device(self._obj, device._obj)
+        elif irqs is not None:
+            # Pass through specific IRQs, all regions
             c_irqs = cast((c_uint8 * len(irqs))(*irqs), POINTER(c_uint8))
-            irqs_len = len(c_irqs)
+            irqs_len = len(irqs)
+            ret = libsdfgen.sdfgen_vmm_add_passthrough_device_irqs(self._obj, device._obj, c_irqs, irqs_len)
+            ret = libsdfgen.sdfgen_vmm_add_passthrough_device_regions(self._obj, device._obj, None, 0)
+        elif regions is not None:
+            # Pass through specific regions, all IRQs
+            c_regions = cast((c_uint8 * len(regions))(*regions), POINTER(c_uint8))
+            regions_len = len(regions)
+            ret = libsdfgen.sdfgen_vmm_add_passthrough_device_regions(self._obj, device._obj, c_regions, regions_len)
+            ret = libsdfgen.sdfgen_vmm_add_passthrough_device_irqs(self._obj, device._obj, None, 0)
         else:
-            c_irqs = None
-            irqs_len = 0
-
-        return libsdfgen.sdfgen_vmm_add_passthrough_device(self._obj, c_name, device._obj, c_regions, regions_len, c_irqs, irqs_len)
+            # unreachable case
+            raise Exception("internal error")
 
     def add_passthrough_irq(self, irq: SystemDescription.Irq):
         return libsdfgen.sdfgen_vmm_add_passthrough_irq(self._obj, irq._obj)

{sdfgen-0.17.0.dist-info → sdfgen-0.19.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sdfgen
-Version: 0.17.0
+Version: 0.19.0
 Summary: Automating the creation of Microkit System Description Files (SDF)
 Home-page: https://github.com/au-ts/microkit_sdf_gen
 Description-Content-Type: text/markdown

sdfgen-0.19.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+csdfgen.cpython-312-darwin.so,sha256=WQwK6HOrh8j38eOT5AV61MbBQCMXltOf2KKOrZEcio0,759864
+libcsdfgen.0.19.0.dylib,sha256=WQwK6HOrh8j38eOT5AV61MbBQCMXltOf2KKOrZEcio0,759864
+libcsdfgen.0.dylib,sha256=WQwK6HOrh8j38eOT5AV61MbBQCMXltOf2KKOrZEcio0,759864
+libcsdfgen.dylib,sha256=WQwK6HOrh8j38eOT5AV61MbBQCMXltOf2KKOrZEcio0,759864
+sdfgen/__init__.py,sha256=_d7GGV8GhadIAEYP8uiJlez0yKtXnHMHdRkRzVMKS3c,143
+sdfgen/module.py,sha256=lDfOUdrj6Sw-Aw8dxjtNLrsxYa8K1ZNzyuR0rifcVqQ,40387
+sdfgen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdfgen-0.19.0.dist-info/METADATA,sha256=8D7AWuueKDuan7yrfQydpIMk48N7qYFhbuT7yC5eJMw,4654
+sdfgen-0.19.0.dist-info/WHEEL,sha256=K6Spq1kyvln8vdZf4xAPz20_F-9hz62IhBAuac6sFbY,109
+sdfgen-0.19.0.dist-info/top_level.txt,sha256=M3gUW9vTMij10peQKgv1Qs0jZkdsk_PG0REFxuv6jNY,15
+sdfgen-0.19.0.dist-info/RECORD,,

sdfgen-0.17.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-csdfgen.cpython-312-darwin.so,sha256=tIosKsFLrP17i6nHsAi1YwUi5zepW-4SoIW-DRVIzCc,759144
-libcsdfgen.0.17.0.dylib,sha256=tIosKsFLrP17i6nHsAi1YwUi5zepW-4SoIW-DRVIzCc,759144
-libcsdfgen.0.dylib,sha256=tIosKsFLrP17i6nHsAi1YwUi5zepW-4SoIW-DRVIzCc,759144
-libcsdfgen.dylib,sha256=tIosKsFLrP17i6nHsAi1YwUi5zepW-4SoIW-DRVIzCc,759144
-sdfgen/__init__.py,sha256=_d7GGV8GhadIAEYP8uiJlez0yKtXnHMHdRkRzVMKS3c,143
-sdfgen/module.py,sha256=43JZjSFFzMDoYd0r_O26HFVsfFyzgh1r51bkbzkVA20,37296
-sdfgen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sdfgen-0.17.0.dist-info/METADATA,sha256=pofeKoD0ElzkpumR1NqPDjFJsAjP9WZmmPfhX3QdGeQ,4654
-sdfgen-0.17.0.dist-info/WHEEL,sha256=K6Spq1kyvln8vdZf4xAPz20_F-9hz62IhBAuac6sFbY,109
-sdfgen-0.17.0.dist-info/top_level.txt,sha256=M3gUW9vTMij10peQKgv1Qs0jZkdsk_PG0REFxuv6jNY,15
-sdfgen-0.17.0.dist-info/RECORD,,