queues.h

#pragma once
 
/************************************************************************************************
 * @file   queues.h
 *
 * @brief  Header file for the queue library
 *
 * @date   2024-11-02
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
 
/* Inter-component Headers */
#include "FreeRTOS.h"
#include "queue.h"
 
/* Intra-component Headers */
#include "status.h"
 
#define QUEUE_DELAY_BLOCKING 0xFFFFFFFFU
 
typedef struct {
  uint32_t num_items;   
  uint32_t item_size;   
  uint8_t *storage_buf; 
  StaticQueue_t queue;  
  QueueHandle_t handle; 
} Queue;
 
StatusCode queue_init(Queue *queue);
 
StatusCode queue_send(Queue *queue, const void *item, uint32_t delay_ms);
 
StatusCode queue_send_from_isr(Queue *queue, const void *item, BaseType_t *higher_prio_woken);
 
StatusCode queue_receive(Queue *queue, void *buf, uint32_t delay_ms);
 
StatusCode queue_receive_from_isr(Queue *queue, void *buf, BaseType_t *higher_prio_woken);
 
// Attempt to receive an item from the queue without removing it from the queue, delaying for
// delay_ms in ms before timing out.
 
StatusCode queue_peek(Queue *queue, void *buf, uint32_t delay_ms);
 
void queue_reset(Queue *queue);
 
uint32_t queue_get_num_items(Queue *queue);
 
uint32_t queue_get_spaces_available(Queue *queue);