Move platform definitions to separate repositories #214
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Marking this as ready for review since the corresponding PRs have been merged to the Cynthion and luna-boards repos. |
Platform definitions will now be kept in separate repositories. Auto-detection will be used if the apollo_fpga module is present, and the detected Apollo device is supported by the installed 'cynthion' or 'luna_boards' modules. In all other cases, the LUNA_PLATFORM environment variable must be set for get_appropriate_platform() to return a platform.
martinling
force-pushed
the
remove-platforms
branch
from
333625b to
88ccb09
Compare
miek
approved these changes
Jan 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To simplify maintenance of the LUNA project, we'd like platform definitions to be kept in separate repositories going forward. The aim is to avoid having to update the LUNA package for every new platform, or platform change.
Platform definitions for Cynthion hardware have been added to the Cynthion repository, and @mndza is preparing a luna-boards repository to contain other board definitions for LUNA which are not currently maintained elsewhere.
Moving platform definitions out of the LUNA repository means that auto-detection of connected hardware will need to work differently to how it does currently. The approach implemented in this PR is that:
get_appropriate_platformfunction will look for theapollo_fpgamodule, and if it is present, check for an Apollo-based device.APOLLO_PLATFORMStable in known modules, currentlycynthionandluna_boards. If a corresponding platform is found, it will be used.LUNA_PLATFORMenvironment variable to be set to select a platform.This approach is intended to be backwards-compatible with existing usage. It may be extended to support other autodetection methods, or other sources of platform definitions.