The AWECore API Header File. More...

#include <stdlib.h>
#include <string.h>
#include <stddef.h>
#include "TargetProcessor.h"

Data Structures
struct	IOPinDescriptor
	AWE IO Pin type. More...

struct	AWEFlashFSInstance
	The DSPC Flash File System Instance. More...

struct	AWEInstance
	The AWE instance. More...

Typedefs
typedef struct IOPinDescriptor	IOPinDescriptor
	AWE IO Pin type. More...

typedef struct AWEFlashFSInstance	AWEFlashFSInstance
	The DSPC Flash File System Instance. More...

typedef struct AWEInstance	AWEInstance
	The AWE instance. More...

typedef INT32	packetProcessFunction(AWEInstance *pAWE)

Functions
INT32	awe_init (AWEInstance *pAWE)
	Initialize the instance. More...

INT32	awe_initPin (IOPinDescriptor pPin, UINT32 channels, const char name)
	Initialize an input or output pin. More...

void	awe_initFlashFS (AWEInstance pAWE, AWEFlashFSInstance pAWEFlashFSInstance)
	Initialize the file system. More...

INT32	awe_packetProcess (AWEInstance *pAWE)
	Process an AWEInstance's newly received tuning packet. More...

INT32	awe_audioPump (AWEInstance *pAWE, UINT32 layoutIndex)
	Audio pump function. More...

INT32	awe_audioImportSamples (const AWEInstance pAWE, const void inSamples, INT32 inStride, INT32 channel, SampleType inType)
	Import samples from a user buffer to a channel. More...

INT32	awe_audioExportSamples (const AWEInstance pAWE, void outSamples, INT32 outStride, INT32 channel, SampleType outType)
	Export samples to a user buffer from a channel. More...

INT32	awe_audioIsStarted (const AWEInstance *pAWE)
	Check if this instance is running. More...

INT32	awe_audioGetPumpMask (const AWEInstance *pAWE)
	Test if AWE is ready to run. More...

INT32	awe_deferredSetCall (AWEInstance *pAWE)
	Perform deferred awe set on a module. More...

INT32	awe_loadAWBfromArray (AWEInstance pAWE, const UINT32 pCommands, UINT32 arraySize, UINT32 *pPos)
	Executes packet commands from an in-memory array. More...

void	awe_layoutGetChannelCount (const AWEInstance pAWE, UINT32 pinIdx, UINT32 inCount, UINT32 *outCount)
	Returns the number of channels in the Layout's input and output pins. More...

INT32	awe_layoutGetInputBlockSize (const AWEInstance pAWE, UINT32 pinIdx, UINT32 blockSize)
	Returns the block size of a pin. More...

INT32	awe_layoutGetInputSampleRate (const AWEInstance pAWE, UINT32 pinIdx, FLOAT32 sampleRate)
	Returns the sample rate of an input pin. More...

INT32	awe_layoutIsValid (const AWEInstance *pAWE)
	Determines if a layout is loaded and valid. More...

INT32	awe_ctrlSetValue (const AWEInstance pAWE, UINT32 handle, const void value, INT32 arrayOffset, UINT32 length)
	Set a scalar or array value of a module variable by handle. More...

INT32	awe_ctrlGetValue (const AWEInstance pAWE, UINT32 handle, void value, INT32 arrayOffset, UINT32 length)
	Get a scalar or array value of a module variable by handle. More...

INT32	awe_ctrlSetStatus (const AWEInstance *pAWE, UINT32 handle, UINT32 status)
	Set the runtime status of a module. More...

INT32	awe_ctrlGetStatus (const AWEInstance pAWE, UINT32 handle, UINT32 status)
	Get the runtime status of a module. More...

INT32	awe_ctrlSetValueMask (const AWEInstance pAWE, UINT32 handle, const void value, INT32 arrayOffset, UINT32 length, UINT32 mask)
	Set a scalar or array value of a module variable by handle with mask. More...

INT32	awe_ctrlGetValueMask (const AWEInstance pAWE, UINT32 handle, void value, INT32 arrayOffset, UINT32 length, UINT32 mask)
	Get a scalar or array value of a module variable by handle with mask. More...

