Buffer initialization functionality

Buffer initialization functionality. More...

Macros
#define	MCUXCLBUFFER_INIT(name, info, ptr, size)
	Initialize an input/output buffer (mcuxCl_Buffer_t).
#define	MCUXCLBUFFER_INIT_RO(name, info, ptr, size)
	Initialize an input buffer (mcuxCl_InputBuffer_t) with plain CPU handling.
#define	MCUXCLBUFFER_INIT_RW(name, info, ptr, size)
	Initialize an input/output buffer (mcuxCl_Buffer_t) with plain CPU handling.
#define	MCUXCLBUFFER_INIT_DMA_RO(name, info, ptr, size)
	Initialize an input buffer (mcuxCl_InputBuffer_t) with DMA handling.
#define	MCUXCLBUFFER_INIT_DMA_RW(name, info, ptr, size)
	Initialize an input/output buffer (mcuxCl_Buffer_t) with DMA handling.
#define	MCUXCLBUFFER_INIT_DMA(name, info, ptr, size)
	Initialize an input/output buffer (mcuxCl_Buffer_t) with DMA handling.
#define	MCUXCLBUFFER_INIT_CUSTOM(name, handler, info, spec, ptr, size)
	Initialize an input/output buffer with custom handler.
#define	MCUXCLBUFFER_INIT_PLAIN_RO_IMPL(_name, _info, _ptr, _size)
	Initialize an input buffer with plain CPU handling.
#define	MCUXCLBUFFER_INIT_PLAIN_RW_IMPL(_name, _info, _ptr, _size)
	Initialize an input/output buffer with plain CPU handling.
#define	MCUXCLBUFFER_INIT_DMA_RO_IMPL(_name, _info, _ptr, _size)
	DMA handling is not supported.
#define	MCUXCLBUFFER_INIT_DMA_RW_IMPL(_name, _info, _ptr, _size)
	DMA handling is not supported.
#define	MCUXCLBUFFER_INIT_CUSTOM_IMPL(_name, _handler, _info, _spec, _ptr, _size)
	Usage of custom handler is not supported.

Detailed Description

Buffer initialization functionality.

Two sets of default buffer initializations are provided, each with read-only (RO, for mcuxCl_InputBuffer_t) and read-write (RW, for mcuxCl_Buffer_t) variants:

• Plain: basic CPU copy operations (aligned when possible)
• DMA: utilizing DMA peripherals

Note

The DMA variants will be mapped to plain for buffer implementations that do not support DMA operations.

Additionally a custom initializer is provided as well as some aliases that can be used as shorthand notation.

Macro Definition Documentation

MCUXCLBUFFER_INIT

#define MCUXCLBUFFER_INIT	(		name,
			info,
			ptr,
			size )

Initialize an input/output buffer (mcuxCl_Buffer_t).

This macro is an alias for MCUXCLBUFFER_INIT_RW.

See also

MCUXCLBUFFER_INIT_RW

Parameters

name	the name to be used for the buffer variable
info	pointer to a data structure that holds relevant information for the handler
ptr	pointer to the memory location of the buffer
size	size of the buffer - RFU

Examples

