fpgad 0.2.0

An FPGA manager daemon that handles the dirty work for you.
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

// 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/.

//! Error types for FPGA softener implementations.
//!
//! This module defines error types specific to vendor-specific softener implementations
//! (like Xilinx DFX Manager). These errors are converted to the main [`crate::error::FpgadError`] type
//! for propagation through the daemon's DBus interfaces.
//!
//! # Error Types
//!
//! - [`FpgadSoftenerError`] - Errors from vendor-specific softener operations
//!
//! # Error Handling
//!
//! Softener errors implement conversion traits to both `fdo::Error` (for DBus responses)
//! and `FpgadError` (for internal error handling). All errors are logged when converted.

use crate::error::FpgadError;
use log::error;
use zbus::fdo;

/// Errors specific to FPGA softener implementations.
///
/// This enum represents errors that occur in vendor-specific softener code,
/// such as failures in communication with external tools or daemons (e.g., dfx-mgr-client).
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum FpgadSoftenerError {
    /// Error from Xilinx DFX Manager operations.
    ///
    /// This variant represents failures when calling dfx-mgr-client or when
    /// dfx-mgrd is not available or returns an error. The string contains
    /// detailed error information from the dfx-mgr tooling.
    #[error("FpgadSoftenerError::DfxMgr: {0}")]
    DfxMgr(String),
}

impl From<FpgadSoftenerError> for fdo::Error {
    fn from(err: FpgadSoftenerError) -> Self {
        error!("{err}");
        match err {
            FpgadSoftenerError::DfxMgr(..) => fdo::Error::Failed(err.to_string()),
        }
    }
}

impl From<FpgadSoftenerError> for FpgadError {
    fn from(err: FpgadSoftenerError) -> Self {
        error!("{err}");
        match err {
            FpgadSoftenerError::DfxMgr(..) => FpgadError::Softener(err),
        }
    }
}