INT32	awe_ctrlGetModuleClass (const AWEInstance pAWE, UINT32 handle, UINT32 pClassID)
	Get an object class from its handle. More...

INT32	awe_setProfilingStatus (AWEInstance *pAWE, UINT32 enable)
	Enable or disable the profiling ability of the AWECore. More...

INT32	awe_getAverageLayoutCycles (AWEInstance pAWE, UINT32 layoutIdx, UINT32 averageCycles)
	Get the average cycles of a running layout, in units of cycles at profileSpeed. More...

Detailed Description

The AWECore API Header File.

Typedef Documentation

◆ IOPinDescriptor

typedef struct IOPinDescriptor IOPinDescriptor

AWE IO Pin type.

The AWE typedef for input/output pins. A BSP author will allocate their input/output pins of this type.

◆ AWEFlashFSInstance

typedef struct AWEFlashFSInstance AWEFlashFSInstance

The DSPC Flash File System Instance.

Optional – SINGLE INSTANCE ONLY

◆ AWEInstance

typedef struct AWEInstance AWEInstance

The AWE instance.

The AWE Instance struct must have its members/pointers assigned at init time. The AWEInstance is the most important structure, and it must be initialized properly. After assigning all of the required members, the BSP author will call the awe_init() function. All members are required to be assigned unless they are marked optional in the detailed description below..

Function Documentation

◆ awe_init()

INT32 awe_init ( AWEInstance * pAWE )

Initialize the instance.

Call this once you have assigned all of the required members/pointers of the AWE Instance, and after calling awe_InitPin on both input and output pins. Calling awe_init before assigning all members of the instance structure or initializing the pins will result in crashes/erratic behavior.

Parameters

pAWE	instance to initialize

Returns: 0 or error code

Examples: bare_metal_example.c, ControlApp.c, LinuxApp.c, and singleinstance_simple.c.

◆ awe_initPin()

INT32 awe_initPin	(	IOPinDescriptor *	pPin,
		UINT32	channels,
		const char *	name
	)

Initialize an input or output pin.

This function must be called for both the input and output pins. Must be called BEFORE the awe_init API function.

Parameters

[in]	pPin	the pin instance to initialize
[in]	channels	number of channels
[in]	name	optional pin name

Returns: 0 or error code

Examples: bare_metal_example.c, ControlApp.c, LinuxApp.c, and singleinstance_simple.c.

◆ awe_initFlashFS()

void awe_initFlashFS	(	AWEInstance *	pAWE,
		AWEFlashFSInstance *	pAWEFlashFSInstance
	)

Initialize the file system.

Parameters

pAWE	instance to initialize
pAWEFlashFSInstance	the file system instance

◆ awe_packetProcess()

INT32 awe_packetProcess ( AWEInstance * pAWE )

Process an AWEInstance's newly received tuning packet.

Parameters

[in] pAWE The AWE instance pointer to process

Returns: error/success 0 for success, negative on error

Examples: bare_metal_example.c, LinuxApp.c, and singleinstance_simple.c.

◆ awe_audioPump()

INT32 awe_audioPump	(	AWEInstance *	pAWE,
		UINT32	layoutIndex
	)

Audio pump function.

Call this in your audio thread once you have imported the data you wish to process. Before pumping, you must also check that the AudioWeaver buffers have been filled (awe_getPumpMask) and that audio has been started (awe_audioIsStarted). This function will return 1 if awe_deferredSetCall needs to be called. This is for modules that need to do more time consuming calculations, like calculating filter coefficients. For example, a SOF Control module needs to calculate new coeffs when the frequency is modified by the control input.

Parameters

[in]	pAWE	AWE instance pointer
[in]	layoutIndex	the layout index to pump

Returns: 0 for success, negative for error, 1 for deferred set needed

Examples: bare_metal_example.c, ControlApp.c, and LinuxApp.c.

◆ awe_audioImportSamples()

INT32 awe_audioImportSamples	(	const AWEInstance *	pAWE,
		const void *	inSamples,
		INT32	inStride,
		INT32	channel,
		SampleType	inType
	)

Import samples from a user buffer to a channel.

