/*
 * Copyright (c) 2014-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/**
 *  \file utils_prf.h
 *
 *  \brief Header file containing API declarations for load functions
 */

#ifndef UTILS_PRF_H_
#define UTILS_PRF_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

/* Maximum number of Utils perf handles allowed */
#define UTILS_PRF_MAX_HNDL     (64U)

/* Typedef for the loadupdate function for the user */
typedef void *Osal_TaskHandle;

/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */

/*
 *  Structure containing load value - used to store load value
 */
typedef struct {

    struct TotalLoad{

        uint32_t integerValue;
        uint32_t fractionalValue;

    } totalLoadParams;

} Utils_SystemLoadStats;

/*
 *  Structure containing load information - used to store load
 *  of various components of BIOS
 */
typedef struct
{
    int32_t cpuLoad;
    /**< cpu load */
    int32_t hwiLoad;
    /**< hardware interrupt load */
    int32_t swiLoad;
    /**< software interrupt load */
    int32_t tskLoad;
    /**< task load */
} Utils_PrfLoad;


/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

int32_t     Utils_prfInit(void);
int32_t     Utils_prfDeInit(void);
uint64_t    Utils_prfTsGet64(void);
Void        Utils_prfLoadUpdate(void);
int32_t     Utils_prfLoadRegister(Osal_TaskHandle pTsk, char *name);
int32_t     Utils_prfLoadUnRegister(Osal_TaskHandle pTsk);
int32_t     Utils_prfLoadPrintAll(Bool printTskLoad);
int32_t     Utils_prfGetLoad(Utils_SystemLoadStats * pStats);
Void        Utils_prfLoadCalcStart(void);
Void        Utils_prfLoadCalcStop(void);
Void        Utils_prfLoadCalcReset(void);
uint32_t    Utils_calcFps(uint32_t count, uint32_t divValue);

int32_t     Utils_prfLoadPrintAll(Bool printTskLoad);
Void        Utils_prfLoadCalcReset(void);

void        Utils_consolePrintf(const char *pcString, ...);

/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */

/* None */

#ifdef __cplusplus
}
#endif

#endif /* #ifndef UTILS_PRF_H_ */
