zuspec-dataclasses 0.0.1.17421055506rc0__py3-none-any.whl → 0.0.1.17516204125rc0__py3-none-any.whl

zuspec/dataclasses/__init__.py

@@ -9,7 +9,7 @@ from .tlm import *
 # from .core_lib import *
 # from vsc_dataclasses.expr import *
 
-from .bit import Bit
+from .bit import Bit, uint64_t
 from .component import Component
 from .struct import Struct
 from .ports import Input, Output, Port

zuspec/dataclasses/__version__.py

@@ -1,4 +1,4 @@
 
 BASE="0.0.1"
-SUFFIX=".17421055506rc0"
+SUFFIX=".17516204125rc0"
 VERSION="%s%s" % (BASE, SUFFIX)

zuspec/dataclasses/addr_reg.py

@@ -1,61 +1,72 @@
 import abc
 import zuspec.dataclasses as zdc
 from typing import Annotated, TypeVar, Type, Union
+from .bit import BitVal
+from .decorators import dataclass, constraint
 from .struct import StructPacked
 
+class AddrHandle(): pass
+
 class AddrTrait(zdc.Struct): pass
 
 
 class AddrSpaceBase:
     pass
 
-uint64_t = Annotated[int, "abc"]
+# uint64_t = Annotated[int, "abc"]
 
 AddrTraitT = TypeVar('AddrTraitT', bound=AddrTrait)
 
+@dataclass
 class AddrRegion[AddrTraitT]():
-    trait : Type[AddrTraitT] = zdc.trait()
-    pass
-
-class MyTrait(AddrTrait):
-    a : int = 5
+    trait : Type[AddrTraitT] = zdc.field()
 
+@dataclass
 class TransparentAddrSpace[AddrTraitT](AddrSpaceBase):
 
-    def add_region(self, region : AddrRegion[AddrTraitT]): pass
-
-    pass
-
-class MyAddrTrait(AddrTrait):
-    pass
-
-class Other(object):
-    pass
+    @abc.abstractmethod
+    def add_region(self, region : AddrRegion[AddrTraitT]) -> AddrHandle: 
+        """Adds a region to the address space, returning a handle to that region"""
+        pass
 
-t : TransparentAddrSpace = TransparentAddrSpace()
-o = Other()
+@dataclass
+class AddrClaim[AddrTraitT]():
+    trait : AddrTraitT = zdc.field(rand=True)
+    size : int = zdc.field(rand=True)
 
-r = AddrRegion[MyTrait]()
-r2 = AddrRegion[Other]()
+    @constraint
+    def size_align_c(self):
+        self.size > 0
 
-t.add_region(r2)
 
-r.trait.a
+    @abc.abstractmethod
+    def handle(self, offset : int = 0) -> AddrHandle:
+        """Returns a handle corresponding to the claim"""
+        pass
 
-RegT = TypeVar("RegT", bound=Union[int,StructPacked])
+RegT = TypeVar("RegT", bound=Union[BitVal,StructPacked])
 
 class Reg[RegT](object):
 
     @abc.abstractmethod
-    def read(self) -> Type[RegT]: pass
+    async def read(self) -> Type[RegT]:
+        """Reads the value of the register"""
+        pass
 
     @abc.abstractmethod
-    def write(self, data : Type[RegT]): pass
+    async def write(self, data : Type[RegT]): 
+        """Writes the value of the register"""
+        pass
 
 class RegGroup(object):
     @abc.abstractmethod
-    def get_handle(self): pass
+    def get_handle(self) -> AddrHandle: 
+        """Gets the address handle that corresponds to this group"""
+        pass
 
     @abc.abstractmethod
-    def set_handle(self, h): pass
+    def set_handle(self, h): 
+        """Sets the address handle corresponding to this root group"""
+        pass
+
 

zuspec/dataclasses/bit.py

@@ -1,5 +1,5 @@
 import dataclasses as dc
-from typing import Dict
+from typing import Dict, Generic, TypeVar, Literal, Type
 
 class BitMeta(type):
 
@@ -20,7 +20,55 @@ class BitMeta(type):
             self.type_m[W] = t
             return t
 
