PM5358 S/UNI-4x622 Driver Manual

Application Programming Interface

Side Effects Changes the MODULE state to SUNI4x622_MOD_IDLE

4.2Profile Management

This section describes the functions that add, get and clear an initialization profile. Initialization profiles allow the user to store pre-defined Device Initialization Vectors (DIV) that are validated ahead of time. When the device initialization function is invoked only a profile number needs to be passed. This method simplifies and expedites the initialization process.

Adding an Initialization Profile: suni4x622AddInitProfile

This function creates an initialization profile that is stored by the driver. A device can now be initialized by simply passing the initialization profile number.

Prototype

INT4 suni4x622AddInitProfile(sSUNI4x622_DIV

 

*pProfile, UINT2 *pProfileNum)

Inputs

pProfile

: (pointer to) initialization profile being added

 

pProfileNum : (pointer to) profile number to be assigned by the driver

Outputs

pProfileNum : (pointer to) profile number assigned by the driver

Returns

Success = SUNI4x622_SUCCESS

 

Failure = SUNI4x622_ERR_INVALID_MODULE_STATE

 

SUNI4x622_ERR_INVALID_ARG

 

SUNI4x622_ERR_INVALID_PROFILE

 

SUNI4x622_ERR_PROFILES_FULL

Valid States

SUNI4x622_MOD_IDLE, SUNI4x622_MOD_READY

Side Effects

None

 

Getting an Initialization Profile: suni4x622GetInitProfile

This function gets the content of an initialization profile given its profile number.

Prototype

INT4 suni4x622GetInitProfile(UINT2 profileNum,

 

sSUNI4x622_DIV *pProfile)

Inputs

profileNum

: initialization profile number

 

pProfile

: (pointer to) initialization profile

Outputs

pProfile

: (pointer to) contents of the corresponding profile

Returns Success = SUNI4x622_SUCCESS

Failure = SUNI4x622_ERR_INVALID_MODULE_STATE

SUNI4x622_ERR_INVALID_ARG

SUNI4x622_ERR_INVALID_PROFILE_NUM

Proprietary and Confidential to PMC-Sierra, Inc.

54

Document ID: PMC-2010419, Issue 1

 

Page 54
Image 54
PMC-Sierra PM5358 S/UNI 4x622 manual Profile Management, Adding an Initialization Profile suni4x622AddInitProfile