Load.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2024, Texas Instruments Incorporated - http://www.ti.com
 * 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.
 *
 */
#ifndef ti_sysbios_utils_Load__include
#define ti_sysbios_utils_Load__include

/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#include <ti/sysbios/knl/Queue.h>
#include <ti/sysbios/knl/Task.h>
#include <ti/sysbios/hal/Hwi.h>

#include <ti/sysbios/runtime/Error.h>

#define ti_sysbios_utils_Load_long_names
#include "Load_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

/*
 * ======== INTERNAL DEFINITIONS ========
 */

typedef void (*Load_FuncPtr)(void);

typedef struct {
    uint32_t threadTime; 
    uint32_t totalTime;  
} Load_Stat;

typedef struct {
    Queue_Elem qElem;        
    uint32_t totalTimeElapsed; 
    uint32_t totalTime;        
    uint32_t nextTotalTime;    
    uint32_t timeOfLastUpdate; 
    void * threadHandle;        
} Load_HookContext;
typedef struct {
    Queue_Object taskList;   /* List to hold registered task instances */
    int taskHId;             /* Task Hook Context Id for this module */
    uint32_t taskStartTime;    /* The start time of the current task */
    Task_Handle runningTask; /* Currently running task */
    uint32_t timeElapsed;      /* Working count of time elapsed */
    bool firstSwitchDone;    /* Flag for first task switch */
    uint32_t swiStartTime;     /* Start time of the current Swi */
    Load_HookContext swiEnv; /* Singleton hook context for swi's */
    uint32_t swiCnt;           /* number of Swi's currently executing */
    uint32_t hwiStartTime;     /* Start time of the current Hwi */
    Load_HookContext hwiEnv; /* Singleton hook context for hwi's */
    uint32_t hwiCnt;           /* number of Hwi's currently executing */
    uint32_t timeSlotCnt;      /* count of number of time windows printed */
    uint32_t minLoop;          /* shortest time thru the idle loop */
    uint32_t minIdle;          /* minLoop is never set below this value */
    uint32_t t0;               /* start time of previous call to idle fxn */
    uint32_t idleCnt;          /* number of times through idle loop */
    uint32_t cpuLoad;          /* CPU load in previous time window */
} Load_Module_State;

/*
 * ======== FUNCTION DECLARATIONS ========
 */
extern void Load_init(void);
extern bool Load_getTaskLoad(Task_Handle task, Load_Stat *stat);
extern void Load_update();
extern void Load_updateLoads();
extern void Load_updateContextsAndPost();
extern void Load_updateCurrentThreadTime();
extern void Load_updateThreadContexts();
extern void Load_reset();
extern bool Load_getGlobalSwiLoad(Load_Stat *stat);
extern bool Load_getGlobalHwiLoad(Load_Stat *stat);
extern uint32_t Load_getCPULoad();
extern uint32_t Load_calculateLoad(Load_Stat *stat);
extern uint32_t Load_setMinIdle(uint32_t newMinIdleTime);
extern void Load_addTask(Task_Handle task, Load_HookContext *env);
extern bool Load_removeTask(Task_Handle taskHandle);
extern void Load_idleFxn();
extern void Load_startup();
extern void Load_taskCreateHook(Task_Handle task, Error_Block *eb);
extern void Load_taskDeleteHook(Task_Handle task);
extern void Load_taskSwitchHook(Task_Handle curTask, Task_Handle nextTask);
extern void Load_swiBeginHook(Swi_Handle swi);
extern void Load_swiEndHook(Swi_Handle swi);
extern void Load_hwiBeginHook(Hwi_Handle hwi);
extern void Load_hwiEndHook(Hwi_Handle hwi);
extern void Load_taskRegHook(int id);
extern void Load_logLoads(void);
extern void logCPULoad(void);
#define Load_module ((Load_Module_State *) &(Load_Module_state))

#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_utils_Load__include */

#undef ti_sysbios_utils_Load_long_names
#include "Load_defs.h"