mcuxClBuffer_Pointer.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2022-2025 NXP                                                  */
/*                                                                          */
/* NXP Confidential and Proprietary. This software is owned or controlled   */
/* by NXP and may only be used strictly in accordance with the applicable   */
/* license terms.  By expressly accepting such terms or by downloading,     */
/* installing, activating and/or otherwise using the software, you are      */
/* agreeing that you have read, and that you agree to comply with and are   */
/* bound by, such license terms.  If you do not agree to be bound by the    */
/* applicable license terms, then you may not retain, install, activate or  */
/* otherwise use the software.                                              */
/*--------------------------------------------------------------------------*/

 
#ifndef MCUXCLBUFFER_POINTER_H_
#define MCUXCLBUFFER_POINTER_H_
 
#include <mcuxClCore_Platform.h>
#include <mcuxCsslFlowProtection.h>


typedef const uint8_t * mcuxCl_InputBuffer_t;

typedef uint8_t * mcuxCl_Buffer_t;

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

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

#define MCUXCLBUFFER_INIT_PLAIN_RO_IMPL(_name, _info, _ptr, _size) \
  mcuxCl_InputBuffer_t (_name) = (mcuxCl_InputBuffer_t)(_ptr)

#define MCUXCLBUFFER_INIT_PLAIN_RW_IMPL(_name, _info, _ptr, _size) \
  mcuxCl_Buffer_t (_name) = (mcuxCl_Buffer_t)(_ptr)

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

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

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

#define MCUXCLBUFFER_UPDATE_IMPL(_name, _offset) \
  do { (_name) += (_offset); } while(false)

#define MCUXCLBUFFER_DERIVE_RO_IMPL(_name, _original, _offset) \
  mcuxCl_InputBuffer_t (_name) = (mcuxCl_InputBuffer_t) &(_original)[_offset]

#define MCUXCLBUFFER_DERIVE_RW_IMPL(_name, _original, _offset) \
  mcuxCl_Buffer_t (_name) = (mcuxCl_Buffer_t) &(_original)[_offset]

#define MCUXCLBUFFER_SET_IMPL(_name, _ptr, _size) \
  do { (_name) = (_ptr); } while(false)

#define MCUXCLBUFFER_GET_IMPL(_name) \
  (_name)

#define MCUXCLBUFFER_IS_NULL_IMPL(_name) \
  (NULL == MCUXCLBUFFER_GET_IMPL(_name))
 
 
#endif /* MCUXCLBUFFER_POINTER_H_ */