/**************************************************************************
*
* Copyright (c) 2026-2026 Diality Inc. - All Rights Reserved.
*
* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN
* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER.
*
* @file    Prime.h
*
* @author  (last)      Praneeth Bunne
* @date    (last)      16-Jul-2026
*
* @author  (original)  Praneeth Bunne
* @date    (original)  16-Jul-2026
*
***************************************************************************/

#ifndef __PRIME_H__
#define __PRIME_H__

#include "TDCommon.h"
#include "TDDefs.h"

/**
 *  @defgroup Prime Prime
 *  @brief Prime provides blood circuit and dialysate circuit priming
 *  service to Pre-Treatment and Treatment modes.
 *
 *  @addtogroup Prime
 *  @{
 */

// ********** public definitions **********

/// Payload record structure for a priming status data broadcast message.
typedef struct
{
    U32  primeState;            ///< Current Prime state
    U32  totalDurationSec;      ///< Total allowed prime duration
    U32  countDownSec;          ///< Remaining time before total duration
    U32  pauseCountdownSec;     ///< Remaining time before pause timeout
} PRIMING_DATA_PAYLOAD_T;

// ********** public function prototypes **********

void initPrime( void );                         // Initialize prime sub-mode (of pre-treatment mode).
void execPrime( void );                         // Execute the prime state machine.
TD_PRIME_STATE_T getCurrentPrimeState( void );  // Get the current state of the prime state machine.

void signalResumePrime( void );                 // User has requested to resume prime

/**@}*/

#endif