Overview

System Variable

Discussion

This module implements the system variable query.

Layout Sample Rate - Sample rate of HW input pin in Hz.

Profile Clock Speed - Profile clock speed in Hz.

Fundamental Block Size - HW input pin block size in samples.

Core Clock Speed - Core clock speed in Hz.

Average Time - Average time in seconds.

Peak Time - Peak time in seconds.

Num Pumps - Number of audio pumps.

Cycle Time - Cycle time in seconds.

Elapsed Time - Elapsed time in seconds.

Percent CPU - CPU percent load.

Inst Cycle Time - Instantaneous cycle time.

Reset Counter - Counter indicates how many times System Level Reset happened every time an overflow detected in any layout on any instance. Overflow occurs when FiFoIn and FiFoOut in Buffer Up/Down module or IPCFiFoIn or IPCFiFoOut in IPCBuffer module go out of sync. This variable keeps incremented every time system reset occurred.

Type Definition

typedef struct _ModuleSystemVariable
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 variableIndex;                          // Variable Index
    INT32 prevTime;                               // Previous cycle time
    void * pOwnerPtr;                             // Pointer to hold owner AWEInstance pointer
    UINT32 * resetCounter;                        // Pointer to hold reset count. It is used as a unsigned int variable and added as a pointer to avoid compatibility issues
} ModuleSystemVariableClass;

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
variableIndex	int	parameter	0	1	Unrestricted
prevTime	int	const	0	0	Unrestricted
pOwnerPtr	void *	state	1		Unrestricted
resetCounter	UINT32	state	1		Unrestricted

Pins

Input Pins

Name: variable

Description: System Variable

Data type: {float, int, fract32}

MATLAB Usage

File Name: system_variable_module.m

 M = system_variable_module(NAME)
 Audio Weaver system variable module.  Arguments:
   NAME - name of the module.
   SAMPLERATE - sample rate to output value with
 Copyright (c) 2020 DSP Concepts, Inc.  All Rights Reserved.

Documentation Hub [PUBLIC]

(8.D.2.3) SystemVariable