/**
*   @copyright       © 2026 Microchip Technology Inc.
    Microchip Technology Inc. and its subsidiaries. You may use this
    software and any derivatives exclusively with Microchip products.

    THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
    EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
    WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
    PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION
    WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION.

    IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
    WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
    BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
    FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
    ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
    THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.

    MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE
    TERMS. 
*
*************************************************************************/

/*************************************************************************
 *  @file           diag_pc.h
 *  @version       	1.0
 *  @brief     		This file has the declarations for the program counter
 *                  diagnostic tests.
 *************************************************************************/

/**
 * @defgroup functions Functions
 * @defgroup macros Macros
 * @defgroup errorcodes ErrorCodes
 * @defgroup enums Enums
*/
 
#ifndef DIAG_PC_H
#define DIAG_PC_H

#include "diag.h"

/**
 * @ingroup functions
 * @brief **Software Requirement Reference ID : SW_PROGRAM_COUNTER_TEST**
 *
 * This diagnostic API verifies the program counter as it progresses through the code. The API repeatedly calls three internal helper functions
 * to indicate that those functions have been touched, a counter variable is 
 * updated and the updated value is verified at the end of the API for the correct 
 * value to indicate a PASS/FAIL.
 * @param void
 * @return @ref DIAG_PASS \n
 * @return @ref DIAG_FAIL \n
 @par
Imageref DIAG_PC_ProgramCounterTest_UML.svg "PC Program Counter Test Sequence Diagram"
Imageref DIAG_PC_ProgramCounterTest_ClassDiagram.svg "PC Program Counter Test Class Diagram"
 */

uint32_t DIAG_PC_ProgramCounterTest(void);

#endif /* DIAG_PC_H */
