Recorded Announcement File System Report 0x0119

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Recorded Announcement File System Report 0x0119

SwitchKit Name

RecAnnFSReport

Type

EXS API and SwitchKit API message

Description

This message reports information about the file system used by the VRAS SIMM’s Flash memory on the DSP-ONE card. It also reports used, available, and deleted memory. To receive this message, the host must send a Recorded Announcement File System Query.

Sent by

Excel platform

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE SIMM;

UBYTE reserved19[28];

unsigned short RANCount;

unsigned short FSRevision;

int UsedMemory;

int DeletedMemory;

int AvailableMemory;

UBYTE Reserved;

UBYTE DefragmentationLevel;

UBYTE reserved65[205];

} XL_RecAnnFSReport;

C++ Class

class XLC_RecAnnFSReport : public XLC_InboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getSIMM() const;

void setSIMM(UBYTE x);

unsigned short getRANCount() const;

void setRANCount(unsigned short x);

unsigned short getFSRevision() const;

void setFSRevision(unsigned short x);

int getUsedMemory() const };

void setUsedMemory(int x);

int getDeletedMemory() const;

void setDeletedMemory(int x);

int getAvailableMemory() const;

void setAvailableMemory(int x);

UBYTE getReserved() const;

void setReserved(UBYTE x);

UBYTE getDefragmentationLevel() const;

};

EXS API Hex Format

MESSAGE (White)		RESPONSE (Gray)
Byte	Field Description	Byte	Field Description
0	Frame (0xFE)	0	Frame (0xFE)
1, 2	Length (0x001D)	1, 2	Length (0x0007)
3, 4	Message Type (0x0119)	3, 4	Message Type (0x0119)
5	Reserved (0x00)	5	Reserved (0x00)
6	Sequence Number	6	Same Sequence Number
7	Logical Node ID	7	Logical Node ID
8 :	AIB Address Method 0x00 - Individual AEs	8, 9	Status MSB, LSB
	Number of AEs to follow	10	Checksum
	AE 0x12 DSP SIMM
14, 15	Number of RANs (MSB, LSB) Number of RANs on the VRAS SIMM, including those marked for deletion.
16, 17	File System Revision (MSB, LSB) Revision of VRAS SIMM Flash File System used for storing RANs. 0x00 Revision 0: older, does not allows Single Message Deletion 0x01 Revision 1: newer, allows Single Message Deletion
18 - 21	Used Memory (MSB, LSB) Number of 32-bit words of memory used by all RANs on the VRAS SIMM, including deleted RANs.
22 - 25	Deleted Memory (MSB, LSB) Number of 32-bit words of memory used by deleted RANs on the VRAS SIMM
26 - 29	Available Memory (MSB, LSB) Number of 32-bit words of memory available for use on the VRAS SIMM
30	Reserved (0x00)
31	Defragmentation Level Value calculated by the Excel platform, indicating the need to defragment the Flash memory. 0x00 Level 0: Lowest: No deleted memory. (Deleted memory = 0) 0x01 Level 1: Low Medium: Some deleted memory (Deleted memory > 0) 0x02 Level 2: High Medium (Available memory < 1/4 Total memory ) and (Deleted memory > 1/4 Total memory) 0x03 Level 3: Highest. (Available memory < 1/4 Total memory) and (Deleted memory > 1/2 Total memory)
32	Checksum

Memory Field Information

The memory is reported in 32-bit words because that is the smallest memory storage unit. This means that a RAN six bytes long uses 2 words of memory for storing the RAN data.

Both File System revisions 0 and 1 use 16 words of memory for header information for each RAN stored.

File System revision 0 removes 16 words for each of the 2048 RANs (32768 words total) that could be stored on the VRAS SIMM from the available memory. So the total Available Memory for File System revision 0 is 0x5F8000. The Used Memory field counts only the memory words used for the RAN data, not the 16 words used for the RAN header.

File System revision 1 does not know the maximum number of RANs that may be stored on the VRAS SIMM, so the 16 words of header information for each RAN stored is added to the Used Memory for each RAN. Thus the total Available Memory for File System revision 1 is 0x600000. The deleted memory in the Defragmentation Level field also includes the 16 words for each deleted RAN.