mcuxClAeadModes_Ccm_Aes128_Multipart_example.c, mcuxClAeadModes_Ccm_Aes128_Oneshot_Nist1_example.c, mcuxClAeadModes_Ccm_Aes128_Oneshot_Nist2_example.c, mcuxClAeadModes_Ccm_Aes128_Oneshot_PreloadedKey_example.c, mcuxClAeadModes_Gcm_Aes128_Multipart_example.c, mcuxClAeadModes_Gcm_Aes128_Oneshot_LongNonce_example.c, mcuxClAeadModes_Gcm_Aes128_Oneshot_example.c, mcuxClCipherModes_Cbc_Aes128_Multipart_KeyRfc3394Encoding_example.c, mcuxClCipherModes_Cbc_Aes128_Multipart_PaddingISO_example.c, mcuxClCipherModes_Cbc_Aes128_Multipart_PaddingZero_example.c, mcuxClCipherModes_Cbc_Aes128_Multipart_example.c, mcuxClCipherModes_Cbc_Aes128_Oneshot_PaddingISO_example.c, mcuxClCipherModes_Cbc_Aes128_Oneshot_PaddingZero_example.c, mcuxClCipherModes_Cbc_Aes128_Oneshot_example.c, mcuxClCipherModes_Ctr_Aes128_Multipart_example.c, mcuxClCipherModes_Ctr_Aes128_Oneshot_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_PaddingISO_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_PaddingZero_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_PaddingISO_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_PaddingPKCS7_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_PaddingZero_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_PreloadedKey_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_example.c, mcuxClEcc_ECDSA_FixedKeys_NIST_P256_example.c, mcuxClEcc_ECDSA_GeneratedKeys_NIST_P256_example.c, mcuxClEcc_EdDSA_Ed25519_example.c, mcuxClEcc_EdDSA_Ed25519ctx_example.c, mcuxClEcc_EdDSA_Ed25519ph_example.c, mcuxClEcc_EdDSA_GenerateSignature_Ed25519_example.c, mcuxClEcc_WeierECC_DecodePoint_brainpoolP384r1_example.c, mcuxClEcc_WeierECC_DecodePoint_secp224r1_example.c, mcuxClKey_Load_Flush_Sgi_example.c, mcuxClKey_Unwrap_Rfc3394_Sgi_example.c, mcuxClMacModes_Cmac_Aes128_Compute_PreloadedKey_example.c, mcuxClMacModes_Cmac_Aes128_Compute_example.c, mcuxClMacModes_Cmac_Aes128_Multipart_example.c, mcuxClMacModes_Cmac_Aes256_Compute_example.c, mcuxClRandomModes_CtrDrbg_AES256_DRG3_example.c, mcuxClRandomModes_CtrDrbg_AES256_DRG4_example.c, mcuxClRandomModes_Different_Sessions_example.c, mcuxClRandomModes_PatchMode_CtrDrbg_AES256_DRG3_example.c, mcuxClRandomModes_TestMode_CtrDrbg_AES256_DRG4_example.c, mcuxClRandom_PRNG_Patch_example.c, mcuxClRandom_PRNG_Seed_example.c, and mcuxClRsa_Signature_RSASSA_PSS_example.c.

MCUXCLBUFFER_INIT_RO

#define MCUXCLBUFFER_INIT_RO	(		name,
			info,
			ptr,
			size )

Initialize an input buffer (mcuxCl_InputBuffer_t) with plain CPU handling.

This macro can be used to initialize an input buffer that will be handled using plain CPU operations.

Parameters

name	the name to be used for the buffer variable
info	pointer to a data structure that holds relevant information for the handler
ptr	pointer to the memory location of the buffer
size	size of the buffer - RFU

Examples

mcuxClAeadModes_Ccm_Aes128_Multipart_example.c, mcuxClAeadModes_Ccm_Aes128_Oneshot_Nist1_example.c, mcuxClAeadModes_Ccm_Aes128_Oneshot_Nist2_example.c, mcuxClAeadModes_Ccm_Aes128_Oneshot_PreloadedKey_example.c, mcuxClAeadModes_Gcm_Aes128_Multipart_example.c, mcuxClAeadModes_Gcm_Aes128_Oneshot_LongNonce_example.c, mcuxClAeadModes_Gcm_Aes128_Oneshot_example.c, mcuxClCipherModes_Cbc_Aes128_Multipart_KeyRfc3394Encoding_example.c, mcuxClCipherModes_Cbc_Aes128_Multipart_PaddingISO_example.c, mcuxClCipherModes_Cbc_Aes128_Multipart_PaddingZero_example.c, mcuxClCipherModes_Cbc_Aes128_Multipart_example.c, mcuxClCipherModes_Cbc_Aes128_Oneshot_PaddingISO_example.c, mcuxClCipherModes_Cbc_Aes128_Oneshot_PaddingZero_example.c, mcuxClCipherModes_Cbc_Aes128_Oneshot_example.c, mcuxClCipherModes_Ctr_Aes128_Multipart_example.c, mcuxClCipherModes_Ctr_Aes128_Oneshot_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_PaddingISO_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_PaddingZero_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_PaddingISO_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_PaddingPKCS7_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_PaddingZero_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_PreloadedKey_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_example.c, mcuxClEcc_ECDSA_FixedKeys_NIST_P256_example.c, mcuxClEcc_ECDSA_GeneratedKeys_NIST_P256_example.c, mcuxClEcc_ECDSA_VerifyOnly_NIST_P256_example.c, mcuxClEcc_EdDSA_Ed25519_example.c, mcuxClEcc_EdDSA_Ed25519ctx_example.c, mcuxClEcc_EdDSA_Ed25519ph_example.c, mcuxClEcc_EdDSA_GenerateSignature_Ed25519_example.c, mcuxClEcc_WeierECC_CustomEccWeierType_BN256_example.c, mcuxClEcc_WeierECC_DecodePoint_brainpoolP384r1_example.c, mcuxClEcc_WeierECC_DecodePoint_secp224r1_example.c, mcuxClHashModes_sha224_oneshot_example.c, mcuxClHashModes_sha256_longMsgOneshot_example.c, mcuxClHashModes_sha256_oneshot_example.c, mcuxClHashModes_sha256_streaming_example.c, mcuxClHashModes_sha384_oneshot_example.c, mcuxClHashModes_sha512_oneshot_example.c, mcuxClHmac_Sw_Multipart_example.c, mcuxClHmac_Sw_Oneshot_example.c, mcuxClKey_Load_Flush_Sgi_example.c, mcuxClKey_Unwrap_Rfc3394_Sgi_example.c, mcuxClMacModes_Cmac_Aes128_Compute_PreloadedKey_example.c, mcuxClMacModes_Cmac_Aes128_Compute_example.c, mcuxClMacModes_Cmac_Aes128_Multipart_example.c, mcuxClMacModes_Cmac_Aes256_Compute_example.c, mcuxClRsa_Signature_RSASSA_PSS_example.c, and mcuxClSession_cleanupOnError_example.c.

