LFS_scp.h File Reference

LFS package SCP application definitions. More...

#include <CLI/CLI_pubdefs.h>

Functions
unsigned int	LFS_sendFileDump (unsigned int latUnit, unsigned int dev, unsigned int dir, unsigned int file, unsigned int xactId)
	Send a file dump CTDB telecommand.
unsigned int	LFS_sendFileDumpSSR (unsigned int latUnit, unsigned int dev, unsigned int dir, unsigned int file, unsigned int xactId)
	Send a file dump SSR telecommand.
unsigned int	LFS_sendFileDelete (unsigned int latUnit, unsigned int dev, unsigned int dir, unsigned int file, unsigned int xactId)
	Send a file delete telecommand.
unsigned int	LFS_sendFileCopy (unsigned int latUnit, unsigned int srcDev, unsigned int srcDir, unsigned int srcFile, unsigned int destDev, unsigned int destDir, unsigned int destFile, unsigned int xactId)
	Send a file local copy telecommand.
unsigned int	LFS_sendDirCreate (unsigned int latUnit, unsigned int dev, unsigned int dir, unsigned int xactId)
	Send a directory create telecommand.
unsigned int	LFS_sendDirDelete (unsigned int latUnit, unsigned int dev, unsigned int dir, unsigned int xactId)
	Send a directory delete telecommand.
unsigned int	LFS_sendDirDump (unsigned int latUnit, unsigned int dev, unsigned int dir, unsigned int xactId)
	Send a directory listing dump telecommand.
unsigned int	LFS_sendSysStatus (unsigned int latUnit, unsigned int dev, unsigned int xactId)
	Send a file system status report telecommand.
unsigned int	LFS_sendSysMount (unsigned int latUnit, unsigned int dev)
	Send a file system mount report telecommand.
unsigned int	LFS_sendSysCheck (unsigned int latUnit, unsigned int dev)
	Send a file system check report telecommand.
unsigned int	LFS_sendSysRepair (unsigned int latUnit, unsigned int dev)
	Send a file system repair telecommand.
unsigned int	LFS_sendSysFormat (unsigned int latUnit, unsigned int dev, unsigned int offset)
	Send a file system format report telecommand.
unsigned int	LFS_sendNoop (unsigned int latUnit)
	Send a LFS/FILE no-op telecommand.
unsigned int	LFS_addSyntaxSCP (CLI_Syntax *syntax)
	Initialize CLI definitions for LFS SCP commands.

---

Detailed Description

LFS package SCP application definitions.

Author:

D.L. Wood

Functions for controlling the LFS package SCP application.

---

Function Documentation

unsigned int LFS_addSyntaxSCP

(

CLI_Syntax *

syntax

)

Initialize CLI definitions for LFS SCP commands.

Adds a set of commands to the SCP command line definitions for supporting LFS package operations.

Parameters:

syntax

The CLI master syntax handle.

Returns:

A LFS MSG code.

References LFS_sendDirCreateCli(), LFS_sendDirDeleteCli(), LFS_sendDirDumpCli(), LFS_sendFileCopyCli(), LFS_sendFileDeleteCli(), LFS_sendFileDumpCli(), and LFS_sendSysStatusCli().

unsigned int LFS_sendDirCreate	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	xactId
	)

Send a directory create telecommand.

Send a LFS directory create telecommand (LFSDIRCREATE).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of directory to delete.
	dir	Directory number to delete.
	xactId	The transaction ID.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpDirCreateCmd().

Referenced by LFS_sendDirCreateCli().

unsigned int LFS_sendDirDelete	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	xactId
	)

Send a directory delete telecommand.

Send a LFS directory delete telecommand (LFSDIRDELETE).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of directory to delete.
	dir	Directory number to delete.
	xactId	The transaction ID.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpDirDeleteCmd().

Referenced by LFS_sendDirDeleteCli().

unsigned int LFS_sendDirDump	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	xactId
	)

Send a directory listing dump telecommand.

