Manuals / Brands / Computer Equipment / Network Card / Freescale Semiconductor / Computer Equipment / Network Card

Freescale Semiconductor SEC2SWUG 8.4 Conditional Compilation, 8.5 Debug Messaging, 8.6 Distribution Archive

1 44

Download 44 pages, 605.62 Kb

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

Freescale Semiconductor PRELIMINARY—SUBJECT TO CHANGE WITHOUT NOTICE 43

Porting

8.4 Conditional Compilation

See the makefile for specifics on the default build of the driver

8.5 Debug Messaging

The driver includes a DBG define that allows for debug message output to the developer's console. If defined in the

driver build, debug messages will be sent from various components in the driver to the console.

Messages come from various sections of the driver, and a bitmask is kept in a driver global variable so that the

developer can turn message sources on or off as required. This globa l is named SEC2DebugLevel, and c ontains an

ORed combination of any of the following bits:

In normal driver operation (not in a development setting), the DBG definition should be left undefined for best

performance.

8.6 Distribution Archive

For this release, the distribution archive consists of the source files listed in this secti on. Note that the use r may wish

to reorganize header file locations consistent with the file location conventions appropriate for their system

configuration.

DBGTXT_SETRQ Messages from request setup operations (new requests inbound from the application).

DBGTXT_SVCRQ Messages from servicing device responses (ISR/deferred service routine handlers)

outbound to the application.

DBGTXT_INITDEV Messages from the device/driver initialization process.

DBGTXT_DPDSHOW Shows the content of a constructed DPD before it is handed to the security core.

DBGTXT_INFO Shows a short banner at device initialization describing the driver and hardware version.

Header Description

Sec2.h Primary public header file for all users of the driver

Sec2Driver.h Driver/Hardware interfaces, private to the driver itself

Sec2Descriptors.h DPD type definitions

Sec2Notify.h Structures for ISR/main thread communication

sec2_dpd_Table.h DPD construction constants

sec2_cha.c CHA mapping and management

sec2_dpd.c DPD construction functionality

sec2_init.c Device/driver initialization code

sec2_io.c Basic register I/O primitives

sec2_ioctl.c Operating system interfaces

sec2_request.c Request/response management

sec2_sctrMap.c Scatter buffer identification and mapping

sec2isr.c Interrupt service 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: