PMC-Sierra PM5358 S/UNI 4x622 manual

	PM5358 S/UNI-4x622 Driver Manual
3.2	Structures Passed by the Application	26
	Module Initialization Vector: MIV	26
	Device Initialization Vector: DIV	27
	ISR Enable/Disable Mask	28
3.3	Structures in the Driver’s Allocated Memory	33
	Module Data Block: MDB	33
	Device Data Block: DDB	34
3.4	Structures Passed through RTOS Buffers	50
	Interrupt-Service Vector: ISV	50
	Deferred-Processing Vector: DPV	50
3.5	Global Variable	51
4	Application Programming Interface	52
4.1	Module Management	52
	Opening the Driver Module: suni4x622ModuleOpen	52
	Closing the Driver Module: suni4x622ModuleClose	52
	Starting the Driver Module: suni4x622ModuleStart	53
	Stopping the Driver Module: suni4x622ModuleStop	53
4.2	Profile Management	54
	Adding an Initialization Profile: suni4x622AddInitProfile	54
	Getting an Initialization Profile: suni4x622GetInitProfile	54
	Deleting an Initialization Profile: suni4x622DeleteInitProfile	55
4.3	Device Management	55
	Adding a Device: suni4x622Add	55
	Deleting a Device: suni4x622Delete	56
	Initializing a Device: suni4x622Init	56
	Updating the Configuration of a Device: suni4x622Update	57
	Resetting a Device: suni4x622Reset	57
	Activating a Device: suni4x622Activate	58
	De-Activating a Device: suni4x622DeActivate	58
4.4	Device Read and Write	59
	Reading from Device Registers: suni4x622Read	59
	Writing to Device Registers: suni4x622Write	59
	Reading from a block of Device Registers: suni4x622ReadBlock	60
	Writing to a Block of Device Registers: suni4x622WriteBlock	60
4.5	Section Overhead (SOH)	61
	Writing the J0 Byte: suni4x622SOHWriteJ0	61
	Reading and Setting the Section Trace Message :
	suni4x622SOHTraceMsg	62
	Forcing A1 Error : suni4x622SOHForceA1	62
	Forcing B1 Error: suni4x622SOHForceB1	63
	Forcing OOF: suni4x622SOHForceOOF	63
	Forcing LOS: suni4x622SOHForceLOS	64
4.6	Line Overhead (LOH)	64
	Configuring SF Error Monitor: suni4x622LOHSFCfg	64
	Configuring SD Error Monitor: suni4x622LOHSDCfg	65

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

Image 5

PMC-Sierra PM5358 S/UNI 4x622 manual Updating the Configuration of a Device suni4x622Update

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 Hardware Interface Main ComponentsReal-Time OS Interface Rtos Module Data-Block and Devices Data-Blocks Deferred-Processing Routine Interrupt-Service RoutineAlarms, Status and Counts APS Configuration Interface ConfigurationSection Overhead Line Overhead Module States Software States Device States Module States Device Management Processing FlowsModule Management Suni4x622AddInitProfile Interrupt Servicing Suni4x622ISR and suni4x622DPR Calling suni4x622ISR Calling suni4x622Poll Calling suni4x622DPR Polling Service Model Module Initialization Vector MIV ConstantsStructures Passed by the Application 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 Clock configuration block Per-Channel Ralrm ConfigurationPer-Channel Line Interface Configuration 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 Payload Processor Pyld Counter Line Overhead LOH CounterReceive Path Overhead Rpoh Counter Deferred-Processing Vector DPV Interrupt-Service Vector ISVStructures Passed through Rtos Buffers 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 Getting an Initialization Profile suni4x622GetInitProfile Profile ManagementAdding an Initialization Profile suni4x622AddInitProfile Side Effects None Device ManagementAdding a Device suni4x622Add Prototype Inputs Outputs Returns Valid States Side Effects Deleting a Device suni4x622DeleteInitializing a Device suni4x622Init Side Effects Changes the Device state to SUNI4x622INACTIVE Updating the Configuration of a Device suni4x622UpdateResetting a Device suni4x622Reset De-Activating a Device suni4x622DeActivate Activating a Device suni4x622ActivateChanges the Device state to SUNI4x622ACTIVE Changes the Device state to SUNI4x622INACTIVE Writing to Device Registers suni4x622Write Device Read and WriteReading from Device Registers suni4x622Read Prototype Inputs Reading from a block of Device Registers suni4x622ReadBlockWriting to a Block of Device Registers suni4x622WriteBlock Writing the J0 Byte suni4x622SOHWriteJ0 Section Overhead SOH Forcing A1 Error suni4x622SOHForceA1 Forcing OOF suni4x622SOHForceOOF Forcing B1 Error suni4x622SOHForceB1Flag to start/stop B1 error insertion 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 Forcing Line AIS suni4x622LOHForceAIS Forcing B2 Error suni4x622LOHForceB2Reading the S1 Byte suni4x622LOHReadS1 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 Inserting a Pointer Value suni4x622TPOHInsertTxPtr Force Path BIP-8 Errors suni4x622TPOHForceB3Writing SS Bits suni4x622TPOHWriteSS 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 Configuring the Receive and Transmit Fifo suni4x622FIFOCfg Interface ConfigurationResetting the Receive/Transmit Fifo suni4x622FIFOReset 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 Setting Device Interrupt Enable Mask suni4x622SetMask Configuring ISR Processing suni4x622ISRConfigGetting Device Interrupt Enable Mask suni4x622GetMask Side Effects May change the operation of the ISR / DPR Clearing Device Interrupt Enable Mask suni4x622ClrMaskGetting SOH Interrupt Enable Mask suni4x622GetMaskSOH May change the operation of the ISR / DPR Setting SOH Interrupt Enable Mask suni4x622SetMaskSOHClearing SOH Interrupt Enable Mask suni4x622ClrMaskSOH 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 Pseudocode Clearing APS Interrupt Enable Mask suni4x622ClrMaskAPSPolling the Interrupt Status Registers suni4x622Poll Deferred-Processing Routine suni4x622DPR Interrupt-Service Routine suni4x622ISRPointer to ISV buffer Outputs None Returns Getting the Device Status suni4x622GetStatusSOH Alarm, Status and Counts FunctionsGetting the Device Status suni4x622GetStatusChan 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 Getting the Device Counts suni4x622GetCountsPYLD Device DiagnosticsTesting Register Accesses suni4x622DiagTestReg 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 Structures MacrosConstants Variables File OrganizationFunctions 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 System Interface Events Sysintf Payload Events PyldLine Interface Events Intfline Automatic Protection Switching Events APS List of Terms Acronyms Index Callbacks Device Enumerated types System-specific functions