Main Page   Modules   Data Structures   File List   Globals  

mutex.h

Go to the documentation of this file.
00001 /*
00002 Copyright (c) 2002, 2003, Oliver Tscherwitschke
00003 All rights reserved.
00004 
00005 Redistribution and use in source and binary forms, with or without
00006 modification, are permitted provided that the following conditions are met:
00007 
00008 1. Redistributions of source code must retain the above copyright notice,
00009    this list of conditions and the following disclaimer.
00010 2. Redistributions in binary form must reproduce the above copyright notice,
00011    this list of conditions and the following disclaimer in the documentation
00012    and/or other materials provided with the distribution.
00013 3. The name of the author may not be used to endorse or promote products
00014    derived from this software without specific prior written permission.
00015 
00016 THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
00017 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00018 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
00019 EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00020 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00021 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
00022 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00023 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
00024 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
00025 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026 */
00027 
00035 #ifndef MUTEX_H
00036 #define MUTEX_H
00037 
00038 
00039 #include "types.h"
00040 #include "task.h"
00041 
00042 
00043 /*
00044  * Constants
00045  */
00046 
00047 #define MUTEX_SUCCESS           0
00048 #define MUTEX_ALREADY_LOCKED    1
00049 #define MUTEX_TIMEOUT           2
00050 #define MUTEX_NOT_OWNER         3
00051 
00052 
00053 
00054 /*
00055  * Types
00056  */
00057 
00058 typedef struct
00059 {
00060     uint8_t     lock;       /* Lock state. 0: unlocked, 1: locked */
00061     OtosTask*   pOwner;     /* The task that owns this mutex */
00062 } OtosMutex;
00063 
00064 
00065 
00066 
00067 /*
00068  * function prototypes
00069  */
00070  
00071 uint8_t   otosLockMutex(OtosMutex* pMutex, uint32_t timeout);
00072 uint8_t   otosUnlockMutex(OtosMutex* pMutex);
00073 
00074 
00075 /*
00076  * These definitions are only intended for otOS-internal use
00077  */
00078 #ifdef COMPILE_OTOS
00079 
00080 inline uint8_t otosTestAndSet(uint8_t* pLock);
00081 
00082 #endif /* #ifdef COMPILE_OTOS */
00083 
00084 
00085 #endif

Generated on Sat Jan 25 18:41:43 2003 for otOS by doxygen1.3-rc2