mirror of
https://github.com/retroSoC/retroSoC.git
synced 2026-11-04 22:32:36 +00:00
maksyuki
167db9fa86
- Introduced a new overview section detailing the product features and specifications for the retroSoC Mini. - Created a comprehensive peripherals section outlining memory interfaces, GPIO, DMA, timers, multimedia, and encryption components. - Added a pins section that includes pin mapping, GPIO alternate-function matrix, and electrical specifications. - Developed a software section covering boot sequence, runtime environment, applications, and Linux driver status. - Established a style file to define the visual presentation of the datasheet. - Implemented tests for validating datasheet generation and ensuring integrity of engineering inputs.
91 lines
3.7 KiB
Python
91 lines
3.7 KiB
Python
"""Datasheet extraction rejects stale, ambiguous and incomplete engineering inputs."""
|
|
from __future__ import annotations
|
|
|
|
import copy
|
|
import sys
|
|
from pathlib import Path
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
sys.path.insert(0, str(ROOT))
|
|
from publications import build_datasheet as ds # noqa: E402
|
|
|
|
|
|
def sample_catalog():
|
|
return [{"id": "timer", "regions": ["TIM0"], "irqs": ["timer0"],
|
|
"sources": ["docs/ip/timer.md"]}]
|
|
|
|
|
|
def test_catalog_rejects_missing_active_or_reserved_window():
|
|
with pytest.raises(ValueError, match="undocumented regions"):
|
|
ds.validate_catalog(sample_catalog(), [{"symbol": "TIM0"}, {"symbol": "RESERVED"}],
|
|
[{"name": "timer0"}])
|
|
|
|
|
|
def test_catalog_rejects_duplicate_region_between_different_ips():
|
|
entries = sample_catalog()
|
|
second = copy.deepcopy(entries[0])
|
|
second["id"] = "other"
|
|
entries.append(second)
|
|
with pytest.raises(ValueError, match="duplicate catalog region"):
|
|
ds.validate_catalog(entries, [{"symbol": "TIM0"}], [{"name": "timer0"}])
|
|
|
|
|
|
def test_catalog_rejects_lost_interrupt():
|
|
with pytest.raises(ValueError, match="undocumented IRQs"):
|
|
ds.validate_catalog(sample_catalog(), [{"symbol": "TIM0"}],
|
|
[{"name": "timer0"}, {"name": "timer1"}])
|
|
|
|
|
|
def test_catalog_rejects_unknown_interrupt():
|
|
with pytest.raises(ValueError, match="unknown or duplicate catalog IRQ"):
|
|
ds.validate_catalog(sample_catalog(), [{"symbol": "TIM0"}], [])
|
|
|
|
|
|
def test_profile_rejects_make_evaluation_and_duplicate_assignment(tmp_path):
|
|
profile = tmp_path / "bad.mk"
|
|
profile.write_text("SRAM_SIZE_KIB := $(shell echo 32)\n")
|
|
with pytest.raises(ValueError, match="unsupported profile expression"):
|
|
ds.profile_values(profile)
|
|
profile.write_text("SRAM_SIZE_KIB := 32\nSRAM_SIZE_KIB := 128\n")
|
|
with pytest.raises(ValueError, match="duplicate profile assignment"):
|
|
ds.profile_values(profile)
|
|
|
|
|
|
def test_reviewed_profile_resolves_sram_instead_of_using_decoder_maximum():
|
|
config = ds.read_json(ds.CONFIG)
|
|
profile = ds.profile_values(ROOT / config["profile"])
|
|
generator = ds.load_generator("test_datasheet_memory", "rtl/mini/address_map/generate_memory_map.py")
|
|
_, regions, _ = generator.read_map(ROOT / ds.MAP, int(profile["SRAM_SIZE_KIB"]))
|
|
sram = next(r for r in regions if r["symbol"] == "SRAM")
|
|
assert sram["size"] == 32768
|
|
assert sram["end"] == 0x30007FFF
|
|
assert next(r for r in regions if r["symbol"] == "SPISD")["kind"] == "reserved"
|
|
|
|
|
|
def test_gpio_label_preserves_index_and_collapses_bidirectional_pair():
|
|
mode = SimpleNamespace(inputs=["u_opipsram_if.dq_i[4]"], do="u_opipsram_if.dq_o[4]")
|
|
assert ds.gpio_label(mode) == "OPIPSRAM.DQ[4]"
|
|
assert ds.gpio_label(SimpleNamespace(inputs=[], do="1'b0")) == "-"
|
|
|
|
|
|
def test_source_drift_does_not_silently_relabel_old_prose(monkeypatch):
|
|
monkeypatch.setattr(ds, "git", lambda *args, **kwargs: "rtl/mini/top/retrosoc.sv")
|
|
with pytest.raises(ValueError, match="technical sources differ"):
|
|
ds.validate_source(ds.read_json(ds.CONFIG))
|
|
|
|
|
|
def test_missing_media_fails_without_attempting_network(tmp_path, monkeypatch):
|
|
monkeypatch.setattr(ds, "ROOT", tmp_path)
|
|
with pytest.raises(ValueError, match="media repository missing; run setup"):
|
|
ds.check_assets({"sources": {"publication_media": {"destination": "publications/media"}}})
|
|
|
|
|
|
def test_compiler_version_is_checked_before_build(monkeypatch):
|
|
monkeypatch.setattr(ds.subprocess, "check_output", lambda *a, **k: "typst 0.14.0 (test)")
|
|
lock = {"publication_tools": {"typst": {"version": "0.15.1"}}}
|
|
with pytest.raises(ValueError, match="expected Typst 0.15.1"):
|
|
ds.resolve_typst("typst", lock)
|