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

Add documentation on app info register block

Browse Source 
Signed-off-by: Alex Forencich <alex@alexforencich.com>
This commit is contained in:
Alex Forencich 2023-02-01 18:49:32 -08:00
parent 96bb163038
commit e4764bc600
2 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/source/rb/app_info.rst Normal file
View File

@ -0,0 +1,35 @@
.. _rb_app_info:
=======================
App info register block
=======================
The app info register block has a header with type 0x0000C005, version 0x00000200, and contains the app ID of the application section.
.. table::
======== ============= ====== ====== ====== ====== =============
Address Field 31..24 23..16 15..8 7..0 Reset value
======== ============= ====== ====== ====== ====== =============
RBB+0x00 Type Vendor ID Type RO 0x0000C005
-------- ------------- -------------- -------------- -------------
RBB+0x04 Version Major Minor Patch Meta RO 0x00000200
-------- ------------- ------ ------ ------ ------ -------------
RBB+0x08 Next pointer Pointer to next register block RO -
-------- ------------- ------------------------------ -------------
RBB+0x0C App ID App ID RO -
======== ============= ============================== =============
See :ref:`rb_overview` for definitions of the standard register block header fields.
.. object:: App ID
The app ID field contains the app ID of the application section.
.. table::
======== ====== ====== ====== ====== =============
Address 31..24 23..16 15..8 7..0 Reset value
======== ====== ====== ====== ====== =============
RBB+0x0C App ID RO -
======== ============================== =============

2
docs/source/rb/index.rst
View File

@ -67,7 +67,7 @@ The NIC register space is constructed from a linked list of register blocks. Ea
0x0000C002 0x00000200 :ref:`rb_port`
0x0000C003 0x00000200 :ref:`rb_port_ctrl`
0x0000C004 0x00000300 :ref:`rb_sched_block`
0x0000C005 0x00000200 application
0x0000C005 0x00000200 :ref:`rb_app_info`
0x0000C006 0x00000100 stats
0x0000C007 0x00000100 IRQ config
0x0000C008 0x00000100 Clock info