ra8_ipc_sync.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_err.h"
#include "ra8_ipc_regs.h"
#include "ra8_ipc_types.h"
 
/* =============================================================================
 * Cross-core ordering barrier
 * =============================================================================
 */

RA8_ISR_SAFE
static inline void ra8_ipc_barrier(void)
{
#ifndef RA8_OFF_TARGET
  __asm__ volatile("dmb 0xF" ::: "memory");
#endif
}
 
/* =============================================================================
 * Hardware semaphores (IPCSEM0..15)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ipc_sem_try_take(uint8_t sem_id);

[[nodiscard]] ra8_err_t ra8_ipc_sem_take_timeout(uint8_t sem_id, uint16_t max_spins);

[[nodiscard]] ra8_err_t ra8_ipc_sem_release(uint8_t sem_id);

[[nodiscard]] ra8_err_t ra8_ipc_sem_is_locked(uint8_t sem_id, bool* out_locked);
 
/* =============================================================================
 * NMI surface (IPC0NMI* / IPC1NMI*)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ipc_nmi_send(uint8_t unit);

[[nodiscard]] ra8_err_t ra8_ipc_nmi_clear(uint8_t unit);

[[nodiscard]] ra8_err_t ra8_ipc_nmi_get_status(uint8_t unit, bool* out_pending);

[[nodiscard]] ra8_err_t ra8_ipc_attach_nmi_handler(ra8_ipc_nmi_fn_t fn, void* ctx);

void ra8_ipc_dispatch_nmi(uint8_t unit);
 
/* =============================================================================
 * Interrupt path (maskable)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ipc_attach_handler(ra8_ipc_event_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t ra8_ipc_attach_event_handler(uint8_t                channel,
                                                     ra8_ipc_irq_event_id_t event_id,
                                                     ra8_ipc_irq_fn_t       fn,
                                                     void*                  ctx);

void ra8_ipc_dispatch(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_ipc_install_isr(uint8_t unit, uint8_t priority);

[[nodiscard]] ra8_err_t ra8_ipc_uninstall_isr(uint8_t unit);
 
/* =============================================================================
 * Shared-memory ring-buffer protocol primitives
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ipc_ring_init(ra8_ipc_ring_t* ring);

[[nodiscard]] ra8_err_t ra8_ipc_ring_produce(ra8_ipc_ring_t* ring, uint32_t payload);

[[nodiscard]] ra8_err_t ra8_ipc_ring_consume(ra8_ipc_ring_t* ring, uint32_t* out_payload);

[[nodiscard]] ra8_err_t ra8_ipc_ring_is_empty(const ra8_ipc_ring_t* ring, bool* out_empty);

[[nodiscard]] ra8_err_t ra8_ipc_ring_is_full(const ra8_ipc_ring_t* ring, bool* out_full);
 
#ifdef __cplusplus
}
#endif