Library Structure

Next to the actual TLM simulation models, the library contains an extensive set of unit tests and support-functions for building and analyzing simulations. The top-level of the library is structured as follows:

• ./core

  • /common

    Contains utility classes and functions, which are jointly used by all models of the library. This mainly comprises timing monitor, power monitor, endianess conversion and verbosity control. More detailed explanations on the seperate files in this directory are given here.

    • /grambasockets
    • /gs_config

    • /signalkit_h

      Home of the SoCRocket SignalKit. The SignalKit comprises a set of functions/templates that allow signal communication in TLM-Style, without the overhead of maintaining payload objects.
      Within the library it is mainly used to model interrupts and reset distribution. More detailed information can be found in here.

    • /trapgen

  • /doc

    The documentation to this library which you are reading now.

  • /models

    The central folder containing all simulation models and unit tests. You can find documentation for the models linked in the IP Models list. Each model is located in a separate sub-directory. The directory extern contains external libraries which have been included in the models.

    • /ahbctrl
    • /ahbin
    • /ahbmem
    • /ahbout
    • /ahbprof
    • /apbctrl
    • /apbuart
    • /extern
    • /gptimer
    • /irqmp
    • /mctrl
    • /memory
    • /mmu_cache
    • /utils

  • /platforms

    The platforms directory contains a subdirectory for all platforms. These correlate to a .tpa file in the templates directory. At the moment only the leon3mp platform is working.

    Todo:

    whats this tpa stuff? does it still work?

    • /base
    • /leon3mp
    • /newleon3mp

  • /software

    This directory contains benchmarks, tests and the OS for the platform.

    • /fft64
    • /grlib_tests
    • /prom
    • /trapgen

  • /tools

    A collection of small helpers for the SoCRocket library.

    • /generator

      The implementation of the Configuration Wizard. The tool uses templates and configurations to generate platform instances. Example templates can be found in the templates folder. The platform sources are written to ./core/platforms/{name_of_platform}. More detailed information is given in 2.4.

      Todo:

      is the configuration wizard and generator documentation still needed?

  • /waf

    Some extra modules for the waf build system to deal with modelsim, multi dependend tests and switching between host and SPARC compiler.

• LICENSE.AGPL.md
• LICENSE.COM.md
• README.md

• waf

  WAF executable

• wscript

  Top-level build script