include/stb_os.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _STB_OS_H
#define _STB_OS_H

#include "techtype.h"

/*---Constant and macro definitions for public use-----------------------------*/

// timeouts for queues, semaphores etc
#define TIMEOUT_NOW     0
#define TIMEOUT_NEVER   0xffff

/*---Enumerations for public use-----------------------------------------------*/

/*---Global type defs for public use-------------------------------------------*/

/*---Global Function prototypes for public use---------------------------------*/

U32BIT STB_OSGetClockMilliseconds(void);

void* STB_OSCreateTask(void (*function)(void *), void *param, U32BIT stack, U8BIT priority, U8BIT *name);

void STB_OSTaskDelay(U16BIT timeout);

void STB_OSDestroyTask(void *task);

void* STB_OSCreateQueue(U16BIT msg_size, U16BIT msg_max);

BOOLEAN STB_OSReadQueue(void *queue, void *msg, U16BIT msg_size, U16BIT timeout);

BOOLEAN STB_OSWriteQueue(void *queue, void *msg, U16BIT msg_size, U16BIT timeout);

BOOLEAN STB_OSDestroyQueue(void *queue);

void* STB_OSCreateSemaphore(void);

void* STB_OSCreateCountSemaphore(U32BIT value);

void STB_OSSemaphoreWait(void *semaphore);

void STB_OSSemaphoreSignal(void *semaphore);

BOOLEAN STB_OSSemaphoreWaitTimeout(void *semaphore, U16BIT timeout);

void STB_OSDeleteSemaphore(void *semaphore);

void* STB_OSCreateMutex(void);

void STB_OSMutexLock(void *mutex);

void STB_OSMutexUnlock(void *mutex);

void STB_OSDeleteMutex(void *mutex);

#endif //  _STB_OS_H