FBS_prvrtos.h File Reference

Private definitions for FBS facilities built into the RTOS. More...

#include <FBS/FBS_pubrtos.h>
#include <MDB/MDB_pubdefs.h>

Classes
struct	_FILE_Hdr
	Structure representing the external format of a file header. Requires that the structure be aligned on a 16-bit boundary. More...
struct	_FILE_PrimaryHeader
	A description of the sacrosanct primary file header. More...
Defines
#define	FILE_L_NAME   (256)
	Longest name saved by FILE_open() (including EOS).
#define	FILE_HDR_SIZE   (32)
	The size in bytes of a file header.
#define	FILE_SYS_MAX_FILES   (32)
	The maximum number of files that may be open at once on a given DOSFS partition.
#define	FILE_HDR_MSG(_status, _param)   _msg_report((_status), 0, 1, (_param))
	Configuration-dependent message signaller. For boot configuration, a no-op. For application configuration, calls _msg_report().
#define	FILE_HDR_M_VERSION   (0xe000)
	Bit mask for file header internal version number.
#define	FILE_HDR_M_COMPRESS   (0x1000)
	Bit mask for file header compression flag.
#define	FILE_HDR_M_LENGTH   (0x01ff)
	Bit mask for file header internal length value.
#define	FILE_K_HDR_SIZ   (9)
	Number of bits used to describe header size.
#define	FILE_K_HDR_RSV   (3)
	Number of bits used (reserved).
#define	FILE_K_HDR_CMP   (1)
	Number of bits used to describe header compression.
#define	FILE_K_HDR_VER   (3)
	Number of bits used to describe header version.
#define	FILE_V_HDR_SIZ   ( 0 )
	Bit offset to header size field.
#define	FILE_V_HDR_RSV   ( FILE_V_HDR_SIZ + FILE_K_HDR_SIZ )
	Bit offset to (reserved) field.
#define	FILE_V_HDR_CMP   ( FILE_V_HDR_RSV + FILE_K_HDR_RSV )
	Bit offset to compression field.
#define	FILE_V_HDR_VER   ( FILE_V_HDR_CMP + FILE_K_HDR_CMP )
	Bit offset to version field.
#define	FILE_M_HDR_SIZ   (((1 << FILE_K_HDR_SIZ ) - 1) << FILE_V_HDR_SIZ )
	In place mask for the header size field.
#define	FILE_M_HDR_RSV   (((1 << FILE_K_HDR_RSV ) - 1) << FILE_V_HDR_RSV )
	In place mask for the (reserved) field.
#define	FILE_M_HDR_CMP   (((1 << FILE_K_HDR_CMP ) - 1) << FILE_V_HDR_CMP )
	In place mask for the compression field.
#define	FILE_M_HDR_VER   (((1 << FILE_K_HDR_VER ) - 1) << FILE_V_HDR_VER )
	In place mask for the version field.
Typedefs
typedef struct _FILE_Hdr	FILE_Hdr
	Typedef for struct _FILE_Hdr.
typedef struct _FILE_PrimaryHeader	FILE_PrimaryHeader
	Typedef for struct _FILE_PrimaryHeader.

---

Detailed Description

Private definitions for FBS facilities built into the RTOS.

CVS $Id: FBS_prvrtos.h,v 1.3 2011/03/24 21:24:42 apw Exp $

Author:

A.P.Waite

---

Define Documentation

#define FILE_HDR_MSG	(	_status,
		_param		)	_msg_report((_status), 0, 1, (_param))

Configuration-dependent message signaller. For boot configuration, a no-op. For application configuration, calls _msg_report().

Parameters:

	_status	The variable holding the status code
	_param	Message specific parameter value