FPGA/corundum
1
0
Fork 0
mirror of https://github.com/corundum/corundum.git synced 2025-01-30 08:32:52 +08:00
Code Issues Projects Releases Wiki Activity

Update parameter documentation

Browse Source
This commit is contained in:
Alex Forencich 2022-03-28 21:55:04 -07:00
parent 3b8643877d
commit a98443a95b
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/modules/mqnic_core.rst
View File

@ -61,6 +61,10 @@ Parameters
Ports per interface, default ``1``. Ports per interface, default ``1``.
.. object:: SCHED_PER_IF
Schedulers per interface, default ``PORTS_PER_IF``.
.. object:: PORT_COUNT .. object:: PORT_COUNT
Total port count, must be set to ``IF_COUNT*PORTS_PER_IF``. Total port count, must be set to ``IF_COUNT*PORTS_PER_IF``.
@ -93,6 +97,10 @@ Parameters
PTP nominal period, fractional ns portion, default ``32'd0``. PTP nominal period, fractional ns portion, default ``32'd0``.
.. object:: PTP_CLOCK_PIPELINE
Output pipeline stages on PTP clock module, default ``0``.
.. object:: PTP_USE_SAMPLE_CLOCK .. object:: PTP_USE_SAMPLE_CLOCK
Use external PTP sample clock, used to synchronize the PTP clock across clock domains, default ``0``. Use external PTP sample clock, used to synchronize the PTP clock across clock domains, default ``0``.
@ -101,6 +109,10 @@ Parameters
Use ``rx_ptp_clk`` instead of ``rx_clk`` for providing current PTP time if set, default ``0``. Use ``rx_ptp_clk`` instead of ``rx_clk`` for providing current PTP time if set, default ``0``.
.. object:: PTP_PORT_CDC_PIPELINE
Output pipeline stages on PTP clock CDC module, default ``0``.
.. object:: PTP_PEROUT_ENABLE .. object:: PTP_PEROUT_ENABLE
Enable PTP period output module, default ``0``. Enable PTP period output module, default ``0``.