handler.h

Go to the documentation of this file.

 
#pragma once
 
#include "fl/stl/isr/constants.h"
#include "fl/stl/compiler_control.h"
#include "fl/stl/stdint.h"
#include "fl/stl/cstddef.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
namespace isr {

typedef void (*handler_fn)(void* user_data);

struct config {
    handler_fn handler;           // Handler function pointer
    void* user_data;              // User context (passed to handler)
    u32 frequency_hz;             // Timer frequency in Hz (0 = GPIO/external interrupt)
    u8 priority;                  // Priority level (platform-dependent range)
    u32 flags;                    // Platform-specific flags (see constants.h)
 
    config() FL_NO_EXCEPT
        : handler(nullptr)
        , user_data(nullptr)
        , frequency_hz(0)
        , priority(ISR_PRIORITY_DEFAULT)
        , flags(0)
    {}
};

struct handle {
    void* platform_handle;        // Platform-specific handle
    handler_fn handler;           // Handler function (for validation)
    void* user_data;              // User data (for validation)
    u8 platform_id;               // Platform identifier (for runtime checks)
 
    handle() FL_NO_EXCEPT
        : platform_handle(nullptr)
        , handler(nullptr)
        , user_data(nullptr)
        , platform_id(0)
    {}
 
    bool is_valid() const FL_NO_EXCEPT { return platform_handle != nullptr; }
};
 
// Backward-compatible type aliases
using isr_handler_t = handler_fn;
using isr_config_t = config;
using isr_handle_t = handle;

int attach_timer_handler(const config& cfg, handle* out_handle = nullptr) FL_NO_EXCEPT;

int attach_external_handler(u8 pin, const config& cfg, handle* out_handle = nullptr) FL_NO_EXCEPT;

int detach_handler(handle& h) FL_NO_EXCEPT;

int enable_handler(handle& h) FL_NO_EXCEPT;

int disable_handler(handle& h) FL_NO_EXCEPT;

bool is_handler_enabled(const handle& h) FL_NO_EXCEPT;

const char* get_error_string(int error_code) FL_NO_EXCEPT;

const char* get_platform_name() FL_NO_EXCEPT;

u32 get_max_timer_frequency() FL_NO_EXCEPT;

u32 get_min_timer_frequency() FL_NO_EXCEPT;

u8 get_max_priority() FL_NO_EXCEPT;

bool requires_assembly_handler(u8 priority) FL_NO_EXCEPT;
 
} // namespace isr
} // namespace fl