aboutsummaryrefslogtreecommitdiffstats
path: root/host/include/uhd/usrp/tune_helper.hpp
blob: db12241c13dffd6ed6731aff7297809d81651ce8 (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
//
// Copyright 2010 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY 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/>.
//

#ifndef INCLUDED_UHD_USRP_TUNE_HELPER_HPP
#define INCLUDED_UHD_USRP_TUNE_HELPER_HPP

#include <uhd/config.hpp>
#include <uhd/wax.hpp>
#include <uhd/types/tune_request.hpp>
#include <uhd/types/tune_result.hpp>

namespace uhd{ namespace usrp{

    /*!
     * Tune a rx chain to the desired frequency:
     * The IF of the subdevice is set as close as possible to
     * the given target frequency + the LO offset (when applicable).
     * The ddc cordic is setup to bring the IF down to baseband.
     * \param subdev the dboard subdevice object with properties
     * \param ddc the mboard dsp object with properties
     * \param chan the channel of the dsp to tune
     * \param tune_request tune request instructions
     * \return a tune result struct
     */
    UHD_API tune_result_t tune_rx_subdev_and_dsp(
        wax::obj subdev, wax::obj ddc, size_t chan,
        const tune_request_t &tune_request
    );

    /*!
     * Calculate the overall frequency from the combination of dboard IF and DDC shift.
     * \param subdev the dboard subdevice object with properties
     * \param ddc the mboard dsp object with properties
     * \param chan the channel of the dsp to tune
     * \return the overall tune frequency of the system in Hz
     */
    UHD_API double derive_freq_from_rx_subdev_and_dsp(
        wax::obj subdev, wax::obj ddc, size_t chan
    );

    /*!
     * Tune a tx chain to the desired frequency:
     * The IF of the subdevice is set as close as possible to
     * the given target frequency + the LO offset (when applicable).
     * The duc cordic is setup to bring the baseband up to IF.
     * \param subdev the dboard subdevice object with properties
     * \param duc the mboard dsp object with properties
     * \param chan the channel of the dsp to tune
     * \param tune_request tune request instructions
     * \return a tune result struct
     */
    UHD_API tune_result_t tune_tx_subdev_and_dsp(
        wax::obj subdev, wax::obj duc, size_t chan,
        const tune_request_t &tune_request
    );

    /*!
     * Calculate the overall frequency from the combination of dboard IF and DUC shift.
     * \param subdev the dboard subdevice object with properties
     * \param duc the mboard dsp object with properties
     * \param chan the channel of the dsp to tune
     * \return the overall tune frequency of the system in Hz
     */
    UHD_API double derive_freq_from_tx_subdev_and_dsp(
        wax::obj subdev, wax::obj duc, size_t chan
    );

}}

#endif /* INCLUDED_UHD_USRP_TUNE_HELPER_HPP */