SBC_shell.c File Reference

Functions to start the LAT secondary boot code process in shell emulation mode. More...

#include <vxWorks.h>
#include <stdio.h>
#include <stdlib.h>
#include <mv2600.h>
#include <BootDiagnostics.h>
#include <SBC/SBC_msg.h>
#include <SBC/SBC_defs.h>
#include <SBC/SBC_shell.h>
#include <MSG/MSG_macdefs.h>
#include <SBC_private.h>

Classes
struct	_SBC_Shell_Config
Typedefs
typedef struct _SBC_Shell_Config	SBC_Shell_Config
Functions
unsigned int	SBC_initialize (void)
	Startup SBC shell emulation.
unsigned int	SBC_shutdown (void)
	Shutdown SBC shell emulation.
unsigned int	SBC_shellLoad (const char *path)
	Load an application object module.
unsigned int	SBC_shellFunc (const char *name, unsigned int p0, unsigned int p1, unsigned int p2, unsigned int p3)
	Call an application initialization function.
void	SBC_error (unsigned int status, unsigned int index, unsigned int data, BOOT_Diagnostics *diag)
Variables
static SBC_Shell_Config	shellConfig
static BOOT_Diagnostics	debugDiag

---

Detailed Description

Functions to start the LAT secondary boot code process in shell emulation mode.

Author:

D.L. Wood

---

Typedef Documentation

SBC_Shell_Config

The typedef for _SBC_Shell_Config.

---

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_initialize

(

void

)

Startup SBC shell emulation.

The entry point for the secondary boot code. This function should be run to start the SBC shell emulation services.

Returns:

A SBC MSG code.

References _SBC_Shell_Config::check, debugDiag, _SBC_Shell_Config::file_buf, _SBC_Shell_Config::func_count, _SBC_Shell_Config::module_count, SBC_error(), SBC_FILE_BUF_SIZE, SBC_mount(), SBC_TEMP_BUF_SIZE, and _SBC_Shell_Config::temp_buf.

unsigned int SBC_shellFunc	(	const char *	name,
		unsigned int	p0,
		unsigned int	p1,
		unsigned int	p2,
		unsigned int	p3
	)

Call an application initialization function.

Calls an application initialization function in SBC format.

Parameters:

	name	The function symbol name.
	p0	Function parameter 0.
	p1	Function parameter 1.
	p2	Function parameter 2.
	p3	Function parameter 3.

Returns:

A SBC MSG code.

References _SBC_Shell_Config::check, debugDiag, _SBC_Shell_Config::func_count, SBC_error(), and SBC_loadFunc().

unsigned int SBC_shellLoad

(

const char *

path

)

Load an application object module.

Loads an application ELF object module in SBC format. The object module data may be compressed.

Parameters:

path

The full path name of the object module file.

Returns:

A SBC MSG code.

References _SBC_Shell_Config::check, debugDiag, _SBC_Shell_Config::file_buf, _SBC_Shell_Config::module_count, SBC_error(), SBC_loadModule(), and _SBC_Shell_Config::temp_buf.

unsigned int SBC_shutdown

(

void

)

Shutdown SBC shell emulation.

Releases resources allocated during SBC_initialize().

Returns:

A SBC MSG code.

References _SBC_Shell_Config::check, debugDiag, _SBC_Shell_Config::file_buf, SBC_error(), and _SBC_Shell_Config::temp_buf.

---

Variable Documentation

debugDiag [static]

A fake diagnostics structure for shell emulation.

Referenced by SBC_initialize(), SBC_shellFunc(), SBC_shellLoad(), and SBC_shutdown().

shellConfig [static]

The SBC shell global configuration and resources.