maksyuki
b5b5492659
- Updated the GPIO interface in multiple modules to use the new user_gpio_if structure instead of the legacy gpio_if. - Modified the ip_apb_wrapper, ip_nmi_wrapper, user_ip_design_template, user_ip_top, and user_ip_wrapper to reflect the new GPIO interface. - Increased the USER_GPIO_NUM from 16 to 32 in mdd_config.svh to accommodate more GPIOs. - Removed legacy GPIO handling from retrosoc and retrosoc_asic modules. - Implemented a migration script in generate_mpw.py to automatically update legacy GPIO ports in source files. - Added tests for the new GPIO user interface and ensured proper functionality through gpio_user_mux_tb and gpio_user_mux.py. - Created new makefiles for IP MDD configurations to support the updated GPIO structure. - Updated regression tests to include new configurations and ensure compatibility with the changes.
retroSoC Runtime and SDK
crt/ contains the freestanding RISC-V runtime and software development kit
used by every retroSoC firmware image. It provides startup code, linker
layouts, public SoC interfaces, hardware abstraction layers, and small runtime
services. It does not provide an application entry point; applications live in
../app.
Layout
| Path | Purpose |
|---|---|
arch/riscv/ |
RISC-V startup, interrupt assembly, compiler runtime helpers, and architecture-specific support. |
include/retrosoc/core/ |
Public status, SoC, architecture, interrupt, and bounded-wait interfaces. |
include/retrosoc/hal/ |
Public memory-mapped peripheral interfaces. |
include/retrosoc/lib/ |
Freestanding console, formatting, string, and conversion interfaces. |
include/retrosoc/service/ |
Public boot, shell, and benchmark service interfaces. |
src/core/, src/hal/, src/lib/, src/service/ |
Implementations grouped by the same ownership boundary as the public headers. |
linker/ |
Supported linker layouts, selected through LINK_TYPE. |
The active public include root is crt/include. Include SDK headers through
the retrosoc namespace, for example:
#include <retrosoc/core/status.h>
#include <retrosoc/hal/uart.h>
#include <retrosoc/lib/printf.h>
crt/inc/ is legacy or generated compatibility material. It is not an active
public include root for the firmware build; new code must not add dependencies
on it.
Build Integration
The central software build assembles the runtime sources in
../rtl/mini/mk/software.mk. It selects the
RISC-V ISA, optional CSR interrupt support, linker layout, and the application
profile. Applications add their own sources after the common runtime is
selected.
Start from a committed configuration profile:
make CONFIG=configs/ci/hazard3-rv32im-ihp130.mk setup
make CONFIG=configs/ci/hazard3-rv32im-ihp130.mk firmware
The resulting firmware and generated headers are isolated under
build/<profile>-<config-hash>/sw/. Do not commit build outputs.
API and Contribution Rules
- Self-owned C/H code in
crt/follows the project MISRA C:2012 Amendment 2 policy. Assembly, linker scripts, compatibility material, and excluded paths are outside that C-language scope. - Keep public interfaces in the matching
include/retrosoc/<layer>/directory and implementations in the correspondingsrc/<layer>/directory. - Use the
rs_API namespace andrs_status_tfor operations that can fail. - Keep the runtime freestanding: do not add hosted-library, dynamic-allocation, or operating-system dependencies.
- Prefer bounded APIs such as
rs_strlcpy,rs_strlcat,rs_snprintf, and timeout-based register waits over unbounded operations. - Add deterministic host tests when new code does not require real registers, timing, or board hardware.
Required-rule deviations need a reviewed entry in
quality/misra/deviations.md. Existing
automation is partial enforcement; it is not a claim of complete MISRA
certification.
Quality Checks
Run the SDK checks from the repository root:
make sw-format-check
make sw-policy-check
make sw-host-test
sw-format-check requires the project formatter version (clang-format-14 in
CI). sw-policy-check enforces the self-owned embedded-C naming and unsafe API
policy. sw-host-test compiles deterministic runtime, parser, and compiler
helper tests with a host C compiler; it does not replace RTL simulation or
hardware validation.
For the complete firmware, simulation, synthesis, and timing flow, see the repository README.