sdfgen 0.24.0__cp311-cp311-macosx_14_0_arm64.whl → 0.26.0__cp311-cp311-macosx_14_0_arm64.whl

sdfgen/module.py

@@ -14,6 +14,7 @@ class SddfStatus(IntEnum):
     INVALID_CLIENT = 2,
     NET_DUPLICATE_COPIER = 100,
     NET_DUPLICATE_MAC_ADDR = 101,
+    NET_INVALID_OPTIONS = 103,
 
 
 # TOOD: double check
@@ -78,13 +79,17 @@ libsdfgen.sdfgen_channel_get_pd_b_id.argtypes = [c_void_p]
 
 libsdfgen.sdfgen_map_create.restype = c_void_p
 libsdfgen.sdfgen_map_create.argtypes = [c_void_p, c_uint64, MapPermsType, c_bool]
+libsdfgen.sdfgen_map_get_vaddr.restype = c_uint64
+libsdfgen.sdfgen_map_get_vaddr.argtypes = [c_void_p]
 libsdfgen.sdfgen_map_destroy.restype = None
 libsdfgen.sdfgen_map_destroy.argtypes = [c_void_p]
 
 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_create_physical.argtypes = [c_void_p, c_char_p, c_uint64, POINTER(c_uint64)]
+libsdfgen.sdfgen_mr_get_size.restype = c_uint64
+libsdfgen.sdfgen_mr_get_size.argtypes = [c_void_p]
 libsdfgen.sdfgen_mr_get_paddr.restype = c_bool
 libsdfgen.sdfgen_mr_get_paddr.argtypes = [c_void_p, POINTER(c_uint64)]
 
@@ -123,6 +128,8 @@ libsdfgen.sdfgen_pd_destroy.argtypes = [c_void_p]
 
 libsdfgen.sdfgen_pd_add_child.restype = c_int8
 libsdfgen.sdfgen_pd_add_child.argtypes = [c_void_p, c_void_p, POINTER(c_uint8)]
+libsdfgen.sdfgen_pd_get_map_vaddr.restype = c_uint64
+libsdfgen.sdfgen_pd_get_map_vaddr.argtypes = [c_void_p, c_void_p]
 libsdfgen.sdfgen_pd_add_map.restype = None
 libsdfgen.sdfgen_pd_add_map.argtypes = [c_void_p, c_void_p]
 libsdfgen.sdfgen_pd_add_irq.restype = c_int8
@@ -183,7 +190,7 @@ libsdfgen.sdfgen_sddf_serial_serialise_config.restype = c_bool
 libsdfgen.sdfgen_sddf_serial_serialise_config.argtypes = [c_void_p, c_char_p]
 
 libsdfgen.sdfgen_sddf_net.restype = c_void_p
-libsdfgen.sdfgen_sddf_net.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_void_p]
+libsdfgen.sdfgen_sddf_net.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_void_p, c_void_p]
 libsdfgen.sdfgen_sddf_net_destroy.restype = None
 libsdfgen.sdfgen_sddf_net_destroy.argtypes = [c_void_p]
 
@@ -192,7 +199,9 @@ libsdfgen.sdfgen_sddf_net_add_client_with_copier.argtypes = [
     c_void_p,
     c_void_p,
     c_void_p,
-    c_char_p
+    c_char_p,
+    c_bool,
+    c_bool
 ]
 
 libsdfgen.sdfgen_sddf_net_connect.restype = c_bool
@@ -328,6 +337,17 @@ def ffi_uint32_ptr(n: Optional[int]):
     return pointer(c_uint32(n))
 
 
+def ffi_uint64_ptr(n: Optional[int]):
+    """
+    Convert an int value to a uint64_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_uint64(n))
+
+
 def ffi_bool_ptr(val: Optional[bool]):
     """
     Convert a bool value to a bool pointer for FFI.
@@ -406,9 +426,6 @@ class SystemDescription:
     """
 
     _obj: c_void_p
-    # We need to hold references to the PDs in case they get GC'd.
-    # TODO: is this really necessary?
-    _pds: List[ProtectionDomain]
 
     class Arch(IntEnum):
         """Target architecture. Used to resolve architecture specific features or attributes."""
@@ -422,9 +439,8 @@ class SystemDescription:
 
     class ProtectionDomain:
         _name: str
+        _program_image: str
         _obj: c_void_p
-        # We need to hold references to the PDs in case they get GC'd.
-        _child_pds: List[SystemDescription.ProtectionDomain]
 
         def __init__(
             self,
@@ -438,10 +454,10 @@ class SystemDescription:
             cpu: Optional[int] = None,
         ) -> None:
             self._name = name
+            self._program_image = program_image
             c_name = c_char_p(name.encode("utf-8"))
             c_program_image = c_char_p(program_image.encode("utf-8"))
             self._obj = libsdfgen.sdfgen_pd_create(c_name, c_program_image)
-            self._child_pds = []
             if priority is not None:
                 libsdfgen.sdfgen_pd_set_priority(self._obj, priority)
             if budget is not None:
@@ -459,6 +475,10 @@ class SystemDescription:
         def name(self) -> str:
             return self._name
 
+        @property
+        def program_image(self) -> str:
+            return self._program_image
+
         def add_child_pd(self, child_pd: SystemDescription.ProtectionDomain, child_id=None) -> int:
             """
             Returns allocated ID for the child.
