nz_circularBufferPwr2.h

Go to the documentation of this file.

 /*********************************************************************
 * @section nz_circularBufferPwr2_lic Software License Agreement
 *
 * The software supplied herewith is owned by Modtronix Engineering, and is
 * protected under applicable copyright laws. The software supplied herewith is
 * intended and supplied to you, the Company customer, for use solely and
 * exclusively on products manufactured by Modtronix Engineering. The code may
 * be modified and can be used free of charge for commercial and non commercial
 * applications. All rights are reserved. Any use in violation of the foregoing
 * restrictions may subject the user to criminal sanctions under applicable laws,
 * as well as to civil liability for the breach of the terms and conditions of this license.
 *
 * THIS SOFTWARE IS PROVIDED IN AN 'AS IS' CONDITION. NO WARRANTIES, WHETHER EXPRESS,
 * IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE
 * COMPANY SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 **********************************************************************
 * File History
 *
 * 2010-11-10, David H. (DH):
 *    - Initial version
 *********************************************************************/
#ifndef NZ_CIRCULAR_BUFFER_PWR2_H
#define NZ_CIRCULAR_BUFFER_PWR2_H

#if defined(CIRBUF_USE_CIRCULAR_BUFFER_PWR2)

#if defined(NZ_CIRCULAR_BUFFER_STD_H)
#error "Can not include both nz_circularBufferPwr2.h AND nz_circularBufferStd.h! Only included the one corresponding to the *.c file used in project!"
#endif

#if defined(THIS_IS_NZ_CIRCULAR_BUFFER_STD_C)
#error "Can not include nz_circularBufferPwr2.h in nz_circularBufferStd.c! For some reason MPLAB X keeps adding it! Remove nz_circularBufferPwr2.h from nz_circularBufferStd.c!"
#endif

#include "nz_circularBuffer.h"

#ifndef __INLINE_FUNCTION__
#define __INLINE_FUNCTION__ extern inline __attribute__((always_inline))
#endif


#if !defined(CIRBUF_OPTIMIZE_SIZE)
#define cbufEmpty(pBuf)  {(pBuf)->get = (pBuf)->put; /*Don't update put, only GET*/}
//#define cbufEmpty(pBuf)  {(pBuf)->get = (pBuf)->put = 0;}
#endif

#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufEmpty_MACRO(pBuf) {(pBuf)->get = (pBuf)->put; /*Don't update put, only GET*/}
#else
#define cbufEmpty_MACRO cbufEmpty
#endif


#if !defined(CIRBUF_OPTIMIZE_SIZE)
#define cbufIsEmpty(pBuf) ((pBuf)->get == (pBuf)->put)
#endif

#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufIsEmpty_MACRO(pBuf) ((pBuf)->get == (pBuf)->put)
#else
#define cbufIsEmpty_MACRO cbufIsEmpty
#endif


#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufIsFull_MACRO(pBuf) ( (((pBuf)->put+1) & (pBuf)->maxOffset) == (pBuf)->get)
#else
#define cbufIsFull_MACRO cbufIsFull
#endif


#define cbufHasData(pBuf) (cbufIsEmpty(pBuf)==0)
#define cbufHasData_MACRO(pBuf) ((pBuf)->get != (pBuf)->put)


#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufHasSpace_MACRO(pBuf) ( (((pBuf)->put+1) & (pBuf)->maxOffset) != (pBuf)->get)
#else
#define cbufHasSpace_MACRO(pBuf) (cbufIsFull(pBuf)==0)
#endif


#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufGetCount_MACRO(pBuf) ( ((pBuf)->put - (pBuf)->get) & (pBuf)->maxOffset)
#else
#define cbufGetCount_MACRO cbufGetCount
#endif


#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufGetFree_MACRO(pBuf) ( ((pBuf)->get - (pBuf)->put - 1) & (pBuf)->maxOffset)
#else
#define cbufGetFree_MACRO cbufGetFree
#endif


#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufGetFormat_MACRO(pBuf) ((pBuf)->flagTF.format)
#else
#define cbufGetFormat_MACRO cbufGetFormat
#endif


#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufGetType_MACRO(pBuf) ((pBuf)->flagTF.type)
#else
#define cbufGetType_MACRO cbufGetType
#endif


