ra8_ipc_xfer.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_ipc_regs.h"
#include "ra8_ipc_types.h"
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ipc_init(const ra8_ipc_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_ipc_deinit(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_ipc_reset_fifo(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_ipc_set_event_mask(uint8_t channel, uint32_t mask);
 
/* =============================================================================
 * Channel-pair convention helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_ipc_channel_for_send(ra8_ipc_core_id_t core, uint8_t pair, uint8_t* out_channel);

[[nodiscard]] ra8_err_t
ra8_ipc_channel_for_recv(ra8_ipc_core_id_t core, uint8_t pair, uint8_t* out_channel);
 
/* =============================================================================
 * Send / receive
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ipc_send_event(uint8_t channel, ra8_ipc_irq_event_id_t event_id);

[[nodiscard]] ra8_err_t ra8_ipc_clear_event(uint8_t channel, ra8_ipc_irq_event_id_t event_id);

[[nodiscard]] ra8_err_t ra8_ipc_send_message(uint8_t channel, uint32_t message);

[[nodiscard]] ra8_err_t
ra8_ipc_send_message_retry(uint8_t channel, uint32_t message, uint16_t max_retries);

[[nodiscard]] ra8_err_t
ra8_ipc_send_burst(uint8_t channel, const uint32_t* data, uint32_t count, uint32_t* out_written);

[[nodiscard]] ra8_err_t ra8_ipc_recv_message(uint8_t channel, uint32_t* out_msg);

[[nodiscard]] ra8_err_t
ra8_ipc_recv_message_retry(uint8_t channel, uint32_t* out_msg, uint16_t max_retries);

[[nodiscard]] ra8_err_t
ra8_ipc_recv_burst(uint8_t channel, uint32_t* out_data, uint32_t capacity, uint32_t* out_read);
 
/* =============================================================================
 * Status / errors
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ipc_get_status(uint8_t channel, uint32_t* out_sta);

[[nodiscard]] ra8_err_t ra8_ipc_clear_status(uint8_t channel, uint32_t mask);

[[nodiscard]] ra8_err_t ra8_ipc_clear_errors(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_ipc_can_send(uint8_t channel, bool* out_can_send);

[[nodiscard]] ra8_err_t ra8_ipc_has_data(uint8_t channel, bool* out_has_data);
 
/* =============================================================================
 * Security / privilege attribution
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ipc_get_attribution(uint8_t channel, ra8_ipc_attr_t* out_attr);

[[nodiscard]] ra8_err_t ra8_ipc_get_nmi_attribution(uint8_t unit, ra8_ipc_attr_t* out_attr);

[[nodiscard]] ra8_err_t ra8_ipc_get_sem_attribution(ra8_ipc_sem_attr_group_t group,
                                                    ra8_ipc_attr_t*          out_attr);

[[nodiscard]] ra8_err_t
ra8_ipc_can_access(uint8_t channel, ra8_ipc_attr_t const* required, bool* out_can_access);
 
#ifdef __cplusplus
}
#endif