Manuals / PMC-Sierra / Power Tools / Power Screwdriver

PMC-Sierra PM5358 S/UNI 4x622 manual Per-Channel Section Overhead SOH Configuration

Models: PM5358 S/UNI 4x622

1 136

Download 136 pages 8.16 Kb

Page 37

PM5358 S/UNI-4x622 Driver Manual

Data Structures

Per-Channel Section Overhead (SOH) Configuration

Table 12: S/UNI-4x622 Section Overhead Configuration: sSUNI4x622_CFG_SOH

Field Name	Field Type	Field Description

algo2	UINT1	Selects framing pattern used to determine and maintain the
		frame alignment

sblkbip	UINT1	Controls accumulation of section BIP errors

dds	UINT1	Rx descrambling

ds	UINT1	Tx scrambling

zeroen	UINT1	Selects whether all zero trace identifier messages accepted
		or ignored

Per-Channel Line Overhead (LOH) Configuration

Table 13: S/UNI-4x622 Line Overhead Configuration: sSUNI4x622_CFG_LOH

Field Name	Field Type	Field Description

laisdet	UINT1	Selects Line AIS detection algorithm

lrdidet	UINT1	Selects Line RDI detection algorithm

lbipword	UINT1	Selects accumulation of line BIP errors

sdlrdi	UINT1	Controls whether signal degrade can cause LRDI insertion

sflrdi	UINT1	Controls whether signal failure can cause LRDI insertion

loflrdi	UINT1	Controls whether loss of frame can cause LRDI insertion

loslrdi	UINT1	Controls whether loss of signal can cause LRDI insertion

rtimlrdi	UINT1	Controls whether section trace message mismatch can cause
		LRDI insertion

rtiulrdi	UINT1	Controls whether section trace message unstable can cause
		LRDI insertion

laislrdi	UINT1	Controls whether line AIS can cause LRDI insertion

autolfebe	UINT1	Controls whether line BIP errors can cause FEBE insertion

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

Image 37

PMC-Sierra PM5358 S/UNI 4x622 Per-Channel Section Overhead SOH Configuration, Per-Channel Line Overhead LOH Configuration

Contents

