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

annotate packages/kernel/current/include/sema.hxx @ 2729:74dbf4c3f2e1 after-copyright-change-20090129

Update all copyright banners to reflect FSF ownership; fix and improve licence text.

author	jlarmour
date	Thu, 29 Jan 2009 17:47:46 +0000
parents	e8b69d9c90a6
children

rev	line source
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	1 #ifndef CYGONCE_KERNEL_SEMA_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	2 #define CYGONCE_KERNEL_SEMA_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 // sema.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 // Semaphore 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: 1062 diff changeset	11 // ####ECOSGPLCOPYRIGHTBEGIN####
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 1062 diff changeset	12 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 1062 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: 1062 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: 115 diff changeset	15 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 1062 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: 1062 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: 1062 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: 1062 diff changeset	19 // version.
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 115 diff changeset	20 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 1062 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: 1062 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: 1062 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: 1062 diff changeset	24 // for more details.
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 115 diff changeset	25 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 1062 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: 1062 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: 1062 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: 115 diff changeset	29 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 1062 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: 1062 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: 1062 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: 1062 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: 1062 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: 1062 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: 1062 diff changeset	36 // General Public License v2.
208 e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST jlarmour parents: 115 diff changeset	37 //
2729 74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 1062 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: 1062 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: 1062 diff changeset	40 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text. jlarmour parents: 1062 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): nickg
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	46 // Contributors: nickg
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	47 // Date: 1997-09-09
443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	48 // Purpose: Define Semaphore 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 binary
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	50 // and counting semaphores.
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	51 // Usage: #include <cyg/kernel/sema.hxx>
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
115 6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST jlarmour parents: 66 diff changeset	60 #include <cyg/kernel/thread.inl> // thread inlines
0 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 // Binary semaphore. This has only two states: posted and not-posted.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	64
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	65 class Cyg_Binary_Semaphore
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 cyg_bool state; // The binary semaphore state
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	68
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	69 Cyg_ThreadQueue queue; // Queue of waiting threads
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 public:
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 CYGDBG_DEFINE_CHECK_THIS
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	74
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	75 Cyg_Binary_Semaphore( // Constructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	76 cyg_bool init_state = false // Initial state value
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	77 );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	78
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	79 ~Cyg_Binary_Semaphore(); // Destructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	80
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	81 cyg_bool wait(); // Wait until state == true
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	82
1062 e8b69d9c90a6 * cdl/kernel.cdl: Added tests/bin_sem3 to list of kernel tests. nickg parents: 210 diff changeset	83 #ifdef CYGFUN_KERNEL_THREADS_TIMER
e8b69d9c90a6 * cdl/kernel.cdl: Added tests/bin_sem3 to list of kernel tests. nickg parents: 210 diff changeset	84 cyg_bool wait( cyg_tick_count timeout );
e8b69d9c90a6 * cdl/kernel.cdl: Added tests/bin_sem3 to list of kernel tests. nickg parents: 210 diff changeset	85 #endif // Wait until state == true or timeout
e8b69d9c90a6 * cdl/kernel.cdl: Added tests/bin_sem3 to list of kernel tests. nickg parents: 210 diff changeset	86
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	87 cyg_bool trywait(); // Set state false if possible
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 void post(); // Increment count
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 cyg_bool posted(); // Get current state
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 };
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	94
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	95 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	96 // Counting semaphore. This implements the usual counter based semaphore.
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	97
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	98 class Cyg_Counting_Semaphore
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	99 {
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	100 cyg_count32 count; // The semaphore count
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	101
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	102 Cyg_ThreadQueue queue; // Queue of waiting threads
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 public:
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	105
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	106 CYGDBG_DEFINE_CHECK_THIS
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	107
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	108 Cyg_Counting_Semaphore( // Constructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	109 cyg_count32 init_count = 0 // Initial count value
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	110 );
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 ~Cyg_Counting_Semaphore(); // Destructor
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	113
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	114 cyg_bool wait(); // Wait until decrement
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 #ifdef CYGFUN_KERNEL_THREADS_TIMER
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	117 cyg_bool wait( cyg_tick_count timeout );
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	118 #endif // Wait until decrement or timeout
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	119
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	120 cyg_bool trywait(); // Try to decrement
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 void post(); // Increment count
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	123
115 6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST jlarmour parents: 66 diff changeset	124 cyg_count32 peek() const; // Get current count value
0 3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	125
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	126 inline
2 443894e2e912 Block commit of eCos version 1.2.1 jlarmour parents: 0 diff changeset	127 cyg_bool waiting() // Is anyone waiting?
0 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 return !queue.empty();
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 // -------------------------------------------------------------------------
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	135 #endif // ifndef CYGONCE_KERNEL_SEMA_HXX
3111d98ba7b3 Initial commit of eCos version 1.1 jlarmour parents: diff changeset	136 // EOF sema.hxx

Mercurial > ecos

annotate packages/kernel/current/include/sema.hxx @ 2729:74dbf4c3f2e1 after-copyright-change-20090129