bertos/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,2005,2006,2007 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999,2000,2001 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \defgroup kern_sem Mutually exclusive semaphores
  35  * \ingroup kern
  36  * \{
  37  * \brief Mutually exclusive semaphores.
  38  *        Shared locking not supported in this implementation.
  39  *
  40  *
  41  * \author Bernie Innocenti <bernie@codewiz.org>
  42  *
  43  * $WIZ$ module_name = "semaphores"
  44  * $WIZ$ module_depends = "kernel"
  45  * $WIZ$ module_configuration = "bertos/cfg/cfg_sem.h"
  46  */
  47
  48
  49 #ifndef KERN_SEM_H
  50 #define KERN_SEM_H
  51
  52 #include <cfg/compiler.h>
  53 #include <struct/list.h>
  54
  55 /* Fwd decl */
  56 struct Process;
  57
  58
  59 typedef struct Semaphore
  60 {
  61         struct Process *owner;
  62         List            wait_queue;
  63         int             nest_count;
  64 } Semaphore;
  65
  66 /**
  67  * \name Process synchronization services
  68  * \{
  69  */
  70 void sem_init(struct Semaphore *s);
  71 bool sem_attempt(struct Semaphore *s);
  72 void sem_obtain(struct Semaphore *s);
  73 void sem_release(struct Semaphore *s);
  74 /* \} */
  75 /* \} */ //defgroup kern_sem
  76
  77 int sem_testRun(void);
  78 int sem_testSetup(void);
  79 int sem_testTearDown(void);
  80
  81 #endif /* KERN_SEM_H */