| commit | 218294b7481edd0dfcc470d1df6c6f01dea75df5 | [log] [tgz] |
|---|---|---|
| author | Andreas Kurth <adk@lowrisc.org> | Tue Feb 07 19:03:35 2023 +0100 |
| committer | Andreas Kurth <github@akurth.net> | Fri Feb 10 12:26:48 2023 +0100 |
| tree | ca901347d767c0ee4775441d479d3fb94eb118ff | |
| parent | f21629e7d859dbc268c21047207882af5becdb2b [diff] |
[hw,doc] Add one-line descriptions to all blocks This commit adds one-line descriptions to all hardware blocks under `hw/ip` that have a `data/<name>.hjson` file except `trial1`. These one-line descriptions are intended for use in summary tables or as subtitles. As such, they should concisely convey the gist of a hardware block. For blocks that have their `.hjson` generated from a template (`.hjson.tpl`), this commit updates the template and the generated `.hjson`. This commit also updates the `.hjson`s of the top-level-specific blocks. The new field that contains the one-line description, `one_line_desc`, is added to `util/reggen` as optional. Co-authored-by: Pirmin Vogel <vogelpi@lowrisc.org> Signed-off-by: Andreas Kurth <adk@lowrisc.org>
OpenTitan is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. OpenTitan is administered by lowRISC CIC as a collaborative project to produce high quality, open IP for instantiation as a full-featured product. See the OpenTitan site and OpenTitan docs for more information about the project.
This repository contains hardware, software and utilities written as part of the OpenTitan project. It is structured as monolithic repository, or “monorepo”, where all components live in one repository. It exists to enable collaboration across partners participating in the OpenTitan project.
The project contains comprehensive documentation of all IPs and tools. You can access it online at docs.opentitan.org.
Have a look at CONTRIBUTING and our documentation on project organization and processes for guidelines on how to contribute code to this repository.
Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).