fota_datagram.h

#pragma once
 
/************************************************************************************************
 * @file    fota_datagram.h
 *
 * @brief   Fota Datagram Header File
 *
 * @date    2025-04-30
 * @author  Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "fota_packet.h"
 
#define FOTA_MAX_DATAGRAM_SIZE (16U * FOTA_PACKET_PAYLOAD_SIZE)
 
#define FOTA_MAX_PACKETS_PER_DATAGRAM ((FOTA_MAX_DATAGRAM_SIZE / FOTA_PACKET_PAYLOAD_SIZE) + 1U)
 
#define FOTA_DATAGRAM_HEADER_PAYLOAD_SIZE 10U
 
typedef enum FotaDatagramType {
  FOTA_DATAGRAM_TYPE_FIRMWARE_METADATA, 
  FOTA_DATAGRAM_TYPE_FIRMWARE_CHUNK,    
  FOTA_DATAGRAM_TYPE_JUMP_TO_APP,       
  FOTA_DATAGRAM_TYPE_ACKNOWLEDGEMENT,   
  FOTA_DATAGRAM_TYPE_ERROR
} FotaDatagramType;
 
typedef struct {
  uint8_t target_node_id;  
  FotaDatagramType type;   
  uint16_t num_packets;    
  uint32_t datagram_id;    
  uint32_t total_length;   
  uint32_t datagram_crc32; 
  uint32_t packet_crc32;   
} FotaDatagramHeaderPacketPayload;
 
typedef struct {
  FotaDatagramHeaderPacketPayload header;              
  uint8_t data[FOTA_MAX_DATAGRAM_SIZE];                
  bool packet_received[FOTA_MAX_PACKETS_PER_DATAGRAM]; 
  uint16_t packets_received;                           
  bool is_complete;                                    
} FotaDatagram;
 
FotaError fota_datagram_init(FotaDatagram *datagram, FotaDatagramType type, uint32_t datagram_id, uint8_t *data, uint32_t length);
 
FotaError fota_datagram_to_packets(FotaDatagram *datagram, FotaPacket *packets, uint16_t *num_packets, uint16_t max_packets);
 
FotaError fota_datagram_process_data_packet(FotaDatagram *datagram, FotaPacket *packet);
 
FotaError fota_datagram_process_header_packet(FotaDatagram *datagram, FotaPacket *packet);
 
bool fota_datagram_is_complete(FotaDatagram *datagram);
 
FotaError fota_datagram_verify(FotaDatagram *datagram);