@@ -469,10 +489,14 @@ class SystemDescription:
             if id < 0:
                 raise Exception(f"failed to add child to PD '{self.name}'")
 
-            self._child_pds.append(child_pd)
-
             return id
 
+        def get_map_vaddr(self, mr: SystemDescription.MemoryRegion) -> int:
+            """
+            Returns next available vaddr for memory region map.
+            """
+            return libsdfgen.sdfgen_pd_get_map_vaddr(self._obj, mr._obj)
+
         def add_map(self, map: SystemDescription.Map):
             libsdfgen.sdfgen_pd_add_map(self._obj, map._obj)
 
@@ -494,8 +518,6 @@ class SystemDescription:
         def __repr__(self) -> str:
             return f"ProtectionDomain({self.name})"
 
-    # TODO: __del__ is more complicated for virtual machine since it may be owned
-    # by a protection domain meaning it would result in a double free
     class VirtualMachine:
         _name: str
         _obj: c_void_p
@@ -533,6 +555,9 @@ class SystemDescription:
         def add_map(self, map: SystemDescription.Map):
             libsdfgen.sdfgen_vm_add_map(self._obj, map._obj)
 
+        def __del__(self):
+            libsdfgen.sdfgen_vm_destroy(self._obj)
+
         def __repr__(self) -> str:
             return f"VirtualMachine({self.name})"
 
@@ -564,22 +589,35 @@ class SystemDescription:
             if self._obj is None:
                 raise Exception("failed to create mapping")
 
+        @property
+        def vaddr(self):
+            return libsdfgen.sdfgen_map_get_vaddr(self._obj)
+
     class MemoryRegion:
         _obj: c_void_p
 
         # TODO: handle more options
         def __init__(
             self,
+            sdf: SystemDescription,
             name: str,
             size: int,
             *,
+            physical: Optional[bool] = None,
             paddr: Optional[int] = None
         ) -> None:
             c_name = c_char_p(name.encode("utf-8"))
             if paddr:
-                self._obj = libsdfgen.sdfgen_mr_create_physical(c_name, size, paddr)
+                physical = True
+            if physical:
+                self._obj = libsdfgen.sdfgen_mr_create_physical(sdf._obj, c_name, size, ffi_uint64_ptr(paddr))
             else:
                 self._obj = libsdfgen.sdfgen_mr_create(c_name, size)
+            self._size = size
+        
+        @property
+        def size(self):
+            return libsdfgen.sdfgen_mr_get_size(self._obj)
 
         @property
         def paddr(self):
@@ -665,13 +703,11 @@ class SystemDescription:
         Create a System Description
         """
         self._obj = libsdfgen.sdfgen_create(arch.value, paddr_top)
-        self._pds = []
 
     def __del__(self):
         libsdfgen.sdfgen_destroy(self._obj)
 
     def add_pd(self, pd: ProtectionDomain):
-        self._pds.append(pd)
         libsdfgen.sdfgen_add_pd(self._obj, pd._obj)
 
     def add_mr(self, mr: MemoryRegion):
@@ -872,23 +908,30 @@ class Sddf:
             device: Optional[DeviceTree.Node],
             driver: SystemDescription.ProtectionDomain,
             virt_tx: SystemDescription.ProtectionDomain,
-            virt_rx: SystemDescription.ProtectionDomain
+            virt_rx: SystemDescription.ProtectionDomain,
+            rx_dma_mr: Optional[SystemDescription.MemoryRegion] = None
         ) -> None:
             if device is None:
                 device_obj = None
             else:
                 device_obj = device._obj
+            if rx_dma_mr is None:
+                rx_dma_mr_obj = None
+            else:
+                rx_dma_mr_obj = rx_dma_mr._obj
 
             self._obj = libsdfgen.sdfgen_sddf_net(
-                sdf._obj, device_obj, driver._obj, virt_tx._obj, virt_rx._obj
+                sdf._obj, device_obj, driver._obj, virt_tx._obj, virt_rx._obj, rx_dma_mr_obj
             )
 
         def add_client_with_copier(
             self,
             client: SystemDescription.ProtectionDomain,
-            copier: SystemDescription.ProtectionDomain,
+            copier: Optional[SystemDescription.ProtectionDomain] = None,
             *,
-            mac_addr: Optional[str] = None
+            mac_addr: Optional[str] = None,
+            rx: Optional[bool] = None,
+            tx: Optional[bool] = None
         ) -> None:
             """
             Add a client connected to a copier component for RX traffic.