+T = TypeVar('T')
 
-class Bit(metaclass=BitMeta):
-    T : int = 1
-    pass
+class Bit[T]: pass
+
+class Int[T]: pass
+
+#    T : int = 1
+
+#    def __class_getitem__(cls, W : int) -> 'Bit[T]':
+#        return "abc"
+#        return cls
+#        pass
+#    pass
+
+
+#W = TypeVar('W')
+
+#def bit_t(W : int) -> _GenericA[Bit[T]]:
+#    return Bit[Literal[W]]
+
+#def int_t(W : int) -> Int:
+#    return Int[Literal[W]]
+
+class Bits():
+    pass
+
+class IntVal():
+    pass
+
+class BitVal(int):
+    def __new__(cls, v : int, w : int):
+        ret = super().__new__(cls, v)
+        setattr(ret, "W", w)
+        return ret
+    def __getitem__(self, v):
+        return 5
+    
+    def __add__(self, rhs):
+        pass
+    
+v = BitVal(5, 16)
+v += 5
+
+def bv(v : int, w : int=1) -> BitVal:
+    return BitVal(v, w)
+
+a = bv(5,32)
+
+def iv(): pass
+
+uint64_t = Bit[Literal[64]]
+#int64_t = Int[Literal[64]]

zuspec/dataclasses/component.py

@@ -9,6 +9,11 @@ class Component(Struct):
     - The root component and fields of component type are constructed
     - The 'init_down' method is invoked in a depth-first manner
     - The 'init_up' method is invoked
