xref: /utopia/UTPA2-700.0.x/modules/vdec_v1/drv/mvd/drvMVD_Common.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1*53ee8cc1Swenshuai.xi //<MStar Software>
2*53ee8cc1Swenshuai.xi //******************************************************************************
3*53ee8cc1Swenshuai.xi // MStar Software
4*53ee8cc1Swenshuai.xi // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5*53ee8cc1Swenshuai.xi // All software, firmware and related documentation herein ("MStar Software") are
6*53ee8cc1Swenshuai.xi // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7*53ee8cc1Swenshuai.xi // law, including, but not limited to, copyright law and international treaties.
8*53ee8cc1Swenshuai.xi // Any use, modification, reproduction, retransmission, or republication of all
9*53ee8cc1Swenshuai.xi // or part of MStar Software is expressly prohibited, unless prior written
10*53ee8cc1Swenshuai.xi // permission has been granted by MStar.
11*53ee8cc1Swenshuai.xi //
12*53ee8cc1Swenshuai.xi // By accessing, browsing and/or using MStar Software, you acknowledge that you
13*53ee8cc1Swenshuai.xi // have read, understood, and agree, to be bound by below terms ("Terms") and to
14*53ee8cc1Swenshuai.xi // comply with all applicable laws and regulations:
15*53ee8cc1Swenshuai.xi //
16*53ee8cc1Swenshuai.xi // 1. MStar shall retain any and all right, ownership and interest to MStar
17*53ee8cc1Swenshuai.xi //    Software and any modification/derivatives thereof.
18*53ee8cc1Swenshuai.xi //    No right, ownership, or interest to MStar Software and any
19*53ee8cc1Swenshuai.xi //    modification/derivatives thereof is transferred to you under Terms.
20*53ee8cc1Swenshuai.xi //
21*53ee8cc1Swenshuai.xi // 2. You understand that MStar Software might include, incorporate or be
22*53ee8cc1Swenshuai.xi //    supplied together with third party`s software and the use of MStar
23*53ee8cc1Swenshuai.xi //    Software may require additional licenses from third parties.
24*53ee8cc1Swenshuai.xi //    Therefore, you hereby agree it is your sole responsibility to separately
25*53ee8cc1Swenshuai.xi //    obtain any and all third party right and license necessary for your use of
26*53ee8cc1Swenshuai.xi //    such third party`s software.
27*53ee8cc1Swenshuai.xi //
28*53ee8cc1Swenshuai.xi // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29*53ee8cc1Swenshuai.xi //    MStar`s confidential information and you agree to keep MStar`s
30*53ee8cc1Swenshuai.xi //    confidential information in strictest confidence and not disclose to any
31*53ee8cc1Swenshuai.xi //    third party.
32*53ee8cc1Swenshuai.xi //
33*53ee8cc1Swenshuai.xi // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34*53ee8cc1Swenshuai.xi //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35*53ee8cc1Swenshuai.xi //    without limitation, any warranties of merchantability, non-infringement of
36*53ee8cc1Swenshuai.xi //    intellectual property rights, fitness for a particular purpose, error free
37*53ee8cc1Swenshuai.xi //    and in conformity with any international standard.  You agree to waive any
38*53ee8cc1Swenshuai.xi //    claim against MStar for any loss, damage, cost or expense that you may
39*53ee8cc1Swenshuai.xi //    incur related to your use of MStar Software.
40*53ee8cc1Swenshuai.xi //    In no event shall MStar be liable for any direct, indirect, incidental or
41*53ee8cc1Swenshuai.xi //    consequential damages, including without limitation, lost of profit or
42*53ee8cc1Swenshuai.xi //    revenues, lost or damage of data, and unauthorized system use.
43*53ee8cc1Swenshuai.xi //    You agree that this Section 4 shall still apply without being affected
44*53ee8cc1Swenshuai.xi //    even if MStar Software has been modified by MStar in accordance with your
45*53ee8cc1Swenshuai.xi //    request or instruction for your use, except otherwise agreed by both
46*53ee8cc1Swenshuai.xi //    parties in writing.
47*53ee8cc1Swenshuai.xi //
48*53ee8cc1Swenshuai.xi // 5. If requested, MStar may from time to time provide technical supports or
49*53ee8cc1Swenshuai.xi //    services in relation with MStar Software to you for your use of
50*53ee8cc1Swenshuai.xi //    MStar Software in conjunction with your or your customer`s product
51*53ee8cc1Swenshuai.xi //    ("Services").
52*53ee8cc1Swenshuai.xi //    You understand and agree that, except otherwise agreed by both parties in
53*53ee8cc1Swenshuai.xi //    writing, Services are provided on an "AS IS" basis and the warranty
54*53ee8cc1Swenshuai.xi //    disclaimer set forth in Section 4 above shall apply.
55*53ee8cc1Swenshuai.xi //
56*53ee8cc1Swenshuai.xi // 6. Nothing contained herein shall be construed as by implication, estoppels
57*53ee8cc1Swenshuai.xi //    or otherwise:
58*53ee8cc1Swenshuai.xi //    (a) conferring any license or right to use MStar name, trademark, service
59*53ee8cc1Swenshuai.xi //        mark, symbol or any other identification;
60*53ee8cc1Swenshuai.xi //    (b) obligating MStar or any of its affiliates to furnish any person,
61*53ee8cc1Swenshuai.xi //        including without limitation, you and your customers, any assistance
62*53ee8cc1Swenshuai.xi //        of any kind whatsoever, or any information; or
63*53ee8cc1Swenshuai.xi //    (c) conferring any license or right under any intellectual property right.
64*53ee8cc1Swenshuai.xi //
65*53ee8cc1Swenshuai.xi // 7. These terms shall be governed by and construed in accordance with the laws
66*53ee8cc1Swenshuai.xi //    of Taiwan, R.O.C., excluding its conflict of law rules.
67*53ee8cc1Swenshuai.xi //    Any and all dispute arising out hereof or related hereto shall be finally
68*53ee8cc1Swenshuai.xi //    settled by arbitration referred to the Chinese Arbitration Association,
69*53ee8cc1Swenshuai.xi //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70*53ee8cc1Swenshuai.xi //    Rules of the Association by three (3) arbitrators appointed in accordance
71*53ee8cc1Swenshuai.xi //    with the said Rules.
72*53ee8cc1Swenshuai.xi //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73*53ee8cc1Swenshuai.xi //    be English.
74*53ee8cc1Swenshuai.xi //    The arbitration award shall be final and binding to both parties.
75*53ee8cc1Swenshuai.xi //
76*53ee8cc1Swenshuai.xi //******************************************************************************
77*53ee8cc1Swenshuai.xi //<MStar Software>
78*53ee8cc1Swenshuai.xi #ifndef _DRVMVD_COMMON_H_
79*53ee8cc1Swenshuai.xi #define _DRVMVD_COMMON_H_
80*53ee8cc1Swenshuai.xi 
81*53ee8cc1Swenshuai.xi #ifndef __MDRV_TYPES_H__
82*53ee8cc1Swenshuai.xi /// data type unsigned char, data length 1 byte
83*53ee8cc1Swenshuai.xi typedef unsigned char               MS_U8;                              // 1 byte
84*53ee8cc1Swenshuai.xi /// data type unsigned short, data length 2 byte
85*53ee8cc1Swenshuai.xi typedef unsigned short              MS_U16;                             // 2 bytes
86*53ee8cc1Swenshuai.xi /// data type unsigned int, data length 4 byte
87*53ee8cc1Swenshuai.xi typedef unsigned long               MS_U32;                             // 4 bytes
88*53ee8cc1Swenshuai.xi /// data type signed char, data length 1 byte
89*53ee8cc1Swenshuai.xi typedef signed char                 MS_S8;                              // 1 byte
90*53ee8cc1Swenshuai.xi /// data type signed short, data length 2 byte
91*53ee8cc1Swenshuai.xi typedef signed short                MS_S16;                             // 2 bytes
92*53ee8cc1Swenshuai.xi /// data type signed int, data length 4 byte
93*53ee8cc1Swenshuai.xi typedef signed long                 MS_S32;                             // 4 bytes
94*53ee8cc1Swenshuai.xi /// data type float, data length 4 byte
95*53ee8cc1Swenshuai.xi typedef float                       MS_FLOAT;                           // 4 bytes
96*53ee8cc1Swenshuai.xi 
97*53ee8cc1Swenshuai.xi /// definition for MS_BOOL
98*53ee8cc1Swenshuai.xi typedef unsigned char               MS_BOOL;
99*53ee8cc1Swenshuai.xi /// definition for VOID
100*53ee8cc1Swenshuai.xi typedef void                        VOID;
101*53ee8cc1Swenshuai.xi /// definition for FILEID
102*53ee8cc1Swenshuai.xi typedef MS_S32                      FILEID;
103*53ee8cc1Swenshuai.xi #endif
104*53ee8cc1Swenshuai.xi 
105*53ee8cc1Swenshuai.xi typedef unsigned long MS_PHYADDR;
106*53ee8cc1Swenshuai.xi 
107*53ee8cc1Swenshuai.xi typedef union _MSIF_Version
108*53ee8cc1Swenshuai.xi {
109*53ee8cc1Swenshuai.xi     struct _DDI
110*53ee8cc1Swenshuai.xi     {
111*53ee8cc1Swenshuai.xi         MS_U8                       tag[4];
112*53ee8cc1Swenshuai.xi         MS_U8                       class[2];
113*53ee8cc1Swenshuai.xi         MS_U16                      customer;
114*53ee8cc1Swenshuai.xi         MS_U16                      model;
115*53ee8cc1Swenshuai.xi         MS_U16                      chip;
116*53ee8cc1Swenshuai.xi         MS_U8                       cpu;
117*53ee8cc1Swenshuai.xi         MS_U8                       name[4];
118*53ee8cc1Swenshuai.xi         MS_U8                       version[2];
119*53ee8cc1Swenshuai.xi         MS_U8                       build[2];
120*53ee8cc1Swenshuai.xi         MS_U8                       change[8];
121*53ee8cc1Swenshuai.xi         MS_U8                       os;
122*53ee8cc1Swenshuai.xi     } DDI;
123*53ee8cc1Swenshuai.xi 
124*53ee8cc1Swenshuai.xi     struct _MW
125*53ee8cc1Swenshuai.xi     {
126*53ee8cc1Swenshuai.xi     } MW;
127*53ee8cc1Swenshuai.xi 
128*53ee8cc1Swenshuai.xi     struct _APP
129*53ee8cc1Swenshuai.xi     {
130*53ee8cc1Swenshuai.xi     } APP;
131*53ee8cc1Swenshuai.xi 
132*53ee8cc1Swenshuai.xi } MSIF_Version;
133*53ee8cc1Swenshuai.xi 
134*53ee8cc1Swenshuai.xi 
135*53ee8cc1Swenshuai.xi #include <linux/module.h>
136*53ee8cc1Swenshuai.xi #define printf 						printk
137*53ee8cc1Swenshuai.xi 
138*53ee8cc1Swenshuai.xi 
139*53ee8cc1Swenshuai.xi #ifndef BIT
140*53ee8cc1Swenshuai.xi #define BIT(_bit_)                  (1 << (_bit_))
141*53ee8cc1Swenshuai.xi #endif
142*53ee8cc1Swenshuai.xi 
143*53ee8cc1Swenshuai.xi #ifndef BITS
144*53ee8cc1Swenshuai.xi     #ifdef _BIT
145*53ee8cc1Swenshuai.xi         #define BITS(bits,value)            ((_BIT(((1)?bits)+1)-_BIT(((0)?bits))) & (value<<((0)?bits)))
146*53ee8cc1Swenshuai.xi     #elif defined(BIT)
147*53ee8cc1Swenshuai.xi         #define BITS(_bits_, _val_)         ((BIT(((1)?_bits_)+1)-BIT(((0)?_bits_))) & (_val_<<((0)?_bits_)))
148*53ee8cc1Swenshuai.xi     #endif
149*53ee8cc1Swenshuai.xi #endif
150*53ee8cc1Swenshuai.xi 
151*53ee8cc1Swenshuai.xi #define MSIF_TAG                    {'M','S','I','F'}                   // MSIF
152*53ee8cc1Swenshuai.xi #define MSIF_CLASS                  {'0','0'}                           // DRV/API (DDI)
153*53ee8cc1Swenshuai.xi #define MSIF_CUS                    0x0000                              // MStar Common library
154*53ee8cc1Swenshuai.xi #define MSIF_MOD                    0x0000                              // MStar Common library
155*53ee8cc1Swenshuai.xi #define MSIF_CHIP                   0x000B
156*53ee8cc1Swenshuai.xi #define MSIF_CPU                    '0'
157*53ee8cc1Swenshuai.xi #define MSIF_OS                     '2'
158*53ee8cc1Swenshuai.xi 
159*53ee8cc1Swenshuai.xi #define DISABLE                     0
160*53ee8cc1Swenshuai.xi #define ENABLE                      1
161*53ee8cc1Swenshuai.xi 
162*53ee8cc1Swenshuai.xi #if !defined(TRUE) && !defined(FALSE)
163*53ee8cc1Swenshuai.xi #define TRUE                        1
164*53ee8cc1Swenshuai.xi #define FALSE                       0
165*53ee8cc1Swenshuai.xi #endif
166*53ee8cc1Swenshuai.xi 
167*53ee8cc1Swenshuai.xi 
168*53ee8cc1Swenshuai.xi #ifdef NULL
169*53ee8cc1Swenshuai.xi #undef NULL
170*53ee8cc1Swenshuai.xi #endif
171*53ee8cc1Swenshuai.xi #define NULL                        0
172*53ee8cc1Swenshuai.xi 
173*53ee8cc1Swenshuai.xi 
174*53ee8cc1Swenshuai.xi #ifndef MS_ASSERT
175*53ee8cc1Swenshuai.xi #define MS_ASSERT(expr)     do {                                                            \
176*53ee8cc1Swenshuai.xi                                 if (!(expr))                                                \
177*53ee8cc1Swenshuai.xi                                 {                                                           \
178*53ee8cc1Swenshuai.xi                                     printk("MVD assert fail %s %d!\n", __FILE__, __LINE__); \
179*53ee8cc1Swenshuai.xi                                 }                                                           \
180*53ee8cc1Swenshuai.xi                             } while(0)
181*53ee8cc1Swenshuai.xi #endif
182*53ee8cc1Swenshuai.xi 
183*53ee8cc1Swenshuai.xi void msleep(unsigned int msecs);
184*53ee8cc1Swenshuai.xi 
185*53ee8cc1Swenshuai.xi #endif
186