Overview

Consumes processing cycles on the target

Discussion

This module recklessly consumes processing cycles on the target. You specify the number of clock ticks to consume per call to the processing function. The units of clock ticks is processor specific, but it matches the information returned by the Audio Weaver profiling function awe_profile.m. Internally, the module has a while loop which waits until the specified number of clock ticks has passed.

Type Definition

typedef struct _ModuleCycleBurner
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 numCyclesPerBlock;                      // Number of cycles to consumer per block process
} ModuleCycleBurnerClass;

Variables

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
numCyclesPerBlock	int	parameter	0	0	0:1000000

MATLAB Usage

File Name: cycle_burner_module.m

 M=cycle_burner_module(NAME)
 The cycle burner module consumes processing on the target.  It can be useful
 for debugging or reserving processing.  Arguments:
    NAME - name of the module.

Documentation Hub [PUBLIC]

(8.D.2.3) CycleBurner