event.h

Go to the documentation of this file.

 
#ifndef ICARUS_EVENT_H
#define ICARUS_EVENT_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
 
/* ---- Severity levels ---------------------------------------------------- */
 
typedef enum {
    EVENT_DEBUG    = 0,
    EVENT_INFO     = 1,
    EVENT_WARN     = 2,
    EVENT_CRITICAL = 3
} event_severity_t;
 
/* ---- Sizing ------------------------------------------------------------- */
 
#ifndef EVENT_MOD_MAX
#define EVENT_MOD_MAX        16
#endif
 
#ifndef EVENT_RING_SIZE
#define EVENT_RING_SIZE      32
#endif
 
/* ---- Event entry: 4B header + 12B payload = 16B ------------------------- */
 
typedef struct {
    uint8_t  module_id;
    uint8_t  severity;       /* event_severity_t */
    uint16_t event_id;
    uint8_t  payload[12];
} __attribute__((packed)) event_entry_t;
 
#ifndef SKIP_STATIC_ASSERTS
_Static_assert(sizeof(event_entry_t) == 16, "event_entry_t must be 16 bytes");
#endif
 
/* ---- Public API --------------------------------------------------------- */
 
void event_init(void);
 
void os_event(uint8_t module_id, event_severity_t severity, uint16_t event_id,
              const void *payload, uint8_t payload_len);
 
void event_set_squelch(uint8_t module_id, event_severity_t min_severity);
 
event_severity_t event_get_squelch(uint8_t module_id);
 
bool event_drain(event_entry_t *out_buf, uint8_t max_entries,
                 uint8_t *num_drained);
 
uint32_t event_get_count(void);
 
/* ---- Privileged implementations (internal — do not call directly) ----- */
 
void __event_init(void);
void __os_event(uint8_t module_id, event_severity_t severity, uint16_t event_id,
                const void *payload, uint8_t payload_len);
void __event_set_squelch(uint8_t module_id, event_severity_t min_severity);
event_severity_t __event_get_squelch(uint8_t module_id);
bool __event_drain(event_entry_t *out_buf, uint8_t max_entries,
                   uint8_t *num_drained);
uint32_t __event_get_count(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ICARUS_EVENT_H */