+
+    A Component class supports the following decorated methods:
+    - sync
+    - constraint
+    - activity
     """
 
     def build(self): pass

zuspec/dataclasses/decorators.py

@@ -5,7 +5,7 @@ Created on Mar 19, 2022
 '''
 import dataclasses
 import dataclasses as dc
-from typing import Any, Callable, Dict, Self, TypeVar
+from typing import Any, Callable, Dict, Self, TypeVar, Generic, Type
 # from vsc_dataclasses.decorators import *
 # from .impl.action_decorator_impl import ActionDecoratorImpl
 # from .impl.exec_decorator_impl import ExecDecoratorImpl
@@ -23,6 +23,8 @@ from typing import Any, Callable, Dict, Self, TypeVar
 from .annotation import Annotation, AnnotationSync
 from .ports import Input, Output
 from .clock import Clock
+from .component import Component
+from .timebase import TimeBase
 
 def dataclass(cls, **kwargs):
     return dc.dataclass(cls, **kwargs)
@@ -94,8 +96,9 @@ def always(instr : BitLiteral):
 a = bit(20)[3:4] 
 
 SelfT = TypeVar('SelfT')
+T = TypeVar('T')
 
-class bind[T](object):
+class bind(Generic[T]):
     def __init__(self, c : Callable[[T],Dict[Any,Any]]):
         self._c = c
     def __call__(self, s) -> Dict[Any,Any]:
@@ -103,7 +106,13 @@ class bind[T](object):
     
 #a = bind2(lambda s:{s.}, selfT=Self)
 
-def field(rand=False, bind : Callable[[object],Dict[Any,Any]] = None):
+from typing import Optional
+
+def field(
+        rand=False, 
+        width=-1,
+        bind : Optional[Callable[[object],Dict[Any,Any]]] = None,
+        **kwargs):
     pass
     
     # @staticmethod
@@ -146,16 +155,39 @@ def reg(offset=0):
 def const(**kwargs):
     return dc.field()
 
-def sync(*args, clock=None, reset=None):
-    # TODO: handle two forms
-    if len(args) == 0:
-        def __call__(T):
-            Annotation.apply(T, AnnotationSync(clock=clock, reset=reset))
-            return T
-        return __call__
-    else:
-        Annotation.apply(args[0], AnnotationSync(clock=clock, reset=reset))
-        return args[0]
+SyncHostT = TypeVar('SyncHostT', bound=Component)
+SyncMethodT = TypeVar('SyncMethodT', bound=Callable[[SyncHostT],Any])
+
+@dc.dataclass
+class Sync(object):
+    method : Callable[[Component],Any] = dc.field()
+    timebase : TimeBase = dc.field()
+
+ComponentT = TypeVar('ComponentT', bound=Component)
+
+def sync(t : Callable[[ComponentT],Any]) -> Sync:
+    """
+    Sync marks a method that has a dependency on a timebase.
+    The method is automatically evaluated by the timebase at 
+    each timestep (eg clock period) of the timebase. The 
+    timebase will automatically assign the reset value 
+    to variables assigned within the decorated method when 
+    the timebase is reset.
+    A sync-decorated method may not be directly called.
+    """
+    # # TODO: handle two forms
+    # if len(args) == 0:
+    #     def __call__(T):
+    #         Annotation.apply(T, AnnotationSync(clock=clock, reset=reset))
+    #         return T
+    #     return __call__
+    # else:
+    #     Annotation.apply(args[0], AnnotationSync(clock=clock, reset=reset))
+    #     return args[0]
+    ret = Sync(t)
+    return ret
+#    return Sync(t)
+
 
 # def action(*args, **kwargs): 
 #     if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):

zuspec/dataclasses/tlm.py

@@ -10,3 +10,9 @@ class IPut[T]():
 class IGet[T]():
     get : Callable[[], Awaitable[T]] = dc.field()
 
+@dc.dataclass
+class IReqRsp[ReqT,RspT]():
+    put : Callable[[Type[ReqT]], Awaitable] = dc.field()
+    get : Callable[[], Awaitable[RspT]] = dc.field()
+
+

{zuspec_dataclasses-0.0.1.17421055506rc0.dist-info → zuspec_dataclasses-0.0.1.17516204125rc0.dist-info}/METADATA

@@ -1,5 +1,5 @@
 Metadata-Version: 2.4
 Name: zuspec-dataclasses
-Version: 0.0.1.17421055506rc0
+Version: 0.0.1.17516204125rc0
 License-File: LICENSE
 Dynamic: license-file

{zuspec_dataclasses-0.0.1.17421055506rc0.dist-info → zuspec_dataclasses-0.0.1.17516204125rc0.dist-info}/RECORD

@@ -1,28 +1,28 @@
-zuspec/dataclasses/__init__.py,sha256=N7A7kcH2MWv11kqVA-s0SyKnWBAKD6ijQXJOrzfRyf8,452
-zuspec/dataclasses/__version__.py,sha256=w206wPrAQOLdhYE50Ud54WEWjFUOPqdoT2NoUpjn64o,71
+zuspec/dataclasses/__init__.py,sha256=-a466Myi0Gs7JWbIm2LiNKkHFuIjoGsjj5aMrAyQuBs,462
+zuspec/dataclasses/__version__.py,sha256=2pHn0_iz8uobg16bUlzrP3GDosLHvXeTtklooC9fUFo,71
 zuspec/dataclasses/action.py,sha256=z7aMc6e_k_-NCzYDm8K1ymEPfcGeyqlO79of0Gucack,570
-zuspec/dataclasses/addr_reg.py,sha256=QmxPQ8lq1255ZfOjQRGFGWGGwK-pSpPFJ4mdzJlj8dw,1111
+zuspec/dataclasses/addr_reg.py,sha256=14dgTvdkyHxzGLOJRqMkAFwKhnRM2iI3B6IdzioJQl8,1728
 zuspec/dataclasses/annotation.py,sha256=M41iS93Oi8M-ER_ZIBI8CIWJ1bvEMI0nHa-RxbmWJUs,328
-zuspec/dataclasses/bit.py,sha256=Zxm3F04GcfuJczmwCrMuvpcBCunWMZQFffB4JvNterI,614
+zuspec/dataclasses/bit.py,sha256=PHGjvh-O4k7m-juXQzEMZJIn5k-h1cJaIHmgk0RhofM,1405
 zuspec/dataclasses/bundle.py,sha256=6fqjfoTS_-_izl4FlPFgurfOg3tnj_1fmEdSa1FF4C0,781
 zuspec/dataclasses/clock.py,sha256=pM0rO-3bp0SGJccxtU-17vIcF9EaSlqD-q1_9O0of1o,30
-zuspec/dataclasses/component.py,sha256=vzPCmLdAgm-x46Or18RtBYRClVUkbqIZ1yqp1nu5sL4,416
-zuspec/dataclasses/decorators.py,sha256=fSJpsTbahzQdtFtlVhDFSHFFuYmiRxg_3S_W1DpjLDY,9797
+zuspec/dataclasses/component.py,sha256=oERqTHRdiI2oYW5q8ijYNY9FUMIrqLlqAVfZFipjzPU,524
+zuspec/dataclasses/decorators.py,sha256=v6toBLONKbw5dj7DRoH9XEOSNghBNjuRWjc1C66LEHc,10762
 zuspec/dataclasses/dependency.py,sha256=kGxdFqKlviUP7qmvN-FbnXIiqCPdgRRel83feuu8OoU,532
 zuspec/dataclasses/ports.py,sha256=3pbBwdBzDMAJTZ15Qf6sSXB-XOH5cJ-G5H8kQa5JurQ,1106
 zuspec/dataclasses/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 zuspec/dataclasses/reset.py,sha256=DV8tiKq_k-AGUNBbpJCJFx_EEfA07UgUJK2veYli0b0,30
 zuspec/dataclasses/struct.py,sha256=vId0487ZJmhnTbTg421B-iN9PtxNexCv9DMqRO8RXBU,973
 zuspec/dataclasses/timebase.py,sha256=rjEiGB2lNPMTewE-Z4iX-CHnbx1QVTUbtwEXnKMkesI,599
-zuspec/dataclasses/tlm.py,sha256=TjODFwvombQR7AVVI7HlW37MEm22Zu9JdVYpOCU4_Vg,277
+zuspec/dataclasses/tlm.py,sha256=sbAlnkYhVidinbiMKBT_mbe5yr1dDU9F_6aKBAXZjjE,431
 zuspec/dataclasses/api/__init__.py,sha256=HfJhJ_B1RJSpJn5NmWzEK3l2IruubiEKd3xwLDuED6Q,30
 zuspec/dataclasses/api/visitor.py,sha256=8-5er0GxAWnvxhDmiR_OBn2iMxtymtol5qM09ucKdLI,1780
 zuspec/dataclasses/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zuspec/dataclasses/util/extract_cpp_embedded_dsl.py,sha256=SyMMLumZD6fsubj40hyekYzWyrcoUGTijJH3NmK1ihY,5630
 zuspec/dataclasses/util/gen_cpp_dt_defs/__main__.py,sha256=t3CnHJKcN_N33sxCsDH-R36ghCcQ7xjMcjUrzUT2SGM,3447
 zuspec/impl/__init__.py,sha256=GZWCeBPdVzLR0RNPkmXNXPgdS-2vg5dMC1goTYJs3yI,33
-zuspec_dataclasses-0.0.1.17421055506rc0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-zuspec_dataclasses-0.0.1.17421055506rc0.dist-info/METADATA,sha256=EZDxpqEdg2prfw4jvirp2j5sMETTp0ICrvue99A-Q44,121
-zuspec_dataclasses-0.0.1.17421055506rc0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-zuspec_dataclasses-0.0.1.17421055506rc0.dist-info/top_level.txt,sha256=3WM_V5g1RvpI4_z1TPY_AmroKhWIp6QJo4Vz5Tqbgak,7
-zuspec_dataclasses-0.0.1.17421055506rc0.dist-info/RECORD,,
+zuspec_dataclasses-0.0.1.17516204125rc0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+zuspec_dataclasses-0.0.1.17516204125rc0.dist-info/METADATA,sha256=i1hPXCIb3njC6aXg7B4-7PEyGQFnISQB-cg4W36qFtY,121
+zuspec_dataclasses-0.0.1.17516204125rc0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+zuspec_dataclasses-0.0.1.17516204125rc0.dist-info/top_level.txt,sha256=3WM_V5g1RvpI4_z1TPY_AmroKhWIp6QJo4Vz5Tqbgak,7
+zuspec_dataclasses-0.0.1.17516204125rc0.dist-info/RECORD,,