The value of the fundamentalBlockSize member of the AWEInstance determines the number of samples that are imported with each call. Call this function once for each audio input channel on the hardware. Channel matching between hardware capabilities and layout will be done automatically. For example, if the target has only 1 audio input channel, and if a layout with 3 input channels is loaded, the second and third channels of the layout input will be all zeros. Inversely, if there are more HW input channels than the layout expects, then they are ignored.

The value of inStride defines the number of samples to skip between each read, and should be the number of interleaved channels in the inSamples buffer being read from. A typical usage for a single source, interleaved stereo input could look like:

awe_audioImportSamples(pAWE, inSamples + 0, 2, 0, Sample32bit);

awe_audioImportSamples(pAWE, inSamples + 1, 2, 1, Sample32bit);

Parameters

[in]	pAWE	AWE instance
[in]	inSamples	pointer to first sample in buffer to import for current channel
[in]	inStride	input buffer import stride
[in]	channel	channel to write to
[in]	inType	type of input data

Returns: 0 on success, negative if error

Examples: bare_metal_example.c, ControlApp.c, and LinuxApp.c.

◆ awe_audioExportSamples()

INT32 awe_audioExportSamples	(	const AWEInstance *	pAWE,
		void *	outSamples,
		INT32	outStride,
		INT32	channel,
		SampleType	outType
	)

Export samples to a user buffer from a channel.

The value of the fundamentalBlockSize member of the AWEInstance determines the number of samples that are exported with each call. Call this function once for each audio output channel on the hardware. Like awe_audioImportSamples, this will do channel matching automatically. For example, if the target has 3 audio output channels, and if a layout with 1 output channel is loaded, the second and third channels of the exported output will be all zeros. Inversely, if the layout has more output channels than the target supports, they are ignored.

The value of outStride defines the number of samples to skip between each write. It should be equal to the number of interleaved channels in the outSamples buffer being written to. A typical usage for exporting to an interleaved 3 channel output could look like:

awe_audioExportSamples(pAWE, &outSamples[0], 3, 0, Sample32bit);
awe_audioExportSamples(pAWE, &outSamples[1], 3, 1, Sample32bit);
awe_audioExportSamples(pAWE, &outSamples[2], 3, 2, Sample32bit);

Parameters

[in]	pAWE	AWE instance
[out]	outSamples	pointer to first sample in buffer to export to
[in]	outStride	output buffer export stride
[in]	channel	channel to read from
[in]	outType	type of output data

Returns: 0 on success, negative on error

Examples: bare_metal_example.c, ControlApp.c, and LinuxApp.c.

◆ awe_audioIsStarted()

INT32 awe_audioIsStarted ( const AWEInstance * pAWE )

Check if this instance is running.

A BSP author can use this to determine if the instance is already running to avoid pumping audio through a dead layout.

Parameters

pAWE	instance pointer

Returns: 0 if not started, 1 if started

Examples: bare_metal_example.c, ControlApp.c, and LinuxApp.c.

◆ awe_audioGetPumpMask()

INT32 awe_audioGetPumpMask ( const AWEInstance * pAWE )

Test if AWE is ready to run.

This will return the "layout mask" which is a bit vector of threads to run. For a simple, single threaded system, the bitvector will be 0x1. Example: int layoutMask = awe_audioGetPumpMask&g_AWEInstance); if (layoutMask > 0) { if (layoutMask & 0x1) { int ret = awe_audioPump(&g_AWEInstance, 0); } }

Parameters

pAWE	AWE instance

Returns: bit vector of threads to run - 0 if none

Examples: bare_metal_example.c, ControlApp.c, and LinuxApp.c.

◆ awe_deferredSetCall()

INT32 awe_deferredSetCall ( AWEInstance * pAWE )

Perform deferred awe set on a module.

Each call to awe_deferredSetCall processes a single module. Usually this function would be called repeatedly until the return value is 0.

Parameters

[in] pAWE AWE instance pointer

Returns: finishedProcessing Will return 1 when processing is incomplete, 0 when complete.

Examples: bare_metal_example.c, and LinuxApp.c.

◆ awe_loadAWBfromArray()

INT32 awe_loadAWBfromArray	(	AWEInstance *	pAWE,
		const UINT32 *	pCommands,
		UINT32	arraySize,
		UINT32 *	pPos
	)

