Features Supported

Encryption and authentication
Encryption and authentication of content in applications requiring DRM (digital rights management) and content/asset protection.
Crypto function library for software acceleration
- AES - 128, 256 operations
- SHA2 - 256, 512 operations
supports Randam number generator(RNG)
- Keys and initialization values (IVs) for encryption
- Keys for keyed MAC algorithms
- Private keys for digital signature algorithms
- Values to be used in entity authentication mechanisms
- PIN and password generation

SysConfig Features

Features NOT Supported

Usage Overview

API Sequence

To use the sa2ul module,following APIs are needed:

SA2UL_init(): Initialize the SA2UL module.
SA2UL_Params_init(): Initialize a SA2UL_Params structure with default values. Then change the parameters from non-default values as needed.
SA2UL_open(): Open an instance of the SA2UL module, passing the initialized parameters, or NULL, and an index to the configuration to open.
SA2UL_contextAlloc() : Function to configure secure context.
SA2UL_contextFree() : Function to free secure context configuration.
SA2UL_contextProcess() : Function to transfer and recieve data buffer.
SA2UL_rngSetup() : setup the SA2UL RNG module.
SA2UL_rngRead() : Read random numbers into the output buffer.
SA2UL_close() : De-initialize the SA2UL instance.
SA2UL_deinit() : De-Initialize the SA2UL module.

Initializing the SA2UL Module

SA2UL_init() must be called before any other SA2UL APIs. This function iterates through the elements of the gSa2ulConfig[] array, calling the element's device implementation SA2UL initialization function. Please note that initializing SA2UL driver is taken care by the SysConfig generated code.

Opening the SA2UL Driver

After initializing the SA2UL driver by calling SA2UL_init(), the application can open a SA2UL instance by calling SA2UL_open(). Please note that opening SA2UL driver is taken care by the SysConfig generated code. This function takes an index into the gSa2ulConfig[] array, and the SA2UL parameters data structure. The SA2UL instance is specified by the index of the SA2UL in gSa2ulConfig[]. Calling SA2UL_open() second time with the same index previously passed to SA2UL_open() will result in an error.
Re-use the index if the instance is closed via SA2UL_close().

If no SA2UL_init structure is passed to SA2UL_open(), default values are used. If the open call is successful, it returns a non-NULL value.

Ultra lite Security Accelerator

Set the ctx parameters using SA2UL_ContextParams structure, all necessary parametets set to SA2UL_ContextParams variables and allocate sa2ul contex by calling SA2UL_contextAlloc(), To get expected result by calling SA2UL_contextProcess() with input buffer and output buffer as parameters, Final output will stored in output buffer. Close sa2ul context by calling SA2UL_contextFree().

RNG (Random number generation)

For enabling SA2UL RNG use SA2UL_open(), Setup rng module by calling SA2UL_rngSetup(), To get 128 bit Random number by calling SA2UL_rngRead() with output buffer as parameters, Final 128 bit random number will stored in output buffer.For disabling SA2UL RNG use SA2UL_close()

Example Usage

Include the below file to access the APIs

 
#include<stdio.h>
#include <security/crypto/include/crypto_sha.h>
#include <security/sa2ul.h>
 
Crypto_ShaContext gCryptoSha512Context;
static uint8_t gCryptoSha512TestBuf[9] = {"abcdefpra"};
SA2UL_ContextObject  gCtxObj;

sa2ul_sha Example

 
    int32_t             status;
    uint8_t             sha512sum[64];
    Crypto_ShaHandle    shaHandle;
    Crypto_ShaParams    params;
    SA2UL_ContextParams ctxParams;
 
    /* Init SA */
    SA2UL_init();
 
    /* Open SHA instance */
    Crypto_ShaParams_init(&params);
    params.authMode = CRYPTO_SHA_AUTHMODE_SHA2_512;
    params.type     = CRYPTO_TYPE_HW;
    shaHandle = Crypto_shaOpen(&gCryptoSha512Context, &params);
 
    /* Configure secure context */
    ctxParams.opType    = SA2UL_OP_AUTH;
    ctxParams.hashAlg   = SA2UL_HASH_ALG_SHA2_512;
    ctxParams.inputLen  = sizeof(gCryptoSha512TestBuf);
    gCtxObj.totalLengthInByes = sizeof(gCryptoSha512TestBuf);
    status = SA2UL_contextAlloc(gCryptoSha512Context.drvHandle,&gCtxObj,&ctxParams);
 
    /* Perform SHA operation */
    status = SA2UL_contextProcess(&gCtxObj,&gCryptoSha512TestBuf[0], sizeof(gCryptoSha512TestBuf), sha512sum);
    /* Close SHA instance */
    status = Crypto_shaClose(shaHandle);
 
    SA2UL_contextFree(&gCtxObj);
    /*deinit SA */
    SA2UL_deinit();
 

API

APIs for SA2UL

Table of Contents