ecos: packages/kernel/current/include/mbox.hxx annotate

annotate packages/kernel/current/include/mbox.hxx @ 3284:4839eca9f0c7

Increase resolution of time measurement for platforms featuring HAL_CLOCK_READ_NS. [Bugzilla 1001958]

author	vae
date	Thu, 13 Mar 2014 21:32:49 +0000
parents	74dbf4c3f2e1
children

rev	line source
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	1 #ifndef CYGONCE_KERNEL_MBOX_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	2 #define CYGONCE_KERNEL_MBOX_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 // mbox.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 // Plain (void *) Mbox (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 Mbox 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 mboxes.
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	50 // Usage: #include <cyg/kernel/mbox.hxx>
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	51 //
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	52 //
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	53 //####DESCRIPTIONEND####
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	54 //
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 #include <cyg/kernel/ktypes.h>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	58 #include <cyg/infra/cyg_ass.h> // assertion macros
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	59 #include <cyg/kernel/thread.hxx>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	60
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	61 #ifdef CYGIMP_MBOX_USE_MBOXT_PLAIN
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	62 #include <cyg/kernel/mboxt.hxx>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	63 #else
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	64 #include <cyg/kernel/mboxt2.hxx>
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	65 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	66
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 // Message/Mail Box. This class implements a queue of void * items using
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	69 // the Cyg_Mbox<Type, QSize> template class.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	70
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	71 #ifndef CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	72 // default is 10 elements
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	73 #define CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE (10)
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	74 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	75
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	76 // Cyg_Mbox has a fixed size array of (void *)s; one size fits all.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	77 // Because of this, we can simplify the API by returning a NULL for
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	78 // "failed" conditions. Ergo a NULL message is illegal. BFD.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	79
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	80 class Cyg_Mbox
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	81 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	82 private:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	83 #ifdef CYGIMP_MBOX_USE_MBOXT_PLAIN
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	84 Cyg_Mboxt<void *, CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE> m;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	85 #else
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	86 Cyg_Mboxt2<void *, CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE> m;
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	87 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	88
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	89 public:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	90
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	91 CYGDBG_DEFINE_CHECK_THIS
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	92
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	93 Cyg_Mbox(); // Constructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	94 ~Cyg_Mbox(); // Destructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	95
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	96 void * get(); // get an item; wait if none
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	97 #ifdef CYGFUN_KERNEL_THREADS_TIMER
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	98 void * get( cyg_tick_count timeout );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	99 #endif
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	100 void * tryget(); // just one attempt
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	101
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	102 void * peek_item(); // Get next item to be returned
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	103 // without removing it
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	104
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	105 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT // then we support it too
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	106 cyg_bool put( void *item ); // put an item; wait if full
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	107 #ifdef CYGFUN_KERNEL_THREADS_TIMER
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	108 cyg_bool put( void *item, cyg_tick_count timeout );
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	109 #endif
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	110 #endif
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	111 cyg_bool tryput( void *item ); // fails if Q full
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	112
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	113 inline
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	114 cyg_count32 peek() // Get current count value
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	115 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	116 return m.peek();
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
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	119 inline
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	120 cyg_bool waiting_to_get() // Any threads waiting to get?
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	121 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	122 return m.waiting_to_get();
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 to put?
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 return m.waiting_to_put();
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	128 }
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	129 };
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	130
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	131
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 #endif // ifndef CYGONCE_KERNEL_MBOX_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	135 // End of mbox.hxx

Mercurial > ecos

annotate packages/kernel/current/include/mbox.hxx @ 3284:4839eca9f0c7