PMC-Sierra PM5358 S/UNI 4x622 User Manual

Page of 136
PM5358 S/UNI-4x622 Driver Manual
Application Programming Interface
Proprietary and Confidential to PMC-Sierra, Inc.
61
Document ID: PMC-2010419, Issue 1
Inputs
deviceHandle
: device handle (from 
suni4x622Add
)
startRegNum
: starting register number
size
: size of block to read
pblock
: (pointer to) block to write
pmask
: (pointer to) mask
Outputs
ERROR code written to the DDB
 
SUNI4x622_ERR_INVALID_DEV
ERROR code written to the DDB
 
SUNI4x622_ERR_INVALID_ARG
SUNI4x622_ERR_INVALID_REG
Returns
None
Valid States
SUNI4x622_PRESENT, SUNI4x622_ACTIVE,
SUNI4x622_INACTIVE
Side Effects
May change the configuration of the device
4.5 Section 
Overhead 
(SOH)
The Section Overhead section provides functions to control and monitor the section overhead
processing. Read / Write access is given to the section trace message (J0). This message is
compared with a configurable reference and mismatches are reported.   For diagnostic purposes,
errors can be introduced in the section overhead bytes.
Writing the J0 Byte: suni4x622SOHWriteJ0
This function writes the J0 byte into the transmit section overhead.
Prototype
INT4 suni4x622SOHWriteJ0(sSUNI4x622_HNDL
deviceHandle, UINT1 channel, UINT1 J0)
Inputs
deviceHandle
: device handle (from 
suni4x622Add
)
channel
: channel number
J0
: J0 byte to write
 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