mkdocs.yml

site_name: Level RISC-V Documentation
site_description: RV32IMC RISC-V Processor Core Documentation
site_author: Kerim Turak
site_url: https://kerimturak.github.io/level-v/

repo_name: kerimturak/level-v
repo_url: https://github.com/kerimturak/level-v

copyright: Copyright © 2024-2025 Kerim Turak

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono

hooks:
  - mkdocs_hooks.py

plugins:
  - search:
      lang: en

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - tables
  - attr_list
  - md_in_html
  # :material-*: / :octicons-*: in card grids (docs/index.md)
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      toc_depth: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/kerimturak
  generator: false

nav:
  - Home: index.md
  - Getting started:
    - Quick start: getting-started.md
    - Tools: tools.md
    - Architecture: architecture.md
  - RTL core:
    - Overview: core/index.md
    - CPU: core/cpu_module.md
    - Hazard Unit: core/hazard_unit_module.md
    - Fetch Stage:
      - Fetch: core/stage01_fetch/fetch_module.md
      - Align Buffer: core/stage01_fetch/align_buffer_module.md
      - Compressed Decoder: core/stage01_fetch/compressed_decoder_module.md
      - Branch Predictor: core/stage01_fetch/gshare_bp_module.md
      - RAS: core/stage01_fetch/ras_module.md
      - Next-line prefetcher: core/stage01_fetch/next_line_prefetcher_module.md
      - Prefetcher wrapper: core/stage01_fetch/prefetcher_wrapper_module.md
    - Decode Stage:
      - Decode: core/stage02_decode/decode_module.md
      - Control Unit: core/stage02_decode/control_unit_module.md
      - Extend: core/stage02_decode/extend_module.md
      - Register File: core/stage02_decode/reg_file_module.md
    - Execute Stage:
      - Execution: core/stage03_execute/execution_module.md
      - ALU: core/stage03_execute/alu_module.md
      - CSR: core/stage03_execute/cs_reg_file_module.md
      - Multiplier: core/stage03_execute/mul_int_module.md
      - Pipelined multiplier: core/stage03_execute/mul_pipelined_module.md
      - Divider: core/stage03_execute/divu_int_module.md
      - Pipelined divider: core/stage03_execute/divu_pipelined_module.md
      - Wallace multiplier: core/stage03_execute/wallace_multiplier_module.md
    - Memory Stage:
      - Memory: core/stage04_memory/memory_module.md
      - Store buffer: core/stage04_memory/store_buffer_module.md
      - Cache logger: core/stage04_memory/cache_logger_module.md
    - Writeback Stage:
      - Writeback: core/stage05_writeback/writeback_module.md
    - Memory Management:
      - Cache: core/mmu/cache_module.md
      - I-cache: core/mmu/icache_module.md
      - D-cache: core/mmu/dcache_module.md
      - FENCE.I helper: core/mmu/dcache_fencei_module.md
      - L2 cache: core/mmu/l2_cache_module.md
      - Memory Arbiter: core/mmu/memory_arbiter_module.md
      - WB Interconnect: core/mmu/wb_interconnect_module.md
      - WB Master Bridge: core/mmu/wb_master_bridge_module.md
    - Memory Protection:
      - PMA: core/pmp_pma/pma_module.md
  - Peripherals:
    - Overview: periph/index.md
    - UART: periph/uart.md
    - SPI: periph/spi.md
    - I2C: periph/i2c.md
    - GPIO: periph/gpio.md
    - GPIO (AXI / Xilinx): periph/gpio_axi_integration.md
    - Timer: periph/timer.md
    - PLIC: periph/plic.md
    - PWM: periph/pwm.md
    - DMA: periph/dma.md
    - WDT: periph/wdt.md
    - VGA: periph/vga.md
  - Support:
    - Include:
      - Overview: include/overview.md
      - Defines: include/level_defines.md
      - Exception Priority: include/exception_priority.md
      - Fetch Log: include/fetch_log.md
      - Writeback Log: include/writeback_log.md
    - Package: pkg/overview.md
    - RAM:
      - Single-port BRAM: ram/overview.md
      - Dual-port BRAM: ram/dp_bram_module.md
    - Tracer: tracer/overview.md
    - Utilities: util/overview.md
    - Wrapper:
      - Overview: wrapper/overview.md
      - Level SoC: wrapper/level_soc.md
      - Level Wrapper: wrapper/level_wrapper.md
      - RAM Programmer: wrapper/ram_programmer.md
      - WB CLINT Slave: wrapper/wb_clint_slave.md
      - WB PBUS Slave: wrapper/wb_pbus_slave.md
      - WB RAM Slave: wrapper/wb_ram_slave.md
      - Wrapper RAM: wrapper/wrapper_ram.md
      - Systessis (FPGA top): wrapper/systessis_wrapper_module.md
  - Build System:
    - Script Overview: script/overview.md
    - Makefiles: script/makefiles.md
    - Python Tools: script/python.md
    - Shell Scripts: script/shell.md
    - OpenLane ASIC Flow: script/openlane.md
    - Configuration: script/config.md
    - Tool Ecosystem: script/tool-ecosystem-design.md
  - Test & Simulation:
    - Simulation: sim/overview.md
    - Environments: env/overview.md
    - Test Suites: subrepo/overview.md
    - Test results dashboard: test-results-dashboard.md
  - Reference:
    - Wishbone Bus: wishbone-bus.md
    - Exception Priority: parametric-exception-priority.md
    - FENCE.I: fence-i-implementation.md
    - CoreMark: coremark-build.md
    - UART Test Guide: custom-uart-test-guide.md
    - Extended Tests: extended-test-suites.md
  - Development:
    - Maintenance:
      - TODO: TODO.md
      - Troubleshooting: TROUBLESHOOTING.md
      - Fix Plan: FIX_PLAN.md
      - Fixes history: FIXES_HISTORY.md
      - Fixes Applied: FIXES_APPLIED.md
      - Combinational Loop Fix: COMBINATIONAL_LOOP_FIX.md
    - Testing & Validation:
      - Test Manager: TEST_MANAGER_README.md
      - Test Manager Summary: TEST_MANAGER_SUMMARY.md
      - Quick Start: QUICKSTART_TESTMANAGER.md
      - Validation System: VALIDATION_SYSTEM.md
    - CoreMark:
      - Quick Start: COREMARK_QUICK_START.md
    - Configuration:
      - Cache Config: CACHE_CONFIG_README.md
      - Makefile Separation: MAKEFILE_SEPARATION.md
  - Roadmap:
    - AI Enhancement: ai-enhancement-plans.md
    - SoC Roadmap: soc-roadmap.md