1
0
mirror of https://github.com/corundum/corundum.git synced 2025-01-16 08:12:53 +08:00
corundum/docs/source/rb/sched_rr.rst
2022-03-13 23:32:01 -07:00

137 lines
5.3 KiB
ReStructuredText

.. _rb_sched_rr:
====================================
Round-robin scheduler register block
====================================
The round-robin scheduler register block has a header with type 0x0000C040, version 0x00000100, and indicates the location of the scheduler in the register space, as well as containing some control, status, and informational registers.
.. table::
======== ============= ====== ====== ====== ====== =============
Address Field 31..24 23..16 15..8 7..0 Reset value
======== ============= ====== ====== ====== ====== =============
RBB+0x00 Type Vendor ID Type RO 0x0000C040
-------- ------------- -------------- -------------- -------------
RBB+0x04 Version Major Minor Patch Meta RO 0x00000100
-------- ------------- ------ ------ ------ ------ -------------
RBB+0x08 Next pointer Pointer to next register block RO -
-------- ------------- ------------------------------ -------------
RBB+0x0C Offset Offset to scheduler RO -
-------- ------------- ------------------------------ -------------
RBB+0x10 CH count Channel count RO -
-------- ------------- ------------------------------ -------------
RBB+0x14 CH stride Channel stride RO 0x00000004
-------- ------------- ------------------------------ -------------
RBB+0x18 Control Control RW 0x00000000
-------- ------------- ------------------------------ -------------
RBB+0x1C Dest Dest RW -
======== ============= ============================== =============
See :ref:`rb_overview` for definitions of the standard register block header fields.
.. object:: Offset
The offset field contains the offset to the start of the scheduler, relative to the start of the current region.
.. table::
======== ====== ====== ====== ====== =============
Address 31..24 23..16 15..8 7..0 Reset value
======== ====== ====== ====== ====== =============
RBB+0x0C Offset to scheduler RO -
======== ============================== =============
.. object:: Channel count
The channel count field contains the number of channels.
.. table::
======== ====== ====== ====== ====== =============
Address 31..24 23..16 15..8 7..0 Reset value
======== ====== ====== ====== ====== =============
RBB+0x10 Channel count RO -
======== ============================== =============
.. object:: Channel stride
The channel stride field contains the size of the region for each channel.
.. table::
======== ====== ====== ====== ====== =============
Address 31..24 23..16 15..8 7..0 Reset value
======== ====== ====== ====== ====== =============
RBB+0x14 Channel stride RO 0x00000004
======== ============================== =============
.. object:: Control
The control field contains scheduler-related control bits.
.. table::
======== ====== ====== ====== ====== =============
Address 31..24 23..16 15..8 7..0 Reset value
======== ====== ====== ====== ====== =============
RBB+0x18 Control RW 0x00000000
======== ============================== =============
.. table::
=== ========
Bit Function
=== ========
0 Enable
=== ========
.. object:: Dest
The dest field controls the destination port and traffic class of the scheduler. It is initialized with the scheduler's index with traffic class 0.
.. table::
======== ====== ====== ====== ====== =============
Address 31..24 23..16 15..8 7..0 Reset value
======== ====== ====== ====== ====== =============
RBB+0x1C Dest RW -
======== ============================== =============
Round-robin scheduler CSRs
==========================
Each scheduler channel has several associated control registers, detailed in this table:
.. table::
========= ============== ====== ====== ====== ====== =============
Address Field 31..24 23..16 15..8 7..0 Reset value
========= ============== ====== ====== ====== ====== =============
Base+0x00 Control Control RW 0x00000000
========= ============== ============================== =============
.. object:: Control
The control field contains scheduler-related control bits.
.. table::
========= ====== ====== ====== ====== =============
Address 31..24 23..16 15..8 7..0 Reset value
========= ====== ====== ====== ====== =============
Base+0x00 Control RW 0x00000000
========= ============================== =============
.. table::
=== =============
Bit Function
=== =============
0 Enable
1 Global enable
2 Control enable
16 Active
24 Scheduled
=== =============