platform/inc/stbhwos.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
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error
#ifndef _STBHWOS_H

#define _STBHWOS_H

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

// hardware event class and types
#define HW_EV_CLASS_HANDSET             0
#define HW_EV_CLASS_KEYPAD              1
#define HW_EV_CLASS_LNB                 2
#define HW_EV_CLASS_TUNER               3
#define HW_EV_CLASS_DECODE              4
#define HW_EV_CLASS_SCART               5
#define HW_EV_CLASS_DISK                6
#define HW_EV_CLASS_DVD                 7
#define HW_EV_CLASS_PVR                 8
#define HW_EV_CLASS_USB                 9
#define HW_EV_CLASS_HDMI               10
#define HW_EV_CLASS_CEC                11
#define HW_EV_CLASS_PRIVATE           255    /* Class to allow events to be created that are unique to a platform */

#define HW_EV_TYPE_FALSE                  0
#define HW_EV_TYPE_TRUE                   1
#define HW_EV_TYPE_LOCKED                 2
#define HW_EV_TYPE_NOTLOCKED              3

#define HW_EV_TYPE_AUDIO_STARTED          4
#define HW_EV_TYPE_VIDEO_STARTED          5
#define HW_EV_TYPE_AUDIO_STOPPED          6
#define HW_EV_TYPE_VIDEO_STOPPED          7

#define HW_EV_TYPE_4_3                    8
#define HW_EV_TYPE_16_9                   9

#define HW_EV_TYPE_SIGNAL_DATA_BAD        10
#define HW_EV_TYPE_SIGNAL_DATA_OK         11

#define HW_EV_TYPE_FORMAT_COMPLETE        12
#define HW_EV_TYPE_FORMAT_FAILED          13

#define HW_EV_TYPE_REPAIR_COMPLETE        14
#define HW_EV_TYPE_REPAIR_FAILED          15

#define HW_EV_TYPE_DVD_DISK_INSERTED      16
#define HW_EV_TYPE_DVD_DISK_REMOVED       17

#define HW_EV_TYPE_PVR_REC_START          18
#define HW_EV_TYPE_PVR_REC_STOP           19
#define HW_EV_TYPE_PVR_PLAY_START         20
#define HW_EV_TYPE_PVR_PLAY_STOP          21
#define HW_EV_TYPE_PVR_PLAY_BOF           22    /* Playback has reached the beginning of the file */
#define HW_EV_TYPE_PVR_PLAY_EOF           23    /* Playback has reached the end of the file */
#define HW_EV_TYPE_PVR_PLAY_NOTIFY_TIME   24    /* Playback has reached the end of the file */

#define HW_EV_TYPE_SAMPLE_STOPPED         25

#define HW_EV_TYPE_DISK_CONNECTED         26
#define HW_EV_TYPE_DISK_REMOVED           27
#define HW_EV_TYPE_DISK_FULL              28

#define HW_EV_TYPE_HDMI_CONNECT           29
#define HW_EV_TYPE_HDMI_DISCONNECT        30

#define HW_EV_TYPE_CEC_PLAY               31
#define HW_EV_TYPE_CEC_STANDBY            32

#define HW_EV_TYPE_AD_STARTED             34
#define HW_EV_TYPE_AD_STOPPED             35

#define HW_EV_TYPE_VIDEO_UNDERFLOW        36
#define HW_EV_TYPE_AUDIO_UNDERFLOW        37

// 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---------------------------------

void STB_OSInitialise(void);

void STB_OSRegisterCallback(void (*func)(BOOLEAN, U16BIT, U16BIT, void *, U32BIT));

void STB_OSSendEvent(BOOLEAN repeat, U16BIT event_class, U16BIT event_type, void *data, U32BIT data_size);

void STB_OSSetClockRTC(U32BIT num_seconds);

U32BIT STB_OSGetClockRTC(void);

void STB_OSSetClockGMT(U32BIT num_seconds);

U32BIT STB_OSGetClockGMT(void);

U32BIT STB_OSGetClockMilliseconds(void);

U32BIT STB_OSGetClockDiff(U32BIT timestamp);

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

void STB_OSTaskSuspend(void);

void STB_OSTaskDelay(U16BIT timeout);

void STB_OSTaskSleep(void);

void STB_OSDestroyTask(void *task);

U8BIT STB_OSTaskPriority(void *task, U8BIT priority);

void STB_OSTaskLock(void);

void STB_OSTaskUnlock(void);

void* STB_OSGetCurrentTask(void);

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_OSInitCountSemaphore(void *semaphore, U32BIT value);

void STB_OSDeleteSemaphore(void *semaphore);

void STB_OSSemaphoreWait(void *semaphore);

void STB_OSSemaphoreSignal(void *semaphore);

BOOLEAN STB_OSSemaphoreWaitTimeout(void *semaphore, U16BIT timeout);

void* STB_OSCreateMutex(void);

void STB_OSMutexLock(void *mutex);

void STB_OSMutexUnlock(void *mutex);

void STB_OSDeleteMutex(void *mutex);

void STB_OSResetCPU(void);

#endif //  _STBHWOS_H

//*****************************************************************************
// End of file
//*****************************************************************************