metadata.hpp

Go to the documentation of this file.

//
// Copyright 2010-2012,2014 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#pragma once

#include <uhd/config.hpp>
#include <uhd/types/time_spec.hpp>
#include <stdint.h>
#include <string>

namespace uhd {

struct UHD_API rx_metadata_t
{
    rx_metadata_t()
    {
        reset();
    }

    void reset()
    {
        has_time_spec       = false;
        time_spec           = time_spec_t(0.0);
        more_fragments      = false;
        fragment_offset     = 0;
        start_of_burst      = false;
        end_of_burst        = false;
        eov_positions       = nullptr;
        eov_positions_size  = 0;
        eov_positions_count = 0;
        error_code          = ERROR_CODE_NONE;
        out_of_sequence     = false;
    }

    bool has_time_spec;

    time_spec_t time_spec;

    bool more_fragments;

    size_t fragment_offset;

    bool start_of_burst;

    bool end_of_burst;

    size_t* eov_positions;
    size_t eov_positions_size;

    size_t eov_positions_count;

    enum error_code_t {
        ERROR_CODE_NONE = 0x0,
        ERROR_CODE_TIMEOUT = 0x1,
        ERROR_CODE_LATE_COMMAND = 0x2,
        ERROR_CODE_BROKEN_CHAIN = 0x4,
        ERROR_CODE_OVERFLOW = 0x8,
        ERROR_CODE_ALIGNMENT = 0xc,
        ERROR_CODE_BAD_PACKET = 0xf
    } error_code;

    bool out_of_sequence;

    std::string to_pp_string(bool compact = true) const;

    std::string strerror(void) const;
};

struct UHD_API tx_metadata_t
{
    bool has_time_spec;

    time_spec_t time_spec;

    bool start_of_burst;

    bool end_of_burst;

    size_t* eov_positions     = nullptr;
    size_t eov_positions_size = 0;

    tx_metadata_t(void);
};

struct UHD_API async_metadata_t
{
    size_t channel;

    bool has_time_spec;

    time_spec_t time_spec;

    enum event_code_t {
        EVENT_CODE_BURST_ACK = 0x1,
        EVENT_CODE_UNDERFLOW = 0x2,
        EVENT_CODE_SEQ_ERROR = 0x4,
        EVENT_CODE_TIME_ERROR = 0x8,
        EVENT_CODE_UNDERFLOW_IN_PACKET = 0x10,
        EVENT_CODE_SEQ_ERROR_IN_BURST = 0x20,
        EVENT_CODE_USER_PAYLOAD = 0x40
    } event_code;

    uint32_t user_payload[4];
};

} // namespace uhd