PMC-Sierra PM5358 S/UNI 4x622 manual - page 8

PM5358 S/UNI-4x622 Driver Manual
Proprietary and Confidential to PMC-Sierra, Inc. 8
Document ID: PMC-2010419, Issue 1
5.2 System-Specific Interrupt Servicing..........................................................................109
Installing the ISR Handler: sysSuni4x622ISRHandlerInstall .................................109
ISR Handler: sysSuni4x622ISRHandler................................................................110
DPR Task: sysSuni4x622DPRTask .......................................................................110
Removing the ISR Handl er: s ysSuni4x 622 ISR Han dl erRemove........................... 111
6 RTOS Interface .........................................................................................................112
6.1 Memory Allocation / De-Allocation............................................................................112
Allocating Memory: sysSuni4x622MemAlloc.........................................................112
Initiali ze Memor y: sysSuni4x622 MemSet..............................................................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
Disablin g Preemption: s ysSuni 4x622 PreemptDis ab le ..........................................116
Re-Enabling Preemption: sysSuni4x622PreemptEnable......................................116
7 Porting the S/UNI- 4x622 Dr iver ................................................................................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 Ty pe 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