Function Naming Conventions
Intel IPP Cryptography functions have the same naming conventions for all domains.
Function names in Intel IPP Cryptography have the following general format:
ipp<
data-domain
><
name
>[_<
descriptor
>](<
parameters
>)
The support functions in Intel IPP Cryptography like
ippcpGetCpuFeatures()
do not need an input data type. These functions have
ippcp
as a prefix without the data-domain field.
Data-domain
The
data-domain
element is a single character indicating type of input data. Intel IPP Cryptography supports the following data-domain:
s | one-dimensional operations on signals, vectors, buffers
|
Parameters
The
parameters
element specifies the function parameters (arguments).
The order of parameters is as follows:
- All source operands. Constants follow vectors.
- All destination operands. Constants follow vectors.
- Other, operation-specific parameters.
A parameter name has the following conventions:
- All parameters defined as pointers start withp, for example,pBuffer,pSrc; parameters defined as double pointers start withpp, for example,ppData. All parameters defined as values start with a lowercase letter, for example,length,bitSize,keyLen.
- Each new part of a parameter name starts with an uppercase character, without underscore; for example,pSrc,bitSize,pResult.
- Each parameter name specifies its functionality. Source parameters are namedpSrcorsrc, in some cases followed by names or numbers, for example,pSrc2,srcLen. Output parameters are namedpDstordstfollowed by names or numbers, for example,pDst2,dstLen. For in-place operations, the input/output parameter contains the namepSrcDstorsrcDst.