168 lines
6.0 KiB
C
168 lines
6.0 KiB
C
|
/* ###################################################################
|
||
|
|
** THIS COMPONENT MODULE IS GENERATED BY THE TOOL. DO NOT MODIFY IT.
|
||
|
|
** Filename : Rx1.h
|
||
|
|
** Project : Landungsbruecke_KDS_v2.0.0
|
||
|
|
** Processor : MK20DN512VLL10
|
||
|
|
** Component : RingBuffer
|
||
|
|
** Version : Component 01.025, Driver 01.00, CPU db: 3.00.000
|
||
|
|
** Compiler : GNU C Compiler
|
||
|
|
** Date/Time : 2015-01-09, 16:27, # CodeGen: 0
|
||
|
|
** Abstract :
|
||
|
|
** This component implements a ring buffer for different integer data type.
|
||
|
|
** Settings :
|
||
|
|
** Component name : Rx1
|
||
|
|
** Buffer Size : 1
|
||
|
|
** Contents :
|
||
|
|
** Clear - void Rx1_Clear(void);
|
||
|
|
** Put - byte Rx1_Put(Rx1_ElementType elem);
|
||
|
|
** Get - byte Rx1_Get(Rx1_ElementType *elemP);
|
||
|
|
** NofElements - Rx1_BufSizeType Rx1_NofElements(void);
|
||
|
|
** NofFreeElements - Rx1_BufSizeType Rx1_NofFreeElements(void);
|
||
|
|
** Init - void Rx1_Init(void);
|
||
|
|
**
|
||
|
|
** License : Open Source (LGPL)
|
||
|
|
** Copyright : (c) Copyright Erich Styger, 2014, all rights reserved.
|
||
|
|
** Web: http://www.mcuoneclipse.com
|
||
|
|
** This an open source software of an embedded component for Processor Expert.
|
||
|
|
** This is a free software and is opened for education, research and commercial developments under license policy of following terms:
|
||
|
|
** * This is a free software and there is NO WARRANTY.
|
||
|
|
** * No restriction on use. You can use, modify and redistribute it for personal, non-profit or commercial product UNDER YOUR RESPONSIBILITY.
|
||
|
|
** * Redistributions of source code must retain the above copyright notice.
|
||
|
|
** ###################################################################*/
|
||
|
|
/*!
|
||
|
|
** @file Rx1.h
|
||
|
|
** @version 01.00
|
||
|
|
** @brief
|
||
|
|
** This component implements a ring buffer for different integer data type.
|
||
|
|
*/
|
||
|
|
/*!
|
||
|
|
** @addtogroup Rx1_module Rx1 module documentation
|
||
|
|
** @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef __Rx1_H
|
||
|
|
#define __Rx1_H
|
||
|
|
|
||
|
|
/* MODULE Rx1. */
|
||
|
|
|
||
|
|
/* Include shared modules, which are used for whole project */
|
||
|
|
#include "PE_Types.h"
|
||
|
|
#include "PE_Error.h"
|
||
|
|
#include "PE_Const.h"
|
||
|
|
#include "MK20D10.h"
|
||
|
|
/* Include inherited beans */
|
||
|
|
#include "CS1.h"
|
||
|
|
|
||
|
|
//#include "Cpu.h"
|
||
|
|
|
||
|
|
|
||
|
|
#define Rx1_BUF_SIZE 64 /* number of elements in the buffer */
|
||
|
|
#define Rx1_ELEM_SIZE 1 /* size of a single element in bytes */
|
||
|
|
#define Rx1_IS_REENTRANT 0 /* 0: Critical section NOT used for accessing shared data, 1 otherwise */
|
||
|
|
#if Rx1_ELEM_SIZE==1
|
||
|
|
typedef uint8 Rx1_ElementType; /* type of single element */
|
||
|
|
#elif Rx1_ELEM_SIZE==2
|
||
|
|
typedef uint16 Rx1_ElementType; /* type of single element */
|
||
|
|
#elif Rx1_ELEM_SIZE==4
|
||
|
|
typedef uint32 Rx1_ElementType; /* type of single element */
|
||
|
|
#else
|
||
|
|
#error "illegal element type size in properties"
|
||
|
|
#endif
|
||
|
|
#if Rx1_BUF_SIZE<=256
|
||
|
|
typedef uint8 Rx1_BufSizeType; /* up to 256 elements (index 0x00..0xFF) */
|
||
|
|
#else
|
||
|
|
typedef uint16 Rx1_BufSizeType; /* more than 256 elements, up to 2^16 */
|
||
|
|
#endif
|
||
|
|
|
||
|
|
byte Rx1_Put(Rx1_ElementType elem);
|
||
|
|
/*
|
||
|
|
** ===================================================================
|
||
|
|
** Method : Rx1_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
|
||
|
|
** ===================================================================
|
||
|
|
*/
|
||
|
|
|
||
|
|
byte Rx1_Get(Rx1_ElementType *elemP);
|
||
|
|
/*
|
||
|
|
** ===================================================================
|
||
|
|
** Method : Rx1_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
|
||
|
|
** ===================================================================
|
||
|
|
*/
|
||
|
|
|
||
|
|
Rx1_BufSizeType Rx1_NofElements(void);
|
||
|
|
/*
|
||
|
|
** ===================================================================
|
||
|
|
** Method : Rx1_NofElements (component RingBuffer)
|
||
|
|
** Description :
|
||
|
|
** Returns the actual number of elements in the buffer.
|
||
|
|
** Parameters : None
|
||
|
|
** Returns :
|
||
|
|
** --- - Number of elements in the buffer.
|
||
|
|
** ===================================================================
|
||
|
|
*/
|
||
|
|
|
||
|
|
void Rx1_Init(void);
|
||
|
|
/*
|
||
|
|
** ===================================================================
|
||
|
|
** Method : Rx1_Init (component RingBuffer)
|
||
|
|
** Description :
|
||
|
|
** Initializes the data structure
|
||
|
|
** Parameters : None
|
||
|
|
** Returns : Nothing
|
||
|
|
** ===================================================================
|
||
|
|
*/
|
||
|
|
|
||
|
|
Rx1_BufSizeType Rx1_NofFreeElements(void);
|
||
|
|
/*
|
||
|
|
** ===================================================================
|
||
|
|
** Method : Rx1_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 Rx1_Clear(void);
|
||
|
|
/*
|
||
|
|
** ===================================================================
|
||
|
|
** Method : Rx1_Clear (component RingBuffer)
|
||
|
|
** Description :
|
||
|
|
** Clear (empty) the ring buffer.
|
||
|
|
** Parameters : None
|
||
|
|
** Returns : Nothing
|
||
|
|
** ===================================================================
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* END Rx1. */
|
||
|
|
|
||
|
|
#endif
|
||
|
|
/* ifndef __Rx1_H */
|
||
|
|
/*!
|
||
|
|
** @}
|
||
|
|
*/
|
||
|
|
/*
|
||
|
|
** ###################################################################
|
||
|
|
**
|
||
|
|
** This file was created by Processor Expert 10.4 [05.11]
|
||
|
|
** for the Freescale Kinetis series of microcontrollers.
|
||
|
|
**
|
||
|
|
** ###################################################################
|
||
|
|
*/
|