Procedure 4 Building the Driver | PMC-Sierra PM5358 S/UNI 4x622

PM5358 S/UNI-4x622 Driver Manual

Porting the S/UNI-4x622 Driver

SUNI4x622_DPR_TASK_STACK_SZ	DPR task stack size, in bytes	8192

SUNI4x622_POLL_DELAY	The constant used in polling task mode	100
	defines the interval time in millisecond
	between each polling action

SUNI4x622_TASK_SHUTDOWN_DELAY	Delay time in millisecond. When	100
	clearing the DPR loop active flag in the
	DPR task, this delay is used to
	gracefully shutdown the DPR task
	before deleting it

SUNI4x622_MAX_MSGS	The queue message depth of the queue	1000
	used for pass interrupt context between
	the ISR task and DPR task

2.Code the callback functions according to your application. The driver will call these callback functions when an event occurs on the device. The application is responsible for releasing the DPV buffer using sysSuni4x622DPVBufferRtn after necessary processing is completed.

These functions must conform to the following prototypes:

void cbackSuni4x622XX(sSUNI4x622_USR_CTXT usrCtxt, sSUNI4x622_DPV *pdpv)

Procedure 4: Building the Driver

This section describes how to build the driver.

To build the driver:

1.Ensure that the directory variable names in the makefile reflect your actual driver and directory names.

2.Compile the source files and build the driver using your make utility.

3.Link the driver to your application code.

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

Image 120

PMC-Sierra PM5358 S/UNI 4x622 Procedure 4 Building the Driver, DPR task stack size, in bytes 8192, To build the driver

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 Main Components Real-Time OS InterfaceHardware Interface Module Data-Block and Devices Data-Blocks Rtos Interrupt-Service Routine Alarms, Status and CountsDeferred-Processing Routine Interface Configuration APS ConfigurationSection Overhead 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 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 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 Section BIP error counter Tfclk activeRefclka 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 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 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 Activating a Device suni4x622Activate De-Activating a Device suni4x622DeActivateChanges the Device state to SUNI4x622ACTIVE 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 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 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 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 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 Interface 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 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 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 Interrupt-Service Routine suni4x622ISR Deferred-Processing Routine suni4x622DPRPointer to ISV buffer 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 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 Macros ConstantsStructures File Organization FunctionsVariables 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 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