Support multiple CSRs interface types; Improve User Guide.

[arturum1]

• Update core and simulation wrapper to include iob_universal_converter to convert to the corresponding CSRs interface.
  Currently supported CSR interfaces: "IOb", "AXI-Lite", "Wishbone".
• Add doxygen documentation in bare-metal driver header sources.
• Improve User Guide document.
• Pre-built document available at: https://github.com/arturum1/iob-eth/blob/master/document/ug.pdf

[Copilot]

Pull request overview

This pull request adds support for multiple CSR interface types (IOb, AXI-Lite, Wishbone, APB, AXI) and significantly improves documentation by adding comprehensive Doxygen comments to bare-metal driver headers and enhancing the User Guide.

Key Changes:

• Added Doxygen documentation to all bare-metal driver header files with detailed descriptions of macros, functions, and constants
• Implemented CSR interface selection via iob_universal_converter in both the core and simulation wrapper
• Enhanced User Guide with new sections for simulation, instantiation, features, and deliverables
• Updated build system to support CSR_IF parameter selection

Reviewed changes

Copilot reviewed 19 out of 24 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
software/src/iob_eth_rmac.h	Added file-level doxygen documentation explaining RMAC placeholder functionality
software/src/iob_eth_macros.h	Converted all macro comments to doxygen format with grouped documentation sections
software/src/iob_eth_defines.h	Added doxygen documentation for macro functions with parameter descriptions
software/src/iob_eth.h	Added comprehensive doxygen function documentation with parameter and return value descriptions
software/src/iob_eth.c	Fixed function signature to match header declaration (removed void parameter)
software/src/eth_mem_map.h	Added doxygen documentation for register offset macros
software/src/eth_frame_struct.h	Added doxygen documentation for frame structure constants
iob_eth.py	Added CSR_IF parameter support and improved signal descriptions
hardware/simulation/iob_eth_sim/iob_eth_sim.py	Added universal converter to support multiple CSR interface types in testbench
document/tsrc/*.tex	Added new documentation sections for simulation, instantiation, features, and deliverables
document/figures/*.odg	Added binary diagram files for documentation
document/doc_build.mk	Added DOXYGEN and CONFIDENTIAL configuration flags
default.nix	Updated py2hwsw dependency version
Makefile	Enhanced to support CSR_IF parameter configuration
README.md	Fixed function signature consistency

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The interrupt output signal description was changed from "Interrupt Output A" to "Interrupt Output", but the signal name remains "inta_o". The description in the nested signal still says "Interrupt Output A". For consistency, either both descriptions should match, or the nested signal description should be updated to match the port-level description.

Suggested change

	"descr": "Interrupt Output A",
	"descr": "Interrupt Output",

[arturum1]

The inta_o signal description still mentions "Interrupt Output A".
I removed the 'A' from the description of the port (group of signals), so that 'A' does not appear in the LaTeX table description. It will only appear on the description of the signal itself, inside the table.

[Copilot]

The construction and reuse of PY_PARAMS here allows shell command injection via both CSR_IF and PY_PARAMS, since their values are interpolated unquoted into $(shell echo $(PY_PARAMS) | cut -c2-) and then into nix-shell --run as --py_params '$(PY_PARAMS)'. An attacker who can influence CSR_IF or PY_PARAMS (e.g., via environment variables or build parameters) can inject shell metacharacters such as ; or ' to execute arbitrary commands during make, potentially compromising the build environment. To fix this, avoid passing untrusted values through $(shell ...) and shell-quoted arguments; instead, pass them as environment variables or ensure they are rigorously escaped before use in shell commands.

[arturum1]

This does not apply.

Any user that runs the Makefile already has access to the system and can modify the Makefile to run any commands.

[P-Miranda]

block diagram figure does not match with block diagram table, maybe need to manually add subblocks to iob_eth.py subblocks list with instantiate:True to show in ug table.

[jjts]

avoid bent lines in the block diagram such as CPU IF

[jjts]

RX buffer and MII managemnt also have bents

[P-Miranda]

User Guide seems ok.
Possible improvements include moving CDC logic to dedicated module (example: iob_eth_cdc) and remaining top level logic - like remaining iob_regs for no-auto CSRs - to another dedicated module (example: iob_eth_logic.v)

[P-Miranda]

Usually we place all CDC in a dedicated verilog module (for example iob_eth_cdc.v), instead of placing then at the top module level.
Not sure if we want to do the same for this core.

[jjts]

This would be worth doing. The internal objective of this milestone is to train people in designing IP.

Ideally, the top should be just the modules in the block diagram, interconnected by wires.