From e4764bc600c7694f561863974b361b68fe4ec41a Mon Sep 17 00:00:00 2001 From: Alex Forencich Date: Wed, 1 Feb 2023 18:49:32 -0800 Subject: [PATCH] Add documentation on app info register block Signed-off-by: Alex Forencich --- docs/source/rb/app_info.rst | 35 +++++++++++++++++++++++++++++++++++ docs/source/rb/index.rst | 2 +- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 docs/source/rb/app_info.rst diff --git a/docs/source/rb/app_info.rst b/docs/source/rb/app_info.rst new file mode 100644 index 000000000..11b87d3de --- /dev/null +++ b/docs/source/rb/app_info.rst @@ -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 - + ======== ============================== ============= diff --git a/docs/source/rb/index.rst b/docs/source/rb/index.rst index 2b19965a4..289665657 100644 --- a/docs/source/rb/index.rst +++ b/docs/source/rb/index.rst @@ -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