aboutsummaryrefslogtreecommitdiffstats
path: root/host/lib/rfnoc/registry_factory.cpp
blob: 117b60e96ee120ae9c2db14f50c55c1c5f51a9d2 (plain)
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
//
// Copyright 2019 Ettus Research, a National Instruments Brand
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#include <uhd/exception.hpp>
#include <uhd/rfnoc/registry.hpp>
#include <uhd/rfnoc/defaults.hpp>
#include <uhd/utils/static.hpp>
#include <uhdlib/rfnoc/factory.hpp>
#include <unordered_map>
#include <iomanip>
#include <iostream>
#include <sstream>

using namespace uhd::rfnoc;

///////////////////////////////////////////////////////////////////////////////
// There are two registries:
// - The "direct" registry, which is for blocks that do not have a block
//   descriptor file
// - The "descriptor" registry, which is for blocks that *do* have a block
//   descriptor file
//
// This is the direct registry:
using block_direct_reg_t =
    std::unordered_map<noc_block_base::noc_id_t, block_factory_info_t>;
UHD_SINGLETON_FCN(block_direct_reg_t, get_direct_block_registry);
//
// This is the descriptor registry:
using block_descriptor_reg_t =
    std::unordered_map<std::string /* block_key */, registry::factory_t>;
UHD_SINGLETON_FCN(block_descriptor_reg_t, get_descriptor_block_registry);
///////////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////////
// These registries are for blocks that have requested motherboard access
using block_direct_mb_access_req_t = std::unordered_set<noc_block_base::noc_id_t>;
UHD_SINGLETON_FCN(block_direct_mb_access_req_t, get_direct_block_mb_access_requested);
//
// This is the descriptor registry:
using block_descriptor_mb_access_req_t = std::unordered_set<std::string>;
UHD_SINGLETON_FCN(
    block_descriptor_mb_access_req_t, get_descriptor_block_mb_access_requested);
///////////////////////////////////////////////////////////////////////////////

/******************************************************************************
 * Registry functions
 *
 * Note: Don't use UHD_LOG_*, since all of this can be executed in a static
 * fashion.
 *****************************************************************************/
void registry::register_block_direct(noc_block_base::noc_id_t noc_id,
    const std::string& block_name,
    const std::string& timebase_clock,
    const std::string& ctrlport_clock,
    factory_t factory_fn)
{
    if (get_direct_block_registry().count(noc_id)) {
        std::cerr
            << "[REGISTRY] WARNING: Attempting to overwrite previously registered RFNoC "
               "block with Noc-ID 0x"
            << std::hex << noc_id << std::dec << std::endl;
        return;
    }
    get_direct_block_registry().emplace(noc_id,
        block_factory_info_t{
            block_name, timebase_clock, ctrlport_clock, std::move(factory_fn)});
}

void registry::register_block_descriptor(
    const std::string& block_key, factory_t factory_fn)
{
    if (get_descriptor_block_registry().count(block_key)) {
        std::cerr << "WARNING: Attempting to overwriting previously registered RFNoC "
                     "block with block key"
                  << block_key << std::endl;
        return;
    }
    get_descriptor_block_registry().emplace(block_key, std::move(factory_fn));
}

void registry::request_mb_access(noc_block_base::noc_id_t noc_id)
{
    if (!get_direct_block_mb_access_requested().count(noc_id)) {
        get_direct_block_mb_access_requested().emplace(noc_id);
    }
}

void registry::request_mb_access(const std::string& block_key)
{
    if (!get_descriptor_block_mb_access_requested().count(block_key)) {
        get_descriptor_block_mb_access_requested().emplace(block_key);
    }
}

/******************************************************************************
 * Factory functions
 *****************************************************************************/
block_factory_info_t factory::get_block_factory(noc_block_base::noc_id_t noc_id)
{
    // First, check the descriptor registry
    // FIXME TODO

    // Second, check the direct registry
    if (!get_direct_block_registry().count(noc_id)) {
        UHD_LOG_WARNING("RFNOC::BLOCK_FACTORY",
            "Could not find block with Noc-ID "
                << std::hex << std::setw(sizeof(noc_block_base::noc_id_t) * 2) << noc_id);
        noc_id = DEFAULT_NOC_ID;
    }
    return get_direct_block_registry().at(noc_id);
}

bool factory::has_requested_mb_access(noc_block_base::noc_id_t noc_id)
{
    if (get_direct_block_mb_access_requested().count(noc_id)) {
        return true;
    }

    // FIXME tbw:
    // - Map noc_id to block key
    // - Check that key's descriptor
    // - If that block has requested MB access, stash the noc ID in
    // get_direct_block_mb_access_requested() for faster lookups in the future

    return false;
}