platform/inc/stbhwtun.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 _STBHWTUN_H

#define _STBHWTUN_H

//---#includes for this file---------------------------------------------------
#include "stbhwc.h"

//---Constant and macro definitions for public use-----------------------------
#define SYMBOL_RATE_AUTO         0

//---Enumerations for public use-----------------------------------------------
typedef enum e_stb_tune_system_type
{
   TUNE_SYSTEM_TYPE_UNKNOWN = 0,
   TUNE_SYSTEM_TYPE_DVBT = 1,
   TUNE_SYSTEM_TYPE_DVBT2 = 2,
   TUNE_SYSTEM_TYPE_DVBS = 3,
   TUNE_SYSTEM_TYPE_DVBS2 = 4,
   TUNE_SYSTEM_TYPE_DVBC = 5
} E_STB_TUNE_SYSTEM_TYPE;


typedef enum e_stb_tune_signal_type
{
   TUNE_SIGNAL_NONE = 0,
   TUNE_SIGNAL_QPSK = 1,
   TUNE_SIGNAL_COFDM = 2,
   TUNE_SIGNAL_QAM = 3,
   TUNE_SIGNAL_ANALOG = 4
} E_STB_TUNE_SIGNAL_TYPE;

/* Terrestrial */
typedef enum e_stb_tune_tmode
{
   TUNE_MODE_COFDM_1K = 0,
   TUNE_MODE_COFDM_2K = 1,
   TUNE_MODE_COFDM_4K = 2,
   TUNE_MODE_COFDM_8K = 3,
   TUNE_MODE_COFDM_16K = 4,
   TUNE_MODE_COFDM_32K = 5,
   TUNE_MODE_COFDM_UNDEFINED = 255
} E_STB_TUNE_TMODE;

typedef enum e_stb_tune_tbwidth
{
   TUNE_TBWIDTH_8MHZ = 0,
   TUNE_TBWIDTH_7MHZ = 1,
   TUNE_TBWIDTH_6MHZ = 2,
   TUNE_TBWIDTH_5MHZ = 3
} E_STB_TUNE_TBWIDTH;

typedef enum e_stb_tune_tconst
{
   TUNE_TCONST_QPSK = 0,
   TUNE_TCONST_QAM16 = 1,
   TUNE_TCONST_QAM64 = 2,
   TUNE_TCONST_QAM128 = 3,
   TUNE_TCONST_QAM256 = 4,
   TUNE_TCONST_UNDEFINED = 255
} E_STB_TUNE_TCONST;

typedef enum E_STB_TUNE_THIERARCHY
{
   TUNE_THIERARCHY_NONE = 0,
   TUNE_THIERARCHY_1 = 1,
   TUNE_THIERARCHY_2 = 2,
   TUNE_THIERARCHY_4 = 4,
   TUNE_THIERARCHY_8 = 8,
   TUNE_THIERARCHY_16 = 16,
   TUNE_THIERARCHY_32 = 32,
   TUNE_THIERARCHY_64 = 64,
   TUNE_THIERARCHY_128 = 128,
   TUNE_THIERARCHY_UNDEFINED = 255
} E_STB_TUNE_THIERARCHY;

typedef enum e_stb_tune_tcoderate
{
   TUNE_TCODERATE_1_2 = 0,
   TUNE_TCODERATE_2_3 = 1,
   TUNE_TCODERATE_3_4 = 2,
   TUNE_TCODERATE_5_6 = 3,
   TUNE_TCODERATE_7_8 = 4,
   TUNE_TCODERATE_UNDEFINED = 255
} E_STB_TUNE_TCODERATE;

typedef enum e_stb_tune_tguardint
{
   TUNE_TGUARDINT_1_32 = 0,
   TUNE_TGUARDINT_1_16 = 1,
   TUNE_TGUARDINT_1_8 = 2,
   TUNE_TGUARDINT_1_4 = 3,
   TUNE_TGUARDINT_1_128 = 4,
   TUNE_TGUARDINT_19_128 = 5,
   TUNE_TGUARDINT_19_256 = 6,
   TUNE_TGUARDINT_UNDEFINED = 255
} E_STB_TUNE_TGUARDINT;

/* Cable */
typedef enum  e_stb_tune_cmode
{
   TUNE_MODE_QAM_4 = 0,
   TUNE_MODE_QAM_8 = 1,
   TUNE_MODE_QAM_16 = 2,
   TUNE_MODE_QAM_32 = 3,
   TUNE_MODE_QAM_64 = 4,
   TUNE_MODE_QAM_128 = 5,
   TUNE_MODE_QAM_256 = 6,
   TUNE_MODE_QAM_UNDEFINED = 255
} E_STB_TUNE_CMODE;


/* Satellite */
typedef enum
{
   TUNE_MOD_AUTO,
   TUNE_MOD_QPSK,   /* quartenary phase shift key */
   TUNE_MOD_8PSK,   /* octenary phase shift key */
   TUNE_MOD_16QAM   /* Not valid for DVB-S2 */
} E_STB_TUNE_MODULATION;

typedef enum e_stb_tune_lnb_voltage
{
   LNB_VOLTAGE_OFF = 0,
   LNB_VOLTAGE_14V = 1,
   LNB_VOLTAGE_18V = 2
} E_STB_TUNE_LNB_VOLTAGE;

