FFS Wrapper

Overview

Module which wraps Flash File System into RAM memory

Discussion

Audio Weaver module which constructs Flash File System instance from the address in RAM, which is used as input e.g. to wave player supporting FFS. This module accepts file system start address on input pin, constructs file system structure instance and send it through the output pin. This module supports additional argument through which user can specify Audio Weaver Flash File System (.bin) file name to simulate functionality on Native-PC target.

On the Native-PC target, input pin is ignored and flash file system is constructed from file name supplied through the argument. If the file name is empty input pin will be checked.

On a 64-bit system, user has to provide the 64-bit address of a bin file stored in RAM on two channels of fsStartAddr, with lower 32-bits of the address in the first channel (index 0) and upper 32-bits of the address in the second channel (index 1).

Similarly the module outputs a 64-bit address on fsInstance output pin.

Module Pack

awe-mod-dspc-snd

ClassID

classID = 41820

Type Definition

typedef struct _ModuleFFSWrapper
{
ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
INT32 isFFSValid;                             // Internal flag to control FFS bin file handling (used only for Native-PC targets)
INT32 FFSFileNameLength;                      // Length of the FFS file path (used only for Native-PC targets)
INT32* FFSFileName;                           // Name and path of the  AWE Flash File System (.bin) file (used only for Native-PC targets)
INT32* FFSInstance;                           //  AWE Flash File System instance structure
UINT32 * FFSStartAddrPtr;                     //  AWE Flash File System start address in RAM
UINT32 * FFSInstancePtr;                      //  AWE Flash File System instance pointer
void * pOwnerPtr;                             // Pointer to hold owner AWEInstance pointer
} ModuleFFSWrapperClass;

Variables

Properties

Name	Type	Usage	isHidden	Default Value	Range
isFFSValid	int	state	1	1	Unrestricted
FFSFileNameLength	int	const	1	1	Unrestricted
FFSFileName	int*	parameter	1	[1 x 1]	Unrestricted
FFSInstance	int*	state	1	[1 x 1]	Unrestricted
FFSStartAddrPtr	UINT32 *	state	1		Unrestricted
FFSInstancePtr	UINT32 *	state	1		Unrestricted
pOwnerPtr	void *	state	1		Unrestricted

Pins

Input Pins


Name	FFSStartAddr
Description	FFS start address in RAM
Data type	int
Channel range	Unrestricted
Block size range	1
Sample rate range	Unrestricted
Complex support	Real

Output Pins


Name	FFSInstancePtr
Description	AWE Flash File System instance pointer
Data Type	int

Matlab Usage

File Name: ffs_wrapper_module.m 
 M = ffs_wrapper_module(NAME, AWE_FFS_BIN_FILENAME) 

 Audio Weaver module which constructs Flash File System instance from the 
 address in RAM, which is used as input, e.g. to wave player supporting FFS.  
 This module accepts file system start address on input pin, constructs file 
 system structure instance and send it through the output pin. 
 This module supports additional argument through which user can specify 
 Audio Weaver flash file system bin file name to simulate functionality 
 on Native-PC target. 

 Arguments: 
    NAME - name of the module. 
    AWE_FFS_BIN_FILENAME - AudioWeaver Flash File System (.bin) file name 

 Copyright 2022-2024.  DSP Concepts, Inc.  All Rights Reserved. 

 AudioWeaverModule [This tag makes it appear under awe_help]