Freescale Semiconductor SEC2SWUG specifications

This document contains information on a new product. Specifications and information herein

are subject to change without notice.

©Freescale Semiconductor, Inc., 2005. All rights reserved.

PRELIMINARY—SUBJECT TO CHANGE WITHOUT NOTICE

Freescale Semiconductor

1Overview

The SEC2 device driver manages the operation of the SEC2.0

commonly instantiated into PowerQUICC processors. It is a fully

functional component, meant to serve as an example of applicati on

interaction with the SEC2 core.

The driver is coded in ANSI C. In it’s design, an attempt has been

made to write a device driver that is as operating system agnostic

as practical. Where necessary, operating system dependenci es are

identified and Sect io n 8, “Porting” addresses them.

Testing has been accomplished on VxWorks 5.5 and LinuxPPC

using kernel version 2.4.27.

Application interfaces to this driver are implemented through the

ioctl() function call. Requests made through this interface can

be broken down into specific components, including

miscellaneous requests and process requests. The miscellaneous

requests are any requests not related to the direct processing of

data by the SEC2 core.

Process requests comprise the majority of the requests and al l are

executed using the same ioctl() access point. Structures needed

to compose these requests are described in detail in Section3 .3.6,

“Process Request Structures.”

Throughout the document, the acronyms CHA (crypto hardware

accelerator) and EU (execution unit) are used interch ang eab ly.

SEC2SWUG

Rev. 0, 02/2005

Contents

1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

2. Device Driver Compo nents . . . . . . . . . . . . . . . . . . . . 3

3. User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4. Individual Request Type Des criptions . . . . . . . . . . . 14

5. Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

6. Linux Environment . . . . . . . . . . . . . . . . . . . . . . . . . . 39

7. VxWorks Environment . . . . . . . . . . . . . . . . . . . . . . . 40

8. Porting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

SEC 2.0 Reference Device Driver User’s Guide

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: