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. 69
Document ID: PMC-2010419, Issue 1
Retrieving and Setting the Path Trace Messages: suni4x622POHTraceMsg
This function retrieves and sets the current path trace message in the Sonet/SDH Path Trace
Buffer. Note: It is the USER’s responsibility to make sure that the message pointer points to an
area of memory large enough to hold the returned data.
Prototype
INT4 suni4x622POHTraceMsg(sSUNI4x622_HNDL
deviceHandle, UINT1 channel, UINT2 acctyp, UINT1*
pJ1)
Inputs
deviceHandle : device handle (from suni4x622Add)
channel : channel number
acctyp : type of access
0 = write tx path trace msg
1 = read rx accepted path trace msg
2 = read rx captured path trace msg
3 = write rx expected path trace msg
pJ1 : (pointer to) the path trace message
Outputs
pJ1 : (pointer to) updated path 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
Writing the J1 Byte: suni4x622TPOHWriteJ1
This function writes the J1 byte into the path overhead.
Prototype
INT4 suni4x622TPOHWriteJ1(sSUNI4x622_HNDL
deviceHandle, UINT1 channel, UINT1 J1)
Inputs
deviceHandle : device handle (from suni4x622Add)
channel : channel number
J1 : J1 byte to write
Outputs
None
Returns
Success =
SUNI4x622_SUCCESS
Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE
SUNI4x622_ERR_INVALID_DEV
SUNI4x622_ERR_INVALID_CHAN