Executes packet commands from an in-memory array.

Designer can generate AWB arrays directly from a layout.

Parameters

[in]	pAWE	AWE instance pointer
[in]	pCommands	Buffer with commands to execute
[in]	arraySize	Number of DWords in command buffer
[out]	pPos	Report failing word index

Returns: 0 or error code

Examples: ControlApp.c.

◆ awe_layoutGetChannelCount()

void awe_layoutGetChannelCount	(	const AWEInstance *	pAWE,
		UINT32	pinIdx,
		UINT32 *	inCount,
		UINT32 *	outCount
	)

Returns the number of channels in the Layout's input and output pins.

Parameters

[in]	pAWE	AWE instance pointer
[in]	pinIdx	which input pin (always 0)
[out]	inCount	channels in primary input pin
[out]	outCount	channels in primary output pin

Examples: ControlApp.c.

◆ awe_layoutGetInputBlockSize()

INT32 awe_layoutGetInputBlockSize	(	const AWEInstance *	pAWE,
		UINT32	pinIdx,
		UINT32 *	blockSize
	)

Returns the block size of a pin.

Because the block size of the output pin is inherited from the input pin, the user only needs to check the input pin.

Parameters

[in]	pAWE	The AWE Instance
[in]	pinIdx	which input pin (always 0)
[out]	blockSize	block size of input pin

Returns: 0 or error code

Examples: ControlApp.c.

◆ awe_layoutGetInputSampleRate()

INT32 awe_layoutGetInputSampleRate	(	const AWEInstance *	pAWE,
		UINT32	pinIdx,
		FLOAT32 *	sampleRate
	)

Returns the sample rate of an input pin.

Because the sample rate of the output pin is inherited from the input pin, the user only needs to check the input pin.

Parameters

[in]	pAWE	The AWE Instance
[in]	pinIdx	which input pin (always 0)
[out]	sampleRate	the input pin sample rate

Returns: 0 or error code

◆ awe_layoutIsValid()

INT32 awe_layoutIsValid ( const AWEInstance * pAWE )

Determines if a layout is loaded and valid.

Parameters

[in] pAWE The AWE Instance

Returns: 0 if layout not valid/loaded, 1 if it is

Examples: bare_metal_example.c, ControlApp.c, and LinuxApp.c.

◆ awe_ctrlSetValue()

INT32 awe_ctrlSetValue	(	const AWEInstance *	pAWE,
		UINT32	handle,
		const void *	value,
		INT32	arrayOffset,
		UINT32	length
	)

Set a scalar or array value of a module variable by handle.

Parameters

[in]	pAWE	instance pointer
[in]	handle	packed object handle
[in]	value	value(s) to set
[in]	arrayOffset	array index if array
[in]	length	number of elements. 1 if scaler

Returns: error code

Examples: bare_metal_example.c, and ControlApp.c.

◆ awe_ctrlGetValue()

INT32 awe_ctrlGetValue	(	const AWEInstance *	pAWE,
		UINT32	handle,
		void *	value,
		INT32	arrayOffset,
		UINT32	length
	)

Get a scalar or array value of a module variable by handle.

Parameters

[in]	pAWE	instance pointer
[in]	handle	packed object handle
[out]	value	value(s) to get
[in]	arrayOffset	array index if array
[in]	length	number of elements. 1 if scaler

Returns: error code

Examples: bare_metal_example.c, and ControlApp.c.

◆ awe_ctrlSetStatus()

INT32 awe_ctrlSetStatus	(	const AWEInstance *	pAWE,
		UINT32	handle,
		UINT32	status
	)

Set the runtime status of a module.

0 = Active, 1 = Bypass, 2 = Mute, 3 = Inactive

Parameters

[in]	pAWE	instance pointer
[in]	handle	packed object handle
[in]	status	status to set

Returns: error code

◆ awe_ctrlGetStatus()

INT32 awe_ctrlGetStatus	(	const AWEInstance *	pAWE,
		UINT32	handle,
		UINT32 *	status
	)

Get the runtime status of a module.

0 = Active, 1 = Bypass, 2 = Mute, 3 = Inactive

Parameters

