/**************************************************************************
*
* Copyright (c) 2024-2025 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    AlarmAudio.h
*
* @author  (last)      Sean Nash
* @date    (last)      19-Sep-2024
*
* @author  (original)  Sean Nash
* @date    (original)  15-Aug-2024
*
***************************************************************************/

#ifndef __ALARM_AUDIO_H__
#define __ALARM_AUDIO_H__

#include "TDCommon.h"
#include "MessageSupport.h"

/**
 *  @defgroup AlarmAudio AlarmAudio
 *  @brief The Alarm Audio unit controls the audio for the alarm system.
 *  Provides functions for requesting alarm audio patterns and testing the
 *  alarm audio.
 *
 *  @addtogroup AlarmAudio
 *  @{
 */

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

#define MAX_ALARM_VOLUME_LEVEL                          5           ///< Maximum alarm audio level.
#define MAX_ALARM_VOLUME_ATTENUATION                    4           ///< Maximum alarm audio attenuation.
#define MIN_ALARM_VOLUME_ATTENUATION                    0           ///< Minimum alarm audio attenuation.

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

void initAlarmAudio( void );
void execAlarmAudio( void );

void setAlarmAudio( void );
void setAlarmAudioVolume( U32 volumeLevel );

U32 getAlarmAudioVolume( void );

F32 getAlarmAudioPrimaryHighGainCurrent( void );
F32 getAlarmAudioPrimaryLowGainCurrent( void );
F32 getAlarmAudioBackupCurrent( void );

SELF_TEST_STATUS_T execAlarmAudioSelfTest( void );
void resetAlarmAudioPOSTState( void );

BOOL testAlarmAudioVolumeLevelOverride( MESSAGE_T *message );
BOOL testPrimaryAlarmAudioCurrentHGOverride( MESSAGE_T *message );
BOOL testPrimaryAlarmAudioCurrentLGOverride( MESSAGE_T *message );
BOOL testBackupAlarmAudioCurrentOverride( MESSAGE_T *message );

/**@}*/

#endif