xref: /utopia/UTPA2-700.0.x/modules/dmx/hal/M7621/fq/halFQ.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   halFQ.h
79 // @brief  FQ HAL
80 // @author MStar Semiconductor,Inc.
81 ////////////////////////////////////////////////////////////////////////////////////////////////////
82 #ifndef __HAL_FQ_H__
83 #define __HAL_FQ_H__
84 
85 //--------------------------------------------------------------------------------------------------
86 //  Driver Compiler Option
87 //--------------------------------------------------------------------------------------------------
88 
89 //--------------------------------------------------------------------------------------------------
90 //  FQ Hardware Abstraction Layer
91 //--------------------------------------------------------------------------------------------------
92 
93 // FQ define
94 #define FQ_NUM 1UL
95 
96 // HW characteristic
97 #define MIU_FQ(_addr_)                 ((_addr_)>>4UL)
98 
99 //--------------------------------------------------------------------------------------------------
100 //  Macro of bit operations
101 //--------------------------------------------------------------------------------------------------
102 #define _AND_(flag, bit)            ((flag) &   (bit) )
103 #define _SET_(flag, bit)            ((flag) |   (bit) )
104 #define _CLR_(flag, bit)            ((flag) & (~(bit)))
105 
106 //Skip rush path define
107 #define HAL_FQ_SKIP_RUSH_DATA_PATH_NON         0x00000000UL
108 #define HAL_FQ_SKIP_APES_RUSH_DATA             0x00000008UL
109 #define HAL_FQ_SKIP_APES_B_RUSH_DATA           0x00000010UL
110 #define HAL_FQ_SKIP_VPES_RUSH_DATA             0x00000020UL
111 #define HAL_FQ_SKIP_SEC_RUSH_DATA              0x00000040UL
112 #define HAL_FQ_SKIP_ADP_RUSH_DATA              0x00000080UL
113 #define HAL_FQ_SKIP_PCR_RUSH_DATA              0x00000100UL
114 #define HAL_FQ_SKIP_RASP_RUSH_DATA             0x00000200UL
115 #define HAL_FQ_SKIP_PVR1_RUSH_DATA             HAL_FQ_SKIP_RASP_RUSH_DATA
116 #define HAL_FQ_SKIP_PCR1_RUSH_DATA             0x00001000UL
117 #define HAL_FQ_SKIP_PVR3_RUSH_DATA             HAL_FQ_SKIP_PCR1_RUSH_DATA
118 #define HAL_FQ_SKIP_CFG1_MASK                  0x80000000UL
119 #define HAL_FQ_SKIP_APES_C_RUSH_DATA           0x80000008UL
120 #define HAL_FQ_SKIP_APES_D_RUSH_DATA           0x80000010UL
121 #define HAL_FQ_SKIP_V3DPES_RUSH_DATA           0x80000020UL
122 #define HAL_FQ_SKIP_PVR2_RUSH_DATA             0x80000200UL
123 
124 ////////////////////////////////////////////////
125 // HAL API
126 ////////////////////////////////////////////////
127 MS_BOOL HAL_FQ_SetBank(MS_VIRT virtBankAddr);
128 void    HAL_FQ_PVR_SetBuf(MS_U32 u32FQEng, MS_PHY phyStartAddr, MS_U32 u32BufSize);
129 void    HAL_FQ_PVR_SetRushAddr(MS_U32 u32FQEng, MS_PHY phyRushAddr);
130 void    HAL_FQ_PVR_Start(MS_U32 u32FQEng);
131 void    HAL_FQ_PVR_Stop(MS_U32 u32FQEng);
132 void    HAL_FQ_Rush_Enable(MS_U32 u32FQEng);
133 void    HAL_FQ_Bypass(MS_U32 u32FQEng, MS_U8 u8Bypass);
134 void    HAL_FQ_SWReset(MS_U32 u32FQEng, MS_U8 u8Reset);
135 void    HAL_FQ_AddrMode(MS_U32 u32FQEng, MS_U8 u8AddrMode);
136 void    HAL_FQ_SkipRushData(MS_U32 u32FQEng, MS_U32 u32SkipPath);
137 MS_U32  HAL_FQ_GetPVRTimeStamp(MS_U32 u32FQEng);
138 void    HAL_FQ_SetPVRTimeStamp(MS_U32 u32FQEng , MS_U32 u32Stamp);
139 MS_U32  HAL_FQ_GetRead(MS_U32 u32FQEng);
140 MS_U32  HAL_FQ_GetWrite(MS_U32 u32FQEng);
141 
142 #ifdef MSOS_TYPE_LINUX_KERNEL
143 MS_BOOL HAL_FQ_SaveRegs(void);
144 MS_BOOL HAL_FQ_RestoreRegs(void);
145 #endif
146 
147 
148 #endif // #ifndef __HAL_FQ_H__
149