typedef enum e_stb_tune_fec
{
   TUNE_FEC_AUTOMATIC = 0,
   TUNE_FEC_1_2 = 1,
   TUNE_FEC_2_3 = 2,
   TUNE_FEC_3_4 = 3,
   TUNE_FEC_5_6 = 4,
   TUNE_FEC_7_8 = 5,
   TUNE_FEC_1_4 = 6,
   TUNE_FEC_1_3 = 7,
   TUNE_FEC_2_5 = 8,
   TUNE_FEC_8_9 = 9,
   TUNE_FEC_9_10 = 10
} E_STB_TUNE_FEC;


/* Analog */
typedef enum e_stb_tune_analog_video_type
{
   TUNE_ANLG_VIDEO_PAL_I = 0,
   TUNE_ANLG_VIDEO_PAL_B = 1,
   TUNE_ANLG_VIDEO_PAL_G = 2,
   TUNE_ANLG_VIDEO_PAL_D = 3,
   TUNE_ANLG_VIDEO_PAL_K = 4,
   TUNE_ANLG_VIDEO_PAL_L = 5,
   TUNE_ANLG_VIDEO_PAL_LDASH = 6
} E_STB_TUNE_ANALOG_VIDEO_TYPE;


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

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

void STB_TuneInitialise(U8BIT paths);

void STB_TuneSetSystemType(U8BIT path, E_STB_TUNE_SYSTEM_TYPE type);

E_STB_TUNE_SYSTEM_TYPE STB_TuneGetSystemType(U8BIT path);

void STB_TuneAutoRelock(U8BIT path, BOOLEAN state);

E_STB_TUNE_SIGNAL_TYPE STB_TuneGetSignalType(U8BIT path);

U32BIT STB_TuneGetMinTunerFreqKHz(U8BIT path);

U32BIT STB_TuneGetMaxTunerFreqKHz(U8BIT path);

void STB_TuneStartTuner(U8BIT path, U32BIT freq, U32BIT srate, E_STB_TUNE_FEC fec,
   S8BIT freq_off, E_STB_TUNE_TMODE tmode, E_STB_TUNE_TBWIDTH tbwidth,
   E_STB_TUNE_CMODE cmode, E_STB_TUNE_ANALOG_VIDEO_TYPE anlg_vtype);

void STB_TuneRestartTuner(U8BIT path);

void STB_TuneStopTuner(U8BIT path);

U8BIT STB_TuneGetSignalStrength(U8BIT path);

U8BIT STB_TuneGetDataIntegrity(U8BIT path);

U32BIT STB_TuneGetActualTerrFrequency(U8BIT path);

S8BIT STB_TuneGetActualTerrFreqOffset(U8BIT path);

E_STB_TUNE_TMODE STB_TuneGetActualTerrMode(U8BIT path);

E_STB_TUNE_TBWIDTH STB_TuneGetActualTerrBwidth(U8BIT path);

E_STB_TUNE_TCONST STB_TuneGetActualTerrConstellation(U8BIT path);

E_STB_TUNE_THIERARCHY STB_TuneGetActualTerrHierarchy(U8BIT path);

E_STB_TUNE_TCODERATE STB_TuneGetActualTerrLpCodeRate(U8BIT path);

E_STB_TUNE_TCODERATE STB_TuneGetActualTerrHpCodeRate(U8BIT path);

E_STB_TUNE_TGUARDINT STB_TuneGetActualTerrGuardInt(U8BIT path);

U16BIT STB_TuneGetActualTerrCellId(U8BIT path);

void STB_TuneSetPLP(U8BIT path, U8BIT plp);

U8BIT STB_TuneGetPLP(U8BIT path);

void STB_TuneActiveAerialPower(U8BIT path, BOOLEAN enabled);

void STB_TuneSetLNBfrequencies(U8BIT path, U16BIT low_freq_mhz, U16BIT high_freq_mhz);

void STB_TuneSetModulation(U8BIT path, E_STB_TUNE_MODULATION modulation);

void STB_TuneSetLNBVoltage(U8BIT path, E_STB_TUNE_LNB_VOLTAGE voltage);

void STB_TuneSet22kState(U8BIT path, BOOLEAN state);

void STB_TuneSet12VSwitch(U8BIT path, BOOLEAN state);

U8BIT STB_TuneGetDISEQCReply(U8BIT path, U8BIT *data, U32BIT timeout);

void STB_TuneSendDISEQCMessage(U8BIT path, U8BIT *data, U8BIT size);

void STB_TuneSetPulseLimitEast(U8BIT path, U16BIT count);

void STB_TuneSetPulseLimitWest(U8BIT path, U16BIT count);

void STB_TuneChangePulsePosition(U8BIT path, U16BIT count);

U16BIT STB_TuneGetPulsePosition(U8BIT path);

void STB_TuneAtPulsePosition(U8BIT path, U16BIT position);

void STB_TuneChangeSkewPosition(U8BIT path, U16BIT count);

U8BIT STB_TuneSatGetCarrierStrength(U8BIT path, U32BIT freq);

U32BIT STB_TuneGetActualSymbolRate(U8BIT path);

E_STB_TUNE_CMODE STB_TuneGetActualCableMode(U8BIT path);

E_STB_TUNE_SYSTEM_TYPE STB_TuneGetSupportedSystemType(U8BIT path);

#endif //  _STBHWTUN_H