platform/inc/stbhwc.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 _STBHWC_H
#define _STBHWC_H

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

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

typedef enum
{
   HANDSHAKING_NONE,
   HANDSHAKING_XONXOFF,
   HANDSHAKING_RTSCTS
} E_STB_SP_HANDSHAKING;

typedef enum e_hw_status
{
   HW_OK = 0,
   HW_GEN_ERROR,
   HW_BAD_PARAM,
   HW_NO_MEMORY
} E_HW_STATUS;

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

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

// Serial port functions

void STB_SPWrite(U8BIT *data, U32BIT len, U32BIT timeout, U32BIT *written);
void STB_SPRead(U8BIT *data, U32BIT len, U32BIT timeout, U32BIT *read);

void STB_SPDebugWrite(const char *format, ... );

void STB_SPDebugNoCnWrite(const char *format, ... );

void STB_SPDebugAssertFail(const char *file, int line, const char *eval_str);

U8BIT STB_HWGetTunerPaths(void);

U8BIT STB_HWGetNumRecorders(void);

U8BIT STB_HWGetAudioDecodePaths(void);

U8BIT STB_HWGetVideoDecodePaths(void);

U8BIT STB_HWGetDemuxPaths(void);

U8BIT STB_HWGetNumCISlots(void);

U8BIT STB_HWGetNumSCSlots(void);

U8BIT* STB_HWGetOUI(void);

U16BIT STB_HWGetHwId(void);

U16BIT STB_HWGetCustomerId(void);

U32BIT STB_HWGetBoxSerialNumber(void);

BOOLEAN STB_GetSqlFileName(U8BIT *pathname, U16BIT max_pathname_len);

// VBI interface
void STB_HWInitialiseVBI(void);
void STB_HWVBIInsert(U8BIT *pes_data_field, U32BIT num_bytes);

#endif //  _STBHWC_H