TPU

Modules
	TPU_Registers

Macros
#define	MXC_AES_DATA_LEN
#define	MXC_AES_KEY_128_LEN   (128 / 8)
#define	MXC_AES_KEY_192_LEN   (192 / 8)
#define	MXC_AES_KEY_256_LEN   (256 / 8)

Enumerations
enum	mxc_tpu_ciphersel_t
enum	mxc_tpu_keysrc_t
enum	mxc_tpu_modesel_t
enum	mxc_tpu_hashfunsel_t
enum	mxc_tpu_maa_clcsel_t

Functions
int	MXC_TPU_Init (mxc_sys_periph_clock_t clock)
int	MXC_TPU_Shutdown (mxc_sys_periph_clock_t clock)
void	MXC_TPU_Reset (void)
int	MXC_TPU_CRC_Config (void)
int	MXC_TPU_CRC (const uint8_t *src, uint32_t len, uint32_t poly, uint32_t *crc)
int	MXC_TPU_Ham_Config (void)
int	MXC_TPU_Ham (const uint8_t *src, uint32_t len, uint32_t *ecc)
unsigned int	MXC_TPU_Cipher_Get_Key_Size (mxc_tpu_ciphersel_t cipher)
unsigned int	MXC_TPU_Cipher_Get_Block_Size (mxc_tpu_ciphersel_t cipher)
unsigned int	MXC_TPU_Cipher_GetLength (mxc_tpu_ciphersel_t cipher, unsigned int data_size)
void	MXC_TPU_Cipher_EncDecSelect (int enc)
int	MXC_TPU_Cipher_Config (mxc_tpu_modesel_t mode, mxc_tpu_ciphersel_t cipher)
int	MXC_TPU_Cipher_KeySelect (mxc_tpu_keysrc_t key_src)
int	MXC_TPU_Cipher_DoOperation (const char *src, const char *iv, const char *key, mxc_tpu_ciphersel_t cipher, mxc_tpu_modesel_t mode, unsigned int data_size, char *outptr)
int	MXC_TPU_Cipher_DES_Encrypt (const char *plaintext, const char *iv, const char *key, mxc_tpu_modesel_t mode, unsigned int data_size, char *outptr)
int	MXC_TPU_Cipher_DES_Decrypt (const char *ciphertext, const char *iv, const char *key, mxc_tpu_modesel_t mode, unsigned int data_size, char *outptr)
int	MXC_TPU_Cipher_TDES_Encrypt (const char *plaintext, const char *iv, const char *key, mxc_tpu_modesel_t mode, unsigned int data_size, char *outptr)
int	MXC_TPU_Cipher_TDES_Decrypt (const char *ciphertext, const char *iv, const char *key, mxc_tpu_modesel_t mode, unsigned int data_size, char *outptr)
int	MXC_TPU_Cipher_AES_Encrypt (const char *plaintext, const char *iv, const char *key, mxc_tpu_ciphersel_t cipher, mxc_tpu_modesel_t mode, unsigned int data_size, char *outptr)
int	MXC_TPU_Cipher_AES_Decrypt (const char *ciphertext, const char *iv, const char *key, mxc_tpu_ciphersel_t cipher, mxc_tpu_modesel_t mode, unsigned int data_size, char *outptr)
unsigned int	MXC_TPU_Hash_Get_Block_Size_SHA (mxc_tpu_hashfunsel_t func)
unsigned int	MXC_TPU_Hash_Get_Dgst_Size (mxc_tpu_hashfunsel_t func)
void	MXC_TPU_Hash_SHA_Size (unsigned int *blocks, unsigned int *length, unsigned int *lbyte, mxc_tpu_hashfunsel_t fun)
int	MXC_TPU_Hash_Config (mxc_tpu_hashfunsel_t func)
int	MXC_TPU_Hash_SHA (const char *msg, mxc_tpu_hashfunsel_t fun, unsigned int byteLen, char *digest)
uint8_t	MXC_TPU_TRNG_Read8BIT (mxc_trng_regs_t *trng)
uint16_t	MXC_TPU_TRNG_Read16BIT (mxc_trng_regs_t *trng)
uint32_t	MXC_TPU_TRNG_Read32BIT (mxc_trng_regs_t *trng)
void	MXC_TPU_TRNG_Read (mxc_trng_regs_t *trng, uint8_t *data, int len)
void	MXC_TPU_TRNG_Generate_AES (mxc_trng_regs_t *trng)
void	MXC_TPU_MAA_Mem_Clear (void)
void	MXC_TPU_MAA_Reset (void)
int	MXC_TPU_MAA_Init (unsigned int size)
int	MXC_TPU_MAA_Shutdown (void)
int	MXC_TPU_MAA_Compute (mxc_tpu_maa_clcsel_t clc, char *multiplier, char *multiplicand, char *exp, char *mod, int *result, unsigned int len)

