xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/drvFQ.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 ////////////////////////////////////////////////////////////////////////////////////////////////////
78 /// file   drvFQ.h
79 /// @brief  FQ Driver Interface
80 /// @author MStar Semiconductor,Inc.
81 /// @attention
82 ////////////////////////////////////////////////////////////////////////////////////////////////////
83 #ifndef _DRVFQ_H_
84 #define _DRVFQ_H_
85 
86 #ifdef __cplusplus
87 extern "C"
88 {
89 #endif
90 
91 //--------------------------------------------------------------------------------------------------
92 //  Define
93 //--------------------------------------------------------------------------------------------------                                               // Transport stream null PID
94 //--------------------------------------------------------------------------------------------------
95 //  Driver Capability
96 //--------------------------------------------------------------------------------------------------
97 //--------------------------------------------------------------------------------------------------
98 //  Type and Structure
99 //--------------------------------------------------------------------------------------------------
100 
101 /// FQ DDI return value
102 /// @name TSP_Result
103 /// @ref TSP_Result
104 /// return value
105 /// @{
106 typedef enum
107 {
108     DRVFQ_FAIL                   = 0,
109     DRVFQ_OK,
110     DRVFQ_INVALID_PARAM,
111     DRVFQ_FUNC_ERROR,
112 } FQ_Result;
113 
114 //--------------------------------------------------------------------------------------------------
115 //  Function Prototype
116 //--------------------------------------------------------------------------------------------------
117 
118 // Initialization API
119 FQ_Result MDrv_FQ_Init(MS_U32 u32FQEng, MS_U8 u8AddrMode);
120 FQ_Result MDrv_FQ_Exit(MS_U32 u32FQEng);
121 
122 // FQ API
123 FQ_Result MDrv_FQ_IsInit(MS_U32 u32FQEng, MS_BOOL* pbIsInit);
124 FQ_Result MDrv_FQ_SetBuffer(MS_U32 u32FQEng, MS_PHYADDR u32BufStart, MS_U32 u32BufSize);
125 FQ_Result MDrv_FQ_Start(MS_U32 u32FQEng, MS_BOOL bStart);
126 FQ_Result MDrv_FQ_PVR_SetRushAddr(MS_U32 u32FQEng, MS_PHYADDR u32RushAddr);
127 FQ_Result MDrv_FQ_SkipRushData(MS_U32 u32FQEng, MS_U16 u16SkipPath);
128 FQ_Result MDrv_FQ_RushEnable(MS_U32 u32FQEng);
129 FQ_Result MDrv_FQ_TimeStampSetRecordStamp(MS_U32 u32FQEng, MS_U32 u32Stamp);
130 FQ_Result MDrv_FQ_TimeStampGetRecordStamp(MS_U32 u32FQEng, MS_U32* u32Stamp);
131 
132 #ifdef __cplusplus
133 } // closing brace for extern "C"
134 #endif
135 #endif // _DRVFQ_H_
136