diff --git a/docs/source/manual/arch_lang/simulation_setting.rst b/docs/source/manual/arch_lang/simulation_setting.rst index 32c5a3ebf..d480f4160 100644 --- a/docs/source/manual/arch_lang/simulation_setting.rst +++ b/docs/source/manual/arch_lang/simulation_setting.rst @@ -14,7 +14,10 @@ General organization is as follows ... - + + + ... + @@ -61,7 +64,10 @@ We should the full syntax in the code block below and then provide details on ea ... - + + + ... + Operating clock setting @@ -121,6 +127,22 @@ Programming clocks are defined under the XML node ```` Specify the frequency of the programming clock using an absolute value in the unit of ``[Hz]`` This frequency is used in testbenches for programming phase simulation. +.. option:: + +- ``name="`` + Specify a unique name for a clock signal. The name should match a reserved word of programming clock, i.e., ``bl_sr_clock`` and ``wl_sr_clock``. + + .. note:: The ``bl_sr_clock`` represents the clock signal driving the BL shift register chains, while the ``wl_sr_clock`` represents the clock signal driving the WL shift register chains + +- ``port="`` + Specify the clock port which the clock signal should be applied to. The clock port must be a valid clock port defined in OpenFPGA architecture description. Explicit index is required, e.g., ``clk[1:1]``. Otherwise, default index ``0`` will be considered, e.g., ``clk`` will be translated as ``clk[0:0]``. + +- ``frequency="auto|`` + Specify frequency of a clock signal in the unit of ``[Hz]``. If ``auto`` is used, the programming clock frequency will be inferred by OpenFPGA. + +- ``is_shift_register="`` + Specify if this clock signal is used to drive shift register chains in BL/WL protocols + .. note:: Programming clock frequency is typically much slower than the operating clock and strongly depends on the process technology. Suggest to characterize the speed of your configuration protocols before specifying a value! Simulator Option