thread.h

Go to the documentation of this file.

#ifndef _SYS_THREAD_H_
#define _SYS_THREAD_H_

/*
 * Copyright (C) 2001-2006 by egnite Software GmbH. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * For additional information see http://www.ethernut.de/
 *
 * -
 * Portions Copyright (C) 2000 David J. Hudson <dave@humbug.demon.co.uk>
 *
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * You can redistribute this file and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software Foundation;
 * either version 2 of the License, or (at your discretion) any later version.
 * See the accompanying file "copying-gpl.txt" for more details.
 *
 * As a special exception to the GPL, permission is granted for additional
 * uses of the text contained in this file.  See the accompanying file
 * "copying-liquorice.txt" for details.
 */

#include <compiler.h>
#include <sys/types.h>
#include <cfg/memory.h>

#include <stdint.h>

#define DEADBEEF    0xDEADBEEF


typedef struct _NUTTHREADINFO NUTTHREADINFO;

struct _NUTTHREADINFO {
    NUTTHREADINFO *td_next;     
    NUTTHREADINFO *td_qnxt;     
    volatile unsigned int td_qpec;     
    char td_name[9];            
    uint8_t td_state;            
    uintptr_t td_sp;               
    uint8_t td_priority;         
    uint8_t *td_memory;          
    HANDLE td_timer;            
    volatile HANDLE td_queue;   
#ifdef __NUT_EMULATION__
    pthread_t td_pthread;       
    void (*td_fn) (void *);     
    void *td_arg;               
    pthread_cond_t td_cv;       
    uint16_t td_cs_level;        
#endif
};

#define TDS_TERM        0       
#define TDS_RUNNING     1       
#define TDS_READY       2       
#define TDS_SLEEP       3       

#define SLEEP_MODE_NONE 0xff

#ifndef NUT_THREAD_STACK_MULT
#define NUT_THREAD_STACK_MULT   1
#endif

#ifndef NUT_THREAD_STACK_ADD
#define NUT_THREAD_STACK_ADD    0
#endif

extern NUTTHREADINFO *runningThread;

extern NUTTHREADINFO *nutThreadList;

extern NUTTHREADINFO *runQueue;

#ifndef __NUT_EMULATION__

extern void NutThreadInit(void);
#endif

#if defined(__GNUC__) && defined (__AVR_ENHANCED__)
extern uint8_t NutThreadSetSleepMode(uint8_t mode);
#endif


extern HANDLE NutThreadCreate(char *name, void (*fn) (void *), void *arg, size_t stackSize);

extern uint8_t NutThreadSetPriority(uint8_t level);

extern void NutThreadKill(void);

extern void NutThreadDestroy(void);

extern void NutThreadExit(void);

extern void NutThreadResume(void);

extern void NutThreadWake(HANDLE timer, HANDLE th);

extern void NutThreadYield(void);

extern void NutThreadAddPriQueue(NUTTHREADINFO * td, NUTTHREADINFO * volatile *tqpp);

extern void NutThreadRemoveQueue(NUTTHREADINFO * td, NUTTHREADINFO * volatile *tqpp);

extern void NutThreadSwitch(void);

extern HANDLE GetThreadByName(char *name);

extern NUTTHREADINFO *NutThreadStackCheck(size_t minsiz);

extern size_t NutThreadStackAvailable(char *name);

#define THREAD(threadfn, arg) \
void threadfn(void *arg) __attribute__ ((noreturn)); \
void threadfn(void *arg)

#endif