ra8_ipc_types.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_ipc_regs.h"
 
/* =============================================================================
 * Public types
 * =============================================================================
 */

typedef enum : uint32_t {
  k_ra8_ipc_event_none      = 0x00000000U, 
  k_ra8_ipc_event_irq0      = 0x00000001U, 
  k_ra8_ipc_event_irq1      = 0x00000002U, 
  k_ra8_ipc_event_irq2      = 0x00000004U, 
  k_ra8_ipc_event_irq3      = 0x00000008U, 
  k_ra8_ipc_event_irq4      = 0x00000010U, 
  k_ra8_ipc_event_irq5      = 0x00000020U, 
  k_ra8_ipc_event_irq6      = 0x00000040U, 
  k_ra8_ipc_event_irq7      = 0x00000080U, 
  k_ra8_ipc_event_irq_all   = 0x000000FFU, 
  k_ra8_ipc_event_msg_ready = 0x00010000U, 
  k_ra8_ipc_event_fifo_full = 0x00020000U, 
  k_ra8_ipc_event_err_empty = 0x01000000U, 
  k_ra8_ipc_event_err_full  = 0x02000000U, 
} ra8_ipc_event_t;

typedef enum : uint8_t {
  k_ra8_ipc_irq_event_0 = 0U, 
  k_ra8_ipc_irq_event_1 = 1U, 
  k_ra8_ipc_irq_event_2 = 2U, 
  k_ra8_ipc_irq_event_3 = 3U, 
  k_ra8_ipc_irq_event_4 = 4U, 
  k_ra8_ipc_irq_event_5 = 5U, 
  k_ra8_ipc_irq_event_6 = 6U, 
  k_ra8_ipc_irq_event_7 = 7U, 
} ra8_ipc_irq_event_id_t;

typedef enum : uint16_t {
  k_ra8_ipc_retry_default = 16U,   
  k_ra8_ipc_retry_max     = 1024U, 
  k_ra8_ipc_sem_take_max  = 1024U, 
} ra8_ipc_retry_limits_t;

typedef struct {
  bool secure;     
  bool privileged; 
} ra8_ipc_attr_t;

typedef struct {
  uint8_t  channel;      
  bool     reset_fifo;   
  bool     clear_status; 
  uint32_t event_mask;   
} ra8_ipc_config_t;

typedef void (*ra8_ipc_event_fn_t)(void*    ctx,
                                   uint8_t  channel,
                                   uint32_t event_mask,
                                   uint32_t message);

typedef void (*ra8_ipc_irq_fn_t)(void* ctx, uint8_t channel, ra8_ipc_irq_event_id_t event_id);

typedef void (*ra8_ipc_nmi_fn_t)(void* ctx, uint8_t unit);

typedef struct {
  volatile uint32_t*     slots;     
  volatile uint32_t*     head;      
  volatile uint32_t*     tail;      
  uint32_t               capacity;  
  uint8_t                channel;   
  uint8_t                sem_id;    
  ra8_ipc_irq_event_id_t notify_id; 
} ra8_ipc_ring_t;