[in]	pAWE	instance pointer
[in]	handle	packed object handle
[out]	status	status to get

Returns: error code

◆ awe_ctrlSetValueMask()

INT32 awe_ctrlSetValueMask	(	const AWEInstance *	pAWE,
		UINT32	handle,
		const void *	value,
		INT32	arrayOffset,
		UINT32	length,
		UINT32	mask
	)

Set a scalar or array value of a module variable by handle with mask.

A mask allows you to only call module's set function for a single variable.

Parameters

[in]	pAWE	instance pointer
[in]	handle	packed object handle
[in]	value	value(s) to set
[in]	arrayOffset	array index if array
[in]	length	number of elements if array. 1 if scaler
[in]	mask	mask to use - 0 to not call set function

Returns: error code

◆ awe_ctrlGetValueMask()

INT32 awe_ctrlGetValueMask	(	const AWEInstance *	pAWE,
		UINT32	handle,
		void *	value,
		INT32	arrayOffset,
		UINT32	length,
		UINT32	mask
	)

Get a scalar or array value of a module variable by handle with mask.

A mask allows you to only call module's set function for a single variable.

Parameters

[in]	pAWE	instance pointer
[in]	handle	packed object handle
[out]	value	value(s) to get
[in]	arrayOffset	array index if array
[in]	length	number of elements if array. 1 if scaler
[in]	mask	mask to use - 0 to not call get function

Returns: error code

◆ awe_ctrlGetModuleClass()

INT32 awe_ctrlGetModuleClass	(	const AWEInstance *	pAWE,
		UINT32	handle,
		UINT32 *	pClassID
	)

Get an object class from its handle.

Parameters

	pAWE	instance pointer
[in]	handle	handle of object to find
[out]	pClassID	pointer to found object class

Returns: 0 for success, else error code

Examples: bare_metal_example.c, and ControlApp.c.

◆ awe_setProfilingStatus()

INT32 awe_setProfilingStatus	(	AWEInstance *	pAWE,
		UINT32	enable
	)

Enable or disable the profiling ability of the AWECore.

Enabled by default at awe_init. Use this if you wish to enable or disable per pump profiling during runtime. Disabling profiling saves a small amount of cycles per pump.

Parameters

pAWE	instance pointer
enable	0 for disabled, 1 for enabled

Returns: 0 or error code. Possible error code is E_PARAMETER_ERROR (Invalid AWEInstance)

◆ awe_getAverageLayoutCycles()

INT32 awe_getAverageLayoutCycles	(	AWEInstance *	pAWE,
		UINT32	layoutIdx,
		UINT32 *	averageCycles
	)

Get the average cycles of a running layout, in units of cycles at profileSpeed.

Returns cycles in 24.8 format, so shift right by 8 bits for integer value. To get CPU cycles, multiply by target cpuSpeed / profileSpeed.

Parameters

pAWE	instance pointer
layoutIdx	Layout index (typically 0, except in advanced use cases)
averageCycles	Pointer the output (average layout cycles)

Returns: 0 or error code. Possible error code is E_PARAMETER_ERROR (Invalid AWEInstance)

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ IOPinDescriptor

◆ AWEFlashFSInstance

◆ AWEInstance

Function Documentation

◆ awe_init()

◆ awe_initPin()

◆ awe_initFlashFS()

◆ awe_packetProcess()

◆ awe_audioPump()

◆ awe_audioImportSamples()

◆ awe_audioExportSamples()

◆ awe_audioIsStarted()

◆ awe_audioGetPumpMask()

◆ awe_deferredSetCall()

◆ awe_loadAWBfromArray()

◆ awe_layoutGetChannelCount()

◆ awe_layoutGetInputBlockSize()

◆ awe_layoutGetInputSampleRate()

◆ awe_layoutIsValid()

◆ awe_ctrlSetValue()

◆ awe_ctrlGetValue()

◆ awe_ctrlSetStatus()

◆ awe_ctrlGetStatus()

◆ awe_ctrlSetValueMask()

◆ awe_ctrlGetValueMask()

◆ awe_ctrlGetModuleClass()

◆ awe_setProfilingStatus()

◆ awe_getAverageLayoutCycles()