mcuxClBuffer.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2022-2024 NXP                                                  */
/*                                                                          */
/* SPDX-License-Identifier: BSD-3-Clause                                    */
/*                                                                          */
/* Redistribution and use in source and binary forms, with or without       */
/* modification, are permitted provided that the following conditions are   */
/* met:                                                                     */
/*                                                                          */
/* 1. Redistributions of source code must retain the above copyright        */
/*    notice, this list of conditions and the following disclaimer.         */
/*                                                                          */
/* 2. Redistributions in binary form must reproduce the above copyright     */
/*    notice, this list of conditions and the following disclaimer in the   */
/*    documentation and/or other materials provided with the distribution.  */
/*                                                                          */
/* 3. Neither the name of the copyright holder nor the names of its         */
/*    contributors may be used to endorse or promote products derived from  */
/*    this software without specific prior written permission.              */
/*                                                                          */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS  */
/* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED    */
/* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A          */
/* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT       */
/* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,   */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR   */
/* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF   */
/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS       */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.             */
/*--------------------------------------------------------------------------*/

 
#ifndef MCUXCLBUFFER_H_
#define MCUXCLBUFFER_H_
 
#include <mcuxClCore_Platform.h>
 
#include <mcuxClBuffer_Constants.h>
 
/* Include the actual implementation of the flow protection mechanism. */
#include <mcuxClBuffer_Impl.h>


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

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

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

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

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

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

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


#define MCUXCLBUFFER_UPDATE(name, offset) \
  MCUXCLBUFFER_UPDATE_IMPL(name, offset)

#define MCUXCLBUFFER_DERIVE_RO(name, original, offset) \
  MCUXCLBUFFER_DERIVE_RO_IMPL(name, original, offset)

#define MCUXCLBUFFER_DERIVE_RW(name, original, offset) \
  MCUXCLBUFFER_DERIVE_RW_IMPL(name, original, offset)

#define MCUXCLBUFFER_SET(name, ptr, size) \
  MCUXCLBUFFER_SET_IMPL(name, ptr, size)

#define MCUXCLBUFFER_GET(name) \
  MCUXCLBUFFER_GET_IMPL(name)

#define MCUXCLBUFFER_IS_NULL(name) \
  MCUXCLBUFFER_IS_NULL_IMPL(name)
 
 
#endif /* MCUXCLBUFFER_H_ */