SBC_private.h File Reference

Private definitions for SBC constituents. More...

#include <BootDiagnostics.h>

Defines
#define	SBC_TEMP_DIR   0
#define	SBC_TEMP_FILE   0
#define	SBC_NAME_MAX_SIZE   31
#define	SBC_TEMP_BUF_SIZE   1024
#define	SBC_FILE_BUF_SIZE   0x20000
Typedefs
typedef unsigned int	SBC_App_Init (unsigned int p0, unsigned int p1, unsigned int p2, unsigned int p3)
Functions
unsigned int	SBC_mount (BOOT_Diagnostics *diag)
unsigned int	SBC_loadModule (const char *inName, unsigned int id, unsigned char *tempBuf, unsigned char *fileBuf, unsigned int index, BOOT_Diagnostics *diag)
unsigned int	SBC_loadFunc (char *name, const unsigned int *param, unsigned int index, BOOT_Diagnostics *diag, unsigned int funcNum)
void	SBC_error (unsigned int status, unsigned int index, unsigned int data, BOOT_Diagnostics *diag)

---

Detailed Description

Private definitions for SBC constituents.

Author:

D.L. Wood

---

Define Documentation

#define SBC_FILE_BUF_SIZE   0x20000

The size in bytes of the largest compressed object module.

Referenced by SBC_initialize(), and SBC_loadModule().

#define SBC_NAME_MAX_SIZE   31

The maximum number of characters for an SBC application intialization function symbol name.

#define SBC_TEMP_BUF_SIZE   1024

The size in bytes of the loader temporary buffers.

Referenced by SBC_initialize(), and SBC_loadInflate().

#define SBC_TEMP_DIR   0

The SBC temporary directory number.

Referenced by SBC_loadModule().

#define SBC_TEMP_FILE   0

The SBC_temporary file number.

Referenced by SBC_loadModule().

---

Typedef Documentation

SBC_App_Init

Prototype for application initialization function called by SBC loader.

Parameters:

	p0	Init function parameter 0.
	p1	Init function parameter 1.
	p2	Init function parameter 2.
	p3	Init function parameter 3.

Returns:

A MSG code signalling success or not.

---

Function Documentation

void SBC_error	(	unsigned int	status,
		unsigned int	index,
		unsigned int	data,
		BOOT_Diagnostics *	diag
	)

Reports errors from the SBC initialization process.

Parameters:

	status	An SBC MSG code indicating the error condition.
	index	An SBC MSG code indicating the progress index at time of error.
	data	Error specific data to help diagnosis.
	diag	A pointer to the boot diagnostics area.

Referenced by SBC_initialize(), SBC_loadFunc(), SBC_loadInflate(), SBC_loadModule(), SBC_mountRAM(), SBC_shellFunc(), SBC_shellLoad(), and SBC_shutdown().

unsigned int SBC_loadFunc	(	char *	name,
		const unsigned int *	param,
		unsigned int	index,
		BOOT_Diagnostics *	diag,
		unsigned int	funcNum
	)

Calls the specified function. Looks up the function name in the VxWorks system symbol table.

Parameters:

	name	The function symbol name.
	param	A pointer to an array of 4 function parameter words.
	index	SBC progress index MSG code.
	diag	A pointer to the boot diagnostics area.
	funcNum	A function index number for diagnostics.

Returns:

A SBC MSG code.

References SBC_error(), and sysSymTbl.

Referenced by SBC_shellFunc().

unsigned int SBC_loadModule	(	const char *	inName,
		unsigned int	id,
		unsigned char *	tempBuf,
		unsigned char *	fileBuf,
		unsigned int	index,
		BOOT_Diagnostics *	diag
	)

Invokes the VxWorks ELF object loader for the specified module. Possibly inflates the file first.

Parameters:

	inName	The path name of the module file.
	id	The file ID value.
	tempBuf	A temporary scratch buffer (SBC_TEMP_BUF_SIZE bytes).
	fileBuf	A temporary file buffer (SBC_FILE_BUF_SIZE bytes).
	index	SBC progress index MSG code.
	diag	A pointer to the boot diagnostics area.

Returns:

A SBC MSG code.

References SBC_error(), SBC_FILE_BUF_SIZE, SBC_loadInflate(), SBC_TEMP_DIR, and SBC_TEMP_FILE.

Referenced by SBC_shellLoad().

unsigned int SBC_mount

(

BOOT_Diagnostics *

diag

)

Mounts the RAM disk partition. Mounts the TFFS/EEPROM partitions. Creates any special files or directories needed by secondary boot process.

Parameters:

diag

A pointer to the boot diagnostics area.

References SBC_mountRAM(), SBC_SBF_MOUNT_EE0, SBC_SBF_MOUNT_EE1, and TFFS_TASK_NAME.

Referenced by SBC_initialize().