mirror of
https://github.com/stnolting/neorv32.git
synced 2025-04-24 22:27:21 -04:00
[docs] cleanup rtl file overview
This commit is contained in:
parent
03474a7163
commit
259b68ed6b
1 changed files with 80 additions and 79 deletions
|
@ -130,36 +130,36 @@ The root directory of the repository is considered the NEORV32 base or home fold
|
|||
|
||||
.Folder Structure
|
||||
...................................
|
||||
neorv32 - Project home folder
|
||||
neorv32 - Project home folder
|
||||
│
|
||||
├docs - Project documentation
|
||||
│├datasheet - AsciiDoc sources for the NEORV32 data sheet
|
||||
│├figures - Figures and logos
|
||||
│├references - Data sheets and RISC-V specs
|
||||
│├sources - Sources for the images in 'figures/'
|
||||
│└userguide - AsciiDoc sources for the NEORV32 user guide
|
||||
├-docs - Project documentation
|
||||
│ ├-datasheet - AsciiDoc sources for the NEORV32 data sheet
|
||||
│ ├-figures - Figures and logos
|
||||
│ ├-references - Data sheets and RISC-V specs
|
||||
│ ├-sources - Sources for the images in 'figures/'
|
||||
│ └-userguide - AsciiDoc sources for the NEORV32 user guide
|
||||
│
|
||||
├rtl - VHDL sources
|
||||
│├core - Core sources of the CPU & SoC
|
||||
│├processor_templates - Pre-configured SoC wrappers
|
||||
│├system_integration - System wrappers and bridges for advanced connectivity
|
||||
│└test_setups - Minimal test setup "SoCs" used in the User Guide
|
||||
├-rtl - VHDL sources
|
||||
│ ├-core - Core sources of the CPU & SoC
|
||||
│ ├-processor_templates - Pre-configured SoC wrappers
|
||||
│ ├-system_integration - System wrappers and bridges for advanced connectivity
|
||||
│ └-test_setups - Minimal test setup "SoCs" used in the User Guide
|
||||
│
|
||||
├sim - Simulation files
|
||||
├-sim - Simulation files
|
||||
│
|
||||
└-sw - Software framework
|
||||
├bootloader - Sources of the processor-internal bootloader
|
||||
├common - Linker script, crt0.S start-up code and central makefile
|
||||
├example - Example programs for the core and the SoC modules
|
||||
│├eclipse - Pre-configured Eclipse IDE project
|
||||
│└... - Several example programs
|
||||
├lib - Processor core library
|
||||
│├include - NEORV32 core library header files (*.h)
|
||||
│└source - NEORV32 core library source files (*.c)
|
||||
├image_gen - Helper program to generate executables & memory images
|
||||
├ocd_firmware - Firmware for the on-chip debugger's "park loop"
|
||||
├openocd - OpenOCD configuration files
|
||||
└svd - Processor system view description file (CMSIS-SVD)
|
||||
└-sw - Software framework
|
||||
├-bootloader - Sources of the processor-internal bootloader
|
||||
├-common - Linker script, crt0.S start-up code and central makefile
|
||||
├-example - Example programs for the core and the SoC modules
|
||||
│ ├-eclipse - Pre-configured Eclipse IDE project
|
||||
│ └-... - Several example programs
|
||||
├-lib - Processor core library
|
||||
│ ├-include - NEORV32 core library header files (*.h)
|
||||
│ └-source - NEORV32 core library source files (*.c)
|
||||
├-image_gen - Helper program to generate executables & memory images
|
||||
├-ocd_firmware - Firmware for the on-chip debugger's "park loop"
|
||||
├-openocd - OpenOCD configuration files
|
||||
└-svd - Processor system view description file (CMSIS-SVD)
|
||||
...................................
|
||||
|
||||
|
||||
|
@ -179,60 +179,61 @@ All core VHDL files from the list below have to be assigned to a **new library**
|
|||
[NOTE]
|
||||
See section <<_file_list_files>> for more information.
|
||||
|
||||
.RTL File List and Hierarchy (in alphabetical order)
|
||||
.RTL File List (in alphabetical order)
|
||||
...................................
|
||||
neorv32_top.vhd - NEORV32 PROCESSOR/SOC TOP ENTITY
|
||||
│
|
||||
├neorv32_cpu.vhd - NEORV32 CPU TOP ENTITY
|
||||
│├neorv32_cpu_alu.vhd - Arithmetic/logic unit
|
||||
││├neorv32_cpu_cp_bitmanip.vhd - Bit-manipulation co-processor (B ext.)
|
||||
││├neorv32_cpu_cp_cfu.vhd - Custom instructions co-processor (Zxcfu ext.)
|
||||
││├neorv32_cpu_cp_cond.vhd - Integer conditional co-processor (Zicond ext.)
|
||||
││├neorv32_cpu_cp_crypto.vhd - Scalar cryptographic co-processor (Zk*/Zbk* ext.)
|
||||
││├neorv32_cpu_cp_fpu.vhd - Floating-point co-processor (Zfinx ext.)
|
||||
││├neorv32_cpu_cp_muldiv.vhd - Mul/Div co-processor (M ext.)
|
||||
││└neorv32_cpu_cp_shifter.vhd - Bit-shift co-processor (base ISA)
|
||||
│├neorv32_cpu_control.vhd - CPU control, exception system and CSRs
|
||||
││└neorv32_cpu_decompressor.vhd - Compressed instructions decoder (C ext.)
|
||||
│├neorv32_cpu_icc.vhd - Inter-core communication unit
|
||||
│├neorv32_cpu_lsu.vhd - Load/store unit
|
||||
│├neorv32_cpu_pmp.vhd - Physical memory protection unit (Smpmp ext.)
|
||||
│└neorv32_cpu_regfile.vhd - Data register file
|
||||
│
|
||||
├neorv32_boot_rom.vhd - Bootloader ROM
|
||||
│└neorv32_bootloader_image.vhd - Bootloader ROM memory image (package)
|
||||
├neorv32_bus.vhd - SoC bus infrastructure modules
|
||||
├neorv32_cache.vhd - Generic cache module
|
||||
├neorv32_cfs.vhd - Custom functions subsystem
|
||||
├neorv32_clint.vhd - Core local interruptor
|
||||
├neorv32_clockgate.vhd - Generic clock gating switch
|
||||
├neorv32_crc.vhd - Cyclic redundancy check unit
|
||||
├neorv32_debug_dm.vhd - on-chip debugger: debug module
|
||||
├neorv32_debug_auth.vhd - on-chip debugger: authentication module
|
||||
├neorv32_debug_dtm.vhd - on-chip debugger: debug transfer module
|
||||
├neorv32_dma.vhd - Direct memory access controller
|
||||
├neorv32_dmem.vhd - Generic processor-internal data memory
|
||||
├neorv32_fifo.vhd - Generic FIFO component
|
||||
├neorv32_gpio.vhd - General purpose input/output port unit
|
||||
├neorv32_gptmr.vhd - General purpose 32-bit timer
|
||||
├neorv32_imem.vhd - Generic processor-internal instruction memory
|
||||
│└neorv32_application_image.vhd - IMEM application initialization image (package)
|
||||
├neorv32_neoled.vhd - NeoPixel (TM) compatible smart LED interface
|
||||
├neorv32_onewire.vhd - One-Wire serial interface controller
|
||||
├neorv32_package.vhd - Main VHDL package file
|
||||
├neorv32_pwm.vhd - Pulse-width modulation controller
|
||||
├neorv32_sdi.vhd - Serial data interface controller (SPI device)
|
||||
├neorv32_slink.vhd - Stream link interface
|
||||
├neorv32_spi.vhd - Serial peripheral interface controller (SPI host)
|
||||
├neorv32_sys.vhd - System infrastructure modules
|
||||
├neorv32_sysinfo.vhd - System configuration information memory
|
||||
├neorv32_trng.vhd - True random number generator
|
||||
├neorv32_twi.vhd - Two wire serial interface controller
|
||||
├neorv32_uart.vhd - Universal async. receiver/transmitter
|
||||
├neorv32_wdt.vhd - Watchdog timer
|
||||
├neorv32_xbus.vhd - External (Wishbone) bus interface gateways
|
||||
├neorv32_xip.vhd - Execute in place module
|
||||
└neorv32_xirq.vhd - External interrupt controller
|
||||
rtl/core
|
||||
├-neorv32_application_image.vhd - IMEM application initialization image (package)
|
||||
├-neorv32_boot_rom.vhd - Bootloader ROM
|
||||
├-neorv32_bootloader_image.vhd - Bootloader ROM memory image (package)
|
||||
├-neorv32_bus.vhd - SoC bus infrastructure modules
|
||||
├-neorv32_cache.vhd - Generic cache module
|
||||
├-neorv32_clint.vhd - Core local interruptor
|
||||
├-neorv32_clockgate.vhd - Generic clock gating switch
|
||||
├-neorv32_cfs.vhd - Custom functions subsystem
|
||||
├-neorv32_core_complex.vhd - NEORV32 CORE COMPLEX TOP ENTITY
|
||||
├-neorv32_cpu.vhd - NEORV32 CPU TOP ENTITY
|
||||
├-neorv32_cpu_alu.vhd - Arithmetic/logic unit
|
||||
├-neorv32_cpu_control.vhd - CPU control, exception system and CSRs
|
||||
├-neorv32_cpu_cp_bitmanip.vhd - Bit-manipulation co-processor (B ext.)
|
||||
├-neorv32_cpu_cp_cfu.vhd - Custom instructions co-processor (Zxcfu ext.)
|
||||
├-neorv32_cpu_cp_cond.vhd - Integer conditional co-processor (Zicond ext.)
|
||||
├-neorv32_cpu_cp_crypto.vhd - Scalar cryptography co-processor (Zk*/Zbk* ext.)
|
||||
├-neorv32_cpu_cp_fpu.vhd - Floating-point co-processor (Zfinx ext.)
|
||||
├-neorv32_cpu_cp_muldiv.vhd - Mul/Div co-processor (M ext.)
|
||||
├-neorv32_cpu_cp_shifter.vhd - Bit-shift co-processor (base ISA)
|
||||
├-neorv32_cpu_decompressor.vhd - Compressed instructions decoder (C ext.)
|
||||
├-neorv32_cpu_icc.vhd - Inter-core communication unit
|
||||
├-neorv32_cpu_lsu.vhd - Load/store unit
|
||||
├-neorv32_cpu_pmp.vhd - Physical memory protection unit (Smpmp ext.)
|
||||
├-neorv32_cpu_regfile.vhd - Data register file
|
||||
├-neorv32_crc.vhd - Cyclic redundancy check unit
|
||||
├-neorv32_debug_auth.vhd - On-chip debugger: authentication module
|
||||
├-neorv32_debug_dm.vhd - On-chip debugger: debug module
|
||||
├-neorv32_debug_dtm.vhd - On-chip debugger: debug transfer module
|
||||
├-neorv32_dma.vhd - Direct memory access controller
|
||||
├-neorv32_dmem.vhd - Generic processor-internal data memory
|
||||
├-neorv32_fifo.vhd - Generic FIFO component
|
||||
├-neorv32_gpio.vhd - General purpose input/output port unit
|
||||
├-neorv32_gptmr.vhd - General purpose 32-bit timer
|
||||
├-neorv32_imem.vhd - Generic processor-internal instruction memory
|
||||
├-neorv32_neoled.vhd - NeoPixel (TM) compatible smart LED interface
|
||||
├-neorv32_onewire.vhd - One-Wire serial interface controller
|
||||
├-neorv32_package.vhd - Main VHDL package file
|
||||
├-neorv32_pwm.vhd - Pulse-width modulation controller
|
||||
├-neorv32_sdi.vhd - Serial data interface controller (SPI device)
|
||||
├-neorv32_slink.vhd - Stream link interface
|
||||
├-neorv32_spi.vhd - Serial peripheral interface controller (SPI host)
|
||||
├-neorv32_sys.vhd - System infrastructure modules
|
||||
├-neorv32_sysinfo.vhd - System configuration information memory
|
||||
├-neorv32_top.vhd - NEORV32 PROCESSOR/SOC TOP ENTITY
|
||||
├-neorv32_trng.vhd - True random number generator
|
||||
├-neorv32_twd.vhd - Two wire serial device controller
|
||||
├-neorv32_twi.vhd - Two wire serial interface controller
|
||||
├-neorv32_uart.vhd - Universal async. receiver/transmitter
|
||||
├-neorv32_wdt.vhd - Watchdog timer
|
||||
├-neorv32_xbus.vhd - External (Wishbone) bus interface gateways
|
||||
├-neorv32_xip.vhd - Execute in place module
|
||||
└-neorv32_xirq.vhd - External interrupt controller
|
||||
...................................
|
||||
|
||||
.Replacing Modules for Customization or Optimization
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue