hbbtv_sif_os.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2014 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
 *******************************************************************************/
/* pre-processor mechanism so multiple inclusions don't cause compilation error*/

#ifndef _HBBTV_SIF_OS_H

#define _HBBTV_SIF_OS_H

#include "techtype.h"

/*---Constant and macro definitions for public use-----------------------------*/
#define HBBTV_OS_TIMEOUT_NOW 0
#define HBBTV_OS_TIMEOUT_NEVER 0xffff

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

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

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

void* HBBTV_OSAlloc(U32BIT size);

void HBBTV_OSFree(void *ptr);

void* HBBTV_OSCreateMutex(void);

void HBBTV_OSDeleteMutex(void *mutex);

void HBBTV_OSMutexLock(void *mutex);

void HBBTV_OSMutexUnlock(void *mutex);

void* HBBTV_OSCreateCountSemaphore(U32BIT value);

void HBBTV_OSDeleteSemaphore(void *semaphore);

void HBBTV_OSSemaphoreWait(void *semaphore);

BOOLEAN HBBTV_OSSemaphoreWaitTimeout(void *semaphore, U16BIT timeout);

void HBBTV_OSSemaphoreSignal(void *semaphore);

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

void HBBTV_OSDestroyTask(void *task_id);

void HBBTV_OSTaskDelay(U16BIT time);

U32BIT HBBTV_OSGetClockMilliseconds(void);

U32BIT HBBTV_OSGetTimeNow(void);

void* HBBTV_OSCreateQueue(U16BIT msg_size, U16BIT msg_max);

void HBBTV_OSDeleteQueue(void *queue);

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

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

#endif /* _HBBTV_SIF_OS_H */