MCUXCLBUFFER_INIT_RW

#define MCUXCLBUFFER_INIT_RW	(		name,
			info,
			ptr,
			size )

Initialize an input/output buffer (mcuxCl_Buffer_t) with plain CPU handling.

This macro can be used to initialize an input/output buffer that will be handled using plain CPU operations.

Parameters

name	the name to be used for the buffer variable
info	pointer to a data structure that holds relevant information for the handler
ptr	pointer to the memory location of the buffer
size	size of the buffer - RFU

Examples

mcuxClHashModes_sha224_oneshot_example.c, mcuxClHashModes_sha256_longMsgOneshot_example.c, mcuxClHashModes_sha256_oneshot_example.c, mcuxClHashModes_sha256_streaming_example.c, mcuxClHashModes_sha384_oneshot_example.c, mcuxClHashModes_sha512_oneshot_example.c, mcuxClHmac_Sw_Multipart_example.c, and mcuxClHmac_Sw_Oneshot_example.c.

MCUXCLBUFFER_INIT_DMA_RO

#define MCUXCLBUFFER_INIT_DMA_RO	(		name,
			info,
			ptr,
			size )

Initialize an input buffer (mcuxCl_InputBuffer_t) with DMA handling.

This macro can be used to initialize an input buffer that will be handled using DMA operations.

Note

DMA operations are only supported for object-oriented buffer implementations.

Parameters

name	the name to be used for the buffer variable
info	pointer to a data structure that holds relevant information for the handler
ptr	pointer to the memory location of the buffer
size	size of the buffer - RFU

Examples

mcuxClCipherModes_Cbc_Aes128_Multipart_PaddingZero_Dma_NonBlocking_example.c, mcuxClCipherModes_Cbc_Aes128_Oneshot_Dma_NonBlocking_example.c, mcuxClCipherModes_Ctr_Aes128_Multipart_Dma_NonBlocking_example.c, mcuxClCipherModes_Ctr_Aes128_Oneshot_Dma_NonBlocking_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_PaddingZero_Dma_NonBlocking_MultipleProcess_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_PaddingZero_Dma_NonBlocking_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_Dma_NonBlocking_example.c, mcuxClHashModes_sha256_oneshot_dma_nonBlocking_example.c, mcuxClHashModes_sha256_streaming_dma_nonBlocking_example.c, mcuxClMacModes_Cmac_Aes128_Compute_Dma_NonBlocking_example.c, and mcuxClMacModes_Cmac_Aes128_Multipart_Dma_NonBlocking_example.c.

MCUXCLBUFFER_INIT_DMA_RW

#define MCUXCLBUFFER_INIT_DMA_RW	(		name,
			info,
			ptr,
			size )

Initialize an input/output buffer (mcuxCl_Buffer_t) with DMA handling.

This macro can be used to initialize an input/output buffer that will be handled using DMA operations.

Note

DMA operations are only supported for object-oriented buffer implementations.

Parameters

name	the name to be used for the buffer variable
info	pointer to a data structure that holds relevant information for the handler
ptr	pointer to the memory location of the buffer
size	size of the buffer - RFU

Examples

mcuxClHashModes_sha256_oneshot_dma_nonBlocking_example.c, and mcuxClHashModes_sha256_streaming_dma_nonBlocking_example.c.

MCUXCLBUFFER_INIT_DMA

#define MCUXCLBUFFER_INIT_DMA	(		name,
			info,
			ptr,
			size )

Initialize an input/output buffer (mcuxCl_Buffer_t) with DMA handling.

This macro is an alias for MCUXCLBUFFER_INIT_RW.

See also

MCUXCLBUFFER_INIT_RW

Parameters

