xref: /utopia/UTPA2-700.0.x/modules/xc/drv/xc/include/mdrv_ldalgo.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 //<MStar Software>
78 ////////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2008-2010 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // ("MStar Confidential Information") by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 //
93 ////////////////////////////////////////////////////////////////////////////////
94 
95 ///////////////////////////////////////////////////////////////////////////////////////////////////
96 /// file    Mdrv_ldalgo.h
97 /// @brief  local dimming algorithm
98 /// @author MStar Semiconductor Inc.
99 ///////////////////////////////////////////////////////////////////////////////////////////////////
100 
101 #ifndef _MDRV_LDALGO_H_
102 #define _MDRV_LDALGO_H_
103 
104 #include "MsCommon.h"
105 //#include "mhal_xc_chip_config.h"
106 
107 #ifdef _MDRV_LDALGO_C_
108     #define INTERFACE
109 #else
110     #define INTERFACE extern
111 #endif
112 
113 typedef enum
114 {
115     E_LD_DUMP_NONE                    = 0x00, // none dummp
116     E_LD_DUMP_PWM_Block               = 0x01, // dummp pwm block
117     E_LD_DUMP_Gamma_Block             = 0x02, // dummp gamma block
118     E_LD_DUMP_VDown_Block             = 0x03, // dummp vdown block
119 } EnuLDDumpStage;
120 
121 typedef struct __attribute__((packed)) _TYPE_LD_PANEL_TYPE_t
122 {
123     MS_U8 u8PWMHigh;
124     MS_U8 u8PWMWidth;
125     MS_U8 u8LDWidth;
126     MS_U8 u8LDHeight;
127     MS_U16 u16PWMSize;
128     MS_U16 u16BLSize;
129     MS_U8 u8LD_Mode2D3D;
130     MS_U8 u8LD_Mode2D3D_tmax;
131 }ST_TYPE_LD_PANEL_TYPE;
132 
133 #define REG_DEBUG_LD_DUMP_SEL        SC_R2BYTEMSK(psXCInstPri->u32DeviceID, REG_SC_BK2E_7A_L,0xF000) >>12
134 
135 #if  (LD_ENABLE==1)
136 //-------------------------------------------------------------------------------------------------
137 /// set LD enable flags
138 /// @param u8LDEnable            \b IN: 0 off ; 1 on
139 /// @return  void                \b IN: none
140 //-------------------------------------------------------------------------------------------------
141 INTERFACE void MDrv_LD_EnableLD(void *pInstance, MS_BOOL bLDEnable);
142 //-------------------------------------------------------------------------------------------------
143 /// set LD gamma control
144 /// @param  u8GammaControl        \b IN: gamma control index
145 /// @return  void                \b IN: none
146 //-------------------------------------------------------------------------------------------------
147 INTERFACE void MDrv_LD_SetGammaControl(void *pInstance, MS_U8 u8GammaControl);
148 //-------------------------------------------------------------------------------------------------
149 /// set LD ISR
150 /// @param  void                \b IN: none
151 /// @return  void                \b IN: none
152 //-------------------------------------------------------------------------------------------------
153 void MDrv_XC_LD_ISR(void* pInstance);
154 
155 //-------------------------------------------------------------------------------------------------
156 /// Get LD value
157 /// @param pu8LDValue    @ref MS_U8      \b OUT: get the LD back light value (The amount is u8WSize x u8HSize)
158 /// @param u8WSize       @ref MS_U8      \b IN: set the LD back light width
159 /// @param u8HSize       @ref MS_U8      \b IN: set the LD back light height
160 /// @Return TRUE: Successful FALSE: Fail
161 //-------------------------------------------------------------------------------------------------
162 MS_BOOL  MDrv_LD_Get_Value(void *pInstance, MS_U8 *pu8LDValue, MS_U8 u8WSize, MS_U8 u8HSize );
163 
164 #endif
165 
166 #undef INTERFACE
167 
168 
169 #endif
170 
171