PMC-Sierra PM5358 S/UNI 4x622 3.3 Structures in the Drivers Allocated Memory

PM5358 S/UNI-4x622 Driver Manual
Data Structures
Proprietary and Confidential to PMC-Sierra, Inc. 33
Document ID: PMC-2010419, Issue 1
Field Name Field Type Field Description
lof UINT2 Los of frame
oof UINT2 Out of frame
lot UINT2 Loss of transition
dool UINT2 Recovered data out of lock
rool UINT2 Recovered refere nce out of lock
ese UINT2 Elastic store FIFO error
pj UINT2 Pointer Jus ti fic ation
3.3 Structures in the Driver’s Allocated Memory
These structures are defined and used by the driver and are part of the context memory allocated
when the driver is opened. These structures are the Module Data Block (MDB), the Device Data
Block (DDB).
Module Data Block: MDB
The MDB is the top-level structure for the module. It contains configuration data about the
module level code and pointers to configuration data about the device level codes.
• errModule most of the module API functions return a specific error code directly. When the
returned code is SUNI4x622_FAILURE, this ind ica tes tha t the top-level function was not able
to carry the specified error code back to the application. Under those circumstances, the
proper error code is recorded in this element. The element is the first in the structure so that
the USER can cast the MDB pointer into a INT4 pointer and retrieve the local error (this
elimina tes the need to inc lude the MDB template into the app lica tion cod e).
• valid indicates that this structure has been properly initialized and may be read by the
USER.
• stateModule contains the current state of the module and could be set to:
SUNI4x622_MOD_START, SUNI4x622_MOD_IDLE or SUNI4x622_MOD_READY.
Table 8: S/UNI-4x622 Module Data Block: sSUNI4x622_MDB
Field Name Field Type Field Description
errModule INT4 Global error Indicator for module calls
valid UINT2 Indicates that this structure has been