name	the name to be used for the buffer variable
info	pointer to a data structure that holds relevant information for the handler
ptr	pointer to the memory location of the buffer
size	size of the buffer - RFU

Examples

mcuxClCipherModes_Cbc_Aes128_Multipart_PaddingZero_Dma_NonBlocking_example.c, mcuxClCipherModes_Cbc_Aes128_Oneshot_Dma_NonBlocking_example.c, mcuxClCipherModes_Ctr_Aes128_Multipart_Dma_NonBlocking_example.c, mcuxClCipherModes_Ctr_Aes128_Oneshot_Dma_NonBlocking_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_PaddingZero_Dma_NonBlocking_MultipleProcess_example.c, mcuxClCipherModes_Ecb_Aes128_Multipart_PaddingZero_Dma_NonBlocking_example.c, mcuxClCipherModes_Ecb_Aes128_Oneshot_Dma_NonBlocking_example.c, mcuxClMacModes_Cmac_Aes128_Compute_Dma_NonBlocking_example.c, and mcuxClMacModes_Cmac_Aes128_Multipart_Dma_NonBlocking_example.c.

MCUXCLBUFFER_INIT_CUSTOM

#define MCUXCLBUFFER_INIT_CUSTOM	(		name,
			handler,
			info,
			spec,
			ptr,
			size )

Initialize an input/output buffer with custom handler.

This macro can be used to initialize an input/output buffer with a custom handler.

Note

Custom handlers are only supported for object-oriented buffer implementations.

Parameters

name	the name to be used for the buffer variable
handler	the callback function that will handle the buffer operations
info	pointer to a data structure that holds relevant information for the handler
spec	specification of the buffer properties
ptr	pointer to the memory location of the buffer
size	size of the buffer - RFU

MCUXCLBUFFER_INIT_PLAIN_RO_IMPL

#define MCUXCLBUFFER_INIT_PLAIN_RO_IMPL	(		_name,
			_info,
			_ptr,
			_size )

Initialize an input buffer with plain CPU handling.

This macro can be used to initialize an input buffer that will be handled using plain CPU operations.

Parameters

_name	the name to be used for the buffer variable
_info	unused for the current implementation
_ptr	pointer to the memory location of the buffer
_size	unused for the current implementation

MCUXCLBUFFER_INIT_PLAIN_RW_IMPL

#define MCUXCLBUFFER_INIT_PLAIN_RW_IMPL	(		_name,
			_info,
			_ptr,
			_size )

Initialize an input/output buffer with plain CPU handling.

This macro can be used to initialize an input/output buffer that will be handled using plain CPU operations.

Parameters

_name	the name to be used for the buffer variable
_info	unused for the current implementation
_ptr	pointer to the memory location of the buffer
_size	unused for the current implementation

MCUXCLBUFFER_INIT_DMA_RO_IMPL

#define MCUXCLBUFFER_INIT_DMA_RO_IMPL	(		_name,
			_info,
			_ptr,
			_size )

DMA handling is not supported.

Initialize an input buffer with plain CPU handling.

This buffer implementation does not support DMA handling, so CPU handling is used as a fallback. This macro is an alias for MCUXCLBUFFER_INIT_PLAIN_RO_IMPL.

Parameters

_name	the name to be used for the buffer variable
_info	unused for the current implementation
_ptr	pointer to the memory location of the buffer
_size	unused for the current implementation

MCUXCLBUFFER_INIT_DMA_RW_IMPL

#define MCUXCLBUFFER_INIT_DMA_RW_IMPL	(		_name,
			_info,
			_ptr,
			_size )

DMA handling is not supported.

Initialize an input/output buffer with plain CPU handling.

This buffer implementation does not support DMA handling, so CPU handling is used as a fallback. This macro is an alias for MCUXCLBUFFER_INIT_PLAIN_RW_IMPL.

Parameters

_name	the name to be used for the buffer variable
_info	unused for the current implementation
_ptr	pointer to the memory location of the buffer
_size	unused for the current implementation

MCUXCLBUFFER_INIT_CUSTOM_IMPL

#define MCUXCLBUFFER_INIT_CUSTOM_IMPL	(		_name,
			_handler,
			_info,
			_spec,
			_ptr,
			_size )

Usage of custom handler is not supported.

Initialize an input/output buffer with plain CPU handling.

This macro is an alias for MCUXCLBUFFER_INIT_PLAIN_RW_IMPL.

Parameters

_name	the name to be used for the buffer variable
_handler	unused for the current implementation
_info	unused for the current implementation
_spec	unused for the current implementation
_ptr	pointer to the memory location of the buffer
_size	unused for the current implementation