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. 67
Document ID: PMC-2010419, Issue 1
Reading the S1 Byte: suni4x622LOHReadS1
This function reads the S1 byte from the line overhead.
Prototype
INT4 suni4x622LOHReadS1(sSUNI4x622_HNDL deviceHandle,
UINT1 channel, UINT1 *pS1)
Inputs
deviceHandle : device handle (from suni4x622Add)
channel : channel number
pS1 : (pointer to) store S1 byte read
Outputs
pS1 : (pointer to) S1 byte read
Returns
Success =
SUNI4x622_SUCCESS
Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE
SUNI4x622_ERR_INVALID_DEV
SUNI4x622_ERR_INVALID_CHAN
SUNI4x622_ERR_INVALID_ARG
Valid States
SUNI4x622_ACTIVE, SUNI4x622_INACTIVE
Side Effects
None
Forcing Line AIS: suni4x622LOHForceAIS
This function forces line AIS in the transmit direction.
Prototype
INT4 suni4x622LOHForceAIS(sSUNI4x622_HNDL
deviceHandle, UINT1 channel, UINT2 enable)
Inputs
deviceHandle : device handle (from suni4x622Add)
channel : channel number
enable : flag to start/stop line AIS insertion
Outputs
None
Returns
Success =
SUNI4x622_SUCCESS
Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE
SUNI4x622_ERR_INVALID_DEV
SUNI4x622_ERR_INVALID_CHAN
Valid States
SUNI4x622_ACTIVE, SUNI4x622_INACTIVE
Side Effects
None
Forcing B2 Error: suni4x622LOHForceB2
This function forces B2 BIP-8 errors into the line overhead.
Prototype
INT4 suni4x622LOHForceB2(sSUNI4x622_HNDL
deviceHandle, UINT1 channel, UINT2 enable)