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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

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

use crate::common::proxies::{control_proxy, status_proxy};
use crate::universal::setup;
use googletest::prelude::*;
use rstest::*;
use zbus::Connection;

#[gtest]
#[tokio::test]
#[rstest]
#[case::load_from_lib_firmware("universal", "fpga0", "/lib/firmware/k26-starter-kits.bit.bin", "")]
async fn load_from_lib_firmware(
    #[case] platform_handle: &str,
    #[case] device_handle: &str,
    #[case] bitstream_file: &str,
    #[case] fw_lookup: &str,
    _setup: (),
) {
    let connection = Connection::system()
        .await
        .expect("failed to create connection");
    let control_proxy = control_proxy::ControlProxy::new(&connection)
        .await
        .expect("failed to create control proxy");
    let status_proxy = status_proxy::StatusProxy::new(&connection)
        .await
        .expect("failed to create status proxy");

    control_proxy
        .set_fpga_flags(platform_handle, device_handle, 0)
        .await
        .expect("failed to set fpga flags");
    expect_that!(
        status_proxy
            .get_fpga_flags(platform_handle, device_handle)
            .await
            .expect("failed to get fpga flags"),
        eq("0")
    );

    control_proxy
        .write_property("/sys/class/fpga_manager/fpga0/key", "")
        .await
        .expect("failed to reset the encryption key");
    control_proxy
        .write_bitstream_direct(platform_handle, device_handle, bitstream_file, fw_lookup)
        .await
        .expect("failed to write bitstream file");
    let s = status_proxy
        .get_fpga_state(platform_handle, device_handle)
        .await
        .expect("failed to get fpga state");
    expect_that!(s, eq("operating"));
}

#[gtest]
#[tokio::test]
#[rstest]
#[case::load_from_lib_firmware("universal", "fpga0", "/lib/firmware/k26-starter-kits.bit.bin", "")]
async fn bad_flags(
    #[case] platform_handle: &str,
    #[case] device_handle: &str,
    #[case] bitstream_file: &str,
    #[case] fw_lookup: &str,
    _setup: (),
) {
    let connection = Connection::system()
        .await
        .expect("failed to create connection");
    let control_proxy = control_proxy::ControlProxy::new(&connection)
        .await
        .expect("failed to create control proxy");
    let status_proxy = status_proxy::StatusProxy::new(&connection)
        .await
        .expect("failed to create status proxy");

    control_proxy
        .set_fpga_flags(platform_handle, device_handle, 127)
        .await
        .expect("failed to set fpga flags");
    expect_that!(
        status_proxy
            .get_fpga_flags(platform_handle, device_handle)
            .await
            .expect("failed to get fpga flags"),
        eq("127"),
        "flags not 127 after setting to 127"
    );

    control_proxy
        .write_property("/sys/class/fpga_manager/fpga0/key", "")
        .await
        .expect("failed to reset the encryption key");
    let r = control_proxy
        .write_bitstream_direct(platform_handle, device_handle, bitstream_file, fw_lookup)
        .await;
    // TODO(upstream): this should not return an arbitrary custom xilinx error type, it should return a
    //  standard error
    assert_that!(&r, err(displays_as(contains_substring("os error"))));
    let s = status_proxy
        .get_fpga_state(platform_handle, device_handle)
        .await
        .expect("failed to get fpga state");
    // TODO: but this should be a custom xilinx error type of decimal: -1794
    expect_that!(s, contains_substring("write error: 0xfffff8fe"));

    // reset flags
    control_proxy
        .set_fpga_flags(platform_handle, device_handle, 0)
        .await
        .expect("failed to set fpga flags");
    expect_that!(
        status_proxy
            .get_fpga_flags(platform_handle, device_handle)
            .await
            .expect("failed to get fpga flags"),
        eq("0")
    );
}