notify.h

#pragma once
 
/************************************************************************************************
 * @file   notify.h
 *
 * @brief  Notify Library Header file
 *
 * @date   2024-11-05
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
 
/* Inter-component Headers */
#include "FreeRTOS.h"
 
/* Intra-component Headers */
#include "status.h"
#include "tasks.h"
 
/* Maximum block amount */
#define BLOCK_INDEFINITELY UINT16_MAX
 
/* Invalid event ID */
#define INVALID_EVENT 32
 
/* 8 bit value that represents a bit in the notification */
typedef uint8_t Event;
 
StatusCode event_from_notification(uint32_t *notification, Event *event);
 
bool notify_check_event(uint32_t *notification, Event event);
 
StatusCode notify_get(uint32_t *notification);
 
StatusCode notify_wait(uint32_t *notification, uint32_t ms_to_wait);
 
StatusCode notify(Task *task, Event event);
 
void notify_from_isr(Task *task, Event event);