cpu_utils.c File Reference

Utilities for CPU Load calculation. More...

#include "cpu_utils.h"
#include "FreeRTOS.h"
#include "task.h"

Functions
void	vApplicationIdleHook (void)
	Application Idle Hook. More...
void	vApplicationTickHook (void)
	Application Idle Hook. More...
void	StartIdleMonitor (void)
	Start Idle monitor. More...
void	EndIdleMonitor (void)
	Stop Idle monitor. More...
uint16_t	osGetCPUUsage (void)
	Stop Idle monitor. More...

Variables
xTaskHandle	xIdleHandle = NULL
__IO uint32_t	osCPU_Usage = 0
uint32_t	osCPU_IdleStartTime = 0
uint32_t	osCPU_IdleSpentTime = 0
uint32_t	osCPU_TotalIdleTime = 0

Detailed Description

Utilities for CPU Load calculation.

Author

MCD Application Team

Version

V1.1.0

Date

20-November-2014

Attention

© COPYRIGHT(c) 2014 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. 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.
3. Neither the name of STMicroelectronics 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 HOLDER 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.

Function Documentation

vApplicationIdleHook()

void vApplicationIdleHook

(

void

)

Application Idle Hook.

Parameters

None

Return values

None

{
  if( xIdleHandle == NULL )
  {
    /* Store the handle to the idle task. */
    xIdleHandle = xTaskGetCurrentTaskHandle();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

vApplicationTickHook()

void vApplicationTickHook

(

void

)

Application Idle Hook.

Parameters

None

Return values

None

{
  static int tick = 0;
 
  if(tick ++ > CALCULATION_PERIOD)
  {
    tick = 0;
 
    if(osCPU_TotalIdleTime > 1000)
    {
      osCPU_TotalIdleTime = 1000;
    }
    osCPU_Usage = (100 - (osCPU_TotalIdleTime * 100) / CALCULATION_PERIOD);
    osCPU_TotalIdleTime = 0;
  }
}

Here is the caller graph for this function:

StartIdleMonitor()

void StartIdleMonitor

(

void

)

Start Idle monitor.

Parameters

None

Return values

None

{
  if( xTaskGetCurrentTaskHandle() == xIdleHandle )
  {
    osCPU_IdleStartTime = xTaskGetTickCountFromISR();
  }
}

Here is the call graph for this function:

EndIdleMonitor()

void EndIdleMonitor

(

void

)

Stop Idle monitor.

Parameters

None

Return values

None

{
  if( xTaskGetCurrentTaskHandle() == xIdleHandle )
  {
    /* Store the handle to the idle task. */
    osCPU_IdleSpentTime = xTaskGetTickCountFromISR() - osCPU_IdleStartTime;
    osCPU_TotalIdleTime += osCPU_IdleSpentTime;
  }
}

Here is the call graph for this function:

osGetCPUUsage()

uint16_t osGetCPUUsage

(

void

)

Stop Idle monitor.

Parameters

None

Return values

None

{
  return (uint16_t)osCPU_Usage;
}

Here is the caller graph for this function:

Variable Documentation

xIdleHandle

xTaskHandle xIdleHandle = NULL

osCPU_Usage

__IO uint32_t osCPU_Usage = 0

osCPU_IdleStartTime

uint32_t osCPU_IdleStartTime = 0

osCPU_IdleSpentTime

uint32_t osCPU_IdleSpentTime = 0

osCPU_TotalIdleTime

uint32_t osCPU_TotalIdleTime = 0