PMC-Sierra PM5358 S/UNI 4x622 User Manuals

Table of Contents

• TITLE PAGE

  1
• CONTENTS

  4
• LIST OF FIGURES

  10
• LIST OF TABLES

  11
• About this Manual and S/UNI-4x622

  2
• Figure 1: Driver External Interfaces 14

  11
• Introduction

  13
• Software Architecture

  14
  • Driver External Interfaces

    14
  • Main Components

    15
  • Software States

    19
  • Processing Flows

    21
  • Interrupt Servicing

    22
• Data Structures

  26
  • Constants

    26
  • Structures Passed by the Application

    26
  • Structures in the Driver’s Allocated Memory

    33
  • Structures Passed through RTOS Buffers

    50
  • Global Variable

    51
• Application Programming Interface

  52
  • Module Management

    52
  • Profile Management

    54
  • Device Management

    55
  • Device Read and Write

    59
  • Section Overhead (SOH)

    61
  • Line Overhead (LOH)

    64
  • Path Overhead (RPOH, TPOH)

    68
  • Payload Processor

    74
  • Interface Configuration

    74
  • Automatic Protection Configuration

    78
  • Interrupt Service Functions

    79
  • Alarm, Status and Counts Functions

    96
  • Device Diagnostics

    101
  • Callback Functions

    103
• Hardware Interface

  108
  • Device I/O

    108
  • System-Specific Interrupt Servicing

    109
• RTOS Interface

  112
  • Memory Allocation / De-Allocation

    112
  • Buffer Management

    113
  • Timers

    115
  • Preemption

    116
• Porting the S/UNI-4x622 Driver

  117
  • Driver Source Files

    117
  • Driver Porting Procedures

    117
• Appendix A: Coding Conventions

  121
• Appendix B: Error Codes

  125
• Appendix C: S/UNI-4x622 Events

  126
• List of Terms

  130
• Acronyms

  131
• Index

  132