diff --git a/source/SpinalHDL/Libraries/flow.rst b/source/SpinalHDL/Libraries/flow.rst index 7fb1404e6b8..0a1de88c079 100644 --- a/source/SpinalHDL/Libraries/flow.rst +++ b/source/SpinalHDL/Libraries/flow.rst @@ -54,13 +54,10 @@ Functions | through a register stage that cut valid/payload paths - Flow[T] - 1 - - * - x.stage() - - | Equivalent to x.m2sPipe() - | + - Equivalent to x.m2sPipe() - Flow[T] - 1 - - * - | x << y | y >> x - Connect y to x diff --git a/source/locale/gettext/SpinalHDL/Libraries/flow.pot b/source/locale/gettext/SpinalHDL/Libraries/flow.pot index 52435b09b60..5f3a138304a 100644 --- a/source/locale/gettext/SpinalHDL/Libraries/flow.pot +++ b/source/locale/gettext/SpinalHDL/Libraries/flow.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: SpinalHDL \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-03-30 13:03+0000\n" +"POT-Creation-Date: 2024-03-30 15:02+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -41,6 +41,7 @@ msgid "Driver" msgstr "" #: ../../SpinalHDL/Libraries/flow.rst:18 +#: ../../SpinalHDL/Libraries/flow.rst:40 msgid "Description" msgstr "" @@ -70,6 +71,7 @@ msgid "payload" msgstr "" #: ../../SpinalHDL/Libraries/flow.rst:26 +#: ../../SpinalHDL/Libraries/flow.rst:78 msgid "T" msgstr "" @@ -85,42 +87,170 @@ msgstr "" msgid "Functions" msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:93 +#: ../../SpinalHDL/Libraries/flow.rst:39 +msgid "Syntax" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:41 +msgid "Return" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:42 +msgid "Latency" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:43 +msgid "Flow(type : Data)" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +#: ../../SpinalHDL/Libraries/flow.rst:44 +msgid "Create a Flow of a given type" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:45 +#: ../../SpinalHDL/Libraries/flow.rst:50 +#: ../../SpinalHDL/Libraries/flow.rst:55 +#: ../../SpinalHDL/Libraries/flow.rst:59 +#: ../../SpinalHDL/Libraries/flow.rst:74 +msgid "Flow[T]" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:47 +msgid "master/slave Flow(type : Data)" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "Initialized with corresponding in/out setup" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:52 +msgid "x.m2sPipe()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "Return a Flow drived by x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "through a register stage that cut valid/payload paths" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:56 +#: ../../SpinalHDL/Libraries/flow.rst:60 +#: ../../SpinalHDL/Libraries/flow.rst:70 +msgid "1" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:57 +msgid "x.stage()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:58 +msgid "Equivalent to x.m2sPipe()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "x << y" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "y >> x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:63 +msgid "Connect y to x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:65 +#: ../../SpinalHDL/Libraries/flow.rst:75 +msgid "0" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "x <-< y" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "y >-> x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:68 +msgid "Connect y to x through a m2sPipe" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:71 +msgid "x.throwWhen(cond : Bool)" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "Return a Flow connected to x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:0 +msgid "When cond is high, transaction are dropped" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:76 +msgid "x.toReg()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:77 +msgid "Return a register which is loaded with ``payload`` when valid is high" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:80 +msgid "x.setIdle()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:81 +msgid "Set the Flow in an Idle state: ``valid`` is ``False`` and don't care about ``payload``." +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:84 +msgid "x.push(newPayload: T)" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:85 +msgid "Assign a new valid payload to the Flow. ``valid`` is set to ``True``." +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:90 msgid "Code example" msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:101 +#: ../../SpinalHDL/Libraries/flow.rst:98 msgid "Simulation Support" msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:107 +#: ../../SpinalHDL/Libraries/flow.rst:104 msgid "Class" msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:108 +#: ../../SpinalHDL/Libraries/flow.rst:105 msgid "Usage" msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:109 +#: ../../SpinalHDL/Libraries/flow.rst:106 msgid "FlowMonitor" msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:110 +#: ../../SpinalHDL/Libraries/flow.rst:107 msgid "Used for both master and slave sides, calls function with payload if Flow transmits data." msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:111 +#: ../../SpinalHDL/Libraries/flow.rst:108 msgid "FlowDriver" msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:112 +#: ../../SpinalHDL/Libraries/flow.rst:109 msgid "Testbench master side, drives values by calling function to apply value (if available). Function must return if value was available. Supports random delays." msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:113 +#: ../../SpinalHDL/Libraries/flow.rst:110 msgid "ScoreboardInOrder" msgstr "" -#: ../../SpinalHDL/Libraries/flow.rst:114 +#: ../../SpinalHDL/Libraries/flow.rst:111 msgid "Often used to compare reference/dut data" msgstr "" diff --git a/source/locale/zh_CN/LC_MESSAGES/SpinalHDL/Libraries/flow.po b/source/locale/zh_CN/LC_MESSAGES/SpinalHDL/Libraries/flow.po index d4de72d069b..f960581de23 100644 --- a/source/locale/zh_CN/LC_MESSAGES/SpinalHDL/Libraries/flow.po +++ b/source/locale/zh_CN/LC_MESSAGES/SpinalHDL/Libraries/flow.po @@ -10,7 +10,7 @@ msgstr "" "+0800PO-Revision-Date:YEAR-MO-DA HO:MI+ZONELast-Translator:FULL NAME " "Language-Team:LANGUAGE MIME-Version:1.0Content-" "Type:text/plain; charset=UTF-8\n" -"POT-Creation-Date: 2024-03-30 13:03+0000\n" +"POT-Creation-Date: 2024-03-30 15:02+0000\n" "PO-Revision-Date: 2024-01-25 03:01+0000\n" "Last-Translator: tsy0123 <675526215@qq.com>\n" "Language: zh_CN\n" @@ -49,7 +49,7 @@ msgstr "类型" msgid "Driver" msgstr "驱动" -#: ../../SpinalHDL/Libraries/flow.rst:18 +#: ../../SpinalHDL/Libraries/flow.rst:18 ../../SpinalHDL/Libraries/flow.rst:40 msgid "Description" msgstr "描述" @@ -77,7 +77,7 @@ msgstr "当为高时 => 接口上存在有效负载(payload)" msgid "payload" msgstr "payload" -#: ../../SpinalHDL/Libraries/flow.rst:26 +#: ../../SpinalHDL/Libraries/flow.rst:26 ../../SpinalHDL/Libraries/flow.rst:78 msgid "T" msgstr "T" @@ -93,48 +93,174 @@ msgstr "valid为低" msgid "Functions" msgstr "函数" -#: ../../SpinalHDL/Libraries/flow.rst:93 +#: ../../SpinalHDL/Libraries/flow.rst:39 +msgid "Syntax" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:41 +msgid "Return" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:42 +msgid "Latency" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:43 +msgid "Flow(type : Data)" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst ../../SpinalHDL/Libraries/flow.rst:44 +msgid "Create a Flow of a given type" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:45 ../../SpinalHDL/Libraries/flow.rst:50 +#: ../../SpinalHDL/Libraries/flow.rst:55 ../../SpinalHDL/Libraries/flow.rst:59 +#: ../../SpinalHDL/Libraries/flow.rst:74 +#, fuzzy +msgid "Flow[T]" +msgstr "Flow" + +#: ../../SpinalHDL/Libraries/flow.rst:47 +msgid "master/slave Flow(type : Data)" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "Initialized with corresponding in/out setup" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:52 +msgid "x.m2sPipe()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "Return a Flow drived by x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "through a register stage that cut valid/payload paths" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:56 ../../SpinalHDL/Libraries/flow.rst:60 +#: ../../SpinalHDL/Libraries/flow.rst:70 +msgid "1" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:57 +msgid "x.stage()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:58 +msgid "Equivalent to x.m2sPipe()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "x << y" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "y >> x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:63 +msgid "Connect y to x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:65 ../../SpinalHDL/Libraries/flow.rst:75 +msgid "0" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "x <-< y" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "y >-> x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:68 +msgid "Connect y to x through a m2sPipe" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:71 +msgid "x.throwWhen(cond : Bool)" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "Return a Flow connected to x" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst +msgid "When cond is high, transaction are dropped" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:76 +msgid "x.toReg()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:77 +msgid "Return a register which is loaded with ``payload`` when valid is high" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:80 +msgid "x.setIdle()" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:81 +msgid "" +"Set the Flow in an Idle state: ``valid`` is ``False`` and don't care " +"about ``payload``." +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:84 +msgid "x.push(newPayload: T)" +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:85 +msgid "Assign a new valid payload to the Flow. ``valid`` is set to ``True``." +msgstr "" + +#: ../../SpinalHDL/Libraries/flow.rst:90 msgid "Code example" msgstr "代码示例" -#: ../../SpinalHDL/Libraries/flow.rst:101 +#: ../../SpinalHDL/Libraries/flow.rst:98 msgid "Simulation Support" msgstr "仿真支持" -#: ../../SpinalHDL/Libraries/flow.rst:107 +#: ../../SpinalHDL/Libraries/flow.rst:104 msgid "Class" msgstr "类" -#: ../../SpinalHDL/Libraries/flow.rst:108 +#: ../../SpinalHDL/Libraries/flow.rst:105 msgid "Usage" msgstr "用法" -#: ../../SpinalHDL/Libraries/flow.rst:109 +#: ../../SpinalHDL/Libraries/flow.rst:106 msgid "FlowMonitor" msgstr "FlowMonitor" -#: ../../SpinalHDL/Libraries/flow.rst:110 +#: ../../SpinalHDL/Libraries/flow.rst:107 msgid "" "Used for both master and slave sides, calls function with payload if Flow" " transmits data." msgstr "用于主端和从端,如果数据流传输数据,则调用带有负载的函数。" -#: ../../SpinalHDL/Libraries/flow.rst:111 +#: ../../SpinalHDL/Libraries/flow.rst:108 msgid "FlowDriver" msgstr "FlowDriver" -#: ../../SpinalHDL/Libraries/flow.rst:112 +#: ../../SpinalHDL/Libraries/flow.rst:109 msgid "" "Testbench master side, drives values by calling function to apply value " "(if available). Function must return if value was available. Supports " "random delays." msgstr "Testbench中主端通过调用函数来应用值(如果可用)以驱动值。如果值可用,则函数必须返回。支持随机的延迟。" -#: ../../SpinalHDL/Libraries/flow.rst:113 +#: ../../SpinalHDL/Libraries/flow.rst:110 msgid "ScoreboardInOrder" msgstr "ScoreboardInOrder" -#: ../../SpinalHDL/Libraries/flow.rst:114 +#: ../../SpinalHDL/Libraries/flow.rst:111 msgid "Often used to compare reference/dut data" msgstr "通常用于比较参考/dut数据"