3.1 Introduction

3.2 Using the Virtual Port Configuration API

3.2.1 Opening and Closing the Virtual Port library

3.2.2 Setting Message Trace Level

3.2.3 Retrieving Virtual Port Library Error Descriptions

3.2.4 Monitoring Virtual Port Library Response Packets

3.2.5 Configuring Packet Fill

3.2.6 Configuring the MVIP Clock and T1/E1 Interfaces

3.2.7 Setting TX Board Resource Definitions

3.2.8 Defining New Virtual Ports

3.3 Using the Virtual Port Data Transfer API

3.3.1 Attaching and Detaching Virtual Ports

3.3.2 Enabling and Disabling Virtual Ports

3.3.3 Transmitting Data through Virtual Port Resources

3.1 Introduction

This chapter summarizes the Virtual Port library functions.

The Virtual Port library provides configuration functions to:

• Open and close the Virtual Port library

• Set message trace level

• Retrieve Virtual Port library error descriptions

• Monitor Virtual Port library response packets

• Configure packet fill

• Configure the MVIP clock and T1/E1 interfaces

• Set TX board resource definitions

• Define new virtual ports

The Virtual Port library provides data transfer functions to:

• Attach and detach virtual ports

• Enable and disable virtual ports

• Transmit data through virtual port resources

3.2 Using the Virtual Port Configuration API

The Virtual Port Configuration API provides functions for initializing the Virtual Port library and defining and configuring virtual ports. The following sections summarize the functions in the Virtual Port Configuration API.

3.2.1 Opening and Closing the Virtual Port library

The following functions enable applications to open and close the Virtual Port API:

Function	Description
TxVpdOpen*	Initializes the Virtual Port library.
TxVpdClose*	Closes the Virtual Port library and releases TX board resources.

* Used by the Fusion Sample Gateway program.

3.2.2 Setting Message Trace Level

TxVpdControl sets the trace level for Virtual Port library requests.

3.2.3 Retrieving Virtual Port Library Error Descriptions

TxVpdErrorStr* provides a short ASCII text string describing Virtual Port library errors.

* Used by the Fusion Sample Gateway program.

3.2.4 Monitoring Virtual Port Library Response Packets

TxVpdLastRsp provides the application with a copy of the last VPD response received by the Virtual Port library.

3.2.5 Configuring Packet Fill

The Virtual Port Configuration API provides the following functions for manipulating the content of a provided dual port RAM packet:

Function	Description
TxVpdReqInit	Initializes the TxVpd dual port RAM request packet to the type of request message indicated.
TxVpdResDflt*	Initializes the resource definition structure to its default settings.
TxVpdResDef*	Initializes the resource definition structure as described by the input parameters.
TxVpdResTdm*	Sets the TDM (time division multiplexed) fields of a resource definition structure.
TxVpdCfgDflt*	Initializes the provided resource configuration structure.
TxVpdCfgHdlc	Initializes the HDLC-specific portion of a resource configuration structure.
TxVpdAddrDef*	Initializes the provided virtual port addressing structure.

* Used by the Fusion Sample Gateway program.

3.2.6 Configuring the MVIP Clock and T1/E1 Interfaces

The following Virtual Port API Configuration functions enable applications to set the MVIP clock and to configure TX board T1/E1 interfaces:

Function	Description
TxVpdMvipCfg*	Sets the overall MVIP configuration for a communications processor.
TxVpdT1E1Cfg	Issues a T1/E1 configuration request for a single line and configures the overall behavior of the line.

* Used by the Fusion Sample Gateway program.

3.2.7 Setting TX Board Resource Definitions

The following Virtual Port API Configuration functions enable applications set and remove TX board resource definitions:.

Function	Description
TxVpdDefine*	Defines or redefines TX board resource definitions on the communications processor.
TxVpdDestroy	Removes a TX board resource definition.
TxVpdConfig*	Identifies how a piece of hardware is to be used.

* Used by the Fusion Sample Gateway program.

3.2.8 Defining New Virtual Ports

TxVpdVport* defines a new virtual port through which the application will access TX board resources.

* Used by the Fusion Sample Gateway program.

3.3 Using the Virtual Port Data Transfer API

The Virtual Port Data Transfer API provides a set of functions for controlling virtual ports by building and issuing requests to the communications processor. The following sections summarize the Virtual Port Data Transfer functions.

3.3.1 Attaching and Detaching Virtual Ports

The following Virtual Port API Data Transfer functions enable applications to attach and detach virtual ports:

Function	Description
TxVpdAttach	Registers the application as the owner of a specified virtual port.
TxVpdDetach	Detaches the application from a virtual port and frees the port for use by other applications.

3.3.2 Enabling and Disabling Virtual Ports

The following Virtual Port API Data Transfer functions enable applications to enable and disable virtual ports:

Function	Description
TxVpdEnable	Enables a virtual port so that transmit requests may be sent and receive notifications may be retrieved.
TxVpdDisable	Disables a virtual port and deactivates data transfer.

3.3.3 Transmitting Data through Virtual Port Resources

TxVpdTx issues a virtual port data transmit request for a specified virtual port.