Automatic Protection Configuration | PMC-Sierra PM5358 S/UNI 4x622

PM5358 S/UNI-4x622 Driver Manual

Application Programming Interface

4.10 Automatic Protection Configuration

The Automatic Protection Configuration section is responsible for configuring the S/UNI-4x622 to use the APS ports.

Configuring APS Working/Protect Mate: suni4x622APSCfg

When enable is set, this function enables the S/UNI-4x622 to operate as an APS working/protect mate under a failed condition. When enable is not set, this function resumes normal operation.

Prototype

Inputs

INT4 suni4x622APSCfg(sSUNI4x622_HNDL deviceHandle, UINT1 mode, UINT1 enable)

deviceHandle	: device handle (from suni4x622Add)
mode	: =0 if working mate; =1 if protect mate
enable	: start/stop APS operation

Outputs	None
Returns	Success = SUNI4x622_SUCCESS
	Failure = SUNI4x622_ERR_INVALID_DEVICE_STATE
	SUNI4x622_ERR_INVALID_DEV
Valid States	SUNI4x622_ACTIVE, SUNI4x622_INACTIVE
Side Effects	None

Configuring the Source Channel for the Given Channel Receive Path: suni4x622RPCfg

The function is used to control the source channel for the receive path.

Prototype

Inputs

Outputs Returns

INT4 suni4x622RPCfg(sSUNI4x622_HNDL deviceHandle, UINT1 channel, UINT1 srcChan)

deviceHandle	: device handle (from suni4x622Add)
channel	: receive path channel number
srcChan	: source channel number
None

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.	78
Document ID: PMC-2010419, Issue 1

Image 78

PMC-Sierra PM5358 S/UNI 4x622 Automatic Protection Configuration, Configuring APS Working/Protect Mate suni4x622APSCfg

Contents

