| --- |
| title: "${display_name} DIF Checklist" |
| --- |
| |
| <!-- |
| NOTE: This is a template checklist document that is required to be copied over |
| to `sw/device/lib/dif/dif_${dif_name}.md` for a new DIF that transitions |
| from L0 (Specification) to L1 (Development) stage, and updated as needed. |
| Once done, please remove this comment before checking it in. |
| --> |
| This checklist is for [Development Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [${display_name} DIF]({{< relref "hw/ip/${ip_name}/doc" >}}). |
| All checklist items refer to the content in the [Checklist]({{< relref "/doc/project/checklist.md" >}}). |
| |
| ## DIF Checklist |
| |
| ### S1 |
| |
| Type | Item | Resolution | Note/Collaterals |
| ---------------|----------------------|-------------|------------------ |
| Implementation | [DIF_EXISTS][] | Not Started | |
| Implementation | [DIF_USED_IN_TREE][] | Not Started | |
| Tests | [DIF_TEST_UNIT][] | Not Started | |
| Tests | [DIF_TEST_SANITY][] | Not Started | |
| Review | Reviewer(s) | Not Started | |
| Review | Signoff date | Not Started | |
| |
| [DIF_EXISTS]: {{< relref "/doc/project/checklist.md#dif-exists" >}} |
| [DIF_USED_IN_TREE]: {{< relref "/doc/project/checklist.md#dif-used-in-tree" >}} |
| [DIF_TEST_UNIT]: {{< relref "/doc/project/checklist.md#dif-test-unit" >}} |
| [DIF_TEST_SANITY]: {{< relref "/doc/project/checklist.md#dif-test-sanity" >}} |
| |
| ### S2 |
| |
| Type | Item | Resolution | Note/Collaterals |
| ---------------|-----------------------------|-------------|------------------ |
| Implementation | [DIF_FEATURES][] | Not Started | |
| Coordination | [DIF_HW_USAGE_REVIEWED][] | Not Started | |
| Coordination | [DIF_HW_FEATURE_COMPLETE][] | Not Started | [HW Dashboard]({{< relref "hw" >}}) |
| Implementation | [DIF_HW_PARAMS][] | Not Started | |
| Documentation | [DIF_DOC_HW][] | Not Started | |
| Documentation | [DIF_DOC_API][] | Not Started | |
| Code Quality | [DIF_CODE_STYLE][] | Not Started | |
| Coordination | [DIF_DV_TESTS][] | Not Started | |
| Implementation | [DIF_USED_TOCK][] | Not Started | |
| Review | HW IP Usage Reviewer(s) | Not Started | |
| Review | Reviewer(s) | Not Started | |
| Review | Signoff date | Not Started | |
| |
| [DIF_FEATURES]: {{< relref "/doc/project/checklist.md#dif-features" >}} |
| [DIF_HW_USAGE_REVIEWED]: {{< relref "/doc/project/checklist.md#dif-hw-usage-reviewed" >}} |
| [DIF_HW_FEATURE_COMPLETE]: {{< relref "/doc/project/checklist.md#dif-hw-feature-complete" >}} |
| [DIF_HW_PARAMS]: {{< relref "/doc/project/checklist.md#dif-hw-params" >}} |
| [DIF_DOC_HW]: {{< relref "/doc/project/checklist.md#dif-doc-hw" >}} |
| [DIF_DOC_API]: {{< relref "/doc/project/checklist.md#dif-doc-api" >}} |
| [DIF_CODE_STYLE]: {{< relref "/doc/project/checklist.md#dif-code-style" >}} |
| [DIF_DV_TESTS]: {{< relref "/doc/project/checklist.md#dif-dv-tests" >}} |
| [DIF_USED_TOCK]: {{< relref "/doc/project/checklist.md#dif-used-tock" >}} |
| |
| ### S3 |
| |
| Type | Item | Resolution | Note/Collaterals |
| ---------------|----------------------------------|-------------|------------------ |
| Coordination | [DIF_HW_DESIGN_COMPLETE][] | Not Started | |
| Coordination | [DIF_HW_VERIFICATION_COMPLETE][] | Not Started | |
| Review | [DIF_REVIEW_C_STABLE][] | Not Started | |
| Tests | [DIF_TEST_UNIT_COMPLETE][] | Not Started | |
| Review | [DIF_TODO_COMPLETE][] | Not Started | |
| Review | [DIF_REVIEW_TOCK_STABLE][] | Not Started | |
| Review | Reviewer(s) | Not Started | |
| Review | Signoff date | Not Started | |
| |
| [DIF_HW_DESIGN_COMPLETE]: {{< relref "/doc/project/checklist.md#dif-hw-design-complete" >}} |
| [DIF_HW_VERIFICATION_COMPLETE]: {{< relref "/doc/project/checklist.md#dif-hw-verification-complete" >}} |
| [DIF_REVIEW_C_STABLE]: {{< relref "/doc/project/checklist.md#dif-review-c-stable" >}} |
| [DIF_TEST_UNIT_COMPLETE]: {{< relref "/doc/project/checklist.md#dif-test-unit-complete" >}} |
| [DIF_TODO_COMPLETE]: {{< relref "/doc/project/checklist.md#dif-todo-complete" >}} |
| [DIF_REVIEW_TOCK_STABLE]: {{< relref "/doc/project/checklist.md#dif-review-tock-stable" >}} |
