ChimeraTK / ChimeraTK/DeviceAccess

Extend the map file to be able to describe Push-Type registers

Open
#71 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement postponed selected umbrellaChild
Dominant language
C++
Stars
12
Forks
12
Avg merge
2d 14h
Merged PRs (30d)
13

Description

This is a child of #51.

Currently registers in mapped devices are implicitly poll-type. Some backends (uio, pcie) are able to deliver interrupts. This has to be integrated into the map files. Maybe the RegisterInfo object should be extended.

The extension must be able to describe different interrupts (numbered?), which can either be one register per interrupt line or one register which has the interrupt numbers that triggered as data (both should be possible).

The extension has to be synchronised with the MSK firmware group, which providers automatically generated map file.

  • Propose a possible extension (or multiple) and have it (them) reviewed before implementing
  • Extend the RegisterinfoMap::RegisterInfo and the map file parser
  • Write tests for the new functionality

Afterwards it should be adapted in the uio branch so it can be merged into the master.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed map-file extension with the MSK firmware group, including the two interrupt representation options. Then inspect RegisterinfoMap::RegisterInfo and the map file parser, add tests for the chosen functionality, and adapt it in the uio branch so it can be merged into master.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend, embedded-iot
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.