/**************************************************************************
*
* Copyright (c) 2025-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    StateTxRecirc.h
*
* @author  (last)      Praneeth Bunne
* @date    (last)      29-Jun-2026
*
* @author  (original)  Praneeth Bunne
* @date    (original)  29-Jun-2026
*
***************************************************************************/

#ifndef __STATE_TX_RECIRC_H__
#define __STATE_TX_RECIRC_H__

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

/**
 *  @defgroup StateTxRecirc StateTxRecirc
 *  @brief Treatment Recirc state unit.
 *
 *  @addtogroup StateTxRecirc
 *  @{
 */

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

/// Payload record structure for treatment recirculate mode data broadcast message
typedef struct
{
    U32 countdown;                          ///< Recirculation timeout countdown (in seconds)
} TREATMENT_RECIRC_PAYLOAD_T;

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

void initTreatmentRecirc( void );
void transitionToTreatmentRecirc( void );
void execTreatmentRecirc( void );

BOOL signalTreatmentRecircUserAction( MESSAGE_T *message );
TREATMENT_RECIRC_STATE_T getCurrentTreatmentRecircState( void );

/**@}*/

#endif