fota_packet.h

#pragma once
 
/************************************************************************************************
 * @file   fota_packet.h
 *
 * @brief  Packet implementation for firmware over the air (FOTA) updates
 *
 * @date   2025-03-16
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "fota_error.h"
 
#define FOTA_PACKET_SOF 0xAAU
#define FOTA_PACKET_EOF 0xBBU
#define FOTA_PACKET_PAYLOAD_SIZE 128U
#define FOTA_PACKET_HEADER_SIZE (1U + 1U + 4U + 1U + 2U)
#define FOTA_PACKET_SERIALIZED_SIZE (FOTA_PACKET_HEADER_SIZE + FOTA_PACKET_PAYLOAD_SIZE + 4U + 1U)
#define FOTA_PACKET_MINIMUM_SIZE FOTA_PACKET_SERIALIZED_SIZE
 
typedef enum {
  FOTA_PACKET_TYPE_DATA = 0, 
  FOTA_PACKET_TYPE_HEADER,   
  FOTA_PACKET_TYPE_ACK,      
  FOTA_PACKET_TYPE_NACK,     
  FOTA_PACKET_TYPE_ERROR     
} FotaPacketType;
 
typedef struct {
  uint8_t sof;                               
  FotaPacketType packet_type;                
  uint32_t datagram_id;                      
  uint8_t sequence_num;                      
  uint16_t payload_length;                   
  uint8_t payload[FOTA_PACKET_PAYLOAD_SIZE]; 
  uint32_t crc32;                            
  uint8_t eof;                               
} FotaPacket;
 
FotaError fota_packet_init(FotaPacket *packet, FotaPacketType type, uint8_t sequence, uint16_t length);
 
FotaError fota_packet_set_crc(FotaPacket *packet);
 
FotaError fota_packet_serialize(FotaPacket *packet, uint8_t *buffer, uint32_t buf_size, uint32_t *bytes_written);
 
FotaError fota_packet_deserialize(FotaPacket *packet, uint8_t *buffer, uint32_t buf_size);