drivers/staging/csr/oska/all.h

   1 /*
   2  * Operating system kernel abstraction -- all functions
   3  *
   4  * Copyright (C) 2007 Cambridge Silicon Radio Ltd.
   5  *
   6  * Refer to LICENSE.txt included with this source code for details on
   7  * the license terms.
   8  */
   9 #ifndef __OSKA_ALL_H
  10 #define __OSKA_ALL_H
  11
  12 /**
  13  * @mainpage Operating System Kernel Abstraction
  14  *
  15  * @section intro Introduction
  16  *
  17  * The Operating System Kernel Abstraction (oska) is a software
  18  * package providing an abstraction for various operating system
  19  * kernel facilities for use by device drivers and other OS kernel
  20  * software (e.g., SDIO stacks).  Oska is modularized and intended to
  21  * be a lightweight wrapper around an OSes interfaces.
  22  *
  23  * @section modules Modules
  24  *
  25  * Oska is organized into the modules, each of which has it's own
  26  * header file providing the interface.
  27  *
  28  *   - \ref alloc "Memory allocation" <oska/alloc.h>
  29  *   - \ref event "Events" <oska/event.h>
  30  *   - \ref mutex "Mutexes" <oska/mutex.h>
  31  *   - \ref print "Console output" <oska/print.h>
  32  *   - \ref spinlock "Spinlocks" <oska/spinlock.h>
  33  *   - \ref thread "Threading" <oska/thread.h>
  34  *   - \ref time "Timing and delays" <oska/time.h>
  35  *   - \ref timer "Timers" <oska/timer.h>
  36  *   - \ref types "Standard Types" <oska/types.h>
  37  *   - \ref util "Miscellaneous utilities" <oska/util.h>
  38  *
  39  * An <oska/all.h> header is provided which includes all the above
  40  * modules.
  41  *
  42  * There are additional modules that are not included in <oska/all.h>.
  43  *
  44  *   - \ref io "Memory mapped I/O" <oska/io.h>
  45  *   - \ref refcount "Reference Counting" <oska/refcount.h>
  46  *   - \ref list "Linked lists" <oska/list.h>
  47  *   - \ref trace "Tracing messages" <oska/trace.h>
  48  */
  49
  50 #include "alloc.h"
  51 #include "event.h"
  52 #include "mutex.h"
  53 #include "print.h"
  54 #include "spinlock.h"
  55 #include "thread.h"
  56 #include "time.h"
  57 #include "timer.h"
  58 #include "types.h"
  59 #include "util.h"
  60
  61 #endif /* __OSKA_ALL_H */