platform/inc/stbhwfp.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 _STBHWFP_H
#define _STBHWFP_H

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

//---Enumerations for public use-----------------------------------------------
typedef enum
{
   WAKEUP_UNKNOWN = 0,
   WAKEUP_TIMER,
   WAKEUP_USER
} E_FRONTPANEL_WAKEUP_TYPE;

typedef enum
{
   LED_OFF = 0,
   LED_ON,
   LED_BLINKING
} E_LED_STATE;

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

//---Global Function prototypes for public use---------------------------------
void STB_FPInitialise(void);

void STB_FPKeyEnable(BOOLEAN enable);

void STB_FPRemoteEnable(BOOLEAN enable);

void STB_FPSetHandsetCode(U16BIT hset_code);

void STB_FPDisplayString(U32BIT str_addr, U8BIT scrollstep, U16BIT scrollrate);

void STB_FPSetClock(U16BIT mjd, U16BIT year, U8BIT month, U8BIT day, U8BIT hours, U8BIT minutes, U8BIT seconds);

void STB_FPShowClock(BOOLEAN show);

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

void STB_FPSetStandby(BOOLEAN standby);

E_FRONTPANEL_WAKEUP_TYPE STB_FPGetWakeUpType(void);

void STB_FPSetLedState(U8BIT led_id, E_LED_STATE led_state, U16BIT period, U8BIT duty_cycle);

void STB_FPWaitForUserInput(void);
U8BIT STB_FPGetDisplaySize(void);
void STB_FPAnimation(U8BIT anim_type, U8BIT frame_rate);
void STB_FPRefreshWatchdog(void);
void STB_FPSetWdogPeriod(U16BIT watchdog_period);
void STB_FPSetAutoStandby(BOOLEAN auto_standby);
void STB_FPSetAutoStandbyTime(U8BIT minute);

#endif //  _STBHWFP_H