PM5358 UNI-4X622 Issue 1 AprilAudience Issue April Document createdReferences Revision HistoryContacting PMC-Sierra Legal IssuesTable 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 InterfacesReal-Time OS Interface Main ComponentsHardware Interface Rtos Module Data-Block and Devices Data-BlocksAlarms, Status and Counts Interrupt-Service RoutineDeferred-Processing Routine APS Configuration Interface ConfigurationSection Overhead Line OverheadModule States Software StatesDevice States Module StatesModule Management Processing FlowsDevice Management Suni4x622AddInitProfile Interrupt ServicingSuni4x622ISR and suni4x622DPR Calling suni4x622ISRCalling suni4x622Poll Calling suni4x622DPRPolling 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 signalLine REI error Line BIP errorSignal Defect Signal FailureRx CP Fifo overrun Tx FP Fifo underrun Rx FP Fifo overrunModule Data Block MDB Structures in the Driver’s Allocated MemoryDevice Data Block DDB Device State can be one of the following Interrupt Enable MaskPRESENT, Active or Inactive Base address of the deviceDevice-wide Global Configuration Per-Channel Line Overhead LOH Configuration Per-Channel Section Overhead SOH ConfigurationPer-Channel Transmit Path Overhead Tpoh Configuration Per-Channel Receive Path Overhead Rpoh ConfigurationControl of the persistence of the RDI asserted into Transmitted streamControls 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 insertionPer-Channel Payload Processor Configuration Per-Channel Clock Interface Configuration Per-Channel Fifo ConfigurationPer-Channel Line Interface Configuration Per-Channel Ralrm ConfigurationClock configuration block Device-wide System Interface Configuration Ralrm configuration blockDevice-Wide Line Interface Configuration Section Overhead SOH Status Receive Path Overhead Rpoh Status Line Overhead LOH StatusClock Status Payload Processor StatusTfclk active Section BIP error counterRefclka active Line Interface StatusReceive 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 ReturnsStopping the Driver Module suni4x622ModuleStop Starting the Driver Module suni4x622ModuleStartValid States Side EffectsAdding 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 SUNI4x622INACTIVEReading 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 SOHForcing 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 LOHWriting the K1K2 Byte suni4x622LOHWriteK1K2 Configuring SD Error Monitor suni4x622LOHSDCfgWriting the S1 Byte suni4x622LOHWriteS1 Reading the K1K2 Byte suni4x622LOHReadK1K2Reading 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 overheadWriting the J1 Byte suni4x622TPOHWriteJ1 Writing the New Data Flag Bits suni4x622TPOHWriteNDF Writing the C2 Byte suni4x622TPOHWriteC2Writing 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 eventForcing Path Ardi suni4x622TPOHForceARDI Forcing Path Erdi suni4x622TPOHForceERDIFlag to start/stop path RDI insertion Flag to start/stop path Erdi insertionPayload Processor Setting Payload configuration parameters suni4x622PyldCfgForcing Path AIS suni4x622TPOHForceAIS Flag to start/stop path AIS insertionResetting 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 interfaceResetting the Rfclk DLL suni4x622IntfSysResetRDLL Resetting the Tfclk DLL suni4x622IntfSysResetTDLLThis function resets the Tfclk DLL This function resets the Rfclk DLLConfiguring APS Working/Protect Mate suni4x622APSCfg Automatic Protection ConfigurationEnable or disable Resetting APS Receive Link suni4x622APSResetRxLinkFunction is used to reset the receive APS link Transmit path channel numberResetting APS Transmit Link suni4x622APSResetTxLink Interrupt Service FunctionsFunction is used to reset the transmit APS link APS link numberGetting 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 suni4x622GetMaskLOHGetting Rpoh Interrupt Enable Mask suni4x622GetMaskRPOH Clearing LOH Interrupt Enable Mask suni4x622ClrMaskLOHClearing Rpoh Interrupt Enable Mask suni4x622ClrMaskRPOH Setting Rpoh Interrupt Enable Mask suni4x622SetMaskRPOHSetting Pyld Interrupt Enable Mask suni4x622SetMaskPYLD Getting Pyld Interrupt Enable Mask suni4x622GetMaskPYLDGetting Fifo Interrupt Enable Mask suni4x622GetMaskFIFO Clearing Pyld Interrupt Enable Mask suni4x622ClrMaskPYLDClearing Fifo Interrupt Enable Mask suni4x622ClrMaskFIFO Setting Fifo Interrupt Enable Mask suni4x622SetMaskFIFOINT4 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 suni4x622GetMaskAPSPolling the Interrupt Status Registers suni4x622Poll Clearing APS Interrupt Enable Mask suni4x622ClrMaskAPSPseudocode Deferred-Processing Routine suni4x622DPR Interrupt-Service Routine suni4x622ISRPointer to ISV buffer Outputs None ReturnsGetting the Device Status suni4x622GetStatusChan Alarm, Status and Counts FunctionsGetting the Device Status suni4x622GetStatusSOH Getting the Device Status suni4x622GetStatusRPOH Getting the Device Status suni4x622GetStatusLOHGetting the Device Status suni4x622GetStatusPYLD Getting the Device Status suni4x622GetStatusIntfLineGetting the Device Counts suni4x622GetCountsSOH Getting the Device Counts suni4x622GetCountsChanGetting the Device Counts suni4x622GetCountsRPOH Getting the Device Counts suni4x622GetCountsLOHTesting 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 loopINT4 suni4x622DiagSerialLoopsSUNI4x622HNDL Notifying the Application of SOH Events cbackSuni4x622SOH Callback FunctionsWill inhibit the flow of active data User context from suni4x622AddNotifying the Application of Rpoh Events cbackSuni4x622RPOH Notifying the Application of LOH Events cbackSuni4x622LOHNotifying 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 ReturnsSystem-Specific Interrupt Servicing Installing the ISR Handler sysSuni4x622ISRHandlerInstallPolling a Bit sysSuni4x622PollBit Outputs NoneDPR Task sysSuni4x622DPRTask ISR Handler sysSuni4x622ISRHandlerPseudocode Begin Format Prototype Inputs Outputs Returns PseudocodeVector table Removing the ISR Handler sysSuni4x622ISRHandlerRemoveAllocating Memory sysSuni4x622MemAlloc Memory Allocation / De-AllocationInitialize Memory sysSuni4x622MemSet Copy Memory sysSuni4x622MemCpyFreeing 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 bufferSleeping a Task sysSuni4x622TimerSleep TimersReturning a DPV Buffer sysSuni4x622DPVBufferRtn Stopping Buffer Management sysSuni4x622BufferStopRe-Enabling Preemption sysSuni4x622PreemptEnable Disabling Preemption sysSuni4x622PreemptDisablePreemption Preemption key returned by sysSuni4x622PreemptDisDriver Source Files Driver Porting ProceduresTo port the S/UNI-4x622 driver to your platform Porting AssumptionsTo port the driver’s OS extensions Procedure 1 Porting Driver OS ExtensionsProcedure 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 elementsThis section describes how to build the driver Procedure 4 Building the DriverDPR task stack size, in bytes 8192 To build the driverNaming Conventions Variable Type DefinitionsConstants MacrosStructures Functions File OrganizationVariables Device diagnostic functions API DiagnosticsInterface configuration functions for connecting Device specific configuration functions definedInvalid ISR/polling mode Error while installing interruptsSuccess FailureLine Overhead Events LOH Section Overhead Events SOHPath 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