PMC-Sierra PM5358 S/UNI 4x622 3.5 Global Variable

PM5358 S/UNI-4x622 Driver Manual
Data Structures
Proprietary and Confidential to PMC-Sierra, Inc. 51
Document ID: PMC-2010419, Issue 1
Table 37: S/UNI-4x622 Deferred-Processing Vector: sSUNI4x622_DPV
Field Name Field Type Field Description
event SUNI4x622_DPR_EVENT Event being reported
cause UINT2 Reason for the Event
3.5 Global Variable
Although most of the variables within the driver are not meant to be used by the application code,
there is one global variable that can be of great use to the application code.
suni4x622Mdb: A global pointer to the Module Data Block (MDB). The content of this global
variable should be considered read-only by the application.
• errModule: This structure element is used to store an error code that specifies the reason for
an API function’s failure. The field is only valid for functions that do not return an error code
or when a value of SUNI4x622_FAILURE is returned.
• stateModule: This st ruc tur e elem ent is used to store the m odule st ate (a s shown in Figure
3).
• pddb[ ]: An array of pointers to the individual Device Data Blocks. The USER is cautioned
that a DDB is only valid if the valid flag is set. Note that the array of DDBs is in no
particular order.
° errDevice: This structure element is used to store an error code that specifies the reason
for an API function’s failure. The field is only valid for functions that do not return an
error code or when a value of SUNI4x622_FAILURE is returned.
° stateDevice: This st ruc ture element is used to store the dev ice state (as show n in
Figure 3).