kern/sem.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2001,2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999,2000,2001 Bernardo Innocenti <bernie@develer.com>
  31  * This file is part of DevLib - See README.devlib for information.
  32  * -->
  33  *
  34  * \brief Mutually exclusive semaphores.
  35  *        Shared locking not supported in this implementation.
  36  *
  37  * \version $Id$
  38  *
  39  * \author Bernardo Innocenti <bernie@develer.com>
  40  */
  41
  42 /*#*
  43  *#* $Log$
  44  *#* Revision 1.7  2006/07/19 12:56:27  bernie
  45  *#* Convert to new Doxygen style.
  46  *#*
  47  *#* Revision 1.6  2005/11/04 16:20:02  bernie
  48  *#* Fix reference to README.devlib in header.
  49  *#*
  50  *#* Revision 1.5  2005/04/11 19:10:28  bernie
  51  *#* Include top-level headers from cfg/ subdir.
  52  *#*
  53  *#* Revision 1.4  2005/01/22 04:21:20  bernie
  54  *#* Add handy typedef for struct Semaphore.
  55  *#*
  56  *#* Revision 1.3  2004/08/25 14:12:09  rasky
  57  *#* Aggiornato il comment block dei log RCS
  58  *#*
  59  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  60  *#* Add dual-license information.
  61  *#*
  62  *#* Revision 1.1  2004/05/23 17:27:00  bernie
  63  *#* Import kern/ subdirectory.
  64  *#*
  65  *#*/
  66
  67 #ifndef KERN_SEM_H
  68 #define KERN_SEM_H
  69
  70 #include <cfg/compiler.h>
  71 #include <mware/list.h>
  72
  73 /* Fwd decl */
  74 struct Process;
  75
  76
  77 typedef struct Semaphore
  78 {
  79         struct Process *owner;
  80         List            wait_queue;
  81         int             nest_count;
  82 } Semaphore;
  83
  84 /**
  85  * \name Process synchronization services
  86  * \{
  87  */
  88 void sem_init(struct Semaphore *s);
  89 bool sem_attempt(struct Semaphore *s);
  90 void sem_obtain(struct Semaphore *s);
  91 void sem_release(struct Semaphore *s);
  92 /* \} */
  93
  94 #endif /* KERN_SEM_H */