network_buffer.h

#pragma once
 
/************************************************************************************************
 * @file   network_buffer.h
 *
 * @brief  Circular Buffer class implementation for firmware over the air (FOTA) updates
 *
 * @date   2025-03-16
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "fota_error.h"
 
#define NETWORK_BUFFER_SIZE 1024U
 
typedef struct {
  uint8_t data[NETWORK_BUFFER_SIZE];
  uint16_t num_items;
  uint16_t write_index;
  uint16_t read_index;
} NetworkBuffer;
 
FotaError network_buffer_init(NetworkBuffer *network_buffer);
 
uint16_t network_buffer_num_items(NetworkBuffer *network_buffer);
 
uint16_t network_buffer_num_empty_slots(NetworkBuffer *network_buffer);
 
bool network_buffer_empty(NetworkBuffer *network_buffer);
 
bool network_buffer_full(NetworkBuffer *network_buffer);
 
FotaError network_buffer_write(NetworkBuffer *network_buffer, uint8_t *data);
 
FotaError network_buffer_read(NetworkBuffer *network_buffer, uint8_t *data);