Manuals / PMC-Sierra / Power Tools / Power Screwdriver

PMC-Sierra PM5358 S/UNI 4x622 manual Device-wide Global Configuration

Models: PM5358 S/UNI 4x622

1 136

Download 136 pages 8.16 Kb

Page 36

PM5358 S/UNI-4x622 Driver Manual

Data Structures

Device-wide Global Configuration

Table 10: S/UNI-4x622 Input/Output Configuration: sSUNI4x622_CFG_GLOBAL

Field Name	Field Type	Field Description

sonetsel	UINT1	Select SONET/SDH mode

cfgIntfSys	sSUNI4x622_CFG_INTF_SYS_GLOBAL	System Interface configuration
		block

cfgIntfLine	sSUNI4x622_CFG_INTF_LINE_GLOBAL	Line Interface configuration
		block

Per-Channel Configuration

Table 11: S/UNI-4x622 Channel Configuration: sSUNI4x622_CFG_CHAN

Field Name	Field Type	Field Description

cfgSOH	sSUNI4x622_CFG_SOH	Section Overhead Processor (SOH) configuration
		block

cfgLOH	sSUNI4x622_CFG_LOH	Line Overhead Processor (LOH) configuration
		block

cfgRPOH	sSUNI4x622_CFG_RPOH	Receive Path Overhead Processor (RPOH)
		configuration block

cfgTPOH	sSUNI4x622_CFG_TPOH	Transmit Path Overhead Processor (TPOH)
		configuration block

cfgPYLD	sSUNI4x622_CFG_PYLD	Payload Processor (PYLD) configuration block

cfgFIFO	sSUNI4x622_CFG_FIFO	FIFO configuration

cfgLine	sSUNI4x622_CFG_INTF	Line Interface configuration block
	_LINE

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

Image 36

PMC-Sierra PM5358 S/UNI 4x622 manual Device-wide Global Configuration

Contents

