Freescale Semiconductor SEC2SWUG 3.3.6 Process Request Structures

SEC 2.0 Reference Device Driver User’s Guide, Rev. 0

Freescale Semiconductor PRELIMINARY—SUBJECT TO CHANGE WITHOUT NOTICE 11

User Interface

STATUS_REQ drivers tatus; // Detailed info rmation as to the state of the

// hardware and the driver at the time of an error

3.3.6 Process Request Structures

All process request structures contain the a copy of the same request header information, which is defined by the

COMMON_REQ_PREAMBLE macro. The members of this he ader must be filled in as needed by the user prior to the

issue of the user's request.

unsigned long opId;

unsigned char scatterBufs;

unsigned char notifyFlags;

unsigned char reserved;

unsigned char channel;

PSEC2_NOTIFY_ROUTIN E notify;

PSEC2_NOTIFY_CTX pNotifyCtx;

PSEC2_NOTIFY_ON_ERROR_ROUTIN E notify_on_error;

SEC2_NOTIFY_ON_ERRO R_CTX ctxNotifyOnEr r;

int status;

void *nextReq;

opId operation Id which identifies what type of request this is. It is normally associated with

a specific type of cryptographic operation, see Section4, “Individual Request Type

Descriptions” for all supported request types.

scatterBufs A bitmask that specifies which of the argued buffers are mapped through a

scatter-gather list. The mask is filled out via the driver's helper function

MarkScatterBuffer(), described in Section3.3.7, “Scatter-Gather Buffer

Management.”

notifyFlags If a POSIX-style signal handler will be responsible for request completion notification,

then it can contain ORed bits of NOTIFY_IS_PID and/or

NOTIFY_ERROR_IS_PID, signifying that the notify or notify_on_error

pointers are instead the process ID's (i.e. getpid()) of the task requesting a signal

upon request completion.

channel identifies the channel to be used for the request. It exists for legacy compatibility

reasons, and is no longer useful for SEC2.

notify pointer to a notification callback routine that will be called when the request has

completed successfully. May instead be a process ID if a user-state signal handler will

flag completion. Refer back to notifyFlags for more info.

pNotifyCtx pointer to context area to be passed back through the notification routine.

Contents

Main Freescale Semiconductor 1Overview SEC2SWUG Rev. 0, 02/2005 SEC 2.0 Reference Device Driver Users Guide Table1. Acronyms and Ab breviations 2 Device Driver Components 2.1 Device Driver Structure 2.1.1 Driver Initialization Routine 2.1.2 Request Dispatch Routine 2.1.3 Process Request Routine 2.1.4 Interrupt Service Routine 2.1.5 Deferred Service Routine 3 User Interface 3.1 A pplication Interface 3.2 Error Handling 3.3 Global Definitions 3.3.1 I/O Control Codes 3.3.2 Channel Definitions 3.3.3 Operation ID (opId) Masks A complete list of the error status results that may be returned to the callback routines follows: 3.3.4 Return Codes Page 3.3.5 Miscellaneous Request Structures 3.3.5.1 STATUS_REQ Structure 3.3.5.2 SEC2_NOTIFY_ON_ERROR_CT X Structure 3.3.6 Process Request Structures issue of the user's request. 3.3.7 Scatter-Gather Buffer Management 3.3.7.1 Building the Local Scatter/Gather List with EXT_SCATTER_ELEM ENT 3.3.7.2 Scatter Buffer Marking 3.3.7.3 Direct Scatter-Gather Usage Example 4 Individual Request Type Descriptions 4.1 Random Number Requests 4.1.1 RNG_REQ 4.2 DES Requests 4.2.1 DES_CBC_CRYPT_REQ 4.3 ARC4 Requests 4.3.1 ARC4_LOADCTX_CRYPT_REQ 4.3.2 ARC4_LOADKEY_CRYPT_UNLOADCTX_REQ 4.4 Hash Requests 4.4.1 HASH_REQ 4.5 HMAC Requests 4.5.1 HMAC_PAD_REQ use this request. 4.6 AES Requests 4.6.1 AESA_CRYPT_REQ 4.7 Integer Public Key Requests 4.7.1 MOD_EXP_REQ 4.7.2 MOD_SS_EXP_REQ 4.7.3 MOD_R2MODN_REQ 4.7.4 MOD_RRMODP_REQ 4.7.5 MOD_2OP_REQ Table19. MOD_2OP_REQ Valid Descriptors (opId) 4.8 ECC Public Key Requests 4.8.1 ECC_POINT_REQ Table19. MOD_2OP_REQ Valid Descriptors (opId) (continued) 4.8.2 ECC_2OP_REQ 4.8.3 ECC_SPKBUILD_REQ 4.8.4 ECC_PTADD_DBL_REQ 4.9 IPSec Requests 4.9.1 IPSEC_CBC_REQ Table23. ECC_PTADD_DBL_REQ Valid Descriptor (opId) DPD_EC_FPADD DPD_EC_FPDBL DPD_EC_F2MADD DPD_EC_F2MDBL Page 4.9.2 IPSEC_ECB_REQ 4.9.3 IPSEC_AES_CBC_REQ 4.9.4 IPSEC_AES_ECB_REQ 4.9.5 IPSEC_ESP_REQ Page Page 4.10 802.11 Protocol Requests 4.10.1 CCMP_REQ 4.11 SRTP Protocol Requests 4.11.1 SRTP_REQ Table 29. CCMP_REQ Valid Descriptors (opId) 5 Sample Code The following sections provide sample codes for DES and IPSec. 5.1 DES Sample Table 30. SRTP_REQ Valid Descriptors (opId) DPD_SRTP_OUTBOUND DPD_SRTP_INBOUND 5.2 IPSEC Sample Page 6Linux Environment 6.1 Installation 6.1.1 Driver Source 6.1.2 Device Inode 6.2 Operation 7 VxWorks Environment 7.1 Installation 7.2 Building the Interface Modules 7.3 BSP Integration 8 Porting 8.1 Header Files 8.2 C Source Files 8.3 Interrupt Service Routine 8.4 Conditional Compilation 8.5 Debug Messaging 8.6 Distribution Archive SEC2SWUG Rev. 0 02/2005 PRELIMINARYSUBJECT TO CHANGE WITHOUT NOTICE How to Reach Us: