metadata.h

Go to the documentation of this file.

/*
 * Copyright 2015 Ettus Research
 * Copyright 2018 Ettus Research, a National Instruments Company
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

#pragma once

#include <uhd/config.h>
#include <uhd/error.h>

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <time.h>

#ifdef __cplusplus
#    include <uhd/types/metadata.hpp>
#    include <string>

struct uhd_rx_metadata_t
{
    uhd::rx_metadata_t rx_metadata_cpp;
    std::string last_error;
};

struct uhd_tx_metadata_t
{
    uhd::tx_metadata_t tx_metadata_cpp;
    std::string last_error;
};

struct uhd_async_metadata_t
{
    uhd::async_metadata_t async_metadata_cpp;
    std::string last_error;
};

extern "C" {
#else
struct uhd_rx_metadata_t;
struct uhd_tx_metadata_t;
struct uhd_async_metadata_t;
#endif


typedef struct uhd_rx_metadata_t* uhd_rx_metadata_handle;


typedef struct uhd_tx_metadata_t* uhd_tx_metadata_handle;


typedef struct uhd_async_metadata_t* uhd_async_metadata_handle;


typedef enum {
    UHD_RX_METADATA_ERROR_CODE_NONE = 0x0,
    UHD_RX_METADATA_ERROR_CODE_TIMEOUT = 0x1,
    UHD_RX_METADATA_ERROR_CODE_LATE_COMMAND = 0x2,
    UHD_RX_METADATA_ERROR_CODE_BROKEN_CHAIN = 0x4,
    UHD_RX_METADATA_ERROR_CODE_OVERFLOW = 0x8,
    UHD_RX_METADATA_ERROR_CODE_ALIGNMENT = 0xC,
    UHD_RX_METADATA_ERROR_CODE_BAD_PACKET = 0xF
} uhd_rx_metadata_error_code_t;


UHD_API uhd_error uhd_rx_metadata_make(uhd_rx_metadata_handle* handle);


UHD_API uhd_error uhd_rx_metadata_free(uhd_rx_metadata_handle* handle);

UHD_API uhd_error uhd_rx_metadata_has_time_spec(
    uhd_rx_metadata_handle h, bool* result_out);

UHD_API uhd_error uhd_rx_metadata_time_spec(
    uhd_rx_metadata_handle h, int64_t* full_secs_out, double* frac_secs_out);

UHD_API uhd_error uhd_rx_metadata_more_fragments(
    uhd_rx_metadata_handle h, bool* result_out);

UHD_API uhd_error uhd_rx_metadata_fragment_offset(
    uhd_rx_metadata_handle h, size_t* fragment_offset_out);

UHD_API uhd_error uhd_rx_metadata_start_of_burst(
    uhd_rx_metadata_handle h, bool* result_out);

UHD_API uhd_error uhd_rx_metadata_end_of_burst(
    uhd_rx_metadata_handle h, bool* result_out);

UHD_API uhd_error uhd_rx_metadata_out_of_sequence(
    uhd_rx_metadata_handle h, bool* result_out);


UHD_API uhd_error uhd_rx_metadata_to_pp_string(
    uhd_rx_metadata_handle h, char* pp_string_out, size_t strbuffer_len);

UHD_API uhd_error uhd_rx_metadata_error_code(
    uhd_rx_metadata_handle h, uhd_rx_metadata_error_code_t* error_code_out);


UHD_API uhd_error uhd_rx_metadata_strerror(
    uhd_rx_metadata_handle h, char* strerror_out, size_t strbuffer_len);


UHD_API uhd_error uhd_rx_metadata_last_error(
    uhd_rx_metadata_handle h, char* error_out, size_t strbuffer_len);

UHD_API uhd_error uhd_tx_metadata_make(uhd_tx_metadata_handle* handle,
    bool has_time_spec,
    int64_t full_secs,
    double frac_secs,
    bool start_of_burst,
    bool end_of_burst);



UHD_API uhd_error uhd_tx_metadata_free(uhd_tx_metadata_handle* handle);

UHD_API uhd_error uhd_tx_metadata_has_time_spec(
    uhd_tx_metadata_handle h, bool* result_out);

UHD_API uhd_error uhd_tx_metadata_time_spec(
    uhd_tx_metadata_handle h, int64_t* full_secs_out, double* frac_secs_out);

UHD_API uhd_error uhd_tx_metadata_start_of_burst(
    uhd_tx_metadata_handle h, bool* result_out);

UHD_API uhd_error uhd_tx_metadata_end_of_burst(
    uhd_tx_metadata_handle h, bool* result_out);


UHD_API uhd_error uhd_tx_metadata_last_error(
    uhd_tx_metadata_handle h, char* error_out, size_t strbuffer_len);


typedef enum {
    UHD_ASYNC_METADATA_EVENT_CODE_BURST_ACK = 0x1,
    UHD_ASYNC_METADATA_EVENT_CODE_UNDERFLOW = 0x2,
    UHD_ASYNC_METADATA_EVENT_CODE_SEQ_ERROR = 0x4,
    UHD_ASYNC_METADATA_EVENT_CODE_TIME_ERROR = 0x8,
    UHD_ASYNC_METADATA_EVENT_CODE_UNDERFLOW_IN_PACKET = 0x10,
    UHD_ASYNC_METADATA_EVENT_CODE_SEQ_ERROR_IN_BURST = 0x20,
    UHD_ASYNC_METADATA_EVENT_CODE_USER_PAYLOAD = 0x40
} uhd_async_metadata_event_code_t;

UHD_API uhd_error uhd_async_metadata_make(uhd_async_metadata_handle* handle);


UHD_API uhd_error uhd_async_metadata_free(uhd_async_metadata_handle* handle);

UHD_API uhd_error uhd_async_metadata_channel(
    uhd_async_metadata_handle h, size_t* channel_out);

UHD_API uhd_error uhd_async_metadata_has_time_spec(
    uhd_async_metadata_handle h, bool* result_out);

UHD_API uhd_error uhd_async_metadata_time_spec(
    uhd_async_metadata_handle h, int64_t* full_secs_out, double* frac_secs_out);

UHD_API uhd_error uhd_async_metadata_event_code(
    uhd_async_metadata_handle h, uhd_async_metadata_event_code_t* event_code_out);

UHD_API uhd_error uhd_async_metadata_user_payload(
    uhd_async_metadata_handle h, uint32_t user_payload_out[4]);


UHD_API uhd_error uhd_async_metadata_last_error(
    uhd_async_metadata_handle h, char* error_out, size_t strbuffer_len);

#ifdef __cplusplus
}
#endif