stbhwini.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 _STBHWINI_H

#define _STBHWINI_H

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


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

typedef enum e_hw_subt_control
{
   HW_SUBT_NONE = 0,    // no effects of subtitle selection on hardware layer
   HW_SUBT_EBU  = 1,    // enables teletext subtitles facilities
   HW_SUBT_DVB  = 2     // enables DVB subtitle facilities
} E_HW_SUBT_CONTROL_MASK;

typedef enum
{
   HW_STANDBY_ON,          /* System is fully on */
   HW_STANDBY_ACTIVE,      /* System is in standby but only the outputs are turned off */
   HW_STANDBY_PASSIVE,     /* Low power standby state with DVBCore still active but not doing anything */
   HW_STANDBY_LOWPOWER     /* Lowest power standby state; DVBCore does not expect to be active */
} E_HW_STANDBY_STATE;

typedef enum
{
   HW_WAKEUP_UNKNOWN = 0,  /* Cause of the system waking up isn't known, so could be power cycle */
   HW_WAKEUP_TIMER,        /* The system was woken up by the wake up timer */
   HW_WAKEUP_USER          /* The system was woken up by user interaction (e.g. front panel or RCU) */
} E_HW_WAKEUP_TYPE;

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

//---Global Function prototypes for public use---------------------------------
void STB_HWInitialise(E_HW_SUBT_CONTROL_MASK hw_subt);

BOOLEAN STB_HWSetStandbyState(E_HW_STANDBY_STATE state);

E_HW_STANDBY_STATE STB_HWGetStandbyState(void);

void STB_HWSetWakeUpTime(U16BIT mjd, U16BIT year, U8BIT month, U8BIT day, U8BIT hours,
   U8BIT minutes, U32BIT time_in_mins);

E_HW_WAKEUP_TYPE STB_HWGetWakeUpType(void);

void STB_HWEnterStandby(void);

void STB_HWLeaveStandby(void);

#endif //  _STBHWINI_H