/**************************************************************************
*
* Copyright (c) 2019-2022 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    ModeService.h
*
* @author  (last)      Michael Garthwaite
* @date    (last)      28-Jul-2022
*
* @author  (original)  Dara Navaei
* @date    (original)  05-Nov-2019
*
***************************************************************************/

#ifndef __MODE_SERVICE_H__
#define __MODE_SERVICE_H__

#include "DGCommon.h"
#include "DGDefs.h"
#include "ModeFault.h"

/**
 *  @defgroup DGServiceMode DGServiceMode
 *  @brief Service mode module. Manages service mode functions via a state machine.
 *
 *  @addtogroup DGServiceMode
 *  @{
 */

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

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

void initServiceMode( void );          // initialize this module
U32  transitionToServiceMode( void );  // prepares for transition to service mode
U32  execServiceMode( void );          // execute the service mode state machine (call from OperationModes)

DG_SERVICE_STATE_T getCurrentServiceState( void );  // get the current state of the service mode.

/**@}*/

#endif