Manuals / PMC-Sierra / Power Tools / Power Screwdriver

PMC-Sierra PM5358 S/UNI 4x622 manual Getting an ISV Buffer sysSuni4x622ISVBufferGet

Models: PM5358 S/UNI 4x622

1 136

Download 136 pages 8.16 Kb

Page 114

PM5358 S/UNI-4x622 Driver Manual

RTOS Interface

Failure = <any other value>

Getting an ISV Buffer: sysSuni4x622ISVBufferGet

This function gets a buffer from the RTOS that will be used by the ISR code to create an Interrupt-Service Vector (ISV). The ISV consists of data transferred from the devices interrupt status registers.

Format	#define sysSuni4x622ISVBufferGet()
Prototype	sSUNI4x622_ISV *sysSuni4x622ISVBufferGet(void)
Inputs	None
Outputs	None
Returns	Success = (pointer to) a ISV buffer
	Failure = NULL (pointer)

Returning an ISV Buffer: sysSuni4x622ISVBufferRtn

This function returns an ISV buffer to the RTOS when the information in the block is no longer needed by the DPR.

Format	#define sysSuni4x622ISVBufferRtn(pISV)
Prototype	void sysSuni4x622ISVBufferRtn(sSUNI4x622_ISV *pISV)
Inputs	pISV	: (pointer to) a ISV buffer
Outputs	None
Returns	None

Getting a DPV Buffer: sysSuni4x622DPVBufferGet

This function gets a buffer from the RTOS that will be used by the DPR code to create a Deferred-Processing Vector (DPV). The DPV consists of information about the state of the device that is to be passed to the USER via a callback function.

Format	#define sysSuni4x622DPVBufferGet()
Prototype	sSUNI4x622_DPV *sysSuni4x622DPVBufferGet(void)
Inputs	None
Outputs	None
Returns	Success = (pointer to) a DPV buffer
	Failure = NULL (pointer)

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

Image 114

PMC-Sierra PM5358 S/UNI 4x622 manual Getting an ISV Buffer sysSuni4x622ISVBufferGet, Pointer to a ISV buffer

Contents

Issue 1 April PM5358 UNI-4X622References Issue April Document createdAudience 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 Section Overhead Interface ConfigurationAPS Configuration 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 Section BIP error Interrupt mask for Fifo ConfigurationLoss of signal Line alarm signalSignal Defect Line BIP errorLine REI error 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 PRESENT, Active or Inactive Interrupt Enable MaskDevice State can be one of the following Base address of the deviceDevice-wide Global Configuration Per-Channel Section Overhead SOH Configuration Per-Channel Line Overhead LOH ConfigurationControl of the persistence of the RDI asserted into Per-Channel Receive Path Overhead Rpoh ConfigurationPer-Channel Transmit Path Overhead Tpoh Configuration Transmitted streamControls 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 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 StatusRefclka active Section BIP error counterTfclk 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 Closing the Driver Module suni4x622ModuleClose Module ManagementOpening the Driver Module suni4x622ModuleOpen Prototype Inputs Outputs ReturnsValid States Starting the Driver Module suni4x622ModuleStartStopping the Driver Module suni4x622ModuleStop 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 Changes the Device state to SUNI4x622ACTIVE Activating a Device suni4x622ActivateDe-Activating a Device suni4x622DeActivate 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 Pointer to SF configuration block Configuring SF Error Monitor suni4x622LOHSFCfgFlag to start/stop a loss of signal condition 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 Forcing Line RDI suni4x622LOHForceRDI Flag to start/stop B2 error insertionPath Overhead RPOH, Tpoh 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 Flag to start/stop B3 masking Forcing Pointer Justification suni4x622TPOHForcePJForcing Path RDI suni4x622TPOHForceRDI Type of Pointer Justification eventFlag to start/stop path RDI insertion Forcing Path Erdi suni4x622TPOHForceERDIForcing Path Ardi suni4x622TPOHForceARDI Flag to start/stop path Erdi insertionForcing Path AIS suni4x622TPOHForceAIS Setting Payload configuration parameters suni4x622PyldCfgPayload Processor Flag to start/stop path AIS insertionInterface 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 interfaceThis function resets the Tfclk DLL Resetting the Tfclk DLL suni4x622IntfSysResetTDLLResetting the Rfclk DLL suni4x622IntfSysResetRDLL This function resets the Rfclk DLLAutomatic Protection Configuration Configuring APS Working/Protect Mate suni4x622APSCfgFunction is used to reset the receive APS link Resetting APS Receive Link suni4x622APSResetRxLinkEnable or disable Transmit path channel numberFunction is used to reset the transmit APS link Interrupt Service FunctionsResetting APS Transmit Link suni4x622APSResetTxLink 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 Pointer to ISV buffer Interrupt-Service Routine suni4x622ISRDeferred-Processing Routine suni4x622DPR 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 Line Loopbacks suni4x622DiagLineLoop Enabling Path Diagnostic Loopbacks suni4x622DiagPathLoopEnabling Data Diagnostic Loopbacks suni4x622DiagDataLoop Sets loop if non-zero, else clears loopINT4 suni4x622DiagSerialLoopsSUNI4x622HNDL Will inhibit the flow of active data Callback FunctionsNotifying the Application of SOH Events cbackSuni4x622SOH 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 Writing to a Device Register sysSuni4x622Write Device I/OReading from a Device Register sysSuni4x622Read Format Prototype Inputs Outputs ReturnsPolling a Bit sysSuni4x622PollBit Installing the ISR Handler sysSuni4x622ISRHandlerInstallSystem-Specific Interrupt Servicing Outputs NonePseudocode Begin ISR Handler sysSuni4x622ISRHandlerDPR Task sysSuni4x622DPRTask Format Prototype Inputs Outputs Returns PseudocodeRemoving the ISR Handler sysSuni4x622ISRHandlerRemove Vector tableInitialize Memory sysSuni4x622MemSet Memory Allocation / De-AllocationAllocating Memory sysSuni4x622MemAlloc Copy Memory sysSuni4x622MemCpyStarting 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 bufferReturning a DPV Buffer sysSuni4x622DPVBufferRtn TimersSleeping a Task sysSuni4x622TimerSleep Stopping Buffer Management sysSuni4x622BufferStopPreemption Disabling Preemption sysSuni4x622PreemptDisableRe-Enabling Preemption sysSuni4x622PreemptEnable Preemption key returned by sysSuni4x622PreemptDisTo port the S/UNI-4x622 driver to your platform Driver Porting ProceduresDriver Source Files Porting AssumptionsProcedure 1 Porting Driver OS Extensions To port the driver’s OS extensionsTo 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 elementsDPR task stack size, in bytes 8192 Procedure 4 Building the DriverThis section describes how to build the driver To build the driverVariable Type Definitions Naming ConventionsMacros ConstantsStructures File Organization FunctionsVariables Interface configuration functions for connecting API DiagnosticsDevice diagnostic functions Device specific configuration functions definedSuccess Error while installing interruptsInvalid ISR/polling mode 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