Detailed Description

Macro Definition Documentation

MXC_AES_DATA_LEN

#define MXC_AES_DATA_LEN

Value:

    (128 /               \
     8)

Number of bytes in an AES plaintext or ciphertext block, which are always 128-bits long.

MXC_AES_KEY_128_LEN

#define MXC_AES_KEY_128_LEN   (128 / 8)

Number of bytes in a AES-128 key.

MXC_AES_KEY_192_LEN

#define MXC_AES_KEY_192_LEN   (192 / 8)

Number of bytes in a AES-192 key.

MXC_AES_KEY_256_LEN

#define MXC_AES_KEY_256_LEN   (256 / 8)

Number of bytes in a AES-256 key.

Enumeration Type Documentation

mxc_tpu_ciphersel_t

enum mxc_tpu_ciphersel_t

Enumeration type for the TPU Cipher Operation(128/192/256-bit key)

mxc_tpu_hashfunsel_t

enum mxc_tpu_hashfunsel_t

Enumeration type for Hash function Select

mxc_tpu_keysrc_t

enum mxc_tpu_keysrc_t

Enumeration type to select which key is used in Cipher operations

mxc_tpu_maa_clcsel_t

enum mxc_tpu_maa_clcsel_t

Enumeration type for MAA initialization

mxc_tpu_modesel_t

enum mxc_tpu_modesel_t

Enumeration type for the TPU Mode Select

Function Documentation

MXC_TPU_Cipher_AES_Decrypt()

int MXC_TPU_Cipher_AES_Decrypt	(	const char *	ciphertext,
		const char *	iv,
		const char *	key,
		mxc_tpu_ciphersel_t	cipher,
		mxc_tpu_modesel_t	mode,
		unsigned int	data_size,
		char *	outptr
	)

The AES decryption process.

Parameters

ciphertext	Pointer to the ciphertext data
iv	Pointer to the initial vector data
key	Pointer to the crypto key
cipher	Selects the Cipher Operation mode
mode	Selects the TPU operation mode
data_size	Specifies length of data in bytes
outptr	Output buffer

Returns

E_NULL_PTR Specified pointers @plaintext; @iv; @key points to null

E_BAD_PARAM Specified Cipher operation mode @cipher is invalid, see #tpu_ciphersel_t

E_INVALID AES Encryption process failed

E_SUCCESS AES Encryption process completed successfully

MXC_TPU_Cipher_AES_Encrypt()

int MXC_TPU_Cipher_AES_Encrypt	(	const char *	plaintext,
		const char *	iv,
		const char *	key,
		mxc_tpu_ciphersel_t	cipher,
		mxc_tpu_modesel_t	mode,
		unsigned int	data_size,
		char *	outptr
	)

The AES encryption process.

Parameters

plaintext	Pointer to the plaintext data
iv	Pointer to the initial vector data
key	Pointer to the crypto key
cipher	Selects the Cipher Operation mode
mode	Selects the TPU operation mode
data_size	Specifies length of data in bytes
outptr	Output buffer

Returns

E_NULL_PTR Specified pointers @plaintext; @iv; @key points to null

E_BAD_PARAM Specified Cipher operation mode @cipher is invalid, see #tpu_ciphersel_t

E_INVALID AES Encryption process failed

E_SUCCESS AES Encryption process completed successfully

MXC_TPU_Cipher_Config()

int MXC_TPU_Cipher_Config	(	mxc_tpu_modesel_t	mode,
		mxc_tpu_ciphersel_t	cipher
	)

Configure crypto cipher operation for different modes.

Parameters

mode	Selects the TPU operation mode
cipher	Selects the Cipher Operation mode

Returns

E_SUCCESS Cipher algorithm configured successfully

MXC_TPU_Cipher_DES_Decrypt()

int MXC_TPU_Cipher_DES_Decrypt	(	const char *	ciphertext,
		const char *	iv,
		const char *	key,
		mxc_tpu_modesel_t	mode,
		unsigned int	data_size,
		char *	outptr
	)

The DES decryption process.

Parameters

ciphertext	Pointer to the ciphertext data
iv	Pointer to the initial vector data
key	Pointer to the crypto key
mode	Selects the TPU operation mode
data_size	Specifies length of data in bytes
outptr	Output buffer

