kernel/generic/include/synch/condvar.h

   1 /*
   2  * Copyright (c) 2001-2004 Jakub Jermar
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup sync
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_CONDVAR_H_
  36 #define KERN_CONDVAR_H_
  37
  38 #include <arch/types.h>
  39 #include <synch/waitq.h>
  40 #include <synch/mutex.h>
  41 #include <synch/synch.h>
  42
  43 typedef struct {
  44         waitq_t wq;
  45 } condvar_t;
  46
  47 #define condvar_wait(cv, mtx) \
  48         _condvar_wait_timeout((cv), (mtx), SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE)
  49 #define condvar_wait_timeout(cv, mtx, usec) \
  50         _condvar_wait_timeout((cv), (mtx), (usec), SYNCH_FLAGS_NONE)
  51
  52 extern void condvar_initialize(condvar_t *cv);
  53 extern void condvar_signal(condvar_t *cv);
  54 extern void condvar_broadcast(condvar_t *cv);
  55 extern int _condvar_wait_timeout(condvar_t *cv, mutex_t *mtx, uint32_t usec,
  56     int flags);
  57
  58 #endif
  59
  60 /** @}
  61  */