xref: /utopia/UTPA2-700.0.x/modules/njpd/drv/njpd_ex/njpeg_def.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-2009 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 ///
97 /// file    njpeg_def.h
98 /// @brief  NJPEG internal definition
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _NJPEG_DEF_H_
103 #define _NJPEG_DEF_H_
104 
105 //-------------------------------------------------------------------------------------------------
106 //  Local Compiler Options
107 //-------------------------------------------------------------------------------------------------
108 #define JPEG_STATIC     static
109 
110 #define MSOS_GET_SYSTEM_TIME    1
111 
112 
113 #if defined(CHIP_EDISON)   // need to modify njpeg_def.h and jpeg_def.h simontaneously
114 #define SUPPORT_OJPD                    TRUE
115 #else
116 #define SUPPORT_OJPD                    FALSE
117 #endif
118 
119 
120 #define ENABLE_NJPD_DEBUG_MSG           FALSE
121 
122 
123 
124 #define SUPPORT_HIGH_LOW_REVERSE        FALSE // NJPD not support high-low reverse, just reserved the code in api layer
125 
126 //NJPD IP supporting feature
127 
128 #define ENABLE_TEST_09_NJPEGWriteProtectTest                    FALSE
129 #define ENABLE_TEST_11_NJPEGScaleDownFunctionTest_2             FALSE
130 #define ENABLE_TEST_11_NJPEGScaleDownFunctionTest_4             FALSE
131 #define ENABLE_TEST_11_NJPEGScaleDownFunctionTest_8             FALSE
132 #define ENABLE_TEST_16_NJPEGEnablePsaveModeTest                 FALSE
133 #define ENABLE_TEST_18_miu_sel_128M                             FALSE
134 #define ENABLE_TEST_18_miu_sel_64M                              FALSE
135 #define ENABLE_TEST_18_miu_sel_32M                              FALSE
136 #define ENABLE_TEST_22_AutoProtectFailTest                      FALSE
137 #define ENABLE_TEST_NJPD_01_table_read_write_test               FALSE
138 #define ENABLE_TEST_NJPD_13_ROI_Test                            FALSE
139 #define ENABLE_TEST_NJPD_17_Obuf_Output_Format                  FALSE
140 #define ENABLE_TEST_NJPD_18_Ibuf_Burst_Length_Test              FALSE
141 #define ENABLE_TEST_NJPD_21_No_Reset_Table_Test                 FALSE
142 
143 //-------------------------------------------------------------------------------------------------
144 //  Macro and Define
145 //-------------------------------------------------------------------------------------------------
146 //------------------------------------------------------------------------------
147 #define JPEG_BLOCK_TYPE         MS_S16
148 //------------------------------------------------------------------------------
149 #define JPEG_QUANT_TYPE         MS_S16
150 //------------------------------------------------------------------------------
151 // May need to be adjusted if support for other colorspaces/sampling factors is added
152 #define JPEG_MAXBLOCKSPERMCU    10
153 //------------------------------------------------------------------------------
154 #define JPEG_MAXHUFFTABLES      8
155 //------------------------------------------------------------------------------
156 #define JPEG_MAXQUANTTABLES     4
157 //------------------------------------------------------------------------------
158 #define JPEG_MAXCOMPONENTS      4
159 //------------------------------------------------------------------------------
160 #define JPEG_MAXCOMPSINSCAN     4
161 //------------------------------------------------------------------------------
162 //Increase this if you increase the max width!
163 #define JPEG_MAXBLOCKSPERROW    6144
164 
165 #if 0//(defined (MSOS_TYPE_NOS) || defined(MSOS_TYPE_LINUX) || defined(MSOS_TYPE_ECOS))
166 #define JPEG_memcpy(pDstAddr, pSrcAddr, u32Size)                \
167     do {                                                        \
168         MS_U32 idx = 0;                                         \
169         volatile MS_U8 *Dest = (volatile MS_U8 *)(pDstAddr);    \
170         volatile MS_U8 *Src = (volatile MS_U8 *)(pSrcAddr);     \
171         for (idx = 0; idx < (u32Size); idx++)                   \
172         {                                                       \
173             Dest[idx] = Src[idx];                               \
174         }                                                       \
175     }while(0)
176 
177 #define JPEG_memset(pDstAddr, u8value, u32Size)                 \
178     do {                                                        \
179         MS_U32 idx = 0;                                         \
180         volatile MS_U8 *Dest = (volatile MS_U8 *)(pDstAddr);    \
181         for (idx = 0; idx < (u32Size); idx++)                   \
182         {                                                       \
183             Dest[idx] = (u8value);                              \
184         }                                                       \
185     }while(0)
186 #else
187 #define JPEG_memcpy(pDstAddr, pSrcAddr, u32Size) memcpy((pDstAddr), (pSrcAddr), (u32Size))
188 #define JPEG_memset(pDstAddr, u8value, u32Size)  memset((pDstAddr), (u8value), (u32Size))
189 #endif
190 
191 #define JPEG_AtoU32(pData, u32value) \
192     do { \
193         u32value = 0; \
194         while(('0' <= *pData) && ('9' >= *pData)) \
195         { \
196             u32value = (10 * u32value) + (MS_U32)(*pData - '0'); \
197             pData++; \
198         } \
199     }while(0)
200 
201 #ifndef UNUSED
202 #define UNUSED(x) ((x)=(x))
203 #endif
204 
205 //-------------------------------------------------------------------------------------------------
206 //  Type and Structure
207 //-------------------------------------------------------------------------------------------------
208 typedef enum
209 {
210     E_NJPD00_NONE,
211     E_NJPD01_TABLE_READ_WRITE,
212     E_NJPD13_ROI,
213     E_NJPD17_OBUF_OUTPUT_FORMAT_YC_SWAP,
214     E_NJPD17_OBUF_OUTPUT_FORMAT_UV_SWAP,
215     E_NJPD17_OBUF_OUTPUT_FORMAT_UV_7BIT,
216     E_NJPD17_OBUF_OUTPUT_FORMAT_UV_MSB,
217     E_NJPD18_IBUF_BURST_LENGTH,
218     E_NJPD21_NO_RESET_TABLE,
219     E_NJPD23_WRITE_PROTECT,
220     E_NJPD25_DOWNSCALE_1_2,
221     E_NJPD25_DOWNSCALE_1_4,
222     E_NJPD25_DOWNSCALE_1_8
223 }NJPD_VerificationMode;
224 
225 //-----------------------------------------------------------------------------
226 //Description: JPEG scan type
227 typedef enum
228 {
229     E_JPEG_GRAYSCALE    = 0
230   , E_JPEG_YH1V1        = 1
231   , E_JPEG_YH2V1        = 2
232   , E_JPEG_YH1V2        = 3
233   , E_JPEG_YH2V2        = 4
234   , E_JPEG_YH4V1        = 5
235 //#if SW_JPD_RGB_CMYK
236   , E_JPEG_CMYK         = 6
237   , E_JPEG_RGB          = 7
238 //#endif
239 }JPEG_ScanType;
240 
241 
242 typedef enum
243 {
244     E_NJPD_MIU_LAST_Z_PATCH
245   , E_NJPD_EAGLE_SW_PATCH
246   , E_NJPD_EIFFEL_REDUCE_CLK
247 }NJPD_PATCH_INDEX;
248 
249 //-----------------------------------------------------------------------------
250 /// @brief \b Struct \b Name: JPEG_QuantTbl
251 /// @brief \b Struct \b Description: Structure for JPEG Quantization Table
252 //-----------------------------------------------------------------------------
253 typedef struct //same as JPD_QuanTbl in drvJPD.h
254 {
255     JPEG_QUANT_TYPE s16Value[64];   ///< value of Q table
256     MS_BOOL bValid;                 ///< has Q table or not.
257 } JPEG_QuantTbl;
258 
259 //-----------------------------------------------------------------------------
260 /// @brief \b Struct \b Name: JPEG_HuffInfo
261 /// @brief \b Struct \b Description: Structure for JPEG huffman information
262 //-----------------------------------------------------------------------------
263 typedef struct
264 {
265     MS_U8 u8Huff_num[17];   ///< number of Huffman codes per bit size
266     MS_U8 u8Huff_val[256];  ///< Huffman codes per bit size
267 
268     MS_U8 u8Symbol[17];     ///< u8Huff_num in reverse order
269     MS_U16 u16Code[17];     ///< Minimun code word
270     MS_U8 u8Valid[17];     ///< Valid bit for NJPD
271     MS_U8 u8SymbolCnt;
272     MS_BOOL bValid;         ///< has huffman table or not
273 } JPEG_HuffInfo;
274 //-----------------------------------------------------------------------------
275 /// @brief \b Struct \b Name: JPEG_HuffTbl
276 /// @brief \b Struct \b Description: Structure for JPEG huffman table
277 //-----------------------------------------------------------------------------
278 typedef struct
279 {
280     MS_S16 s16Look_up[256]; ///< the lookup of huffman code
281     // FIXME: Is 512 tree entries really enough to handle _all_ possible
282     // code sets? I think so but not 100% positive.
283     MS_S16 s16Tree[512];    ///< huffman tree of huffman code
284     MS_U8 u8Code_size[256]; ///< code size of huffman code
285 } JPEG_HuffTbl;
286 
287 
288 #endif //_NJPEG_DEF_H_
289 
290