112 | PMC-Sierra PM5358 S/UNI 4x622 specs

PM5358 S/UNI-4x622 Driver Manual
5.2 System-Specific Interrupt Servicing	109
Installing the ISR Handler: sysSuni4x622ISRHandlerInstall	109
ISR Handler: sysSuni4x622ISRHandler	110
DPR Task: sysSuni4x622DPRTask	110
Removing the ISR Handler: sysSuni4x622ISRHandlerRemove	111
6 RTOS Interface	112
6.1 Memory Allocation / De-Allocation	112
Allocating Memory: sysSuni4x622MemAlloc	112
Initialize Memory: sysSuni4x622MemSet	112
Copy Memory: sysSuni4x622MemCpy	112
Freeing Memory: sysSuni4x622MemFree	113
6.2 Buffer Management	113
Starting Buffer Management: sysSuni4x622BufferStart	113
Getting an ISV Buffer: sysSuni4x622ISVBufferGet	114
Returning an ISV Buffer: sysSuni4x622ISVBufferRtn	114
Getting a DPV Buffer: sysSuni4x622DPVBufferGet	114
Returning a DPV Buffer: sysSuni4x622DPVBufferRtn	115
Stopping Buffer Management: sysSuni4x622BufferStop	115
6.3 Timers	115
Sleeping a Task: sysSuni4x622TimerSleep	115
6.4 Preemption	116
Disabling Preemption: sysSuni4x622PreemptDisable	116
Re-Enabling Preemption: sysSuni4x622PreemptEnable	116
7 Porting the S/UNI-4x622 Driver	117
7.1 Driver Source Files	117
7.2 Driver Porting Procedures	117
Procedure 1: Porting Driver OS Extensions	118
Procedure 2: Porting Drivers to Hardware Platforms	119
Procedure 3: Porting Driver Application-Specific Elements	119
Procedure 4: Building the Driver	120
Appendix A: Coding Conventions	121
Variable Type Definitions	121
Naming Conventions	121
Macros	122
Constants	122
Structures	122
Functions	123
Variables	123
File Organization	123
Appendix B: Error Codes	125
Appendix C: S/UNI-4x622 Events	126
Section Overhead Events (SOH)	126
Line Overhead Events (LOH)	126
Path Overhead Events (RPOH)	127

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

Image 8

PMC-Sierra PM5358 S/UNI 4x622 manual 112

Contents

