AWE Core 8.D.9 Documentation
FlashFSInstance.h
Go to the documentation of this file.
1/*******************************************************************************
2*
3* Audio Framework
4* ---------------
5*
6********************************************************************************
7* FlashFSInstance.h
8********************************************************************************
9*
10* Description: Prototypes of AudioWeaver Flash File System
11*
12* Copyright: (c) 2007-2021 DSP Concepts, Inc. All rights reserved.
13* 3235 Kifer Road
14* Santa Clara, CA 95054
15*
16*******************************************************************************/
17
23#ifndef _FLASHFSINSTANCE_H
24#define _FLASHFSINSTANCE_H
25
26#include "FileInfo.h"
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32// Forward decl as AWEInstance and AWEFlashFSInstance reference each other
33struct _AWEInstance;
34
39typedef struct _AWEFlashFSInstance
40{
43
46
49
52
54 BOOL (*cbInit)(void);
55
57 BOOL (*cbEraseSector)(UINT32 nStartingAddress, UINT32 nNumberOfSectors);
58
60 BOOL (*cbFlashWrite)(UINT32 nFlashAddress, UINT32 * pBuffer, UINT32 nDWordsToWrite);
61
63 BOOL (*cbFlashRead)(UINT32 nFlashAddress, UINT32 * pBuffer, UINT32 nDWordsToRead);
64
68 INT32 (*cbFlashProcessCmd)(struct _AWEInstance *pAWE);
69
70#ifdef FILESYSTEM_FRAMEWORK
71 FILESYSTEM_FRAMEWORK
72#else
74 UINT32 _Reserved[59];
75#endif
76
78
79// Macro to indicate API's changed
80#define FLASH_FS_API_CHANGED
81
82#ifdef __cplusplus
83}
84#endif
85
86
87#endif // _FLASHFSINSTANCE_H
struct _AWEFlashFSInstance AWEFlashFSInstance
The DSPC Flash File System Instance.
The AWE instance.
Definition: AWEInstance.h:45
The DSPC Flash File System Instance.
Definition: FlashFSInstance.h:40
UINT32 flashEraseTimeInMs
Flash erase time in milliseconds.
Definition: FlashFSInstance.h:51
UINT32 _Reserved[59]
Reserved member.
Definition: FlashFSInstance.h:74
BOOL(* cbFlashRead)(UINT32 nFlashAddress, UINT32 *pBuffer, UINT32 nDWordsToRead)
User function to read from flash.
Definition: FlashFSInstance.h:63
INT32(* cbFlashProcessCmd)(struct _AWEInstance *pAWE)
Optional user callback function to return the next command from an awb in flash.
Definition: FlashFSInstance.h:68
BOOL(* cbFlashWrite)(UINT32 nFlashAddress, UINT32 *pBuffer, UINT32 nDWordsToWrite)
User callback function to write to flash.
Definition: FlashFSInstance.h:60
UINT32 flashStartOffsetInBytes
Offset into start of flash used for file system.
Definition: FlashFSInstance.h:48
UINT32 flashSizeInBytes
Size of flash memory - if non-zero, next two values must also be non-zero.
Definition: FlashFSInstance.h:42
BOOL(* cbEraseSector)(UINT32 nStartingAddress, UINT32 nNumberOfSectors)
User callback function to erase one or more sectors.
Definition: FlashFSInstance.h:57
UINT32 flashErasableBlockSizeInBytes
Size of flash erase block.
Definition: FlashFSInstance.h:45
BOOL(* cbInit)(void)
User function to initialize flash file system.
Definition: FlashFSInstance.h:54