@@ -904,8 +947,20 @@ class Sddf:
             c_mac_addr = c_char_p(0)
             if mac_addr is not None:
                 c_mac_addr = c_char_p(mac_addr.encode("utf-8"))
+            if copier is None:
+                copier_obj = None
+            else:
+                copier_obj = copier._obj
+            if rx is None or rx is True:
+                rx_arg = True
+            else:
+                rx_arg = False
+            if tx is None or tx is True:
+                tx_arg = True
+            else:
+                tx_arg = False
             ret = libsdfgen.sdfgen_sddf_net_add_client_with_copier(
-                self._obj, client._obj, copier._obj, c_mac_addr
+                self._obj, client._obj, copier_obj, c_mac_addr, rx_arg, tx_arg
             )
             if ret == SddfStatus.OK:
                 return
@@ -917,6 +972,8 @@ class Sddf:
                 raise Exception(f"duplicate copier given '{copier}'")
             elif ret == SddfStatus.NET_DUPLICATE_MAC_ADDR:
                 raise Exception(f"duplicate MAC address given '{mac_addr}'")
+            elif ret == SddfStatus.NET_INVALID_OPTIONS:
+                raise Exception(f"client must have rx or tx access")
             else:
                 raise Exception(f"internal error: {ret}")
 

{sdfgen-0.24.0.dist-info → sdfgen-0.26.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdfgen
-Version: 0.24.0
+Version: 0.26.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.26.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+csdfgen.cpython-311-darwin.so,sha256=b6459UOs1bM1jz4FoG23HNZqib6k4L3iY436lwhnXP8,630104
+libcsdfgen.0.26.0.dylib,sha256=b6459UOs1bM1jz4FoG23HNZqib6k4L3iY436lwhnXP8,630104
+libcsdfgen.0.dylib,sha256=b6459UOs1bM1jz4FoG23HNZqib6k4L3iY436lwhnXP8,630104
+libcsdfgen.dylib,sha256=b6459UOs1bM1jz4FoG23HNZqib6k4L3iY436lwhnXP8,630104
+sdfgen/__init__.py,sha256=_d7GGV8GhadIAEYP8uiJlez0yKtXnHMHdRkRzVMKS3c,143
+sdfgen/module.py,sha256=D7_EwTuYhocW3SGGrGo4Hn0fhBf1bGoYeTNUiz0Yxoc,47070
+sdfgen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdfgen-0.26.0.dist-info/METADATA,sha256=7M2-Ci34pRRPKOPze_GFLE1DaNWOP69e5odEALWssUk,4549
+sdfgen-0.26.0.dist-info/WHEEL,sha256=gjBbMYF3hHcJ-eJE-RtWtKPJSpb6zv2bFlcPw0JdDB8,109
+sdfgen-0.26.0.dist-info/top_level.txt,sha256=M3gUW9vTMij10peQKgv1Qs0jZkdsk_PG0REFxuv6jNY,15
+sdfgen-0.26.0.dist-info/RECORD,,

{sdfgen-0.24.0.dist-info → sdfgen-0.26.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.0.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: false
 Tag: cp311-cp311-macosx_14_0_arm64
 

sdfgen-0.24.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-csdfgen.cpython-311-darwin.so,sha256=tak-wJ49xs7EI70HYzISz5D1GtT0-nWq_tc0o-bogEo,880280
-libcsdfgen.0.24.0.dylib,sha256=tak-wJ49xs7EI70HYzISz5D1GtT0-nWq_tc0o-bogEo,880280
-libcsdfgen.0.dylib,sha256=tak-wJ49xs7EI70HYzISz5D1GtT0-nWq_tc0o-bogEo,880280
-libcsdfgen.dylib,sha256=tak-wJ49xs7EI70HYzISz5D1GtT0-nWq_tc0o-bogEo,880280
-sdfgen/__init__.py,sha256=_d7GGV8GhadIAEYP8uiJlez0yKtXnHMHdRkRzVMKS3c,143
-sdfgen/module.py,sha256=XCdJ3HyUF7sPTYm-tw9BzE9O7fA-zuFGcA3jBwYTrP8,45235
-sdfgen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sdfgen-0.24.0.dist-info/METADATA,sha256=nLuya7UbzSfHITmPU9TH8LVmjl_3VBaugiabDiLcX2k,4549
-sdfgen-0.24.0.dist-info/WHEEL,sha256=4JsB6AUySjtGjjfSsh8uudjbIb9V3BIYxHWl5wWwxrc,109
-sdfgen-0.24.0.dist-info/top_level.txt,sha256=M3gUW9vTMij10peQKgv1Qs0jZkdsk_PG0REFxuv6jNY,15
-sdfgen-0.24.0.dist-info/RECORD,,