system/include/ke/spinlock.h

   1 /*
   2 Copyright (C) 2008  Mathias Gottschlag
   3
   4 Permission is hereby granted, free of charge, to any person obtaining a copy of
   5 this software and associated documentation files (the "Software"), to deal in the
   6 Software without restriction, including without limitation the rights to use,
   7 copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
   8 Software, and to permit persons to whom the Software is furnished to do so,
   9 subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in all
  12 copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  15 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  16 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  17 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  18 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  19 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20 */
  21 /**
  22  * \file spinlock.h
  23  * Simple spinlocks
  24  */
  25 #ifndef KE_SPINLOCK_H_INCLUDED
  26 #define KE_SPINLOCK_H_INCLUDED
  27
  28 #include <stdint.h>
  29
  30 /**
  31  * Simple spinlock
  32  */
  33 typedef struct
  34 {
  35         uint32_t lock;
  36 } KeSpinlock;
  37
  38 /**
  39  * Initializes a spinlock and unlocks it.
  40  */
  41 int keInitSpinlock(KeSpinlock *spinlock);
  42 /**
  43  * Destroys a spinlock.
  44  */
  45 int keDestroySpinlock(KeSpinlock *spinlock);
  46 /**
  47  * Locks a spinlock. Blocks if the spinlock cannot be locked.
  48  * Warning: At the moment, this just busy-waits.
  49  */
  50 int keLockSpinlock(KeSpinlock *spinlock);
  51 /**
  52  * Locks a spinlock, returns if the spinlock is already locked.
  53  * \return Returns 0 if the spinlock was locked by the function.
  54  */
  55 int keTryLockSpinlock(KeSpinlock *spinlock);
  56 /**
  57  * Unlocks a spinlock.
  58  */
  59 int keUnlockSpinlock(KeSpinlock *spinlock);
  60
  61 #endif
  62