Starting with OCAH
|
This document is currently under development.
|
1. About this Guide
The Open Chiplet Atlas Harness (OCAH) is a chiplet design IP where the non-application-specific functions are integrated to form a chiplet design framework.
These non-application-specific functions include common chiplet subsystems like Security Processor (SEP), System Management Controller (SMC), System Management Network (SMN), AXI-over-UCIe bridge (AoU), Debug & Test Ports (DTP), etc.
This guide outlines how to get started with OCA Harness, including the use of the repository, licensing and guidelines for effective contribution.
Published releases follow semantic versioning.
A tag is vMAJOR.MINOR.PATCH: a patch such as v0.5.1 stays compatible with v0.5.0, a minor release adds functionality, and a major release can break compatibility.
See Versioning.
2. Repository structure
The OCAH repository is organised as below
| Path | Contents |
|---|---|
|
Shared RTL: primitives ( |
|
Reusable IP blocks, grouped by family where applicable (e.g. |
|
Subsystems ( |
|
Top-level integration. |
|
Documentation products (TRM, Integrator Guide, …) |
|
Third-party IP vendored via Bender |
|
Register-flow, documentation, and container helpers. |
3. Starting with OCAH
This documentation is organized into the following sections:
-
Starting as a user
-
Dependencies - System requirements and dependencies
-
Environment and Setup - Instructions for Installing Tooling and Setting up the Repository
-
Workflows - OCAH development methodology
-
Guidelines - OCAH development guidelines
-
-
Starting as a contributor
-
Licensing - OCAH Licensing Guidelines
-
Contributions - Making contributions to OCAH
-
Defect Reporting - Managing OCAH Defects
-
Security Policy - Reporting a Vulnerability
-
Documentation - OCAH documentation
-
Code of Conduct - OCAH Project Code of Conduct
-