nand-ecoscentric: packages/kernel/current/include/mboxt.hxx annotate

annotate packages/kernel/current/include/mboxt.hxx @ 3403:8c8767bb9a62 default tip

devs/nand/micron_mt29: Remove defunct references (in comments) to mt29f2g08_oob_ecc.

author	Ross Younger <wry@ecoscentric.com>
date	Sun, 18 Jan 2015 17:59:01 +1300
parents	74dbf4c3f2e1
children

rev	line source
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	1 #ifndef CYGONCE_KERNEL_MBOXT_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	2 #define CYGONCE_KERNEL_MBOXT_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	3
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	4 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	5 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	6 // mboxt.hxx
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	7 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	8 // Mboxt (Message Box/Mailbox) class declarations
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	9 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	10 //==========================================================================
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	11 // ####ECOSGPLCOPYRIGHTBEGIN####
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	12 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	13 // This file is part of eCos, the Embedded Configurable Operating System.
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	14 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	15 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	16 // eCos is free software; you can redistribute it and/or modify it under
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	17 // the terms of the GNU General Public License as published by the Free
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	18 // Software Foundation; either version 2 or (at your option) any later
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	19 // version.
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	20 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	21 // eCos is distributed in the hope that it will be useful, but WITHOUT
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	22 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	23 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	24 // for more details.
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	25 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	26 // You should have received a copy of the GNU General Public License
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	27 // along with eCos; if not, write to the Free Software Foundation, Inc.,
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	28 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	29 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	30 // As a special exception, if other files instantiate templates or use
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	31 // macros or inline functions from this file, or you compile this file
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	32 // and link it with other works to produce a work based on this file,
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	33 // this file does not by itself cause the resulting work to be covered by
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	34 // the GNU General Public License. However the source code for this file
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	35 // must still be made available in accordance with section (3) of the GNU
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	36 // General Public License v2.
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 66 diff changeset	37 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	38 // This exception does not invalidate any other reasons why a work based
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	39 // on this file might be covered by the GNU General Public License.
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	40 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 210 diff changeset	41 // ####ECOSGPLCOPYRIGHTEND####
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	42 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	43 //#####DESCRIPTIONBEGIN####
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	44 //
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	45 // Author(s): hmt
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	46 // Contributors: hmt
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	47 // Date: 1998-02-10
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	48 // Purpose: Define Mboxt class interfaces
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	49 // Description: The classes defined here provide the APIs for mboxtes.
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	50 // Usage: #include <cyg/kernel/mboxt.hxx>
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	51 // #include <cyg/kernel/mboxt.inl>
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	52 //
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	53 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	54 //####DESCRIPTIONEND####
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	55 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	56 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	57
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	58 #include <cyg/kernel/ktypes.h>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	59 #include <cyg/infra/cyg_ass.h> // assertion macros
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	60 #include <cyg/kernel/thread.hxx>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	61
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	62 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	63 // Message/Mail Box. This template implements a queue of T's.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	64 // Implemented as a template for maximal flexibility; one would hope
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	65 // that only one, with T==(void *) and the same number of them,
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	66 // is ever used without very good reason.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	67
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	68 // Cyg_Mboxt has a fixed size array of T's; one size fits all.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	69
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	70 template <class T, cyg_count32 QUEUE_SIZE>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	71 class Cyg_Mboxt
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	72 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	73 private:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	74 cyg_count32 base; // index of first used slot
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	75 cyg_count32 count; // count of used slots
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	76 Cyg_ThreadQueue get_threadq; // Queue of waiting threads
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	77 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	78 Cyg_ThreadQueue put_threadq; // Queue of waiting threads
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	79 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	80 static const
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	81 cyg_count32 size = QUEUE_SIZE;
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	82 T itemqueue[ QUEUE_SIZE ];
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	83 // queue of items
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	84 // private utility functions
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	85 // wake up a thread from some queue
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	86 inline void wakeup_waiter( Cyg_ThreadQueue &q );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	87
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	88 public:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	89
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	90 CYGDBG_DEFINE_CHECK_THIS
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	91
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	92 Cyg_Mboxt(); // Constructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	93 ~Cyg_Mboxt(); // Destructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	94
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	95 cyg_bool get( T &ritem ); // get an item; wait if none
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	96 #ifdef CYGFUN_KERNEL_THREADS_TIMER
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	97 cyg_bool get( T &ritem, cyg_tick_count abs_timeout );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	98 #endif
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	99 cyg_bool tryget( T &ritem ); // just one attempt
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	100
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	101 cyg_bool peek_item( T &ritem ); // get next item without
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	102 // removing it
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	103
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	104 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	105 cyg_bool put( const T item ); // put an item; wait if full
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	106 #ifdef CYGFUN_KERNEL_THREADS_TIMER
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	107 cyg_bool put( const T item, cyg_tick_count abs_timeout );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	108 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	109 #endif
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	110 cyg_bool tryput( const T item ); // fails if Q full
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	111
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	112 inline
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	113 cyg_count32 peek() // Get current count value
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	114 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	115 return count;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	116 }
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	117
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	118 inline
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	119 cyg_bool waiting_to_get() // Any threads waiting?
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	120 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	121 return ! get_threadq.empty();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	122 }
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	123
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	124 inline
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	125 cyg_bool waiting_to_put() // Any threads waiting?
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	126 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	127 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	128 return ! put_threadq.empty();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	129 #else
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	130 return false;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	131 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	132 }
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	133 };
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	134
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	135 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	136 #endif // ifndef CYGONCE_KERNEL_MBOXT_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	137 // EOF mboxt.hxx

Mercurial > nand-ecoscentric

annotate packages/kernel/current/include/mboxt.hxx @ 3403:8c8767bb9a62 default tip