Section Overhead SOH | PMC-Sierra PM5358 S/UNI 4x622 instruction

		PM5358 S/UNI-4x622 Driver Manual
		Application Programming Interface

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.5Section 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

Inputs

INT4 suni4x622SOHWriteJ0(sSUNI4x622_HNDL deviceHandle, UINT1 channel, UINT1 J0)

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

Proprietary and Confidential to PMC-Sierra, Inc.	61
Document ID: PMC-2010419, Issue 1

Image 61

PMC-Sierra PM5358 S/UNI 4x622 manual Section Overhead SOH, Writing the J0 Byte suni4x622SOHWriteJ0

Contents

PM5358 UNI-4X622 Issue 1 April Audience Issue April Document createdReferences Revision History Contacting PMC-Sierra Legal Issues Table of Contents Updating the Configuration of a Device suni4x622Update Setting Payload configuration parameters suni4x622PyldCfg 100 112 128 List of Figures List of Tables UNI-4x622 Global Line Interface Configuration Introduction Application Programming Interface Driver External Interfaces Real-Time OS Interface Main ComponentsHardware Interface Rtos Module Data-Block and Devices Data-Blocks Alarms, Status and Counts Interrupt-Service RoutineDeferred-Processing Routine APS Configuration Interface ConfigurationSection Overhead Line Overhead Module States Software States Device States Module States Module Management Processing FlowsDevice Management Suni4x622AddInitProfile Interrupt Servicing Suni4x622ISR and suni4x622DPR Calling suni4x622ISR Calling suni4x622Poll Calling suni4x622DPR Polling Service Model Structures Passed by the Application ConstantsModule Initialization Vector MIV Device Initialization Vector DIV ISR Enable/Disable Mask Loss of signal Interrupt mask for Fifo ConfigurationSection BIP error Line alarm signal Line REI error Line BIP errorSignal Defect Signal Failure Rx CP Fifo overrun Tx FP Fifo underrun Rx FP Fifo overrun Module Data Block MDB Structures in the Driver’s Allocated Memory Device Data Block DDB Device State can be one of the following Interrupt Enable MaskPRESENT, Active or Inactive Base address of the device Device-wide Global Configuration Per-Channel Line Overhead LOH Configuration Per-Channel Section Overhead SOH Configuration Per-Channel Transmit Path Overhead Tpoh Configuration Per-Channel Receive Path Overhead Rpoh ConfigurationControl of the persistence of the RDI asserted into Transmitted stream Controls whether unequipped path signal label can cause Controls whether Path signal label mismatch can causeControls whether LOS,LOF or Lais will disable Eprdi Controls whether Pais will disable Eprdi insertion Per-Channel Payload Processor Configuration Per-Channel Clock Interface Configuration Per-Channel Fifo Configuration Per-Channel Line Interface Configuration Per-Channel Ralrm ConfigurationClock configuration block Device-wide System Interface Configuration Ralrm configuration block Device-Wide Line Interface Configuration Section Overhead SOH Status Receive Path Overhead Rpoh Status Line Overhead LOH Status Clock Status Payload Processor Status Tfclk active Section BIP error counterRefclka active Line Interface Status Receive Path Overhead Rpoh Counter Line Overhead LOH CounterPayload Processor Pyld Counter Structures Passed through Rtos Buffers Interrupt-Service Vector ISVDeferred-Processing Vector DPV Global Variable Opening the Driver Module suni4x622ModuleOpen Module ManagementClosing the Driver Module suni4x622ModuleClose Prototype Inputs Outputs Returns Stopping the Driver Module suni4x622ModuleStop Starting the Driver Module suni4x622ModuleStartValid States Side Effects Adding an Initialization Profile suni4x622AddInitProfile Profile ManagementGetting an Initialization Profile suni4x622GetInitProfile Adding a Device suni4x622Add Device ManagementSide Effects None Initializing a Device suni4x622Init Deleting a Device suni4x622DeletePrototype Inputs Outputs Returns Valid States Side Effects Resetting a Device suni4x622Reset Updating the Configuration of a Device suni4x622UpdateSide Effects Changes the Device state to SUNI4x622INACTIVE De-Activating a Device suni4x622DeActivate Activating a Device suni4x622ActivateChanges the Device state to SUNI4x622ACTIVE Changes the Device state to SUNI4x622INACTIVE Reading from Device Registers suni4x622Read Device Read and WriteWriting to Device Registers suni4x622Write Writing to a Block of Device Registers suni4x622WriteBlock Reading from a block of Device Registers suni4x622ReadBlockPrototype Inputs Writing the J0 Byte suni4x622SOHWriteJ0 Section Overhead SOH Forcing A1 Error suni4x622SOHForceA1 Flag to start/stop B1 error insertion Forcing B1 Error suni4x622SOHForceB1Forcing OOF suni4x622SOHForceOOF Flag to start/stop a loss of signal condition Configuring SF Error Monitor suni4x622LOHSFCfgPointer to SF configuration block Line Overhead LOH Writing the K1K2 Byte suni4x622LOHWriteK1K2 Configuring SD Error Monitor suni4x622LOHSDCfg Writing the S1 Byte suni4x622LOHWriteS1 Reading the K1K2 Byte suni4x622LOHReadK1K2 Reading the S1 Byte suni4x622LOHReadS1 Forcing B2 Error suni4x622LOHForceB2Forcing Line AIS suni4x622LOHForceAIS Path Overhead RPOH, Tpoh Flag to start/stop B2 error insertionForcing Line RDI suni4x622LOHForceRDI This function forces the line RDI into the line overhead Writing the J1 Byte suni4x622TPOHWriteJ1 Writing the New Data Flag Bits suni4x622TPOHWriteNDF Writing the C2 Byte suni4x622TPOHWriteC2 Writing SS Bits suni4x622TPOHWriteSS Force Path BIP-8 Errors suni4x622TPOHForceB3Inserting a Pointer Value suni4x622TPOHInsertTxPtr Forcing Path RDI suni4x622TPOHForceRDI Forcing Pointer Justification suni4x622TPOHForcePJFlag to start/stop B3 masking Type of Pointer Justification event Forcing Path Ardi suni4x622TPOHForceARDI Forcing Path Erdi suni4x622TPOHForceERDIFlag to start/stop path RDI insertion Flag to start/stop path Erdi insertion Payload Processor Setting Payload configuration parameters suni4x622PyldCfgForcing Path AIS suni4x622TPOHForceAIS Flag to start/stop path AIS insertion Resetting the Receive/Transmit Fifo suni4x622FIFOReset Interface ConfigurationConfiguring the Receive and Transmit Fifo suni4x622FIFOCfg Pointer to Fifo configuration block Configuring the System interface suni4x622SysIntfCfgPointer to system interface configuration Pointer to device-wide line interface Resetting the Rfclk DLL suni4x622IntfSysResetRDLL Resetting the Tfclk DLL suni4x622IntfSysResetTDLLThis function resets the Tfclk DLL This function resets the Rfclk DLL Configuring APS Working/Protect Mate suni4x622APSCfg Automatic Protection Configuration Enable or disable Resetting APS Receive Link suni4x622APSResetRxLinkFunction is used to reset the receive APS link Transmit path channel number Resetting APS Transmit Link suni4x622APSResetTxLink Interrupt Service FunctionsFunction is used to reset the transmit APS link APS link number Getting Device Interrupt Enable Mask suni4x622GetMask Configuring ISR Processing suni4x622ISRConfigSetting Device Interrupt Enable Mask suni4x622SetMask Getting SOH Interrupt Enable Mask suni4x622GetMaskSOH Clearing Device Interrupt Enable Mask suni4x622ClrMaskSide Effects May change the operation of the ISR / DPR Clearing SOH Interrupt Enable Mask suni4x622ClrMaskSOH Setting SOH Interrupt Enable Mask suni4x622SetMaskSOHMay change the operation of the ISR / DPR Setting LOH Interrupt Enable Mask suni4x622SetMaskLOH Getting LOH Interrupt Enable Mask suni4x622GetMaskLOH Getting Rpoh Interrupt Enable Mask suni4x622GetMaskRPOH Clearing LOH Interrupt Enable Mask suni4x622ClrMaskLOH Clearing Rpoh Interrupt Enable Mask suni4x622ClrMaskRPOH Setting Rpoh Interrupt Enable Mask suni4x622SetMaskRPOH Setting Pyld Interrupt Enable Mask suni4x622SetMaskPYLD Getting Pyld Interrupt Enable Mask suni4x622GetMaskPYLD Getting Fifo Interrupt Enable Mask suni4x622GetMaskFIFO Clearing Pyld Interrupt Enable Mask suni4x622ClrMaskPYLD Clearing Fifo Interrupt Enable Mask suni4x622ClrMaskFIFO Setting Fifo Interrupt Enable Mask suni4x622SetMaskFIFO INT4 suni4x622SetMaskIntfLinesSUNI4x622HNDL Prototype Inputs Outputs Side Effects May change the operation of the ISR / DPR Setting APS Interrupt Enable Mask suni4x622SetMaskAPS Getting APS Interrupt Enable Mask suni4x622GetMaskAPS Polling the Interrupt Status Registers suni4x622Poll Clearing APS Interrupt Enable Mask suni4x622ClrMaskAPSPseudocode Deferred-Processing Routine suni4x622DPR Interrupt-Service Routine suni4x622ISRPointer to ISV buffer Outputs None Returns Getting the Device Status suni4x622GetStatusChan Alarm, Status and Counts FunctionsGetting the Device Status suni4x622GetStatusSOH Getting the Device Status suni4x622GetStatusRPOH Getting the Device Status suni4x622GetStatusLOH Getting the Device Status suni4x622GetStatusPYLD Getting the Device Status suni4x622GetStatusIntfLine Getting the Device Counts suni4x622GetCountsSOH Getting the Device Counts suni4x622GetCountsChan Getting the Device Counts suni4x622GetCountsRPOH Getting the Device Counts suni4x622GetCountsLOH Testing Register Accesses suni4x622DiagTestReg Device DiagnosticsGetting the Device Counts suni4x622GetCountsPYLD Enabling Data Diagnostic Loopbacks suni4x622DiagDataLoop Enabling Path Diagnostic Loopbacks suni4x622DiagPathLoopEnabling Line Loopbacks suni4x622DiagLineLoop Sets loop if non-zero, else clears loop INT4 suni4x622DiagSerialLoopsSUNI4x622HNDL Notifying the Application of SOH Events cbackSuni4x622SOH Callback FunctionsWill inhibit the flow of active data User context from suni4x622Add Notifying the Application of Rpoh Events cbackSuni4x622RPOH Notifying the Application of LOH Events cbackSuni4x622LOH Notifying the Application of Pyld Events cbackSuni4x622PYLD Notifying the Application of Fifo Events cbackSuni4x622FIFO Reading from a Device Register sysSuni4x622Read Device I/OWriting to a Device Register sysSuni4x622Write Format Prototype Inputs Outputs Returns System-Specific Interrupt Servicing Installing the ISR Handler sysSuni4x622ISRHandlerInstallPolling a Bit sysSuni4x622PollBit Outputs None DPR Task sysSuni4x622DPRTask ISR Handler sysSuni4x622ISRHandlerPseudocode Begin Format Prototype Inputs Outputs Returns Pseudocode Vector table Removing the ISR Handler sysSuni4x622ISRHandlerRemove Allocating Memory sysSuni4x622MemAlloc Memory Allocation / De-AllocationInitialize Memory sysSuni4x622MemSet Copy Memory sysSuni4x622MemCpy Freeing Memory sysSuni4x622MemFree Buffer ManagementStarting Buffer Management sysSuni4x622BufferStart Inputs None Outputs Returns Success = Returning an ISV Buffer sysSuni4x622ISVBufferRtn Getting an ISV Buffer sysSuni4x622ISVBufferGetGetting a DPV Buffer sysSuni4x622DPVBufferGet Pointer to a ISV buffer Sleeping a Task sysSuni4x622TimerSleep TimersReturning a DPV Buffer sysSuni4x622DPVBufferRtn Stopping Buffer Management sysSuni4x622BufferStop Re-Enabling Preemption sysSuni4x622PreemptEnable Disabling Preemption sysSuni4x622PreemptDisablePreemption Preemption key returned by sysSuni4x622PreemptDis Driver Source Files Driver Porting ProceduresTo port the S/UNI-4x622 driver to your platform Porting Assumptions To port the driver’s OS extensions Procedure 1 Porting Driver OS Extensions Procedure 3 Porting Driver Application-Specific Elements Procedure 2 Porting Drivers to Hardware PlatformsTo port the driver to your hardware platform To port the driver’s application-specific elements This section describes how to build the driver Procedure 4 Building the DriverDPR task stack size, in bytes 8192 To build the driver Naming Conventions Variable Type Definitions Constants MacrosStructures Functions File OrganizationVariables Device diagnostic functions API DiagnosticsInterface configuration functions for connecting Device specific configuration functions defined Invalid ISR/polling mode Error while installing interruptsSuccess Failure Line Overhead Events LOH Section Overhead Events SOH Path Overhead Events Rpoh Line Interface Events Intfline Payload Events PyldSystem Interface Events Sysintf Automatic Protection Switching Events APS List of Terms Acronyms Index Callbacks Device Enumerated types System-specific functions