URL https://opencores.org/ocsvn/neorv32/neorv32/trunk

Subversion Repositories neorv32

[/] [neorv32/] [trunk/] [docs/] [datasheet/] [soc_sysinfo.adoc] - Blame information for rev 70

Go to most recent revision | Details | Compare with Previous | View Log


<<<
:sectnums:
==== System Configuration Information Memory (SYSINFO)
 
[cols="<3,<3,<4"]
[frame="topbot",grid="none"]
|=======================
| Hardware source file(s): | neorv32_sysinfo.vhd |
| Software driver file(s): | neorv32.h |
| Top entity port:         | none |
| Configuration generics:  | * | most of the top's configuration generics
| CPU interrupts:          | none |
|=======================
 
**Theory of Operation**
 
The SYSINFO allows the application software to determine the setting of most of the processor's top entity
generics that are related to processor/SoC configuration. All registers of this unit are read-only.
 
This device is always implemented - regardless of the actual hardware configuration. The bootloader as well
as the NEORV32 software runtime environment require information from this device (like memory layout
and default clock speed) for correct operation.
 
[NOTE]
Any write access to the SYSINFO module will raise a store bus error exception. The <<_internal_bus_monitor_buskeeper>>
will signal a "DEVICE ERROR" in this case.
 
 
.SYSINFO register map (`struct NEORV32_SYSINFO`)
[cols="<2,<4,<7"]
[options="header",grid="all"]
|=======================
| Address | Name [C] | Function
| `0xffffffe0` | `NEORV32_SYSINFO.CLK`         | clock speed in Hz (via top's <<_clock_frequency>> generic)
| `0xffffffe4` | `NEORV32_SYSINFO.CPU`         | specific CPU configuration (see <<_sysinfo_cpu_configuration>>)
| `0xffffffe8` | `NEORV32_SYSINFO.SOC`         | specific SoC configuration (see <<_sysinfo_soc_configuration>>)
| `0xffffffec` | `NEORV32_SYSINFO.CACHE`       | cache configuration information (see <<_sysinfo_cache_configuration>>)
| `0xfffffff0` | `NEORV32_SYSINFO.ISPACE_BASE` | instruction address space base (via package's `ispace_base_c` constant)
| `0xfffffff4` | `NEORV32_SYSINFO.IMEM_SIZE`   | internal IMEM size in bytes (via top's <<_mem_int_imem_size>> generic)
| `0xfffffff8` | `NEORV32_SYSINFO.DSPACE_BASE` | data address space base (via package's `sdspace_base_c` constant)
| `0xfffffffc` | `NEORV32_SYSINFO.DMEM_SIZE`   | internal DMEM size in bytes (via top's <<_mem_int_dmem_size>> generic)
|=======================
 
 
===== SYSINFO - CPU Configuration
 
._SYSINFO_CPU_ bits
[cols="^1,<10,<11"]
[options="header",grid="all"]
|=======================
| Bit | Name [C] | Function
| `0`  | _SYSINFO_CPU_ZICSR_     | `Zicsr` extension (`I` sub-extension) available when set (via top's <<_cpu_extension_riscv_zicsr>> generic)
| `1`  | _SYSINFO_CPU_ZIFENCEI_  | `Zifencei` extension (`I` sub-extension) available when set (via top's <<_cpu_extension_riscv_zifencei>> generic)
| `2`  | _SYSINFO_CPU_ZMMUL_     | `Zmmul` extension (`M` sub-extension) available when set (via top's <<_cpu_extension_riscv_zmmul>> generic)
| `5`  | _SYSINFO_CPU_ZFINX_     | `Zfinx` extension (`F` sub-/alternative-extension) available when set (via top's <<_cpu_extension_riscv_zfinx>> generic)
| `6`  | _SYSINFO_CPU_ZXSCNT_    | Custom extension - _Small_ CPU counters: `[m]cycle` & `[m]instret` CSRs have less than 64-bit when set (via top's <<_cpu_cnt_width>> generic)
| `7`  | _SYSINFO_CPU_ZXNOCNT_   | Custom extension - _NO_ CPU counters: `[m]cycle` & `[m]instret` CSRs are NOT available at all when set (via top's <<_cpu_cnt_width>> generic)
| `8`  | _SYSINFO_CPU_PMP_       | `PMP` (physical memory protection) extension available when set (via top's <<_pmp_num_regions>> generic)
| `9`  | _SYSINFO_CPU_HPM_       | `HPM` (hardware performance monitors) extension available when set (via top's <<_cpu_extension_riscv_zihpm>> generic)
| `10` | _SYSINFO_CPU_DEBUGMODE_ | RISC-V CPU `debug_mode` available when set (via top's <<_on_chip_debugger_en>> generic)
| `30  | _SYSINFO_CPU_FASTMUL_   | fast multiplication available when set (via top's <<_fast_mul_en>> generic)
| `31` | _SYSINFO_CPU_FASTSHIFT_ | fast shifts available when set (via top's <<_fast_shift_en>> generic)
|=======================
 
 
===== SYSINFO - SoC Configuration
 
._SYSINFO_SOC_ bits
[cols="^1,<10,<11"]
[options="header",grid="all"]
|=======================
| Bit | Name [C] | Function
| `0`  | _SYSINFO_SOC_BOOTLOADER_       | set if the processor-internal bootloader is implemented (via top's <<_int_bootloader_en>> generic)
| `1`  | _SYSINFO_SOC_MEM_EXT_          | set if the external Wishbone bus interface is implemented (via top's <<_mem_ext_en>> generic)
| `2`  | _SYSINFO_SOC_MEM_INT_IMEM_     | set if the processor-internal DMEM implemented (via top's <<_mem_int_dmem_en>> generic)
| `3`  | _SYSINFO_SOC_MEM_INT_DMEM_     | set if the processor-internal IMEM is implemented (via top's <<_mem_int_imem_en>> generic)
| `4`  | _SYSINFO_SOC_MEM_EXT_ENDIAN_   | set if external bus interface uses BIG-endian byte-order (via top's <<_mem_ext_big_endian>> generic)
| `5`  | _SYSINFO_SOC_ICACHE_           | set if processor-internal instruction cache is implemented (via top's <<_icache_en>> generic)
| `13` | _SYSINFO_SOC_IS_SIM_           | set if processor is being **simulated** (⚠️ not guaranteed)
| `14` | _SYSINFO_SOC_OCD_              | set if on-chip debugger implemented (via top's <<_on_chip_debugger_en>> generic)
| `15` | _SYSINFO_SOC_HW_RESET_         | set if a dedicated hardware reset of all core registers is implemented (via package's `dedicated_reset_c` constant)
| `16` | _SYSINFO_SOC_IO_GPIO_          | set if the GPIO is implemented (via top's <<_io_gpio_en>> generic)
| `17` | _SYSINFO_SOC_IO_MTIME_         | set if the MTIME is implemented (via top's <<_io_mtime_en>> generic)
| `18` | _SYSINFO_SOC_IO_UART0_         | set if the primary UART0 is implemented (via top's <<_io_uart0_en>> generic)
| `19` | _SYSINFO_SOC_IO_SPI_           | set if the SPI is implemented (via top's <<_io_spi_en>> generic)
| `20` | _SYSINFO_SOC_IO_TWI_           | set if the TWI is implemented (via top's <<_io_twi_en>> generic)
| `21` | _SYSINFO_SOC_IO_PWM_           | set if the PWM is implemented (via top's <<_io_pwm_num_ch>> generic)
| `22` | _SYSINFO_SOC_IO_WDT_           | set if the WDT is implemented (via top's <<_io_wdt_en>> generic)
| `23` | _SYSINFO_SOC_IO_CFS_           | set if the custom functions subsystem is implemented (via top's <<_io_cfs_en>> generic)
| `24` | _SYSINFO_SOC_IO_TRNG_          | set if the TRNG is implemented (via top's _IO_TRNG_EN_ generic)
| `25` | _SYSINFO_SOC_IO_SLINK_         | set if the SLINK is implemented (via top's <<_slink_num_tx>> and/or <<_slink_num_rx>> generics)
| `26` | _SYSINFO_SOC_IO_UART1_         | set if the secondary UART1 is implemented (via top's <<_io_uart1_en>> generic)
| `27` | _SYSINFO_SOC_IO_NEOLED_        | set if the NEOLED is implemented (via top's <<_io_neoled_en>> generic)
| `28` | _SYSINFO_SOC_IO_XIRQ_          | set if the XIRQ is implemented (via top's <<_xirq_num_ch>> generic)
| `29` | _SYSINFO_SOC_IO_GPTMR_         | set if the GPTMR is implemented (via top's <<_io_gptmr_en>> generic)
| `30` | _SYSINFO_SOC_IO_XIP_           | set if the XIP module is implemented (via top's <<_io_xip_en>> generic)
|=======================
 
 
===== SYSINFO - Cache Configuration
 
[NOTE]
Bit fields in this register are set to all-zero if the according cache is not implemented.
 
._SYSINFO_CACHE_ bits
[cols="^1,<10,<11"]
[options="header",grid="all"]
|=======================
| Bit      | Name [C] | Function
| `3:0`    | _SYSINFO_CACHE_IC_BLOCK_SIZE_3_ : _SYSINFO_CACHE_IC_BLOCK_SIZE_0_       | _log2_(i-cache block size in bytes), via top's <<_icache_block_size>> generic
| `7:4`    | _SYSINFO_CACHE_IC_NUM_BLOCKS_3_ : _SYSINFO_CACHE_IC_NUM_BLOCKS_0_       | _log2_(i-cache number of cache blocks), via top's <<_icache_num_blocks>> generic
| `11:9`   | _SYSINFO_CACHE_IC_ASSOCIATIVITY_3_ : _SYSINFO_CACHE_IC_ASSOCIATIVITY_0_ | _log2_(i-cache associativity), via top's <<_icache_associativity>> generic
| `15:12`  | _SYSINFO_CACHE_IC_REPLACEMENT_3_ : _SYSINFO_CACHE_IC_REPLACEMENT_0_     | i-cache replacement policy (`0001` = LRU if associativity > 0)
| `32:16`  | -                                                                       | zero, reserved for d-cache
|=======================

Line No.	Rev	Author	Line
1	60	zero_gravi	`<<<`
2			`:sectnums:`
3			`==== System Configuration Information Memory (SYSINFO)`
4
5			`[cols="<3,<3,<4"]`
6			`[frame="topbot",grid="none"]`
7			`\|=======================`
8			`\| Hardware source file(s): \| neorv32_sysinfo.vhd \|`
9	61	zero_gravi	`\| Software driver file(s): \| neorv32.h \|`
10	60	zero_gravi	`\| Top entity port: \| none \|`
11			`\| Configuration generics: \| * \| most of the top's configuration generics`
12			`\| CPU interrupts: \| none \|`
13			`\|=======================`
14
15			`Theory of Operation`
16
17			`The SYSINFO allows the application software to determine the setting of most of the processor's top entity`
18			`generics that are related to processor/SoC configuration. All registers of this unit are read-only.`
19
20	65	zero_gravi	`This device is always implemented - regardless of the actual hardware configuration. The bootloader as well`
21	60	zero_gravi	`as the NEORV32 software runtime environment require information from this device (like memory layout`
22			`and default clock speed) for correct operation.`
23
24	70	zero_gravi	`[NOTE]`
25			`Any write access to the SYSINFO module will raise a store bus error exception. The <<_internal_bus_monitor_buskeeper>>`
26			`will signal a "DEVICE ERROR" in this case.`
27
28
29	64	zero_gravi	.SYSINFO register map (`struct NEORV32_SYSINFO`)
30	60	zero_gravi	`[cols="<2,<4,<7"]`
31			`[options="header",grid="all"]`
32			`\|=======================`
33			`\| Address \| Name [C] \| Function`
34	64	zero_gravi	\| `0xffffffe0` \| `NEORV32_SYSINFO.CLK` \| clock speed in Hz (via top's <<_clock_frequency>> generic)
35			\| `0xffffffe4` \| `NEORV32_SYSINFO.CPU` \| specific CPU configuration (see <<_sysinfo_cpu_configuration>>)
36			\| `0xffffffe8` \| `NEORV32_SYSINFO.SOC` \| specific SoC configuration (see <<_sysinfo_soc_configuration>>)
37			\| `0xffffffec` \| `NEORV32_SYSINFO.CACHE` \| cache configuration information (see <<_sysinfo_cache_configuration>>)
38			\| `0xfffffff0` \| `NEORV32_SYSINFO.ISPACE_BASE` \| instruction address space base (via package's `ispace_base_c` constant)
39			\| `0xfffffff4` \| `NEORV32_SYSINFO.IMEM_SIZE` \| internal IMEM size in bytes (via top's <<_mem_int_imem_size>> generic)
40			\| `0xfffffff8` \| `NEORV32_SYSINFO.DSPACE_BASE` \| data address space base (via package's `sdspace_base_c` constant)
41			\| `0xfffffffc` \| `NEORV32_SYSINFO.DMEM_SIZE` \| internal DMEM size in bytes (via top's <<_mem_int_dmem_size>> generic)
42	60	zero_gravi	`\|=======================`
43
44
45	63	zero_gravi	`===== SYSINFO - CPU Configuration`
46
47			`._SYSINFO_CPU_ bits`
48			`[cols="^1,<10,<11"]`
49			`[options="header",grid="all"]`
50			`\|=======================`
51			`\| Bit \| Name [C] \| Function`
52			\| `0` \| _SYSINFO_CPU_ZICSR_ \| `Zicsr` extension (`I` sub-extension) available when set (via top's <<_cpu_extension_riscv_zicsr>> generic)
53			\| `1` \| _SYSINFO_CPU_ZIFENCEI_ \| `Zifencei` extension (`I` sub-extension) available when set (via top's <<_cpu_extension_riscv_zifencei>> generic)
54			\| `2` \| _SYSINFO_CPU_ZMMUL_ \| `Zmmul` extension (`M` sub-extension) available when set (via top's <<_cpu_extension_riscv_zmmul>> generic)
55			\| `5` \| _SYSINFO_CPU_ZFINX_ \| `Zfinx` extension (`F` sub-/alternative-extension) available when set (via top's <<_cpu_extension_riscv_zfinx>> generic)
56			\| `6` \| _SYSINFO_CPU_ZXSCNT_ \| Custom extension - _Small_ CPU counters: `[m]cycle` & `[m]instret` CSRs have less than 64-bit when set (via top's <<_cpu_cnt_width>> generic)
57			\| `7` \| _SYSINFO_CPU_ZXNOCNT_ \| Custom extension - _NO_ CPU counters: `[m]cycle` & `[m]instret` CSRs are NOT available at all when set (via top's <<_cpu_cnt_width>> generic)
58	70	zero_gravi	\| `8` \| _SYSINFO_CPU_PMP_ \| `PMP` (physical memory protection) extension available when set (via top's <<_pmp_num_regions>> generic)
59			\| `9` \| _SYSINFO_CPU_HPM_ \| `HPM` (hardware performance monitors) extension available when set (via top's <<_cpu_extension_riscv_zihpm>> generic)
60			\| `10` \| _SYSINFO_CPU_DEBUGMODE_ \| RISC-V CPU `debug_mode` available when set (via top's <<_on_chip_debugger_en>> generic)
61	63	zero_gravi	\| `30 \| _SYSINFO_CPU_FASTMUL_ \| fast multiplication available when set (via top's <<_fast_mul_en>> generic)
62			\| `31` \| _SYSINFO_CPU_FASTSHIFT_ \| fast shifts available when set (via top's <<_fast_shift_en>> generic)
63			`\|=======================`
64
65
66			`===== SYSINFO - SoC Configuration`
67
68	64	zero_gravi	`._SYSINFO_SOC_ bits`
69	60	zero_gravi	`[cols="^1,<10,<11"]`
70			`[options="header",grid="all"]`
71			`\|=======================`
72			`\| Bit \| Name [C] \| Function`
73	64	zero_gravi	\| `0` \| _SYSINFO_SOC_BOOTLOADER_ \| set if the processor-internal bootloader is implemented (via top's <<_int_bootloader_en>> generic)
74			\| `1` \| _SYSINFO_SOC_MEM_EXT_ \| set if the external Wishbone bus interface is implemented (via top's <<_mem_ext_en>> generic)
75			\| `2` \| _SYSINFO_SOC_MEM_INT_IMEM_ \| set if the processor-internal DMEM implemented (via top's <<_mem_int_dmem_en>> generic)
76			\| `3` \| _SYSINFO_SOC_MEM_INT_DMEM_ \| set if the processor-internal IMEM is implemented (via top's <<_mem_int_imem_en>> generic)
77			\| `4` \| _SYSINFO_SOC_MEM_EXT_ENDIAN_ \| set if external bus interface uses BIG-endian byte-order (via top's <<_mem_ext_big_endian>> generic)
78			\| `5` \| _SYSINFO_SOC_ICACHE_ \| set if processor-internal instruction cache is implemented (via top's <<_icache_en>> generic)
79	69	zero_gravi	\| `13` \| _SYSINFO_SOC_IS_SIM_ \| set if processor is being simulated (⚠️ not guaranteed)
80	64	zero_gravi	\| `14` \| _SYSINFO_SOC_OCD_ \| set if on-chip debugger implemented (via top's <<_on_chip_debugger_en>> generic)
81			\| `15` \| _SYSINFO_SOC_HW_RESET_ \| set if a dedicated hardware reset of all core registers is implemented (via package's `dedicated_reset_c` constant)
82			\| `16` \| _SYSINFO_SOC_IO_GPIO_ \| set if the GPIO is implemented (via top's <<_io_gpio_en>> generic)
83			\| `17` \| _SYSINFO_SOC_IO_MTIME_ \| set if the MTIME is implemented (via top's <<_io_mtime_en>> generic)
84			\| `18` \| _SYSINFO_SOC_IO_UART0_ \| set if the primary UART0 is implemented (via top's <<_io_uart0_en>> generic)
85			\| `19` \| _SYSINFO_SOC_IO_SPI_ \| set if the SPI is implemented (via top's <<_io_spi_en>> generic)
86			\| `20` \| _SYSINFO_SOC_IO_TWI_ \| set if the TWI is implemented (via top's <<_io_twi_en>> generic)
87	70	zero_gravi	\| `21` \| _SYSINFO_SOC_IO_PWM_ \| set if the PWM is implemented (via top's <<_io_pwm_num_ch>> generic)
88	64	zero_gravi	\| `22` \| _SYSINFO_SOC_IO_WDT_ \| set if the WDT is implemented (via top's <<_io_wdt_en>> generic)
89			\| `23` \| _SYSINFO_SOC_IO_CFS_ \| set if the custom functions subsystem is implemented (via top's <<_io_cfs_en>> generic)
90			\| `24` \| _SYSINFO_SOC_IO_TRNG_ \| set if the TRNG is implemented (via top's _IO_TRNG_EN_ generic)
91			\| `25` \| _SYSINFO_SOC_IO_SLINK_ \| set if the SLINK is implemented (via top's <<_slink_num_tx>> and/or <<_slink_num_rx>> generics)
92			\| `26` \| _SYSINFO_SOC_IO_UART1_ \| set if the secondary UART1 is implemented (via top's <<_io_uart1_en>> generic)
93			\| `27` \| _SYSINFO_SOC_IO_NEOLED_ \| set if the NEOLED is implemented (via top's <<_io_neoled_en>> generic)
94	70	zero_gravi	\| `28` \| _SYSINFO_SOC_IO_XIRQ_ \| set if the XIRQ is implemented (via top's <<_xirq_num_ch>> generic)
95			\| `29` \| _SYSINFO_SOC_IO_GPTMR_ \| set if the GPTMR is implemented (via top's <<_io_gptmr_en>> generic)
96			\| `30` \| _SYSINFO_SOC_IO_XIP_ \| set if the XIP module is implemented (via top's <<_io_xip_en>> generic)
97	60	zero_gravi	`\|=======================`
98	63	zero_gravi
99
100			`===== SYSINFO - Cache Configuration`
101
102			`[NOTE]`
103			`Bit fields in this register are set to all-zero if the according cache is not implemented.`
104
105			`._SYSINFO_CACHE_ bits`
106			`[cols="^1,<10,<11"]`
107			`[options="header",grid="all"]`
108			`\|=======================`
109			`\| Bit \| Name [C] \| Function`
110			\| `3:0` \| _SYSINFO_CACHE_IC_BLOCK_SIZE_3_ : _SYSINFO_CACHE_IC_BLOCK_SIZE_0_ \| _log2_(i-cache block size in bytes), via top's <<_icache_block_size>> generic
111			\| `7:4` \| _SYSINFO_CACHE_IC_NUM_BLOCKS_3_ : _SYSINFO_CACHE_IC_NUM_BLOCKS_0_ \| _log2_(i-cache number of cache blocks), via top's <<_icache_num_blocks>> generic
112			\| `11:9` \| _SYSINFO_CACHE_IC_ASSOCIATIVITY_3_ : _SYSINFO_CACHE_IC_ASSOCIATIVITY_0_ \| _log2_(i-cache associativity), via top's <<_icache_associativity>> generic
113			\| `15:12` \| _SYSINFO_CACHE_IC_REPLACEMENT_3_ : _SYSINFO_CACHE_IC_REPLACEMENT_0_ \| i-cache replacement policy (`0001` = LRU if associativity > 0)
114			\| `32:16` \| - \| zero, reserved for d-cache
115			`\|=======================`

Browse

Tools

Subversion Repositories neorv32

[/] [neorv32/] [trunk/] [docs/] [datasheet/] [soc_sysinfo.adoc] - Blame information for rev 70