vrt_if_packet.hpp

Go to the documentation of this file.

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

#ifndef INCLUDED_UHD_TRANSPORT_VRT_IF_PACKET_HPP
#define INCLUDED_UHD_TRANSPORT_VRT_IF_PACKET_HPP

#include <uhd/config.hpp>
#include <stdint.h>
#include <cstddef> //size_t

namespace uhd { namespace transport { namespace vrt {

static const size_t num_vrl_words32 = 3;

static const size_t max_if_hdr_words32 = 7; // hdr+sid+cid+tsi+tsf

struct UHD_API if_packet_info_t
{
    if_packet_info_t(void);

    // link layer type - always set for pack and unpack
    enum link_type_t {
        LINK_TYPE_NONE = 0x0,
        LINK_TYPE_CHDR = 0x1,
        LINK_TYPE_VRLP = 0x2
    } link_type;

    // packet type
    enum packet_type_t {
        // VRT language:
        PACKET_TYPE_DATA    = 0x0,
        PACKET_TYPE_IF_EXT  = 0x1,
        PACKET_TYPE_CONTEXT = 0x2, // extension context: has_sid = true

        // CHDR language:
        // PACKET_TYPE_DATA      = 0x0, // Data
        PACKET_TYPE_FC   = 0x1, // Flow control
        PACKET_TYPE_ACK  = 0x1, // Flow control (ack)
        PACKET_TYPE_CMD  = 0x2, // Command
        PACKET_TYPE_RESP = 0x3, // Command response
        PACKET_TYPE_ERROR =
            0x3 // Command response: Error (the EOB bit is raised in this case)
    } packet_type;

    // size fields
    size_t num_payload_words32; // required in pack, derived in unpack
    size_t num_payload_bytes; // required in pack, derived in unpack
    size_t num_header_words32; // derived in pack, derived in unpack
    size_t num_packet_words32; // derived in pack, required in unpack

    // header fields
    size_t packet_count;
    bool sob, eob;
    bool error;
    bool fc_ack;

    // optional fields
    bool has_sid;
    uint32_t sid;
    bool has_cid;
    uint64_t cid;
    bool has_tsi;
    uint32_t tsi;
    bool has_tsf;
    uint64_t tsf;
    bool has_tlr;
    uint32_t tlr;
};

UHD_API void if_hdr_pack_be(uint32_t* packet_buff, if_packet_info_t& if_packet_info);

UHD_API void if_hdr_unpack_be(
    const uint32_t* packet_buff, if_packet_info_t& if_packet_info);

UHD_API void if_hdr_pack_le(uint32_t* packet_buff, if_packet_info_t& if_packet_info);

UHD_API void if_hdr_unpack_le(
    const uint32_t* packet_buff, if_packet_info_t& if_packet_info);

UHD_INLINE if_packet_info_t::if_packet_info_t(void)
    : link_type(LINK_TYPE_NONE)
    , packet_type(PACKET_TYPE_DATA)
    , num_payload_words32(0)
    , num_payload_bytes(0)
    , num_header_words32(0)
    , num_packet_words32(0)
    , packet_count(0)
    , sob(false)
    , eob(false)
    , error(false)
    , fc_ack(false)
    , has_sid(false)
    , sid(0)
    , has_cid(false)
    , cid(0)
    , has_tsi(false)
    , tsi(0)
    , has_tsf(false)
    , tsf(0)
    , has_tlr(false)
    , tlr(0)
{
}

}}} // namespace uhd::transport::vrt

#endif /* INCLUDED_UHD_TRANSPORT_VRT_IF_PACKET_HPP */