Issue 1 April PM5358 UNI-4X622 References Issue April Document createdAudience Revision History Legal Issues Contacting PMC-Sierra 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 Driver External Interfaces Application Programming Interface Main Components Real-Time OS InterfaceHardware Interface Module Data-Block and Devices Data-Blocks Rtos Interrupt-Service Routine Alarms, Status and CountsDeferred-Processing Routine Section Overhead Interface ConfigurationAPS Configuration Line Overhead Software States Module States Module States Device States Processing Flows Module ManagementDevice Management Interrupt Servicing Suni4x622AddInitProfile Calling suni4x622ISR Suni4x622ISR and suni4x622DPR Calling suni4x622DPR Calling suni4x622Poll Polling Service Model Constants Structures Passed by the ApplicationModule Initialization Vector MIV Device Initialization Vector DIV ISR Enable/Disable Mask Section BIP error Interrupt mask for Fifo ConfigurationLoss of signal Line alarm signal Signal Defect Line BIP errorLine REI error Signal Failure Rx CP Fifo overrun Rx FP Fifo overrun Tx FP Fifo underrun Structures in the Driver’s Allocated Memory Module Data Block MDB Device Data Block DDB PRESENT, Active or Inactive Interrupt Enable MaskDevice State can be one of the following Base address of the device Device-wide Global Configuration Per-Channel Section Overhead SOH Configuration Per-Channel Line Overhead LOH Configuration Control of the persistence of the RDI asserted into Per-Channel Receive Path Overhead Rpoh ConfigurationPer-Channel Transmit Path Overhead Tpoh Configuration Transmitted stream Controls whether LOS,LOF or Lais will disable Eprdi Controls whether Path signal label mismatch can causeControls whether unequipped path signal label can cause Controls whether Pais will disable Eprdi insertion Per-Channel Payload Processor Configuration Per-Channel Fifo Configuration Per-Channel Clock Interface Configuration Per-Channel Ralrm Configuration Per-Channel Line Interface ConfigurationClock configuration block Ralrm configuration block Device-wide System Interface Configuration Device-Wide Line Interface Configuration Section Overhead SOH Status Line Overhead LOH Status Receive Path Overhead Rpoh Status Payload Processor Status Clock Status Refclka active Section BIP error counterTfclk active Line Interface Status Line Overhead LOH Counter Receive Path Overhead Rpoh CounterPayload Processor Pyld Counter Interrupt-Service Vector ISV Structures Passed through Rtos BuffersDeferred-Processing Vector DPV Global Variable Closing the Driver Module suni4x622ModuleClose Module ManagementOpening the Driver Module suni4x622ModuleOpen Prototype Inputs Outputs Returns Valid States Starting the Driver Module suni4x622ModuleStartStopping the Driver Module suni4x622ModuleStop Side Effects Profile Management Adding an Initialization Profile suni4x622AddInitProfileGetting an Initialization Profile suni4x622GetInitProfile Device Management Adding a Device suni4x622AddSide Effects None Deleting a Device suni4x622Delete Initializing a Device suni4x622InitPrototype Inputs Outputs Returns Valid States Side Effects Updating the Configuration of a Device suni4x622Update Resetting a Device suni4x622ResetSide Effects Changes the Device state to SUNI4x622INACTIVE Changes the Device state to SUNI4x622ACTIVE Activating a Device suni4x622ActivateDe-Activating a Device suni4x622DeActivate Changes the Device state to SUNI4x622INACTIVE Device Read and Write Reading from Device Registers suni4x622ReadWriting to Device Registers suni4x622Write Reading from a block of Device Registers suni4x622ReadBlock Writing to a Block of Device Registers suni4x622WriteBlockPrototype Inputs Section Overhead SOH Writing the J0 Byte suni4x622SOHWriteJ0 Forcing A1 Error suni4x622SOHForceA1 Forcing B1 Error suni4x622SOHForceB1 Flag to start/stop B1 error insertionForcing OOF suni4x622SOHForceOOF Pointer to SF configuration block Configuring SF Error Monitor suni4x622LOHSFCfgFlag to start/stop a loss of signal condition Line Overhead LOH Configuring SD Error Monitor suni4x622LOHSDCfg Writing the K1K2 Byte suni4x622LOHWriteK1K2 Reading the K1K2 Byte suni4x622LOHReadK1K2 Writing the S1 Byte suni4x622LOHWriteS1 Forcing B2 Error suni4x622LOHForceB2 Reading the S1 Byte suni4x622LOHReadS1Forcing Line AIS suni4x622LOHForceAIS Forcing Line RDI suni4x622LOHForceRDI Flag to start/stop B2 error insertionPath Overhead RPOH, Tpoh This function forces the line RDI into the line overhead Writing the J1 Byte suni4x622TPOHWriteJ1 Writing the C2 Byte suni4x622TPOHWriteC2 Writing the New Data Flag Bits suni4x622TPOHWriteNDF Force Path BIP-8 Errors suni4x622TPOHForceB3 Writing SS Bits suni4x622TPOHWriteSSInserting a Pointer Value suni4x622TPOHInsertTxPtr Flag to start/stop B3 masking Forcing Pointer Justification suni4x622TPOHForcePJForcing Path RDI suni4x622TPOHForceRDI Type of Pointer Justification event Flag to start/stop path RDI insertion Forcing Path Erdi suni4x622TPOHForceERDIForcing Path Ardi suni4x622TPOHForceARDI Flag to start/stop path Erdi insertion Forcing Path AIS suni4x622TPOHForceAIS Setting Payload configuration parameters suni4x622PyldCfgPayload Processor Flag to start/stop path AIS insertion Interface Configuration Resetting the Receive/Transmit Fifo suni4x622FIFOResetConfiguring the Receive and Transmit Fifo suni4x622FIFOCfg Pointer to system interface configuration Configuring the System interface suni4x622SysIntfCfgPointer to Fifo configuration block Pointer to device-wide line interface This function resets the Tfclk DLL Resetting the Tfclk DLL suni4x622IntfSysResetTDLLResetting the Rfclk DLL suni4x622IntfSysResetRDLL This function resets the Rfclk DLL Automatic Protection Configuration Configuring APS Working/Protect Mate suni4x622APSCfg Function is used to reset the receive APS link Resetting APS Receive Link suni4x622APSResetRxLinkEnable or disable Transmit path channel number Function is used to reset the transmit APS link Interrupt Service FunctionsResetting APS Transmit Link suni4x622APSResetTxLink APS link number Configuring ISR Processing suni4x622ISRConfig Getting Device Interrupt Enable Mask suni4x622GetMaskSetting Device Interrupt Enable Mask suni4x622SetMask Clearing Device Interrupt Enable Mask suni4x622ClrMask Getting SOH Interrupt Enable Mask suni4x622GetMaskSOHSide Effects May change the operation of the ISR / DPR Setting SOH Interrupt Enable Mask suni4x622SetMaskSOH Clearing SOH Interrupt Enable Mask suni4x622ClrMaskSOHMay change the operation of the ISR / DPR Getting LOH Interrupt Enable Mask suni4x622GetMaskLOH Setting LOH Interrupt Enable Mask suni4x622SetMaskLOH Clearing LOH Interrupt Enable Mask suni4x622ClrMaskLOH Getting Rpoh Interrupt Enable Mask suni4x622GetMaskRPOH Setting Rpoh Interrupt Enable Mask suni4x622SetMaskRPOH Clearing Rpoh Interrupt Enable Mask suni4x622ClrMaskRPOH Getting Pyld Interrupt Enable Mask suni4x622GetMaskPYLD Setting Pyld Interrupt Enable Mask suni4x622SetMaskPYLD Clearing Pyld Interrupt Enable Mask suni4x622ClrMaskPYLD Getting Fifo Interrupt Enable Mask suni4x622GetMaskFIFO Setting Fifo Interrupt Enable Mask suni4x622SetMaskFIFO Clearing Fifo Interrupt Enable Mask suni4x622ClrMaskFIFO INT4 suni4x622SetMaskIntfLinesSUNI4x622HNDL Prototype Inputs Outputs Side Effects May change the operation of the ISR / DPR Getting APS Interrupt Enable Mask suni4x622GetMaskAPS Setting APS Interrupt Enable Mask suni4x622SetMaskAPS Clearing APS Interrupt Enable Mask suni4x622ClrMaskAPS Polling the Interrupt Status Registers suni4x622PollPseudocode Pointer to ISV buffer Interrupt-Service Routine suni4x622ISRDeferred-Processing Routine suni4x622DPR Outputs None Returns Alarm, Status and Counts Functions Getting the Device Status suni4x622GetStatusChanGetting the Device Status suni4x622GetStatusSOH Getting the Device Status suni4x622GetStatusLOH Getting the Device Status suni4x622GetStatusRPOH Getting the Device Status suni4x622GetStatusIntfLine Getting the Device Status suni4x622GetStatusPYLD Getting the Device Counts suni4x622GetCountsChan Getting the Device Counts suni4x622GetCountsSOH Getting the Device Counts suni4x622GetCountsLOH Getting the Device Counts suni4x622GetCountsRPOH Device Diagnostics Testing Register Accesses suni4x622DiagTestRegGetting the Device Counts suni4x622GetCountsPYLD Enabling Line Loopbacks suni4x622DiagLineLoop Enabling Path Diagnostic Loopbacks suni4x622DiagPathLoopEnabling Data Diagnostic Loopbacks suni4x622DiagDataLoop Sets loop if non-zero, else clears loop INT4 suni4x622DiagSerialLoopsSUNI4x622HNDL Will inhibit the flow of active data Callback FunctionsNotifying the Application of SOH Events cbackSuni4x622SOH User context from suni4x622Add Notifying the Application of LOH Events cbackSuni4x622LOH Notifying the Application of Rpoh Events cbackSuni4x622RPOH Notifying the Application of Pyld Events cbackSuni4x622PYLD Notifying the Application of Fifo Events cbackSuni4x622FIFO Writing to a Device Register sysSuni4x622Write Device I/OReading from a Device Register sysSuni4x622Read Format Prototype Inputs Outputs Returns Polling a Bit sysSuni4x622PollBit Installing the ISR Handler sysSuni4x622ISRHandlerInstallSystem-Specific Interrupt Servicing Outputs None Pseudocode Begin ISR Handler sysSuni4x622ISRHandlerDPR Task sysSuni4x622DPRTask Format Prototype Inputs Outputs Returns Pseudocode Removing the ISR Handler sysSuni4x622ISRHandlerRemove Vector table Initialize Memory sysSuni4x622MemSet Memory Allocation / De-AllocationAllocating Memory sysSuni4x622MemAlloc Copy Memory sysSuni4x622MemCpy Starting Buffer Management sysSuni4x622BufferStart Buffer ManagementFreeing Memory sysSuni4x622MemFree Inputs None Outputs Returns Success = Getting a DPV Buffer sysSuni4x622DPVBufferGet Getting an ISV Buffer sysSuni4x622ISVBufferGetReturning an ISV Buffer sysSuni4x622ISVBufferRtn Pointer to a ISV buffer Returning a DPV Buffer sysSuni4x622DPVBufferRtn TimersSleeping a Task sysSuni4x622TimerSleep Stopping Buffer Management sysSuni4x622BufferStop Preemption Disabling Preemption sysSuni4x622PreemptDisableRe-Enabling Preemption sysSuni4x622PreemptEnable Preemption key returned by sysSuni4x622PreemptDis To port the S/UNI-4x622 driver to your platform Driver Porting ProceduresDriver Source Files Porting Assumptions Procedure 1 Porting Driver OS Extensions To port the driver’s OS extensions To port the driver to your hardware platform Procedure 2 Porting Drivers to Hardware PlatformsProcedure 3 Porting Driver Application-Specific Elements To port the driver’s application-specific elements DPR task stack size, in bytes 8192 Procedure 4 Building the DriverThis section describes how to build the driver To build the driver Variable Type Definitions Naming Conventions Macros ConstantsStructures File Organization FunctionsVariables Interface configuration functions for connecting API DiagnosticsDevice diagnostic functions Device specific configuration functions defined Success Error while installing interruptsInvalid ISR/polling mode Failure Section Overhead Events SOH Line Overhead Events LOH Path Overhead Events Rpoh Payload Events Pyld Line Interface Events IntflineSystem Interface Events Sysintf Automatic Protection Switching Events APS List of Terms Acronyms Index Callbacks Device Enumerated types System-specific functions