DVBCore  17.9.0
Open Source DVB Engine
 All Data Structures Files Functions Typedefs Macros Pages
stbhwc.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2004 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
24 // pre-processor mechanism so multiple inclusions don't cause compilation error
25 
26 #ifndef _STBHWC_H
27 #define _STBHWC_H
28 
29 #include "techtype.h"
30 
31 //---Constant and macro definitions for public use-----------------------------
32 
33 //---Enumerations for public use-----------------------------------------------
34 
35 typedef enum
36 {
37  HANDSHAKING_NONE,
38  HANDSHAKING_XONXOFF,
39  HANDSHAKING_RTSCTS
40 } E_STB_SP_HANDSHAKING;
41 
42 typedef enum e_hw_status
43 {
44  HW_OK = 0,
45  HW_GEN_ERROR,
46  HW_BAD_PARAM,
47  HW_NO_MEMORY
48 } E_HW_STATUS;
49 
50 //---Global type defs for public use-------------------------------------------
51 
52 //---Global Function prototypes for public use---------------------------------
53 
54 // Serial port functions
55 
56 void STB_SPWrite(U8BIT *data, U32BIT len, U32BIT timeout, U32BIT *written);
57 void STB_SPRead(U8BIT *data, U32BIT len, U32BIT timeout, U32BIT *read);
58 
64 void STB_SPDebugWrite(const char *format, ... );
65 
70 void STB_SPDebugNoCnWrite(const char *format, ... );
71 
78 void STB_SPDebugAssertFail(const char *file, int line, const char *eval_str);
79 
84 U8BIT STB_HWGetTunerPaths(void);
85 
90 U8BIT STB_HWGetNumRecorders(void);
91 
96 U8BIT STB_HWGetAudioDecodePaths(void);
97 
102 U8BIT STB_HWGetVideoDecodePaths(void);
103 
108 U8BIT STB_HWGetDemuxPaths(void);
109 
114 U8BIT STB_HWGetNumCISlots(void);
115 
120 U8BIT STB_HWGetNumSCSlots(void);
121 
126 U8BIT* STB_HWGetOUI(void);
127 
132 U16BIT STB_HWGetHwId(void);
133 
138 U16BIT STB_HWGetCustomerId(void);
139 
144 U32BIT STB_HWGetBoxSerialNumber(void);
145 
152 BOOLEAN STB_GetSqlFileName(U8BIT *pathname, U16BIT max_pathname_len);
153 
154 // VBI interface
155 void STB_HWInitialiseVBI(void);
156 void STB_HWVBIInsert(U8BIT *pes_data_field, U32BIT num_bytes);
157 
158 #endif // _STBHWC_H
159 
160 
U8BIT * STB_HWGetOUI(void)
Returns the number of smart card slots on the platorm.
U8BIT STB_HWGetTunerPaths(void)
Returns the number of front end (Tuner) paths on the platform.
void STB_SPDebugAssertFail(const char *file, int line, const char *eval_str)
Report Assertion failure.
U16BIT STB_HWGetCustomerId(void)
Returns the platform customer identifier code.
BOOLEAN STB_GetSqlFileName(U8BIT *pathname, U16BIT max_pathname_len)
Gives the name (optionally including path) of the SQL database file.
U16BIT STB_HWGetHwId(void)
Returns the platform hardware identifier code.
U32BIT STB_HWGetBoxSerialNumber(void)
Returns the serial number of the Set Top Box.
U8BIT STB_HWGetVideoDecodePaths(void)
Returns the number of video decoding paths on the platform.
void STB_SPDebugWrite(const char *format,...)
Write debug string to serial/debug port. <CR><LF> characters will be automatically added to the end o...
U8BIT STB_HWGetNumSCSlots(void)
Returns the number of CI slots on the platorm.
U8BIT STB_HWGetAudioDecodePaths(void)
Returns the number of audio decoding paths on the platform.
System Wide Global Technical Data Type Definitions.
U8BIT STB_HWGetNumCISlots(void)
Returns the serial number of the Set Top Box.
void STB_SPDebugNoCnWrite(const char *format,...)
Writes debug string to the serial port without <CR><LF>
U8BIT STB_HWGetNumRecorders(void)
Returns the number of recordings that can take place at the same time.
U8BIT STB_HWGetDemuxPaths(void)
Queries the number of demux paths available.