Struct UniversalPlatform 

pub struct UniversalPlatform { /* private fields */ }

Universal platform implementation for generic FPGA management.

This struct provides a platform implementation that works with any FPGA device using the standard Linux FPGA subsystem. It uses lazy initialization to create FPGA and overlay handler instances on first access, ensuring efficient resource usage.

The #[platform] macro automatically registers this platform with the compatibility string “universal”, making it available as a fallback for devices without specific platform support.

Fields

• fpga - Lazily initialized FPGA device instance
• overlay_handler - Lazily initialized overlay handler instance

Thread Safety

This struct is thread-safe thanks to OnceLock, which ensures that initialization happens exactly once even with concurrent access.

Implementations

impl UniversalPlatform

pub fn new() -> Self

Create a new Universal platform instance.

Creates an empty platform with uninitialized FPGA and overlay handler instances. The actual components will be lazily initialized on first access through the Platform trait methods.

Returns: Self

• New UniversalPlatform instance ready for use

Examples

use crate::platforms::universal::UniversalPlatform;

let platform = platform_for_known_platform("universal")?;

Trait Implementations

impl Debug for UniversalPlatform

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UniversalPlatform

fn default() -> Self

Returns the “default value” for a type.

impl Platform for UniversalPlatform

fn fpga(&self, device_handle: &str) -> Result<&dyn Fpga, FpgadError>

Get or initialize the FPGA device instance.

Returns a reference to the UniversalFPGA instance for the specified device. On first call, this creates and initializes the FPGA instance. Subsequent calls return the same cached instance.

Arguments

• device_handle - The device handle (e.g., “fpga0”)

Returns: Result<&dyn Fpga, FpgadError>

• Ok(&dyn Fpga) - Reference to the FPGA device instance

Note

This implementation currently never returns an error, but the Result type is required by the Platform trait to support platform-specific validation.

fn overlay_handler( &self, overlay_handle: &str, ) -> Result<&dyn OverlayHandler, FpgadError>

Get or initialize the overlay handler instance.

Returns a reference to the UniversalOverlayHandler instance for the specified overlay. On first call, this creates and initializes the handler. This method also validates that the configfs overlay directory exists.

Arguments

• overlay_handle - The overlay handle (directory name in configfs)

Returns: Result<&dyn OverlayHandler, FpgadError>

• Ok(&dyn OverlayHandler) - Reference to the overlay handler instance
• Err(FpgadError::Argument) - Overlay path has no parent or parent doesn’t exist

Implementation Note

This method includes a workaround for the unstable get_or_try_init feature. Once that feature is stable, the error handling can be improved. See: https://github.com/rust-lang/rust/issues/121641

fn status_message(&self) -> Result<String, FpgadError>

Get a formatted status message for this platform.

fn platform_compat_string(&self) -> String

Get the platform compatibility string.