Configuration

Here you can find the documentation for how to configure X-HEEP. X-HEEP uses a series of Python scripts to generate the desired configuration of the MCU and its related files using Mako .tpl templates. For example, hw/core-v-mini-mcu/core_v_mini_mcu.sv.tpl will generate hw/core-v-mini-mcu/core_v_mini_mcu.sv.

The configuration is triggered by the mcu-gen make target, and it has to be run every time the configuration or any of the .tpl files change. If you have to modify any file that is generated from a .tpl file, you should modify the .tpl file and run mcu-gen to generate the new file.

The default configuration of X-HEEP is generated by running:

make mcu-gen

If you want to modify the default parameters, check the system configuration guide.

In this section you will also find the detailed documentation for configuring the different elements of X-HEEP (e.g. the bus, the memory, the pads…), and the API documentation of the xheep_gen Python project that models and is in charge of generating X-HEEP according to the specified configuration.

• System Configuration
  • Make Command
  • Hjson Configuration File
  • Python Configuration (recommended)
• CPU Configuration
  • Arguments in the make command
  • Python configuration file
    • cv32e20 CPU configuration
    • cv32e40p CPU configuration
    • cv32e40px CPU configuration
    • cv32e40x CPU configuration
  • HJSON configuration file
• CORE-V eXtension Interface (CV-X-IF) Configuration
  • Python configuration file
• Memory Banks Configuration
• Bus Type Configuration
• Linker Configuration
  • HJSON configuration file
    • Automatically created sections
    • Manually created sections
  • Python configuration file
    • Grouping multiple input sections inside one linker section
    • Example: interleaved coprocessor section
• Pad Configuration
  • Overview
  • Pin Types
  • Pin Attributes
  • Creating Pin Lists
  • Pin-to-Pad Mapping
  • Floorplan Dimensions (Optional)
  • Building the PadRing
  • Visualization (Optional)
  • 😎 X-pert Zone (mostly for ASIC implementation)
    • Custom Pad Attributes
    • Spacing Pads by Pitch
    • Custom pads cells
    • Custom Pin types
• Peripheral Configuration
  • Overall structure
  • Adding a custom configuration
• Extension Configuration
• xheep_gen
  • xheep_gen package
    • Subpackages
    • Submodules
    • Module contents