/**************************************************************************
*
* Copyright (c) 2020-2023 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    TestSupport.h
*
* @author  (last)      Michael Garthwaite
* @date    (last)      01-Feb-2023
*
* @author  (original)  Sean
* @date    (original)  11-Feb-2020
*
***************************************************************************/

#ifndef __TEST_SUPPORT_H__
#define __TEST_SUPPORT_H__

/**
 *  @defgroup TestSupport TestSupport
 *  @brief Test support header file. Contains the structures and macros for override operations.
 *
 *  @addtogroup TestSupport
 *  @{
 */

// ***************************** OVERRIDE DEFINITIONS & MACROS *************************************

#define OVERRIDE_KEY    0xCCC33C33          ///< Override key
#define OVERRIDE_RESET  0x00000000          ///< Override reset

#pragma pack(push,1)

/// Test override payload type union.
typedef union
{
    U32 u32;                                ///< U32
    F32 f32;                                ///< F32
} TEST_OVERRIDE_PAYLOAD_TYPE_T;

/// Test override payload type structure.
typedef struct
{
    BOOL reset;                             ///< Reset (bool)
    TEST_OVERRIDE_PAYLOAD_TYPE_T state;     ///< Test override payload
} TEST_OVERRIDE_PAYLOAD_T;

/// Test override array payload structure.
typedef struct
{
    BOOL reset;                             ///< Reset (bool)
    TEST_OVERRIDE_PAYLOAD_TYPE_T state;     ///< Test override array payload
    U32 index;                              ///< Index
} TEST_OVERRIDE_ARRAY_PAYLOAD_T;

#pragma pack(pop)

/// Override U32 structure.
typedef struct
{
    U32 data;                               ///< Data
    U32 ovInitData;                         ///< Override init data
    U32 ovData;                             ///< Override data
    U32 override;                           ///< Override
} OVERRIDE_U32_T;

/// Override S32 structure.
typedef struct
{
    S32 data;                               ///< Data
    S32 ovInitData;                         ///< Override init data
    S32 ovData;                             ///< Override data
    U32 override;                           ///< Override
} OVERRIDE_S32_T;

/// Override F32 structure.
typedef struct
{
    F32 data;                               ///< Data
    F32 ovInitData;                         ///< Override init data
    F32 ovData;                             ///< Overrode data
    U32 override;                           ///< Override
} OVERRIDE_F32_T;

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

U08 getU08OverrideValue( OVERRIDE_U32_T *ovU32 );
U16 getU16OverrideValue( OVERRIDE_U32_T *ovU32 );
U32 getU32OverrideValue( OVERRIDE_U32_T *ovU32 );
S32 getS32OverrideValue( OVERRIDE_S32_T *ovS32 );
F32 getF32OverrideValue( OVERRIDE_F32_T *ovF32 );

/**@}*/

#endif