Intel EP80579 Benutzerhandbuch

Intel

®

 EP80579 Software for Security Applications on Intel

®

 QuickAssist Technology

August 2009

PG

Order Number: 320183-004US

47

— Operation type. For the typical case, where the same callback data structure 

type is used for multiple different functions (operation types) on a given API, 

this is used to distinguish the function for which this is the response.

— Operation-specific data. This may be the data structure described in 

 with the suffix 

_op_data_t, or it may be a single output parameter. In the case where there 

are multiple different types of operation-specific data, depending on the 

operation type, then all are provided within a union construct; the operation 

type can be used to decide which field of the union is valid.

This section discusses error values for APIs which are not part of the Intel

®

 QuickAssist 

Technology program, such as 

. 

In the case of an error occurring when an API function is invoked, the API function will 

return with the error condition and no function completion callback function will be 

invoked.

 shows the error values that are defined in icp.h, along with their descriptions.

ICP_E_NO_ERROR

Success status.

ICP_E_FAIL

Fail status.

ICP_E_RETRY

Retry status. Indicates a temporary condition exists which prevents the 

request from being completed at this time, usually due to the limited 

capacity of some internal resource being exhausted such as internal 

message queue is full, internal buffer pool is empty, etc. 
Recommended approach is to wait for a short amount of time (1 millisecond 

or less) and submit the request again. This is expected behavior, but may be 

an indication that some system-level tuning is required, for example, to 

increase internal resource limits or to throttle the rate of new request 

submissions.

ICP_E_UNDERFLOW

Underflow error - client is under submitting data.

ICP_E_OVERFLOW

Overflow error - client is over submitting data.

ICP_E_INVALID_PARAM

Invalid parameter passed in.

ICP_E_NULL_PARAM

One or more parameters is null.

ICP_E_MUTEX

Failure with a mutex operation.

ICP_E_RESOURCE

Error related to system resource.

ICP_E_FATAL

A serious error has occurred. Recommended course of action is to shutdown 

and restart the component.

ICP_E_ALREADY_REGISTERED

An attempt was made to register (for example a callback) with the same 

"key" value as an existing registration.

ICP_E_INVALID_HANDLE

An invalid handle was passed in.

ICP_E_NOT_SUPPORTED

Operation not supported in the current implementation.