fpgad_cli 0.5.1

Command-line interface for interacting with the FPGAd daemon
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

// This file is part of fpgad, an application to manage FPGA subsystem together with device-tree and kernel modules.
//
// Copyright 2025 Canonical Ltd.
//
// SPDX-License-Identifier: GPL-3.0-only
//
// fpgad is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3, as published by the Free Software Foundation.
//
// fpgad is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranties of MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.

//! DFX Manager command implementation for the FPGA CLI.
//!
//! This module passes commands directly to `dfx-mgr-client` via the fpgad daemon's
//! DBus interface.
//!
//! If the connected daemon does not expose `dfx_mgr` (for example because it was built
//! without `xilinx-dfx-mgr`), this handler returns a clear compatibility error.
//!
//! # Usage
//!
//! ```shell
//! # List available acceleration packages
//! fpgad dfx-mgr -listPackage
//!
//! # List FPGA slots and their current state
//! fpgad dfx-mgr -listSlot
//!
//! # Load a package into slot 0
//! fpgad dfx-mgr -load 0 my_design
//!
//! # Remove the package in slot 0
//! fpgad dfx-mgr -remove 0
//! ```
//!
//! Arguments beginning with `-` are accepted without needing a `--` separator.
//! Multiple tokens are supported: `fpgad dfx-mgr -load 0 my_design`
//!
//! For a full list of `dfx-mgr-client` commands see: <https://github.com/Xilinx/dfx-mgr>

use fpgad_proxies::proxies::control_proxy;
use zbus::{self, Connection};

/// Main handler for the `dfx-mgr` subcommand.
///
/// Joins the provided tokens into a single space-separated command string and forwards it to the
/// daemon's `dfx_mgr` DBus method, which in turn passes it to `dfx-mgr-client`.
///
/// # Arguments
///
/// * `cmd` - Slice of argument tokens to pass to `dfx-mgr-client`
///   (e.g. `["-listPackage"]` or `["-load", "0", "my_design"]`)
///
/// # Returns: `Result<String, zbus::Error>`
/// * `Ok(String)` - Exit status, stdout, and stderr from `dfx-mgr-client`
/// * `Err(zbus::Error)` - DBus communication error, missing component, or FpgadError.
///   See [Error Handling](../index.html#error-handling) for details.
pub async fn dfx_mgr_handler(cmd: &[String]) -> Result<String, zbus::Error> {
    let cmd_string = cmd.join(" ");
    let connection = Connection::system().await?;
    let proxy = control_proxy::ControlProxy::new(&connection).await?;
    match proxy.dfx_mgr(&cmd_string).await {
        Ok(out) => Ok(out),
        Err(zbus::Error::MethodError(name, _, _))
            if name.as_str() == "org.freedesktop.DBus.Error.UnknownMethod" =>
        {
            Err(zbus::Error::Failure(
                "feature not enabled in daemon, or CLI/daemon out of date (missing dfx_mgr method)"
                    .to_string(),
            ))
        }
        Err(e) => Err(e),
    }
}