Issue 1 April PM5358 UNI-4X622Issue April Document created AudienceReferences Revision HistoryLegal Issues Contacting PMC-SierraTable 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 InterfaceMain Components Real-Time OS InterfaceHardware Interface Module Data-Block and Devices Data-Blocks RtosInterrupt-Service Routine Alarms, Status and CountsDeferred-Processing Routine Interface Configuration APS ConfigurationSection Overhead Line OverheadSoftware States Module StatesModule States Device StatesProcessing Flows Module ManagementDevice Management Interrupt Servicing Suni4x622AddInitProfileCalling suni4x622ISR Suni4x622ISR and suni4x622DPRCalling suni4x622DPR Calling suni4x622PollPolling Service Model Constants Structures Passed by the ApplicationModule Initialization Vector MIV Device Initialization Vector DIV ISR Enable/Disable Mask Interrupt mask for Fifo Configuration Loss of signalSection BIP error Line alarm signalLine BIP error Line REI errorSignal Defect Signal FailureRx CP Fifo overrun Rx FP Fifo overrun Tx FP Fifo underrunStructures in the Driver’s Allocated Memory Module Data Block MDBDevice Data Block DDB Interrupt Enable Mask Device State can be one of the followingPRESENT, Active or Inactive Base address of the deviceDevice-wide Global Configuration Per-Channel Section Overhead SOH Configuration Per-Channel Line Overhead LOH ConfigurationPer-Channel Receive Path Overhead Rpoh Configuration Per-Channel Transmit Path Overhead Tpoh ConfigurationControl of the persistence of the RDI asserted into Transmitted streamControls 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 insertionPer-Channel Payload Processor Configuration Per-Channel Fifo Configuration Per-Channel Clock Interface ConfigurationPer-Channel Ralrm Configuration Per-Channel Line Interface ConfigurationClock configuration block Ralrm configuration block Device-wide System Interface ConfigurationDevice-Wide Line Interface Configuration Section Overhead SOH Status Line Overhead LOH Status Receive Path Overhead Rpoh StatusPayload Processor Status Clock StatusSection BIP error counter Tfclk activeRefclka active Line Interface StatusLine 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 Module Management Opening the Driver Module suni4x622ModuleOpenClosing the Driver Module suni4x622ModuleClose Prototype Inputs Outputs ReturnsStarting the Driver Module suni4x622ModuleStart Stopping the Driver Module suni4x622ModuleStopValid States Side EffectsProfile 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 Activating a Device suni4x622Activate De-Activating a Device suni4x622DeActivateChanges the Device state to SUNI4x622ACTIVE Changes the Device state to SUNI4x622INACTIVEDevice 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 suni4x622SOHWriteJ0Forcing A1 Error suni4x622SOHForceA1 Forcing B1 Error suni4x622SOHForceB1 Flag to start/stop B1 error insertionForcing OOF suni4x622SOHForceOOF Configuring SF Error Monitor suni4x622LOHSFCfg Flag to start/stop a loss of signal conditionPointer to SF configuration block Line Overhead LOHConfiguring SD Error Monitor suni4x622LOHSDCfg Writing the K1K2 Byte suni4x622LOHWriteK1K2Reading the K1K2 Byte suni4x622LOHReadK1K2 Writing the S1 Byte suni4x622LOHWriteS1Forcing B2 Error suni4x622LOHForceB2 Reading the S1 Byte suni4x622LOHReadS1Forcing Line AIS suni4x622LOHForceAIS Flag to start/stop B2 error insertion Path Overhead RPOH, TpohForcing Line RDI suni4x622LOHForceRDI This function forces the line RDI into the line overheadWriting the J1 Byte suni4x622TPOHWriteJ1 Writing the C2 Byte suni4x622TPOHWriteC2 Writing the New Data Flag Bits suni4x622TPOHWriteNDFForce Path BIP-8 Errors suni4x622TPOHForceB3 Writing SS Bits suni4x622TPOHWriteSSInserting a Pointer Value suni4x622TPOHInsertTxPtr Forcing Pointer Justification suni4x622TPOHForcePJ Forcing Path RDI suni4x622TPOHForceRDIFlag to start/stop B3 masking Type of Pointer Justification eventForcing Path Erdi suni4x622TPOHForceERDI Forcing Path Ardi suni4x622TPOHForceARDIFlag to start/stop path RDI insertion Flag to start/stop path Erdi insertionSetting Payload configuration parameters suni4x622PyldCfg Payload ProcessorForcing Path AIS suni4x622TPOHForceAIS Flag to start/stop path AIS insertionInterface Configuration Resetting the Receive/Transmit Fifo suni4x622FIFOResetConfiguring the Receive and Transmit Fifo suni4x622FIFOCfg Configuring the System interface suni4x622SysIntfCfg Pointer to Fifo configuration blockPointer to system interface configuration Pointer to device-wide line interfaceResetting the Tfclk DLL suni4x622IntfSysResetTDLL Resetting the Rfclk DLL suni4x622IntfSysResetRDLLThis function resets the Tfclk DLL This function resets the Rfclk DLLAutomatic Protection Configuration Configuring APS Working/Protect Mate suni4x622APSCfgResetting APS Receive Link suni4x622APSResetRxLink Enable or disableFunction is used to reset the receive APS link Transmit path channel numberInterrupt Service Functions Resetting APS Transmit Link suni4x622APSResetTxLinkFunction is used to reset the transmit APS link APS link numberConfiguring 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 suni4x622SetMaskLOHClearing LOH Interrupt Enable Mask suni4x622ClrMaskLOH Getting Rpoh Interrupt Enable Mask suni4x622GetMaskRPOHSetting Rpoh Interrupt Enable Mask suni4x622SetMaskRPOH Clearing Rpoh Interrupt Enable Mask suni4x622ClrMaskRPOHGetting Pyld Interrupt Enable Mask suni4x622GetMaskPYLD Setting Pyld Interrupt Enable Mask suni4x622SetMaskPYLDClearing Pyld Interrupt Enable Mask suni4x622ClrMaskPYLD Getting Fifo Interrupt Enable Mask suni4x622GetMaskFIFOSetting Fifo Interrupt Enable Mask suni4x622SetMaskFIFO Clearing Fifo Interrupt Enable Mask suni4x622ClrMaskFIFOINT4 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 suni4x622SetMaskAPSClearing APS Interrupt Enable Mask suni4x622ClrMaskAPS Polling the Interrupt Status Registers suni4x622PollPseudocode Interrupt-Service Routine suni4x622ISR Deferred-Processing Routine suni4x622DPRPointer to ISV buffer Outputs None ReturnsAlarm, Status and Counts Functions Getting the Device Status suni4x622GetStatusChanGetting the Device Status suni4x622GetStatusSOH Getting the Device Status suni4x622GetStatusLOH Getting the Device Status suni4x622GetStatusRPOHGetting the Device Status suni4x622GetStatusIntfLine Getting the Device Status suni4x622GetStatusPYLDGetting the Device Counts suni4x622GetCountsChan Getting the Device Counts suni4x622GetCountsSOHGetting the Device Counts suni4x622GetCountsLOH Getting the Device Counts suni4x622GetCountsRPOHDevice Diagnostics Testing Register Accesses suni4x622DiagTestRegGetting the Device Counts suni4x622GetCountsPYLD Enabling Path Diagnostic Loopbacks suni4x622DiagPathLoop Enabling Data Diagnostic Loopbacks suni4x622DiagDataLoopEnabling Line Loopbacks suni4x622DiagLineLoop Sets loop if non-zero, else clears loopINT4 suni4x622DiagSerialLoopsSUNI4x622HNDL Callback Functions Notifying the Application of SOH Events cbackSuni4x622SOHWill inhibit the flow of active data User context from suni4x622AddNotifying the Application of LOH Events cbackSuni4x622LOH Notifying the Application of Rpoh Events cbackSuni4x622RPOHNotifying 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 ReturnsInstalling the ISR Handler sysSuni4x622ISRHandlerInstall System-Specific Interrupt ServicingPolling a Bit sysSuni4x622PollBit Outputs NoneISR Handler sysSuni4x622ISRHandler DPR Task sysSuni4x622DPRTaskPseudocode Begin Format Prototype Inputs Outputs Returns PseudocodeRemoving the ISR Handler sysSuni4x622ISRHandlerRemove Vector tableMemory Allocation / De-Allocation Allocating Memory sysSuni4x622MemAllocInitialize Memory sysSuni4x622MemSet Copy Memory sysSuni4x622MemCpyBuffer 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 bufferTimers Sleeping a Task sysSuni4x622TimerSleepReturning a DPV Buffer sysSuni4x622DPVBufferRtn Stopping Buffer Management sysSuni4x622BufferStopDisabling Preemption sysSuni4x622PreemptDisable Re-Enabling Preemption sysSuni4x622PreemptEnablePreemption Preemption key returned by sysSuni4x622PreemptDisDriver Porting Procedures Driver Source FilesTo port the S/UNI-4x622 driver to your platform Porting AssumptionsProcedure 1 Porting Driver OS Extensions To port the driver’s OS extensionsProcedure 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 elementsProcedure 4 Building the Driver This section describes how to build the driverDPR task stack size, in bytes 8192 To build the driverVariable Type Definitions Naming ConventionsMacros ConstantsStructures File Organization FunctionsVariables API Diagnostics Device diagnostic functionsInterface configuration functions for connecting Device specific configuration functions definedError while installing interrupts Invalid ISR/polling modeSuccess FailureSection Overhead Events SOH Line Overhead Events LOHPath 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