Struct StatusInterface

Source

pub struct StatusInterface {}

Expand description

Instance of a zbus::object_server::Interface constructed using the zbus::interface macro.

Implementations§

Source §

impl StatusInterface

See crate::comm::dbus for a summary of this interface’s methods, or crate::comm::dbus::status_interface for a summary of this interface in general.

Source

async fn get_status_message( &self, platform_string: &str, ) -> Result<String, Error>

Get a human-readable status message for all FPGA devices on the platform.

Returns a formatted status string whose content is platform-specific.

§Arguments

platform_string: Platform compatibility string (must not be empty).

§Returns: `Result<String, fdo::Error>`

Ok(String) – Platform-specific status message.
Err(fdo::Error) if platform_string is empty or the platform cannot be determined.

§Examples

let msg = status_interface.get_status_message("xlnx-sys").await?;
println!("{msg}");

Source

async fn get_fpga_state( &self, platform_string: &str, device_handle: &str, ) -> Result<String, Error>

The device handle (e.g., fpga0) of the FPGA.

§Arguments

platform_string: Platform compatibility string.
device_handle: The device handle (e.g., fpga0) of the FPGA.

§Returns: `Result<String, fdo::Error>`

Ok(String) – the current FPGA state (e.g., "operating", "unknown").
Err(fdo::Error) if the device handle is invalid or the platform cannot be determined.

§Examples

let state = status_interface.get_fpga_state("xlnx,zynqmp-pcap-fpga", "fpga0").await?;
assert_eq!(state, "operating");

Source

pub async fn get_overlay_status( &self, platform_string: &str, overlay_handle: &str, ) -> Result<String, Error>

Retrieve the status of a specific device-tree overlay.

§Arguments

platform_string: Platform compatibility string.
overlay_handle: The handle (name) of the device-tree overlay to query.

§Returns: `Result<String, fdo::Error>`

Ok(String) – Status of the overlay (e.g., "loaded", "unapplied").
Err(fdo::Error) If the overlay handle is empty or not found.

§Examples

let status = status_interface.get_overlay_status(
    "xlnx,zynqmp-pcap-fpga",
    "my_overlay"
).await?;
assert_eq!(status, "applied");

Source

async fn get_overlays(&self) -> Result<String, Error>

Retrieve a list of all available device-tree overlay handles (names of the device-tree overlay directories present on the system)

§Returns: `Result<String, fdo::Error>`

Ok(String) – List of existing overlay handles, separated by newline (\n).
Err(fdo::Error) - FpgadError::IOReadDir if dir cannot be read

§Examples

let overlays = status_interface.get_overlays().await?;

§Example Ok(String) values

§no overlays present:

assert_eq!(overlays, "");

§One overlay present:

assert_eq!(overlays, "my_overlay");

§Multiple overlays present:

assert_eq!(overlays, "my_overlay1\nmy_overlay2\n...\nmy_overlayN");

Source

async fn get_platform_type(&self, device_handle: &str) -> Result<String, Error>

Get the compatibility string for a single FPGA device.

§Arguments

device_handle: FPGA device handle.

§Returns: `Result<String, Error>`

Ok(String) – Device’s platform compatibility string.
Err(fdo::Error) if device validation or reading the compatible string fails.

§Examples

let platform_string = status_interface.get_platform_type("fpga0").await?;
assert_eq!(platform_string, "xlnx,zynqmp-pcap-fpga");

Source

async fn get_platform_types(&self) -> Result<String, Error>

Get a list of all FPGA devices and their platform types.

§Returns: `Result<String, Error>`

Ok(String) – Each line formatted as <device_handle>:<platform_string>\n. Devices without a valid string appear as <device_handle>:\n.
Err(fdo::Error) if reading FPGA managers directory or compatible strings fails.

§Examples

let platform_map = status_interface.get_platform_types().await?;

If only one device:

assert_eq!(platform_map, "fpga0:xlnx,zynqmp-pcap-fpga\n");

or for multiple devices

assert_eq!(platform_map, "fpga0:xlnx,zynqmp-pcap-fpga\nfpga1:xlnx,versal-fpga\n");

Source

async fn xlnx_sys(&self, sub_cmd: &str, path_str: &str) -> Result<String, Error>

Entrypoint for xilinx_sys platform specific operations.

§Arguments

sub_cmd - The read operation to perform - see crate::platforms::xilinx_sys::ReadSubCommand
path_str - Device handle or full sysfs path to flags for read_flags (e.g. fpga0 or /sys/class/fpga_manager/fpga0/flags), or sysfs property path for read_property.

§Returns: `Result<String, fdo::Error>`

Ok(String) – The property value or flags as a string.
Err(fdo::Error) – If the sub_cmd is unrecognised or the path is invalid / outside the allowed directory.

§Examples

// Read the FPGA manager name
let name = status_interface
    .xlnx_sys("read_property", "/sys/class/fpga_manager/fpga0/name")
    .await?;

// Read the current programming flags for fpga0
let flags = status_interface
    .xlnx_sys("read_flags", "fpga0")
    .await?;