ab_gp_channel.h

Go to the documentation of this file.

#ifndef RTE_EXAMPLE_AB_GP_CHANNEL_H
#define RTE_EXAMPLE_AB_GP_CHANNEL_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "rte/app/appmanager/rte_appmanager.h"
#include "rte/utils/status/rte_status.h"
 
#include "../../common/site_config.h"
#include "../../common/rbc_wire_types.h"
#include "ab_gp_channel_types.h"

typedef struct ab_gp_channel_context_s *ab_gp_channel_handle_t;

rte_status_t ab_gp_channel_open_link(bool is_role_a, rte_example_site_t site, ab_gp_channel_handle_t *out_handle);

void ab_gp_channel_close_link(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_train_codec_setup(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_ga_setup(ab_gp_channel_handle_t handle);

void ab_gp_channel_relay_queues_setup(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_negotiate_setup(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_checkpoint_setup(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_dual_setup(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_watchdog_setup(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_crosscompare_setup(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_cycle_timer_setup(ab_gp_channel_handle_t handle);

const rte_appmanager_checkpoint_config_t *ab_gp_channel_checkpoint_config(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_init(void *context);

rte_status_t ab_gp_channel_shutdown(void *context);

rte_status_t ab_gp_channel_wait_cycle_tick(ab_gp_channel_handle_t handle);

uint32_t ab_gp_channel_poll_relays(ab_gp_channel_handle_t handle, ab_gp_com_envelope_cb cb, void *user_ctx);

void ab_gp_channel_poll_peer(ab_gp_channel_handle_t handle, ab_gp_com_peer_frame_cb cb, void *user_ctx);

void ab_gp_channel_poll_crosscompare(ab_gp_channel_handle_t handle, ab_gp_com_peer_frame_cb cb, void *user_ctx);

rte_status_t ab_gp_channel_send_relay(ab_gp_channel_handle_t handle, rte_example_relay_kind_t kind,
                                     uint8_t index, const uint8_t *bytes, size_t size);

rte_status_t ab_gp_channel_send_peer(ab_gp_channel_handle_t handle, const uint8_t *bytes, size_t size);
ab_gp_saf_train_t *ab_gp_channel_saf_train(ab_gp_channel_handle_t handle);
rte_status_t ab_gp_channel_saf_train_setup(ab_gp_channel_handle_t handle);

rte_status_t ab_gp_channel_send_crosscompare(ab_gp_channel_handle_t handle, uint8_t kind, const uint8_t *payload, size_t size);

void ab_gp_channel_raise_ctc_alarm(ab_gp_channel_handle_t handle, rbc_alarm_severity_t severity, uint32_t code,
                                    const char *log_message);
 
#endif /* RTE_EXAMPLE_AB_GP_CHANNEL_H */