FILE_scp.h File Reference

File SCP application definitions. More...

#include <CLI/CLI_pubdefs.h>

Functions
unsigned int	FILE_sendUpl (const char *name, unsigned int dev, unsigned int dir, unsigned int file)
	Send a complete file upload telecommand set to the SIU.
unsigned int	FILE_sendCancel (unsigned int latUnit)
	Send a file upload cancel telecommand.
unsigned int	FILE_sendData (const char *name)
	Send a string of file upload data telecommands.
unsigned int	FILE_sendCommit (unsigned int latUnit, unsigned int dev, unsigned int dir, unsigned int file)
	Send a file upload commit telecommand.
unsigned int	FILE_sendCopyEpu (unsigned int latUnit, unsigned int dev, unsigned int dir, unsigned int file)
	Upload a copy of an SIU file to an EPU.
unsigned int	FILE_addSyntaxSCP (CLI_Syntax *syntax)
	Initialize CLI definitions for FILE SCP commands.

---

Detailed Description

File SCP application definitions.

Author:

D.L. Wood

Functions for controlling the FILE package SCP application.

---

Function Documentation

unsigned int FILE_addSyntaxSCP

(

CLI_Syntax *

syntax

)

Initialize CLI definitions for FILE SCP commands.

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

Parameters:

syntax

The CLI master syntax handle.

Returns:

A FILE MSG code.

References FILE_sendCancelCli(), FILE_sendCommitCli(), FILE_sendCopyEpuCli(), FILE_sendDataCli(), and FILE_sendUplCli().

unsigned int FILE_sendCancel

(

unsigned int

latUnit

)

Send a file upload cancel telecommand.

Send the file upload cancel telecommand (LFILUPLCANCEL).

Parameters:

latUnit

The LAT CPU to work on.

Returns:

A FILE MSG code.

References cmdFree(), FILE_APID_LAT_FILE_LOAD, and FILE_dumpUplCancel().

Referenced by FILE_sendCancelCli().

unsigned int FILE_sendCommit	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	file
	)

Send a file upload commit telecommand.

Send the file upload cancel telecommand (LFILUPLCOMMIT).

Parameters:

	latUnit	The LAT CPU to work on.
	dev	Device number.
	dir	Directory number.
	file	File number.

Returns:

A FILE MSG code.

References cmdFree(), FILE_APID_LAT_FILE_LOAD, and FILE_dumpUplCommit().

Referenced by FILE_sendCommitCli(), and FILE_sendUpl().

unsigned int FILE_sendCopyEpu	(	unsigned int	latUnit,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	file
	)

Upload a copy of an SIU file to an EPU.

Send the file upload EPU telecommand (LFILUPLEPU), which copies a file from the SIU to an EPU

Parameters:

	latUnit	The LAT EPU CPU to send the file.
	dev	Device number for source file.
	dir	Directory number for source file.
	file	File number for source file.

Returns:

A FILE MSG code.

References cmdFree(), FILE_APID_LAT_FILE_LOAD, and FILE_dumpUplEpu().

Referenced by FILE_sendCopyEpuCli().

unsigned int FILE_sendData

(

const char *

name

)

Send a string of file upload data telecommands.

A file is broken into a series of file upload data telecommands (LFILUPLDATA). This function automatically sends the file upload start telecommand (LFILUPLSTART) at the beginning.

Parameters:

name

Path name of file to upload

Returns:

A FILE MSG code.

References cmdFree(), FILE_APID_LAT_FILE_LOAD, FILE_dumpUplData(), FILE_dumpUplStart(), FILE_UPL_DATA_SIZE, FILE_UPL_DELAY, and FILE_uplDelay().

Referenced by FILE_sendDataCli(), and FILE_sendUpl().

unsigned int FILE_sendUpl	(	const char *	name,
		unsigned int	dev,
		unsigned int	dir,
		unsigned int	file
	)

Send a complete file upload telecommand set to the SIU.

A file is broken into a series of file upload data telecommands (LFILUPLDATA). This function automatically sends the file upload start telecommand (LFILUPLSTART) at the beginning and the file upload commit telecommand (LFILUPLCOMMIT) at the end. Since this telecommand sequence is intended for use only for file uploads between the SC and SIU nodes, the LAT unit ID in the upload commit telecommand is set to 'SIU'.

Parameters:

	name	Path name of file to upload
	dev	Device number.
	dir	Directory number.
	file	File number.

Returns:

A FILE MSG code.

References FILE_sendCommit(), and FILE_sendData().

Referenced by FILE_sendUplCli().