#if !defined(CIRBUF_OPTIMIZE_SIZE)
#define cbufPeekByte(pBuf) ( (pBuf)->buf[(pBuf)->get] )
#endif

#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufPeekByte_MACRO(pBuf) ( (pBuf)->buf[(pBuf)->get] )
#else
#define cbufPeekByte_MACRO cbufPeekByte
#endif


#if !defined(CIRBUF_OPTIMIZE_SIZE)
#define cbufPeekByteAt(pBuf, offset) ((pBuf)->buf[ (((pBuf)->get + (offset)) & (pBuf)->maxOffset) ])
#endif

#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufPeekByteAt_MACRO(pBuf, offset) ((pBuf)->buf[ (((pBuf)->get + (offset)) & (pBuf)->maxOffset) ])
#else
#define cbufPeekByteAt_MACRO cbufPeekByteAt
#endif



#if !defined(CIRBUF_OPTIMIZE_SIZE)
#define cbufRemoveByte(pBuf) ( (pBuf)->get = (((pBuf)->get + 1) & (pBuf)->maxOffset) )
#endif

#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufRemoveByte_MACRO(pBuf) ( (pBuf)->get = (((pBuf)->get + 1) & (pBuf)->maxOffset) )
#else
#define cbufRemoveByte_MACRO cbufRemoveByte
#endif


#if !defined(CIRBUF_OPTIMIZE_SIZE)
#define cbufRemoveBytes(pBuf, n) {(pBuf)->get = (((pBuf)->get + (n)) & (pBuf)->maxOffset); }
#endif

#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufRemoveBytes_MACRO(pBuf, n) {(pBuf)->get = (((pBuf)->get + (n)) & (pBuf)->maxOffset); }
#else
#define cbufRemoveBytes_MACRO cbufRemoveBytes
#endif


#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufGetByte_MACRO(pBuf) ((pBuf)->buf[ (pBuf)->get ]); ( (pBuf)->get = (((pBuf)->get + 1) & (pBuf)->maxOffset) )
#else
#define cbufGetByte_MACRO cbufGetByte
#endif


#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufGetRdArrSize_MACRO(pBuf) (((pBuf)->put < (pBuf)->get) ? (((pBuf)->maxOffset + 1) - (pBuf)->get) : ((pBuf)->put - (pBuf)->get))
#else
#define cbufGetRdArrSize_MACRO cbufGetRdArrSize
#endif


#define cbufGetRdArr(pBuf) ( (BYTE*) &((pBuf)->buf[(pBuf)->get]) )


#if !defined(CIRBUF_OPTIMIZE_SIZE)
#define cbufPutByteNoCheck(pBuf, b) {(pBuf)->buf[(pBuf)->put] = (b); /* Write byte to buf */ (pBuf)->put = (((pBuf)->put + 1) & (pBuf)->maxOffset);}
#endif
#if defined(CIRBUF_USE_PUTBYTE_FOR_PUTBYTENOCHECK)
#define cbufPutByteNoCheck(pBuf, b) cbufPutByte(pBuf, b)
#endif

#if !defined(CIRBUF_DISABLE_ALL_MACRO_FUNCTIONS)

#define cbufPutByteNoCheck_MACRO(pBuf, b) {(pBuf)->buf[(pBuf)->put] = (b); /* Write byte to buf */ (pBuf)->put = (((pBuf)->put + 1) & (pBuf)->maxOffset);}
#else
#define cbufPutByteNoCheck_MACRO cbufPutByteNoCheck
#endif


#define cbufGetWrArr(pBuf) ( (BYTE*) &((pBuf)->buf[(pBuf)->put]) )


#define cbufUpdatePut(pBuf, n) {(pBuf)->put = (((pBuf)->put + (n)) & (pBuf)->maxOffset); }


#define cbufGetError(pBuf)  ((pBuf)->flags.bErrorFull)


#define cbufClearError(pBuf)  ((pBuf)->flags.bErrorFull = 0)


#define cbufIsPacket(pBuf) (pBuf->flagBits.bPacket==TRUE)


#define cbufIsPacketLarge(pBuf) (pBuf->flagBits.bPacketLarge==TRUE)

#endif  //#if defined(CIRBUF_USE_CIRCULAR_BUFFER_PWR2)
#endif  //#ifndef NZ_CIRCULAR_BUFFER_PWR2_H