rte_dual_channel.h

Go to the documentation of this file.

#ifndef RTE_DUAL_CHANNEL_H
#define RTE_DUAL_CHANNEL_H
 
#include <stdint.h>
#include <stdbool.h>
 
#include "rte/redundancy/dual/rte_dual_frames.h"
#include "rte/redundancy/dual/rte_dual_msgchannel.h"
#include "rte/redundancy/dual/rte_dual_types.h"
#include "rte/oal/netlink/rte_netlink.h"
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define RTE_DUAL_CHANNEL_MAX_LINKS 4U

#define RTE_DUAL_CHANNEL_MAX_PAYLOAD (RTE_DUAL_MSGCHANNEL_MAX_PAYLOAD - 4U)

typedef void (*rte_dual_channel_status_callback_t)(rte_dual_channel_status_t new_status,
                                                      rte_dual_channel_status_t old_status,
                                                      void *user_ctx);

typedef struct rte_dual_channel_s
{
    rte_dual_msgchannel_t links[RTE_DUAL_CHANNEL_MAX_LINKS];
    uint32_t                link_count;
    bool                    link_up[RTE_DUAL_CHANNEL_MAX_LINKS];
    rte_dual_channel_status_t last_status;
    rte_dual_channel_status_callback_t status_callback;
    void                   *status_callback_ctx;
    rte_duration_ms_t      ack_timeout_ms;
 
    bool    pending_data_valid;
    uint8_t pending_data[RTE_DUAL_CHANNEL_MAX_PAYLOAD];
    uint8_t pending_data_size;
 
    bool                    pending_state_valid;
    rte_dual_state_frame_t pending_state;
} rte_dual_channel_t;

typedef struct rte_dual_channel_config_s
{
    rte_netlink_handle_t links[RTE_DUAL_CHANNEL_MAX_LINKS];
    uint32_t link_count;
    uint32_t sender_id;
    uint32_t expected_peer_id;
    rte_duration_ms_t ack_timeout_ms;
    rte_dual_channel_status_callback_t status_callback;
    void *status_callback_ctx;
} rte_dual_channel_config_t;

rte_status_t rte_dual_channel_init(rte_dual_channel_t *channel, const rte_dual_channel_config_t *config);

rte_status_t rte_dual_channel_send(rte_dual_channel_t *channel,
                                      const uint8_t *payload,
                                      uint8_t payload_size,
                                      uint32_t *out_ack_link_count);

rte_status_t rte_dual_channel_receive(rte_dual_channel_t *channel,
                                         uint8_t *out_payload,
                                         uint8_t max_size,
                                         rte_duration_ms_t timeout_ms,
                                         uint8_t *out_size);

rte_status_t rte_dual_channel_send_heartbeat(rte_dual_channel_t *channel, uint32_t *out_ack_count);

rte_status_t rte_dual_channel_send_state_frame(rte_dual_channel_t *channel, rte_dual_state_t state,
                                                   bool channel_degraded, uint64_t timestamp_ms);

rte_status_t rte_dual_channel_receive_state_frame(rte_dual_channel_t *channel, rte_duration_ms_t timeout_ms,
                                                      rte_dual_state_frame_t *out_frame);

rte_dual_channel_status_t rte_dual_channel_get_status(const rte_dual_channel_t *channel);

bool rte_dual_channel_is_link_up(const rte_dual_channel_t *channel, uint32_t link_index);

rte_status_t rte_dual_channel_set_resync_on_sequence_error(rte_dual_channel_t *channel, bool enable);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_DUAL_CHANNEL_H */