Code Monkey home page Code Monkey logo

Comments (1)

hcallahan-lowrisc avatar hcallahan-lowrisc commented on July 22, 2024

Hey @desorya,

The .core files are Fusesoc core files, which have a complete API documentation page here.

The .hjson files used throughout OpenTitan have a number of different uses, so there isn't one schema that covers everything. However, I can give you a few examples:

  • Files defining Comportable IP HWIP blocks (e.g. hw/ip/i2c/data/i2c.hjson) have keys defined in the Comportatbility Specification (e.g. here), as well as register definition fields from the reggen/regtool tooling docs.
  • .hjson files for DV simulations have some documentation available. Files defining testplans (e.g. hw/ip/i2c/data/i2c_testplan.hjson) are documented, but the configuration files that drive our simulation runner dvsim (e.g. hw/ip/i2c/dv/i2c_sim_cfg.hjson) are not.
  • Files defining top-level assemblies (e.g. hw/top_earlgrey/data/top_earlgrey.hjson) are ingested by the topgen tool, but the schema here is not formally documented afaik.

This is something we should improve in the future. In the meantime, I suggest trying to find keywords using the search on the documentation site (click the magnifying glass in the topbar or use the keyboard shortcut s). Otherwise, grepping the codebase while limiting your search to python files may bring up some code comments around where a particular keyword is parsed.

I hope that was helpful. If so, would you mind closing the issue? Thanks

from opentitan.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.