Returns

E_NULL_PTR Specified pointers @plaintext; @iv; @key points to null

E_INVALID DES Decryption process failed

E_SUCCESS DES Decryption process completed successfully

MXC_TPU_Cipher_DES_Encrypt()

int MXC_TPU_Cipher_DES_Encrypt	(	const char *	plaintext,
		const char *	iv,
		const char *	key,
		mxc_tpu_modesel_t	mode,
		unsigned int	data_size,
		char *	outptr
	)

The DES encryption process.

Parameters

plaintext	Pointer to the plaintext data
iv	Pointer to the initial vector data
key	Pointer to the crypto key
mode	Selects the TPU operation mode
data_size	Specifies length of data in bytes
outptr	Output buffer

Returns

E_NULL_PTR Specified pointers @plaintext; @iv; @key points to null

E_INVALID DES Encryption process failed

E_SUCCESS DES Encryption process completed successfully

MXC_TPU_Cipher_DoOperation()

int MXC_TPU_Cipher_DoOperation	(	const char *	src,
		const char *	iv,
		const char *	key,
		mxc_tpu_ciphersel_t	cipher,
		mxc_tpu_modesel_t	mode,
		unsigned int	data_size,
		char *	outptr
	)

Test Cipher Algorithm.

Parameters

src	Pointer to the plaintext/ciphertext data
iv	Pointer to the initial vector data
key	Pointer to the crypto key
cipher	Selects the Cipher Operation mode
mode	Selects the TPU operation mode
data_size	Specifies length of data in bytes
outptr	Output buffer

Returns

E_NULL_PTR Specified pointers @plaintext; @iv; @key points to null

E_INVALID DES Encryption process failed

E_SUCCESS DES Encryption process completed successfully

MXC_TPU_Cipher_EncDecSelect()

void MXC_TPU_Cipher_EncDecSelect

(

int

enc

)

Enable Encrypt/Decrypt Cipher Operation.

Parameters

enc	Enable Encryption or Decryption

MXC_TPU_Cipher_KeySelect()

int MXC_TPU_Cipher_KeySelect

(

mxc_tpu_keysrc_t

key_src

)

Select the source of the cipher key used in cipher operations.

Parameters

key_src

Selects the key used in cipher operations

Returns

E_SUCCESS Cipher key selected successfully

MXC_TPU_Cipher_TDES_Decrypt()

int MXC_TPU_Cipher_TDES_Decrypt	(	const char *	ciphertext,
		const char *	iv,
		const char *	key,
		mxc_tpu_modesel_t	mode,
		unsigned int	data_size,
		char *	outptr
	)

The TDES decryption process.

Parameters

ciphertext	Pointer to the ciphertext data
iv	Pointer to the initial vector data
key	Pointer to the crypto key
mode	Selects the TPU operation mode
data_size	Specifies length of data in bytes
outptr	Output buffer

Returns

E_NULL_PTR Specified pointers @plaintext; @iv; @key points to null

E_INVALID TDES Decryption process failed

E_SUCCESS TDES Decryption process completed successfully

MXC_TPU_Cipher_TDES_Encrypt()

int MXC_TPU_Cipher_TDES_Encrypt	(	const char *	plaintext,
		const char *	iv,
		const char *	key,
		mxc_tpu_modesel_t	mode,
		unsigned int	data_size,
		char *	outptr
	)

The TDES encryption process.

Parameters

plaintext	Pointer to the plaintext data
iv	Pointer to the initial vector data
key	Pointer to the crypto key
mode	Selects the TPU operation mode
data_size	Specifies length of data in bytes
outptr	Output buffer

Returns

E_NULL_PTR Specified pointers @plaintext; @iv; @key points to null

E_INVALID TDES Encryption process failed

E_SUCCESS TDES Encryption process completed successfully

MXC_TPU_CRC()

int MXC_TPU_CRC	(	const uint8_t *	src,
		uint32_t	len,
		uint32_t	poly,
		uint32_t *	crc
	)

Test the CRC process.

Parameters

src	Pointer to source message
len	Specifies size of message in bytes
poly	Selects the crc polynomial
crc	Pointer to store crc value

Returns

E_NULL_PTR Specified pointers src; points to null

E_SUCCESS CRC process completed successfully

MXC_TPU_CRC_Config()

int MXC_TPU_CRC_Config

(

void

)

Configure crypto CRC operation.

Returns

E_SUCCESS CRC algorithm configured successfully

MXC_TPU_Ham()

int MXC_TPU_Ham	(	const uint8_t *	src,
		uint32_t	len,
		uint32_t *	ecc
	)

