MCUX CLNS
MCUX Crypto Library Normal Secure
 
Loading...
Searching...
No Matches
mcuxClBuffer_Pointer.h File Reference

Provides the implementation for the basic C pointer buffer types. More...

#include <mcuxClCore_Platform.h>
#include <mcuxCsslFlowProtection.h>

Go to the source code of this file.

Macros

#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.
 
#define MCUXCLBUFFER_UPDATE_IMPL(_name, _offset)
 Update the buffer pointer with the given offset.
 
#define MCUXCLBUFFER_DERIVE_RO_IMPL(_name, _original, _offset)
 Derive a new input buffer object from an existing one (updated with the given offset).
 
#define MCUXCLBUFFER_DERIVE_RW_IMPL(_name, _original, _offset)
 Derive a new input/output buffer object from an existing one (updated with the given offset).
 
#define MCUXCLBUFFER_SET_IMPL(_name, _ptr, _size)
 Update the buffer pointer the a new memory location.
 
#define MCUXCLBUFFER_GET_IMPL(_name)
 Get the pointer of the buffer.
 
#define MCUXCLBUFFER_IS_NULL_IMPL(_name)
 Check the buffer pointer against NULL.
 

Typedefs

typedef const uint8_t * mcuxCl_InputBuffer_t
 Input buffer type.
 
typedef uint8_t * mcuxCl_Buffer_t
 Input/output buffer type.
 

Functions

mcuxClBuffer_Status_t mcuxClBuffer_import (mcuxCl_InputBuffer_t bufSrc, uint32_t offset, uint8_t *pDst, uint32_t byteLength)
 Perform a read from the buffer.
 
mcuxClBuffer_Status_t mcuxClBuffer_export (mcuxCl_Buffer_t bufDst, uint32_t offset, const uint8_t *pSrc, uint32_t byteLength)
 Perform a write to the buffer.
 

Detailed Description

Provides the implementation for the basic C pointer buffer types.

Function Documentation

◆ mcuxClBuffer_import()

mcuxClBuffer_Status_t mcuxClBuffer_import ( mcuxCl_InputBuffer_t  bufSrc,
uint32_t  offset,
uint8_t *  pDst,
uint32_t  byteLength 
)

Perform a read from the buffer.

Parameters
bufSrcInput buffer from which the data shall be read.
offsetOffset into the buffer at which the read operation shall start.
pDstPointer to the memory location where the data will be stored.
byteLengthAmount of bytes that will be read.
Returns
Status of the operation.

◆ mcuxClBuffer_export()

mcuxClBuffer_Status_t mcuxClBuffer_export ( mcuxCl_Buffer_t  bufDst,
uint32_t  offset,
const uint8_t *  pSrc,
uint32_t  byteLength 
)

Perform a write to the buffer.

Parameters
bufDstOutput buffer to which the data shall be written.
offsetOffset into the buffer at which the write operation shall start.
pSrcPointer to the memory location from where the data will be read.
byteLengthAmount of bytes that will be written.
Returns
Status of the operation.
Examples
mcuxClRandom_PRNG_Patch_example.c.