thread.h

Go to the documentation of this file.
00001 #ifndef _SYS_THREAD_H_
00002 #define _SYS_THREAD_H_
00003 
00004 /*
00005  * Copyright (C) 2001-2006 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  *
00035  * -
00036  * Portions Copyright (C) 2000 David J. Hudson <dave@humbug.demon.co.uk>
00037  *
00038  * This file is distributed in the hope that it will be useful, but WITHOUT
00039  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00040  * FITNESS FOR A PARTICULAR PURPOSE.
00041  *
00042  * You can redistribute this file and/or modify it under the terms of the GNU
00043  * General Public License (GPL) as published by the Free Software Foundation;
00044  * either version 2 of the License, or (at your discretion) any later version.
00045  * See the accompanying file "copying-gpl.txt" for more details.
00046  *
00047  * As a special exception to the GPL, permission is granted for additional
00048  * uses of the text contained in this file.  See the accompanying file
00049  * "copying-liquorice.txt" for details.
00050  */
00051 
00144 #include <sys/types.h>
00145 #include <cfg/memory.h>
00146 
00147 #include <stdint.h>
00148 
00149 #define DEADBEEF    0xDEADBEEF
00150 
00151 
00156 
00160 typedef struct _NUTTHREADINFO NUTTHREADINFO;
00161 
00169 struct _NUTTHREADINFO {
00170     NUTTHREADINFO *td_next;     
00171     NUTTHREADINFO *td_qnxt;     
00172     volatile unsigned int td_qpec;     
00173     char td_name[9];            
00174     uint8_t td_state;            
00175     uintptr_t td_sp;               
00176     uint8_t td_priority;         
00177     uint8_t *td_memory;          
00178     HANDLE td_timer;            
00179     volatile HANDLE td_queue;   
00180 #if defined (__APPLE__) || defined(__linux__) || defined(__CYGWIN__)
00181     pthread_t td_pthread;       
00182     void (*td_fn) (void *);     
00183     void *td_arg;               
00184     pthread_cond_t td_cv;       
00185     uint16_t td_cs_level;        
00186 #endif
00187 };
00194 #define TDS_TERM        0       
00195 #define TDS_RUNNING     1       
00196 #define TDS_READY       2       
00197 #define TDS_SLEEP       3       
00199 
00200 #define SLEEP_MODE_NONE 0xff
00201 
00226 #ifndef NUT_THREAD_STACK_MULT
00227 #define NUT_THREAD_STACK_MULT   1
00228 #endif
00229 
00237 #ifndef NUT_THREAD_STACK_ADD
00238 #define NUT_THREAD_STACK_ADD    0
00239 #endif
00240 
00241 extern NUTTHREADINFO *runningThread;
00242 extern NUTTHREADINFO *nutThreadList;
00243 extern NUTTHREADINFO *runQueue;
00244 
00245 __BEGIN_DECLS
00246 /* Function prototypes. */
00247 #if defined (__APPLE__) || defined(__linux__) || defined(__CYGWIN__)
00248 extern void NutThreadInit(void);
00249 #endif
00250 
00251 #if defined(__GNUC__) && defined (__AVR_ENHANCED__)
00252 extern uint8_t NutThreadSetSleepMode(uint8_t mode);
00253 #endif
00254 
00255 extern HANDLE NutThreadCreate(char *name, void (*fn) (void *), void *arg, size_t stackSize);
00256 extern uint8_t NutThreadSetPriority(uint8_t level);
00257 
00258 extern void NutThreadKill(void);
00259 extern void NutThreadDestroy(void);
00260 extern void NutThreadExit(void);
00261 
00262 extern void NutThreadResume(void);
00263 extern void NutThreadWake(HANDLE timer, HANDLE th);
00264 extern void NutThreadYield(void);
00265 
00266 extern void NutThreadAddPriQueue(NUTTHREADINFO * td, NUTTHREADINFO * volatile *tqpp);
00267 extern void NutThreadRemoveQueue(NUTTHREADINFO * td, NUTTHREADINFO * volatile *tqpp);
00268 
00269 extern void NutThreadSwitch(void);
00270 extern HANDLE GetThreadByName(char *name);
00271 
00272 extern NUTTHREADINFO *NutThreadStackCheck(size_t minsiz);
00273 extern size_t NutThreadStackAvailable(char *name);
00274 
00278 #define THREAD(threadfn, arg) \
00279 void threadfn(void *arg) __attribute__ ((noreturn)); \
00280 void threadfn(void *arg)
00281 
00282 __END_DECLS
00283 /* */
00284 #endif

© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/