/* ################################################################### ** This component module is generated by Processor Expert. Do not modify it. ** Filename : McuRingbuffer.h ** Project : FRDM-K64F_Generator ** Processor : MK64FN1M0VLL12 ** Component : RingBuffer ** Version : Component 01.054, Driver 01.00, CPU db: 3.00.000 ** Compiler : GNU C Compiler ** Date/Time : 2020-08-14, 06:24, # CodeGen: 679 ** Abstract : ** This component implements a ring buffer for different integer data type. ** Settings : ** Component name : McuRingbuffer ** Buffer Size : 64 ** Contents : ** Clear - void McuRingbuffer_Clear(void); ** Put - uint8_t McuRingbuffer_Put(McuRingbuffer_ElementType elem); ** Get - uint8_t McuRingbuffer_Get(McuRingbuffer_ElementType *elemP); ** Peek - uint8_t McuRingbuffer_Peek(McuRingbuffer_BufSizeType index,... ** Update - uint8_t McuRingbuffer_Update(McuRingbuffer_BufSizeType index,... ** Putn - uint8_t McuRingbuffer_Putn(McuRingbuffer_ElementType *elem,... ** Getn - uint8_t McuRingbuffer_Getn(McuRingbuffer_ElementType *buf,... ** Compare - uint8_t McuRingbuffer_Compare(McuRingbuffer_BufSizeType index,... ** Delete - uint8_t McuRingbuffer_Delete(void); ** NofElements - McuRingbuffer_BufSizeType McuRingbuffer_NofElements(void); ** NofFreeElements - McuRingbuffer_BufSizeType McuRingbuffer_NofFreeElements(void); ** Deinit - void McuRingbuffer_Deinit(void); ** Init - void McuRingbuffer_Init(void); ** ** * Copyright (c) 2014-2020, Erich Styger ** * Web: https://mcuoneclipse.com ** * SourceForge: https://sourceforge.net/projects/mcuoneclipse ** * Git: https://github.com/ErichStyger/McuOnEclipse_PEx ** * All rights reserved. ** * ** * Redistribution and use in source and binary forms, with or without modification, ** * are permitted provided that the following conditions are met: ** * ** * - Redistributions of source code must retain the above copyright notice, this list ** * of conditions and the following disclaimer. ** * ** * - 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. ** * ** * 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. ** ###################################################################*/ /*! ** @file McuRingbuffer.h ** @version 01.00 ** @brief ** This component implements a ring buffer for different integer data type. */ /*! ** @addtogroup McuRingbuffer_module McuRingbuffer module documentation ** @{ */ #ifndef __McuRingbuffer_H #define __McuRingbuffer_H /* MODULE McuRingbuffer. */ #include "McuLib.h" /* SDK and API used */ #include "McuRingbufferconfig.h" /* configuration */ /* Include inherited components */ #include "McuLib.h" #include "McuCriticalSection.h" #ifdef __cplusplus extern "C" { #endif #if McuRingbuffer_CONFIG_ELEM_SIZE==1 typedef uint8_t McuRingbuffer_ElementType; /* type of single element */ #elif McuRingbuffer_CONFIG_ELEM_SIZE==2 typedef uint16_t McuRingbuffer_ElementType; /* type of single element */ #elif McuRingbuffer_CONFIG_ELEM_SIZE==4 typedef uint32_t McuRingbuffer_ElementType; /* type of single element */ #else #error "illegal element type size in properties" #endif #if McuRingbuffer_CONFIG_BUF_SIZE<256 typedef uint8_t McuRingbuffer_BufSizeType; /* up to 255 elements (index 0x00..0xff) */ #else typedef uint16_t McuRingbuffer_BufSizeType; /* more than 255 elements, up to 2^16 */ #endif uint8_t McuRingbuffer_Put(McuRingbuffer_ElementType elem); /* ** =================================================================== ** Method : Put (component RingBuffer) ** ** Description : ** Puts a new element into the buffer ** Parameters : ** NAME - DESCRIPTION ** elem - New element to be put into the buffer ** Returns : ** --- - Error code ** =================================================================== */ uint8_t McuRingbuffer_Get(McuRingbuffer_ElementType *elemP); /* ** =================================================================== ** Method : Get (component RingBuffer) ** ** Description : ** Removes an element from the buffer ** Parameters : ** NAME - DESCRIPTION ** * elemP - Pointer to where to store the received ** element ** Returns : ** --- - Error code ** =================================================================== */ McuRingbuffer_BufSizeType McuRingbuffer_NofElements(void); /* ** =================================================================== ** Method : NofElements (component RingBuffer) ** ** Description : ** Returns the actual number of elements in the buffer. ** Parameters : None ** Returns : ** --- - Number of elements in the buffer. ** =================================================================== */ void McuRingbuffer_Init(void); /* ** =================================================================== ** Method : Init (component RingBuffer) ** ** Description : ** Initializes the data structure ** Parameters : None ** Returns : Nothing ** =================================================================== */ McuRingbuffer_BufSizeType McuRingbuffer_NofFreeElements(void); /* ** =================================================================== ** Method : NofFreeElements (component RingBuffer) ** ** Description : ** Returns the actual number of free elements/space in the ** buffer. ** Parameters : None ** Returns : ** --- - Number of elements in the buffer. ** =================================================================== */ void McuRingbuffer_Clear(void); /* ** =================================================================== ** Method : Clear (component RingBuffer) ** ** Description : ** Clear (empty) the ring buffer. ** Parameters : None ** Returns : Nothing ** =================================================================== */ uint8_t McuRingbuffer_Peek(McuRingbuffer_BufSizeType index, McuRingbuffer_ElementType *elemP); /* ** =================================================================== ** Method : Peek (component RingBuffer) ** ** Description : ** Returns an element of the buffer without removiing it. ** Parameters : ** NAME - DESCRIPTION ** index - Index of element. 0 peeks the top ** element, 1 the next, and so on. ** * elemP - Pointer to where to store the received ** element ** Returns : ** --- - Error code ** =================================================================== */ #define McuRingbuffer_Deinit() \ /* nothing to deinitialize */ /* ** =================================================================== ** Method : Deinit (component RingBuffer) ** ** Description : ** Driver de-initialization ** Parameters : None ** Returns : Nothing ** =================================================================== */ uint8_t McuRingbuffer_Delete(void); /* ** =================================================================== ** Method : Delete (component RingBuffer) ** ** Description : ** Removes an element from the buffer ** Parameters : None ** Returns : ** --- - Error code ** =================================================================== */ uint8_t McuRingbuffer_Putn(McuRingbuffer_ElementType *elem, McuRingbuffer_BufSizeType nof); /* ** =================================================================== ** Method : Putn (component RingBuffer) ** ** Description : ** Put a number new element into the buffer. ** Parameters : ** NAME - DESCRIPTION ** * elem - Pointer to new elements to be put into ** the buffer ** nof - number of elements ** Returns : ** --- - Error code ** =================================================================== */ uint8_t McuRingbuffer_Compare(McuRingbuffer_BufSizeType index, McuRingbuffer_ElementType *elemP, McuRingbuffer_BufSizeType nof); /* ** =================================================================== ** Method : Compare (component RingBuffer) ** ** Description : ** Compares the elements in the buffer. ** Parameters : ** NAME - DESCRIPTION ** index - Index of element. 0 peeks the top ** element, 1 the next, and so on. ** * elemP - Pointer to elements to compare with ** nof - number of elements to compare ** Returns : ** --- - zero if elements are the same, -1 otherwise ** =================================================================== */ uint8_t McuRingbuffer_Getn(McuRingbuffer_ElementType *buf, McuRingbuffer_BufSizeType nof); /* ** =================================================================== ** Method : Getn (component RingBuffer) ** ** Description : ** Get a number elements into a buffer. ** Parameters : ** NAME - DESCRIPTION ** * buf - Pointer to buffer where to store the ** elements ** nof - number of elements ** Returns : ** --- - Error code ** =================================================================== */ uint8_t McuRingbuffer_Update(McuRingbuffer_BufSizeType index, McuRingbuffer_ElementType *elemP); /* ** =================================================================== ** Method : Update (component RingBuffer) ** ** Description : ** Updates the data of an element. ** Parameters : ** NAME - DESCRIPTION ** index - Index of element. 0 peeks the top ** element, 1 the next, and so on. ** * elemP - Pointer to where to store the received ** element ** Returns : ** --- - Error code ** =================================================================== */ /* END McuRingbuffer. */ #ifdef __cplusplus } /* extern "C" */ #endif #endif /* ifndef __McuRingbuffer_H */ /*! ** @} */