Issue 1 April PM5358 UNI-4X622 Issue April Document created AudienceReferences 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 Hardware Interface Main ComponentsReal-Time OS Interface Module Data-Block and Devices Data-Blocks Rtos Deferred-Processing Routine Interrupt-Service RoutineAlarms, Status and Counts Interface Configuration APS ConfigurationSection Overhead Line Overhead Software States Module States Module States Device States Device Management Processing FlowsModule Management Interrupt Servicing Suni4x622AddInitProfile Calling suni4x622ISR Suni4x622ISR and suni4x622DPR Calling suni4x622DPR Calling suni4x622Poll Polling Service Model Module Initialization Vector MIV ConstantsStructures Passed by the Application Device Initialization Vector DIV ISR Enable/Disable Mask Interrupt mask for Fifo Configuration Loss of signalSection BIP error Line alarm signal Line BIP error Line REI errorSignal Defect 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 Interrupt Enable Mask Device State can be one of the followingPRESENT, Active or Inactive Base address of the device Device-wide Global Configuration Per-Channel Section Overhead SOH Configuration Per-Channel Line Overhead LOH Configuration Per-Channel Receive Path Overhead Rpoh Configuration Per-Channel Transmit Path Overhead Tpoh ConfigurationControl of the persistence of the RDI asserted into Transmitted stream Controls whether Path signal label mismatch can cause Controls whether unequipped path signal label can causeControls whether LOS,LOF or Lais will disable Eprdi Controls whether Pais will disable Eprdi insertion Per-Channel Payload Processor Configuration Per-Channel Fifo Configuration Per-Channel Clock Interface Configuration Clock configuration block Per-Channel Ralrm ConfigurationPer-Channel Line Interface Configuration 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 Section BIP error counter Tfclk activeRefclka 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 Module Management Opening the Driver Module suni4x622ModuleOpenClosing the Driver Module suni4x622ModuleClose Prototype Inputs Outputs Returns Starting the Driver Module suni4x622ModuleStart Stopping the Driver Module suni4x622ModuleStopValid 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 Activating a Device suni4x622Activate De-Activating a Device suni4x622DeActivateChanges 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 Section Overhead SOH Writing the J0 Byte suni4x622SOHWriteJ0 Forcing A1 Error suni4x622SOHForceA1 Forcing OOF suni4x622SOHForceOOF Forcing B1 Error suni4x622SOHForceB1Flag to start/stop B1 error insertion Configuring SF Error Monitor suni4x622LOHSFCfg Flag to start/stop a loss of signal conditionPointer to SF configuration block Line Overhead LOH Configuring SD Error Monitor suni4x622LOHSDCfg Writing the K1K2 Byte suni4x622LOHWriteK1K2 Reading the K1K2 Byte suni4x622LOHReadK1K2 Writing the S1 Byte suni4x622LOHWriteS1 Forcing Line AIS suni4x622LOHForceAIS Forcing B2 Error suni4x622LOHForceB2Reading the S1 Byte suni4x622LOHReadS1 Flag to start/stop B2 error insertion Path Overhead RPOH, TpohForcing Line RDI suni4x622LOHForceRDI 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 Inserting a Pointer Value suni4x622TPOHInsertTxPtr Force Path BIP-8 Errors suni4x622TPOHForceB3Writing SS Bits suni4x622TPOHWriteSS Forcing Pointer Justification suni4x622TPOHForcePJ Forcing Path RDI suni4x622TPOHForceRDIFlag to start/stop B3 masking Type of Pointer Justification event Forcing Path Erdi suni4x622TPOHForceERDI Forcing Path Ardi suni4x622TPOHForceARDIFlag to start/stop path RDI insertion Flag to start/stop path Erdi insertion Setting Payload configuration parameters suni4x622PyldCfg Payload ProcessorForcing Path AIS suni4x622TPOHForceAIS Flag to start/stop path AIS insertion Configuring the Receive and Transmit Fifo suni4x622FIFOCfg Interface ConfigurationResetting the Receive/Transmit Fifo suni4x622FIFOReset Configuring the System interface suni4x622SysIntfCfg Pointer to Fifo configuration blockPointer to system interface configuration Pointer to device-wide line interface Resetting the Tfclk DLL suni4x622IntfSysResetTDLL Resetting the Rfclk DLL suni4x622IntfSysResetRDLLThis function resets the Tfclk DLL This function resets the Rfclk DLL Automatic Protection Configuration Configuring APS Working/Protect Mate suni4x622APSCfg Resetting APS Receive Link suni4x622APSResetRxLink Enable or disableFunction is used to reset the receive APS link Transmit path channel number Interrupt Service Functions Resetting APS Transmit Link suni4x622APSResetTxLinkFunction 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 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 Pseudocode Clearing APS Interrupt Enable Mask suni4x622ClrMaskAPSPolling the Interrupt Status Registers suni4x622Poll Interrupt-Service Routine suni4x622ISR Deferred-Processing Routine suni4x622DPRPointer to ISV buffer Outputs None Returns Getting the Device Status suni4x622GetStatusSOH Alarm, Status and Counts FunctionsGetting the Device Status suni4x622GetStatusChan 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 Getting the Device Counts suni4x622GetCountsPYLD Device DiagnosticsTesting Register Accesses suni4x622DiagTestReg Enabling Path Diagnostic Loopbacks suni4x622DiagPathLoop Enabling Data Diagnostic Loopbacks suni4x622DiagDataLoopEnabling Line Loopbacks suni4x622DiagLineLoop Sets loop if non-zero, else clears loop INT4 suni4x622DiagSerialLoopsSUNI4x622HNDL Callback Functions Notifying the Application of SOH Events cbackSuni4x622SOHWill inhibit the flow of active data 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 Device I/O Reading from a Device Register sysSuni4x622ReadWriting to a Device Register sysSuni4x622Write Format Prototype Inputs Outputs Returns Installing the ISR Handler sysSuni4x622ISRHandlerInstall System-Specific Interrupt ServicingPolling a Bit sysSuni4x622PollBit Outputs None ISR Handler sysSuni4x622ISRHandler DPR Task sysSuni4x622DPRTaskPseudocode Begin Format Prototype Inputs Outputs Returns Pseudocode Removing the ISR Handler sysSuni4x622ISRHandlerRemove Vector table Memory Allocation / De-Allocation Allocating Memory sysSuni4x622MemAllocInitialize Memory sysSuni4x622MemSet Copy Memory sysSuni4x622MemCpy Buffer Management Freeing Memory sysSuni4x622MemFreeStarting Buffer Management sysSuni4x622BufferStart Inputs None Outputs Returns Success = Getting an ISV Buffer sysSuni4x622ISVBufferGet Returning an ISV Buffer sysSuni4x622ISVBufferRtnGetting a DPV Buffer sysSuni4x622DPVBufferGet Pointer to a ISV buffer Timers Sleeping a Task sysSuni4x622TimerSleepReturning a DPV Buffer sysSuni4x622DPVBufferRtn Stopping Buffer Management sysSuni4x622BufferStop Disabling Preemption sysSuni4x622PreemptDisable Re-Enabling Preemption sysSuni4x622PreemptEnablePreemption Preemption key returned by sysSuni4x622PreemptDis Driver Porting Procedures Driver Source FilesTo port the S/UNI-4x622 driver to your platform Porting Assumptions Procedure 1 Porting Driver OS Extensions To port the driver’s OS extensions Procedure 2 Porting Drivers to Hardware Platforms Procedure 3 Porting Driver Application-Specific ElementsTo port the driver to your hardware platform To port the driver’s application-specific elements Procedure 4 Building the Driver This section describes how to build the driverDPR task stack size, in bytes 8192 To build the driver Variable Type Definitions Naming Conventions Structures MacrosConstants Variables File OrganizationFunctions API Diagnostics Device diagnostic functionsInterface configuration functions for connecting Device specific configuration functions defined Error while installing interrupts Invalid ISR/polling modeSuccess Failure Section Overhead Events SOH Line Overhead Events LOH 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