cpu_usage.h File Reference

Contains the public interface to the CPU usage (CPU_USAGE) module routines. More...

#include <math.h>
#include "sw/modules/types/src/types.h"

Go to the source code of this file.

Data Structures
struct	_CPU_USAGE_Obj_
	Defines the CPU usage (CPU_USAGE) object. More...

Typedefs
typedef struct _CPU_USAGE_Obj_	CPU_USAGE_Obj
	Defines the CPU usage (CPU_USAGE) object. More...
typedef struct _CPU_USAGE_Obj_ *	CPU_USAGE_Handle
	Defines the CPU_USAGE handle. More...

Functions
static uint32_t	CPU_USAGE_getTimerPeriod (CPU_USAGE_Handle handle)
	Gets the timer period, cnts. More...
static uint32_t	CPU_USAGE_getCnt_z0 (CPU_USAGE_Handle handle)
	Gets the current count value. More...
static uint32_t	CPU_USAGE_getCnt_z1 (CPU_USAGE_Handle handle)
	Gets the previous count value. More...
static uint32_t	CPU_USAGE_getDeltaCnt (CPU_USAGE_Handle handle)
	Gets the latest delta count measured, cnts. More...
static uint32_t	CPU_USAGE_getDeltaCntAcc (CPU_USAGE_Handle handle)
	Gets the accumulated delta counts, cnts. More...
static uint32_t	CPU_USAGE_getDeltaCntAccNum (CPU_USAGE_Handle handle)
	Gets the number of accumulated delta counts, num. More...
static uint32_t	CPU_USAGE_getDeltaCntAccNumMax (CPU_USAGE_Handle handle)
	Gets the maximum number of accumulated delta counts, num. More...
static uint32_t	CPU_USAGE_getMinDeltaCntObserved (CPU_USAGE_Handle handle)
	Gets the minimum delta count observed, cnts. More...
static uint32_t	CPU_USAGE_getAvgDeltaCntObserved (CPU_USAGE_Handle handle)
	Gets the average delta count observed, cnts. More...
static uint32_t	CPU_USAGE_getMaxDeltaCntObserved (CPU_USAGE_Handle handle)
	Gets the maximum delta count observed, cnts. More...
static bool	CPU_USAGE_getFlag_resetStats (CPU_USAGE_Handle handle)
	Gets the state of the reset stats flag. More...
CPU_USAGE_Handle	CPU_USAGE_init (void *pMemory, const size_t numBytes)
	Initializes the CPU usage (CPU_USAGE) object. More...
static void	CPU_USAGE_setTimerPeriod (CPU_USAGE_Handle handle, const uint32_t timerPeriod_cnts)
	Sets the timer period, cnts. More...
static void	CPU_USAGE_setCnt_z0 (CPU_USAGE_Handle handle, const uint32_t cnt)
	Sets the current count value. More...
static void	CPU_USAGE_setCnt_z1 (CPU_USAGE_Handle handle, const uint32_t cnt)
	Sets the previous count value. More...
static void	CPU_USAGE_setDeltaCnt (CPU_USAGE_Handle handle, const uint32_t deltaCnt)
	Sets the delta count value. More...
static void	CPU_USAGE_setDeltaCntAcc (CPU_USAGE_Handle handle, const uint32_t deltaCntAcc)
	Sets the accumulated delta counts value. More...
static void	CPU_USAGE_setDeltaCntAccNum (CPU_USAGE_Handle handle, const uint32_t deltaCntAccNum)
	Sets the number of accumulated delta counts. More...
static void	CPU_USAGE_setDeltaCntAccNumMax (CPU_USAGE_Handle handle, const uint32_t deltaCntAccNumMax)
	Sets the maximum number of accumulated delta counts. More...
static void	CPU_USAGE_setMinDeltaCntObserved (CPU_USAGE_Handle handle, const uint32_t minDeltaCnt)
	Sets the minimum delta count observed, cnts. More...
static void	CPU_USAGE_setAvgDeltaCntObserved (CPU_USAGE_Handle handle, const uint32_t avgDeltaCnt)
	Sets the average delta count observed, cnts. More...
static void	CPU_USAGE_setMaxDeltaCntObserved (CPU_USAGE_Handle handle, const uint32_t maxDeltaCnt)
	Sets the maximum delta count observed, cnts. More...
static void	CPU_USAGE_setFlag_resetStats (CPU_USAGE_Handle handle, const bool state)
	Sets the state of the reset stats flag. More...
void	CPU_USAGE_setParams (CPU_USAGE_Handle handle, const uint32_t timerPeriod_cnts, const uint32_t numDeltaCntsAvg)
	Sets the CPU usage module parameters. More...
static void	CPU_USAGE_run (CPU_USAGE_Handle handle)
	Runs the CPU usage module. More...
static void	CPU_USAGE_updateCnts (CPU_USAGE_Handle handle, const uint32_t cnt)
	Updates the current and previous count values. More...

Detailed Description

Contains the public interface to the CPU usage (CPU_USAGE) module routines.

(C) Copyright 2013, Texas Instruments, Inc.

Definition in file cpu_usage.h.