Test the CRC process.

Parameters

src	Pointer to source message
len	Specifies size of message in bytes
ecc	Pointer to store ecc value

Returns

E_NULL_PTR Specified pointers src; points to null

E_SUCCESS CRC process completed successfully

MXC_TPU_Ham_Config()

int MXC_TPU_Ham_Config

(

void

)

Configure crypto HAM operation.

Returns

E_SUCCESS HAM algorithm configured successfully

MXC_TPU_Hash_Config()

int MXC_TPU_Hash_Config

(

mxc_tpu_hashfunsel_t

func

)

Configure crypto hash operation for different hash functions.

Parameters

func	Selects the hash function

Returns

E_SUCCESS Hash algorithm configured successfully

MXC_TPU_Hash_SHA()

int MXC_TPU_Hash_SHA	(	const char *	msg,
		mxc_tpu_hashfunsel_t	fun,
		unsigned int	byteLen,
		char *	digest
	)

Test the SHA process.

Parameters

fun	Selects the hash function
msg	Pointer to source message
byteLen	Specifies size of message in bytes
digest	Digest buffer

Returns

E_NULL_PTR Specified pointers msg; digest points to null

E_SUCCESS SHA process completed successfully

MXC_TPU_Init()

int MXC_TPU_Init

(

mxc_sys_periph_clock_t

clock

)

Init TPU system settings.

Parameters

clock

peripheral clock to use

Returns

E_NO_ERROR if successful, E_TIME_OUT otherwise.

MXC_TPU_MAA_Compute()

int MXC_TPU_MAA_Compute	(	mxc_tpu_maa_clcsel_t	clc,
		char *	multiplier,
		char *	multiplicand,
		char *	exp,
		char *	mod,
		int *	result,
		unsigned int	len
	)

MAA operation.

Parameters

clc	Selects the MAA calculation operation
multiplier	Pointer to multiplier data
multiplicand	Pointer to multiplicand data
exp	Pointer to exponent data
mod	Pointer to modular data
result	Output buffer
len	Specifies length to the nearest 32-bit boundary

Returns

E_NULL_PTR Specified pointers multiplier; multiplicand; exp; mod points to null

E_INVALID Specified MAA calculation operation is invalid

E_BAD_STATE MAA Error occurs

E_SUCCESS MAA process completed successfully

Note

multiplier; multiplicand; exp; mod, data must be loaded with zero pad to specified length len, or the "garbage bits" will case erroneous results

MXC_TPU_MAA_Init()

int MXC_TPU_MAA_Init

(

unsigned int

size

)

Configure MAA operation with appropriate MAA word size.

Parameters

size	Defines the number of bits for modular operation

Returns

E_BAD_PARAM Specified size size, out of range

E_SUCCESS Cipher algorithm configured successfully

MXC_TPU_MAA_Shutdown()

int MXC_TPU_MAA_Shutdown

(

void

)

Release MAA.

Shuts down the MAA engine and any associated clocks

Returns

E_BAD_PARAM if MAA cannot be stopped

E_NO_ERROR otherwise

MXC_TPU_TRNG_Generate_AES()

void MXC_TPU_TRNG_Generate_AES

(

mxc_trng_regs_t *

trng

)

Generates 256-bits random number automatically.

Parameters

trng	Pointer to the trng register structure.

MXC_TPU_TRNG_Read()

void MXC_TPU_TRNG_Read	(	mxc_trng_regs_t *	trng,
		uint8_t *	data,
		int	len
	)

Generates Random Number of variable length.

Parameters

trng	Pointer to the trng register structure.
data	Pointer to the Data Buffer.
len	Defines length of data(bytes).

MXC_TPU_TRNG_Read16BIT()

uint16_t MXC_TPU_TRNG_Read16BIT

(

mxc_trng_regs_t *

trng

)

Reads 16-bit value stored in the data register.

Parameters

trng	Pointer to the trng register structure.

Returns

16-bit data register value.

MXC_TPU_TRNG_Read32BIT()

uint32_t MXC_TPU_TRNG_Read32BIT

(

mxc_trng_regs_t *

trng

)

Reads 32-bit value stored in the data register.

Parameters

trng	Pointer to the trng register structure.

Returns

32-bit data register value.

MXC_TPU_TRNG_Read8BIT()

uint8_t MXC_TPU_TRNG_Read8BIT

(

mxc_trng_regs_t *

trng

)

Reads 8-bit value stored in the data register.

Parameters

trng	Pointer to the trng register structure.

Returns

8-bit data register value.