FYPFinalizeProgram -

Users » daryl2110 » Code » FYPFinalizeProgram

Daryl Tan Wei Guang / Mbed 2 deprecated FYPFinalizeProgram

Dependencies: keypad SDHCFileSystem mbed FPointer wave_player

scmRTOS/Common/usrlib.h@0:879af6e11219, 2012-02-20 (annotated)

Committer:: daryl2110
Date:: Mon Feb 20 07:36:06 2012 +0000
Revision:: 0:879af6e11219

Who changed what in which revision?

User	Revision	Line number	New contents of line
daryl2110	0:879af6e11219	1	//******************************************************************************
daryl2110	0:879af6e11219	2	//*
daryl2110	0:879af6e11219	3	//* FULLNAME: Single-Chip Microcontroller Real-Time Operating System
daryl2110	0:879af6e11219	4	//*
daryl2110	0:879af6e11219	5	//* NICKNAME: scmRTOS
daryl2110	0:879af6e11219	6	//*
daryl2110	0:879af6e11219	7	//* PURPOSE: User Suport Library Header
daryl2110	0:879af6e11219	8	//*
daryl2110	0:879af6e11219	9	//* Version: 3.10
daryl2110	0:879af6e11219	10	//*
daryl2110	0:879af6e11219	11	//* $Revision: 256 $
daryl2110	0:879af6e11219	12	//* $Date:: 2010-01-22 #$
daryl2110	0:879af6e11219	13	//*
daryl2110	0:879af6e11219	14	//* Copyright (c) 2003-2010, Harry E. Zhurov
daryl2110	0:879af6e11219	15	//*
daryl2110	0:879af6e11219	16	//* Permission is hereby granted, free of charge, to any person
daryl2110	0:879af6e11219	17	//* obtaining a copy of this software and associated documentation
daryl2110	0:879af6e11219	18	//* files (the "Software"), to deal in the Software without restriction,
daryl2110	0:879af6e11219	19	//* including without limitation the rights to use, copy, modify, merge,
daryl2110	0:879af6e11219	20	//* publish, distribute, sublicense, and/or sell copies of the Software,
daryl2110	0:879af6e11219	21	//* and to permit persons to whom the Software is furnished to do so,
daryl2110	0:879af6e11219	22	//* subject to the following conditions:
daryl2110	0:879af6e11219	23	//*
daryl2110	0:879af6e11219	24	//* The above copyright notice and this permission notice shall be included
daryl2110	0:879af6e11219	25	//* in all copies or substantial portions of the Software.
daryl2110	0:879af6e11219	26	//*
daryl2110	0:879af6e11219	27	//* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
daryl2110	0:879af6e11219	28	//* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
daryl2110	0:879af6e11219	29	//* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
daryl2110	0:879af6e11219	30	//* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
daryl2110	0:879af6e11219	31	//* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
daryl2110	0:879af6e11219	32	//* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
daryl2110	0:879af6e11219	33	//* THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
daryl2110	0:879af6e11219	34	//*
daryl2110	0:879af6e11219	35	//* =================================================================
daryl2110	0:879af6e11219	36	//* See http://scmrtos.sourceforge.net for documentation, latest
daryl2110	0:879af6e11219	37	//* information, license and contact details.
daryl2110	0:879af6e11219	38	//* =================================================================
daryl2110	0:879af6e11219	39	//*
daryl2110	0:879af6e11219	40	//******************************************************************************
daryl2110	0:879af6e11219	41
daryl2110	0:879af6e11219	42	#ifndef USRLIB_H
daryl2110	0:879af6e11219	43	#define USRLIB_H
daryl2110	0:879af6e11219	44
daryl2110	0:879af6e11219	45	#include <commdefs.h>
daryl2110	0:879af6e11219	46
daryl2110	0:879af6e11219	47	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	48	//
daryl2110	0:879af6e11219	49	// DESCRIPTON: user namespace for some useful types and functions
daryl2110	0:879af6e11219	50	//
daryl2110	0:879af6e11219	51	//
daryl2110	0:879af6e11219	52	namespace usr
daryl2110	0:879af6e11219	53	{
daryl2110	0:879af6e11219	54	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	55	//
daryl2110	0:879af6e11219	56	/// The Circular Buffer
daryl2110	0:879af6e11219	57	//
daryl2110	0:879af6e11219	58	/// Byte-wide FIFO.
daryl2110	0:879af6e11219	59	//
daryl2110	0:879af6e11219	60	/// Allows to:
daryl2110	0:879af6e11219	61	/// add byte,
daryl2110	0:879af6e11219	62	/// get byte,
daryl2110	0:879af6e11219	63	/// write bytes from array,
daryl2110	0:879af6e11219	64	/// read bytes to array,
daryl2110	0:879af6e11219	65	/// and some other service actions.
daryl2110	0:879af6e11219	66	//
daryl2110	0:879af6e11219	67	class TCbuf
daryl2110	0:879af6e11219	68	{
daryl2110	0:879af6e11219	69	public:
daryl2110	0:879af6e11219	70	TCbuf(byte* const Address, const byte Size);
daryl2110	0:879af6e11219	71	bool write(const byte* data, const byte Count);
daryl2110	0:879af6e11219	72	void read(byte* const data, const byte Count);
daryl2110	0:879af6e11219	73	byte get_count() const { return count; }
daryl2110	0:879af6e11219	74	byte get_free_size() const { return size - count; }
daryl2110	0:879af6e11219	75	byte get_byte(const byte index) const;
daryl2110	0:879af6e11219	76	void clear() { count = 0; last = first; }
daryl2110	0:879af6e11219	77	bool put(const byte item);
daryl2110	0:879af6e11219	78	byte get();
daryl2110	0:879af6e11219	79
daryl2110	0:879af6e11219	80	private:
daryl2110	0:879af6e11219	81	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	82	//
daryl2110	0:879af6e11219	83	// DESCRIPTON: For internal purposes
daryl2110	0:879af6e11219	84	//
daryl2110	0:879af6e11219	85	void push(const byte item); ///< Use this function with care - it doesn't perform free size check
daryl2110	0:879af6e11219	86	byte pop(); ///< Use this function with care - it doesn't perform count check
daryl2110	0:879af6e11219	87	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	88
daryl2110	0:879af6e11219	89	private:
daryl2110	0:879af6e11219	90	byte* buf;
daryl2110	0:879af6e11219	91	byte size;
daryl2110	0:879af6e11219	92	volatile byte count;
daryl2110	0:879af6e11219	93	byte first;
daryl2110	0:879af6e11219	94	byte last;
daryl2110	0:879af6e11219	95	};
daryl2110	0:879af6e11219	96	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	97
daryl2110	0:879af6e11219	98
daryl2110	0:879af6e11219	99
daryl2110	0:879af6e11219	100	//-----------------------------------------------------------------------
daryl2110	0:879af6e11219	101	//
daryl2110	0:879af6e11219	102	/// The Ring Buffer Template
daryl2110	0:879af6e11219	103	///
daryl2110	0:879af6e11219	104	/// Carries out FIFO functionality for
daryl2110	0:879af6e11219	105	/// arbitrary data types
daryl2110	0:879af6e11219	106	///
daryl2110	0:879af6e11219	107	/// Allows to:
daryl2110	0:879af6e11219	108	/// add item to back (default),
daryl2110	0:879af6e11219	109	/// add item to front,
daryl2110	0:879af6e11219	110	/// get item at front (default),
daryl2110	0:879af6e11219	111	/// get item from back,
daryl2110	0:879af6e11219	112	/// write items from array,
daryl2110	0:879af6e11219	113	/// read items to array and some other actions
daryl2110	0:879af6e11219	114	//
daryl2110	0:879af6e11219	115	//
daryl2110	0:879af6e11219	116	//
daryl2110	0:879af6e11219	117	template<typename T, word Size, typename S = byte>
daryl2110	0:879af6e11219	118	class ring_buffer
daryl2110	0:879af6e11219	119	{
daryl2110	0:879af6e11219	120	public:
daryl2110	0:879af6e11219	121	ring_buffer() : Count(0), First(0), Last(0) { }
daryl2110	0:879af6e11219	122
daryl2110	0:879af6e11219	123	//----------------------------------------------------------------
daryl2110	0:879af6e11219	124	//
daryl2110	0:879af6e11219	125	// Data transfer functions
daryl2110	0:879af6e11219	126	//
daryl2110	0:879af6e11219	127	bool write(const T* data, const S cnt);
daryl2110	0:879af6e11219	128	void read(T* const data, const S cnt);
daryl2110	0:879af6e11219	129
daryl2110	0:879af6e11219	130	bool push_back(const T item);
daryl2110	0:879af6e11219	131	bool push_front(const T item);
daryl2110	0:879af6e11219	132
daryl2110	0:879af6e11219	133	T pop_front();
daryl2110	0:879af6e11219	134	T pop_back();
daryl2110	0:879af6e11219	135
daryl2110	0:879af6e11219	136	bool push(const T item) { return push_back(item); }
daryl2110	0:879af6e11219	137	T pop() { return pop_front(); }
daryl2110	0:879af6e11219	138
daryl2110	0:879af6e11219	139	//----------------------------------------------------------------
daryl2110	0:879af6e11219	140	//
daryl2110	0:879af6e11219	141	// Service functions
daryl2110	0:879af6e11219	142	//
daryl2110	0:879af6e11219	143	S get_count() const { return Count; }
daryl2110	0:879af6e11219	144	S get_free_size() const { return Size - Count; }
daryl2110	0:879af6e11219	145	T& operator[](const S index);
daryl2110	0:879af6e11219	146	void flush() { Count = 0; Last = First; }
daryl2110	0:879af6e11219	147
daryl2110	0:879af6e11219	148	private:
daryl2110	0:879af6e11219	149	//--------------------------------------------------------------
daryl2110	0:879af6e11219	150	// DESCRIPTON: For internal purposes
daryl2110	0:879af6e11219	151	// Use this functions with care: it don't perform
daryl2110	0:879af6e11219	152	// free size and count check
daryl2110	0:879af6e11219	153	//
daryl2110	0:879af6e11219	154	void push_item(const T item);
daryl2110	0:879af6e11219	155	void push_item_front(const T item);
daryl2110	0:879af6e11219	156	T pop_item();
daryl2110	0:879af6e11219	157	T pop_item_back();
daryl2110	0:879af6e11219	158	//--------------------------------------------------------------
daryl2110	0:879af6e11219	159
daryl2110	0:879af6e11219	160	private:
daryl2110	0:879af6e11219	161	S Count;
daryl2110	0:879af6e11219	162	S First;
daryl2110	0:879af6e11219	163	S Last;
daryl2110	0:879af6e11219	164	T Buf[Size];
daryl2110	0:879af6e11219	165	};
daryl2110	0:879af6e11219	166	//------------------------------------------------------------------
daryl2110	0:879af6e11219	167	}
daryl2110	0:879af6e11219	168	//---------------------------------------------------------------------------
daryl2110	0:879af6e11219	169
daryl2110	0:879af6e11219	170
daryl2110	0:879af6e11219	171	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	172	//
daryl2110	0:879af6e11219	173	// The ring buffer function-member definitions
daryl2110	0:879af6e11219	174	//
daryl2110	0:879af6e11219	175	//
daryl2110	0:879af6e11219	176	//
daryl2110	0:879af6e11219	177	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	178	bool usr::ring_buffer<T, Size, S>::write(const T* data, const S cnt)
daryl2110	0:879af6e11219	179	{
daryl2110	0:879af6e11219	180	if( cnt > (Size - Count) )
daryl2110	0:879af6e11219	181	return false;
daryl2110	0:879af6e11219	182
daryl2110	0:879af6e11219	183	for(S i = 0; i < cnt; i++)
daryl2110	0:879af6e11219	184	push_item(*(data++));
daryl2110	0:879af6e11219	185
daryl2110	0:879af6e11219	186	return true;
daryl2110	0:879af6e11219	187	}
daryl2110	0:879af6e11219	188	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	189	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	190	void usr::ring_buffer<T, Size, S>::read(T* data, const S cnt)
daryl2110	0:879af6e11219	191	{
daryl2110	0:879af6e11219	192	S nItems = cnt <= Count ? cnt : Count;
daryl2110	0:879af6e11219	193
daryl2110	0:879af6e11219	194	for(S i = 0; i < nItems; i++)
daryl2110	0:879af6e11219	195	data[i] = pop_item();
daryl2110	0:879af6e11219	196	}
daryl2110	0:879af6e11219	197	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	198	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	199	T& usr::ring_buffer<T, Size, S>::operator[](const S index)
daryl2110	0:879af6e11219	200	{
daryl2110	0:879af6e11219	201	S x = First + index;
daryl2110	0:879af6e11219	202
daryl2110	0:879af6e11219	203	if(x < Size)
daryl2110	0:879af6e11219	204	return Buf[x];
daryl2110	0:879af6e11219	205	else
daryl2110	0:879af6e11219	206	return Buf[x - Size];
daryl2110	0:879af6e11219	207	}
daryl2110	0:879af6e11219	208
daryl2110	0:879af6e11219	209	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	210	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	211	bool usr::ring_buffer<T, Size, S>::push_back(const T item)
daryl2110	0:879af6e11219	212	{
daryl2110	0:879af6e11219	213	if(Count == Size)
daryl2110	0:879af6e11219	214	return false;
daryl2110	0:879af6e11219	215
daryl2110	0:879af6e11219	216	push_item(item);
daryl2110	0:879af6e11219	217	return true;
daryl2110	0:879af6e11219	218	}
daryl2110	0:879af6e11219	219	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	220	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	221	bool usr::ring_buffer<T, Size, S>::push_front(const T item)
daryl2110	0:879af6e11219	222	{
daryl2110	0:879af6e11219	223	if(Count == Size)
daryl2110	0:879af6e11219	224	return false;
daryl2110	0:879af6e11219	225
daryl2110	0:879af6e11219	226	push_item_front(item);
daryl2110	0:879af6e11219	227	return true;
daryl2110	0:879af6e11219	228	}
daryl2110	0:879af6e11219	229	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	230	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	231	T usr::ring_buffer<T, Size, S>::pop_front()
daryl2110	0:879af6e11219	232	{
daryl2110	0:879af6e11219	233	if(Count)
daryl2110	0:879af6e11219	234	return pop_item();
daryl2110	0:879af6e11219	235	else
daryl2110	0:879af6e11219	236	return Buf[First];
daryl2110	0:879af6e11219	237	}
daryl2110	0:879af6e11219	238	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	239	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	240	T usr::ring_buffer<T, Size, S>::pop_back()
daryl2110	0:879af6e11219	241	{
daryl2110	0:879af6e11219	242	if(Count)
daryl2110	0:879af6e11219	243	return pop_item_back();
daryl2110	0:879af6e11219	244	else
daryl2110	0:879af6e11219	245	return Buf[First];
daryl2110	0:879af6e11219	246	}
daryl2110	0:879af6e11219	247	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	248	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	249	void usr::ring_buffer<T, Size, S>::push_item(const T item)
daryl2110	0:879af6e11219	250	{
daryl2110	0:879af6e11219	251	Buf[Last] = item;
daryl2110	0:879af6e11219	252	Last++;
daryl2110	0:879af6e11219	253	Count++;
daryl2110	0:879af6e11219	254
daryl2110	0:879af6e11219	255	if(Last == Size)
daryl2110	0:879af6e11219	256	Last = 0;
daryl2110	0:879af6e11219	257	}
daryl2110	0:879af6e11219	258	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	259	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	260	void usr::ring_buffer<T, Size, S>::push_item_front(const T item)
daryl2110	0:879af6e11219	261	{
daryl2110	0:879af6e11219	262	if(First == 0)
daryl2110	0:879af6e11219	263	First = Size - 1;
daryl2110	0:879af6e11219	264	else
daryl2110	0:879af6e11219	265	--First;
daryl2110	0:879af6e11219	266	Buf[First] = item;
daryl2110	0:879af6e11219	267	Count++;
daryl2110	0:879af6e11219	268	}
daryl2110	0:879af6e11219	269	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	270	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	271	T usr::ring_buffer<T, Size, S>::pop_item()
daryl2110	0:879af6e11219	272	{
daryl2110	0:879af6e11219	273	T item = Buf[First];
daryl2110	0:879af6e11219	274
daryl2110	0:879af6e11219	275	Count--;
daryl2110	0:879af6e11219	276	First++;
daryl2110	0:879af6e11219	277	if(First == Size)
daryl2110	0:879af6e11219	278	First = 0;
daryl2110	0:879af6e11219	279
daryl2110	0:879af6e11219	280	return item;
daryl2110	0:879af6e11219	281	}
daryl2110	0:879af6e11219	282	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	283	template<typename T, word Size, typename S>
daryl2110	0:879af6e11219	284	T usr::ring_buffer<T, Size, S>::pop_item_back()
daryl2110	0:879af6e11219	285	{
daryl2110	0:879af6e11219	286
daryl2110	0:879af6e11219	287	if(Last == 0)
daryl2110	0:879af6e11219	288	Last = Size - 1;
daryl2110	0:879af6e11219	289	else
daryl2110	0:879af6e11219	290	--Last;
daryl2110	0:879af6e11219	291
daryl2110	0:879af6e11219	292	Count--;
daryl2110	0:879af6e11219	293	return Buf[Last];;
daryl2110	0:879af6e11219	294	}
daryl2110	0:879af6e11219	295	//------------------------------------------------------------------------------
daryl2110	0:879af6e11219	296
daryl2110	0:879af6e11219	297
daryl2110	0:879af6e11219	298	#endif // USRLIB_H

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	20 Feb 2012
Imports:	1
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	5
Followers:	1

scmRTOS/Common/usrlib.h@0:879af6e11219, 2012-02-20 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning