corel_mmio 8.0.0

Common Memory-Mapped IO operations and in-memory representations.

corel-mmio

Common Memory-Mapped Input/Output (MMIO) operations and in-memory representations, to aid in the development of packages which communicate with hardware containing a memory-mapped address space.

This package is part of the corel project ecosystem, which is a collection of Python packages for the cooperative development of software and firmware for memory mapped FPGAs, microcontrollers and other hardware.

• Supported Python versions: 3.10+
• Supported platforms: Linux, OSX
• Source: https://gitlab.desy.de/corel/corel-mmio
• Pypi: https://pypi.org/project/corel-mmio
• Documentation: TODO
• License: MIT

Features

• Unification of the interfaces involved in the interaction between software and Memory-Mapped Input/Output (MMIO) hardware.
• Object-oriented description of a memory map address space, providing register address access and validation and supporting multiple layers of submaps.
• Convenient asynchronous read/write methods attached to the memory-mapped registers via an abstract "interface" class defined through the structural subtyping of Python Protocol.
• Supports the development of hardware drivers which can be reused in different bench setups, where the underlying protocol (message format or communication protocol) changes, but the memory map of the device (and therefore the device operation) is common.

Acknowledgements

Concepts in corel-mmio have been inspired by the hdl_registers package. However, corel-mmio deliberately avoids a dependency on hdl_registers, so that it may be used in software architectures which strive to minimise dependencies.

Installation

This package is installable via pip from PyPI:

pip install corel-mmio

This package is installable via pip directly from this repository (via https or ssh), e.g.:

pip install 'git+https://gitlab.desy.de/corel/corel-mmio.git'

For developers, follow the usual git clone procedure and see the Makefile for development commands.