PMC-Sierra PM5358 S/UNI 4x622 Power Screwdriver User Manual


 
PM5358 S/UNI-4x622 Driver Manual
Application Programming Interface
Proprietary and Confidential to PMC-Sierra, Inc. 62
Document ID: PMC-2010419, Issue 1
Reading and Setting the Section Trace Message : suni4x622SOHTraceMsg
This function retrieves and sets the section trace message (J0) in the Sonet/SDH Section Trace
Buffer.
Note: It is the USER’s responsibility to ensure that the message pointer points to an area of
memory large enough to hold the returned data.
Prototype
INT4 suni4x622SOHTraceMsg(sSUNI4x622_HNDL
deviceHandle, UINT1 channel, UINT2 acctyp, UINT1*
pJ0)
Inputs
deviceHandle : device handle (from suni4x622Add)
channel : channel number
acctyp : type of access
0 = write tx section trace msg
1 = read rx accepted section trace msg
2 = read rx captured section trace msg
3 = write rx expected section trace msg
pJ0 : (pointer to) the section trace message
Outputs
pJ0 : (pointer to) section trace message
Returns
Success =
SUNI4x622_SUCCESS
Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE
SUNI4x622_ERR_INVALID_DEV
SUNI4x622_ERR_INVALID_CHAN
SUNI4x622_ERR_INVALID_ARG
SUNI4x622_ERR_POLL_TIMEOUT
Valid States
SUNI4x622_ACTIVE, SUNI4x622_INACTIVE
Side Effects
None
Forcing A1 Error : suni4x622SOHForceA1
When the enable flag is set, this function introduces framing errors in the A1 bytes. When the
enable flag is not set, this function resumes normal processing.
Prototype
INT4 suni4x622SOHForceA1(sSUNI4x622_HNDL
deviceHandle, UINT1 channel, UINT2 enable)
Inputs
deviceHandle : device handle (from suni4x622Add)
channel : channel number
enable : flag to start/stop A1 error insertion
Outputs
None
Returns
Success =
SUNI4x622_SUCCESS
Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE
SUNI4x622_ERR_INVALID_DEV