Send a LFS directory dump listing telecommand (LFSDIRDUMP).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of directory to dump.
	dir	Directory number to dump.
	xactId	The transaction ID.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpDirDumpCmd().

Referenced by LFS_sendDirDumpCli().

unsigned int LFS_sendFileCopy	(	unsigned int	latUnit,
		unsigned int	srcDev,
		unsigned int	srcDir,
		unsigned int	srcFile,
		unsigned int	destDev,
		unsigned int	destDir,
		unsigned int	destFile,
		unsigned int	xactId
	)

Send a file local copy telecommand.

Send a LFS file copy (local) telecommand (LFSFILECOPY).

Parameters:

	latUnit	The LAT CPU to work on.
	srcDev	Device number of source file to copy from.
	srcDir	Directory number of source file to copy from.
	srcFile	File number of source file to copy from.
	destDev	Device number of destination file to copy to.
	destDir	Directory number of destination file to copy to.
	destFile	File number of destination file to copy to.
	xactId	The transaction ID.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpFileCopyCmd().

Referenced by LFS_sendFileCopyCli().

unsigned int LFS_sendFileDelete	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	file,
		unsigned int	xactId
	)

Send a file delete telecommand.

Send a LFS file delete telecommand (LFSFILEDELETE).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of file to delete.
	dir	Directory number of file to delete.
	file	File number of file to delete.
	xactId	The transaction ID.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpFileDeleteCmd().

Referenced by LFS_sendFileDeleteCli().

unsigned int LFS_sendFileDump	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	file,
		unsigned int	xactId
	)

Send a file dump CTDB telecommand.

Send a LFS file dump CTDB telecommand (LFSFILEDUMPC).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of file to delete.
	dir	Directory number of file to delete.
	file	File number of file to delete.
	xactId	The transaction ID.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpFileDumpCmd().

Referenced by LFS_sendFileDumpCli().

unsigned int LFS_sendFileDumpSSR	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	file,
		unsigned int	xactId
	)

Send a file dump SSR telecommand.

Send a LFS file dump SSR telecommand (LFSFILEDUMPS).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of file to delete.
	dir	Directory number of file to delete.
	file	File number of file to delete.
	xactId	The transaction ID.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpFileDumpCmd().

unsigned int LFS_sendNoop

(

unsigned int

latUnit

)

Send a LFS/FILE no-op telecommand.

Send a LFS no-op telecommand (LFSNOOP).

Parameters:

latUnit

The LAT CPU to work on.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpNoopCmd().

unsigned int LFS_sendSysCheck	(	unsigned int	latUnit,
		unsigned int	dev
	)

Send a file system check report telecommand.

Send a LFS file system check telecommand (LFSSYSCHECK).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of device to interrogate.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpSysCheckCmd().

unsigned int LFS_sendSysFormat	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	offset
	)

Send a file system format report telecommand.

Send a LFS file system format telecommand (LFSSYSFORMAT).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of device to interrogate.
	offset	The offset in bytes of the file system partition into the bank.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CRIT, and LFS_dumpSysFormatCmd().

unsigned int LFS_sendSysMount	(	unsigned int	latUnit,
		unsigned int	dev
	)

Send a file system mount report telecommand.

Send a LFS file system mount telecommand (LFSSYSMOUNT).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of device to interrogate.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CRIT, and LFS_dumpSysMountCmd().

unsigned int LFS_sendSysRepair	(	unsigned int	latUnit,
		unsigned int	dev
	)

Send a file system repair telecommand.

Send a LFS file system repair telecommand (LFSSYSREPAIR).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of device to repair.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CRIT, and LFS_dumpSysRepairCmd().

unsigned int LFS_sendSysStatus	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	xactId
	)

Send a file system status report telecommand.

Send a LFS file system status dump telecommand (LFSSYSSTATUS).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number of device to interrogate.
	xactId	The transaction ID.

Returns:

A LFS MSG code.

References cmdFree(), LFS_APID_CMD, and LFS_dumpSysStatCmd().

Referenced by LFS_sendSysStatusCli().