APIs for DTHE AES

Introduction

This module contains APIs to program and use the DTHE AES.

Files
file	dthe_aes.h
	This file contains the prototype of DTHE AES driver APIs.

Data Structures
struct	DTHE_AES_Params
	AES Driver Parameters This structure has all the parameters which are need by the AES Driver to perform the specified operation. More...

Functions
DTHE_AES_Return_t	DTHE_AES_open (DTHE_Handle handle)
	Function to Open DTHE AES Driver. More...
DTHE_AES_Return_t	DTHE_AES_execute (DTHE_Handle handle, const DTHE_AES_Params *ptrParams)
	The function is used to execute the AES Driver with the specified parameters. More...
DTHE_AES_Return_t	DTHE_AES_close (DTHE_Handle handle)
	Function to close DTHE AES Driver. More...

Enumerations
enum	DTHE_AES_Return_t { DTHE_AES_RETURN_SUCCESS = 0x62E699D9U, DTHE_AES_RETURN_FAILURE = 0x904D041AU }
	DTHE AES Driver Error code. More...

Macros
#define	DTHE_AES_ECB_MODE   (0x00000000U)
	Flag for AEC ECB Mode. More...
#define	DTHE_AES_CBC_MODE   (0x00000001U)
	Flag for AEC CBC Mode. More...
#define	DTHE_AES_KEY_128_SIZE   (0x00000001U)
	Size of AES key is of 128-bit. More...
#define	DTHE_AES_KEY_192_SIZE   (0x00000002U)
	Size of AES key is of 192-bit. More...
#define	DTHE_AES_KEY_256_SIZE   (0x00000003U)
	Size of AES key is of 256-bit. More...
#define	DTHE_AES_ENCRYPT   (0x016FE45DU)
	AES Encrypt Flag. More...
#define	DTHE_AES_DECRYPT   (0xDCBA4213U)
	AES Decrypt Flag. More...

Macro Definition Documentation

DTHE_AES_ECB_MODE

#define DTHE_AES_ECB_MODE   (0x00000000U)

Flag for AEC ECB Mode.

DTHE_AES_CBC_MODE

#define DTHE_AES_CBC_MODE   (0x00000001U)

Flag for AEC CBC Mode.

DTHE_AES_KEY_128_SIZE

#define DTHE_AES_KEY_128_SIZE   (0x00000001U)

Size of AES key is of 128-bit.

DTHE_AES_KEY_192_SIZE

#define DTHE_AES_KEY_192_SIZE   (0x00000002U)

Size of AES key is of 192-bit.

DTHE_AES_KEY_256_SIZE

#define DTHE_AES_KEY_256_SIZE   (0x00000003U)

Size of AES key is of 256-bit.

DTHE_AES_ENCRYPT

#define DTHE_AES_ENCRYPT   (0x016FE45DU)

AES Encrypt Flag.

DTHE_AES_DECRYPT

#define DTHE_AES_DECRYPT   (0xDCBA4213U)

AES Decrypt Flag.

Enumeration Type Documentation

DTHE_AES_Return_t

enum DTHE_AES_Return_t

DTHE AES Driver Error code.

The enumeration describes all the possible return and error codes which the DTHE AES Driver can return

Enumerator
DTHE_AES_RETURN_SUCCESS	Success/pass return code
DTHE_AES_RETURN_FAILURE	General or unspecified failure/error

Function Documentation

DTHE_AES_open()

DTHE_AES_Return_t DTHE_AES_open

(

DTHE_Handle

handle

)

Function to Open DTHE AES Driver.

Parameters

handle

DTHE_Handle returned from DTHE_open().

Returns

DTHE_AES_RETURN_SUCCESS if requested operation completed. DTHE_AES_RETURN_FAILURE if requested operation not completed.

DTHE_AES_execute()

DTHE_AES_Return_t DTHE_AES_execute	(	DTHE_Handle	handle,
		const DTHE_AES_Params *	ptrParams
	)

The function is used to execute the AES Driver with the specified parameters.

Parameters

handle	DTHE_Handle returned from DTHE_open().
ptrParams	Pointer to the parameters to be used to execute the driver.

Returns

DTHE_AES_RETURN_SUCCESS if requested operation completed. DTHE_AES_RETURN_FAILURE if requested operation not completed.

DTHE_AES_close()

DTHE_AES_Return_t DTHE_AES_close

(

DTHE_Handle

handle

)

Function to close DTHE AES Driver.

Parameters

handle

DTHE_Handle returned from DTHE_open().

Returns

DTHE_AES_RETURN_SUCCESS if requested operation completed. DTHE_AES_RETURN_FAILURE if requested operation not completed.