app_isched.h

/*$$$LICENCE_NORDIC_STANDARD<2016>$$$*/

#ifndef APP_ISCHED_H__
#define APP_ISCHED_H__

#include "nrf_queue.h"

// Forward declaration of __app_isched_struct.
struct __app_isched_struct;

typedef struct __app_isched_struct app_isched_t;

typedef void (*app_isched_event_handler_t)(void *p_context);

typedef struct
{
 app_isched_event_handler_t handler; 
 void *p_context; 
} app_isched_event_t;

typedef void (*app_isched_hook_t)(const app_isched_t *p_isched,
 const app_isched_event_t *p_evt,
 void *p_hook_context);

typedef enum
{
 APP_ISCHED_HOOK_PRE_PUT, 
 APP_ISCHED_HOOK_POST_PUT, 
 APP_ISCHED_HOOK_PRE_EXEC, 
 APP_ISCHED_HOOK_POST_EXEC, 
 // This must be the last value.
 APP_ISCHED_HOOKS_COUNT,
} app_isched_hook_type_t;

struct __app_isched_struct
{
 const nrf_queue_t *p_event_queue; 
 app_isched_hook_t hooks[APP_ISCHED_HOOKS_COUNT]; 
 void *p_hook_contexts[APP_ISCHED_HOOKS_COUNT]; 
};

#define APP_ISCHED_INIT_NAMED(_name, _isched, _queue_size) \
 do { \
 NRF_QUEUE_DEF(app_isched_event_t, _name##_queue, _queue_size, NRF_QUEUE_MODE_NO_OVERFLOW); \
 (_isched)->p_event_queue = &_name##_queue; \
 \
 for (unsigned int i = 0; i < APP_ISCHED_HOOKS_COUNT; i++) \
 { \
 (_isched)->hooks[i] = NULL; \
 } \
 } while (0)

#define APP_ISCHED_INIT(_isched, _queue_size) \
 APP_ISCHED_INIT_NAMED(/* empty */, _isched, _queue_size)

ret_code_t app_isched_event_put(app_isched_t *p_isched,
 app_isched_event_handler_t handler,
 void *p_context);

ret_code_t app_isched_events_execute(app_isched_t *p_isched);

ret_code_t app_isched_install_hook(app_isched_t *p_isched,
 app_isched_hook_type_t hook_type,
 app_isched_hook_t hook,
 void *p_hook_context);

size_t app_isched_get_max_utilization(const app_isched_t *p_isched);

#endif // APP_ISCHED_H__