Index: TestSupport.h =================================================================== diff -u -rf152a1f8f051ffe9d501b39990e2876423ff0275 -r0f1d0c443daee3e30ae823711e85f3410bbf49fe --- TestSupport.h (.../TestSupport.h) (revision f152a1f8f051ffe9d501b39990e2876423ff0275) +++ TestSupport.h (.../TestSupport.h) (revision 0f1d0c443daee3e30ae823711e85f3410bbf49fe) @@ -1,72 +1,87 @@ /************************************************************************** * -* Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. +* Copyright (c) 2019-2021 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. +* 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 Common.h +* @file TestSupport.h * -* @date 19-Sep-2019 -* @author S. Nash +* @author (last) Sean Nash +* @date (last) 25-Aug-2020 * -* @brief Header file for common definitions and types. +* @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 -#define OVERRIDE_RESET 0x00000000 +#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; - F32 f32; + U32 u32; ///< U32 + F32 f32; ///< F32 } TEST_OVERRIDE_PAYLOAD_TYPE_T; +/// Test override payload type structure. typedef struct { - BOOL reset; - TEST_OVERRIDE_PAYLOAD_TYPE_T state; + 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; - TEST_OVERRIDE_PAYLOAD_TYPE_T state; - U32 index; + 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) -typedef struct \ -{ \ - U32 data; \ - U32 ovInitData; \ - U32 ovData; \ - U32 override; \ +/// Override U32 structure. +typedef struct +{ + U32 data; ///< Data + U32 ovInitData; ///< Override init data + U32 ovData; ///< Override data + U32 override; ///< Override } OVERRIDE_U32_T; -typedef struct \ -{ \ - S32 data; \ - S32 ovInitData; \ - S32 ovData; \ - U32 override; \ +/// Override S32 structure. +typedef struct +{ + S32 data; ///< Data + S32 ovInitData; ///< Override init data + S32 ovData; ///< Override data + U32 override; ///< Override } OVERRIDE_S32_T; -typedef struct \ -{ \ - F32 data; \ - F32 ovInitData; \ - F32 ovData; \ - U32 override; \ +/// Override F32 structure. +typedef struct +{ + F32 data; ///< Data + F32 ovInitData; ///< Override init data + F32 ovData; ///< Overrode data + U32 override; ///< Override } OVERRIDE_F32_T; // DATA_DECL - declares an overrideable data variable @@ -353,4 +368,6 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); \ } +/**@}*/ + #endif