xref: /utopia/UTPA2-700.0.x/modules/vdec_v2/hal/maxim/vpu_ex/controller.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 #ifndef _CONTROL_H_
96 #define _CONTROL_H_
97 
98 extern void CTL_main( void *pvParameters );
99 extern void CTL_Init(void);
100 extern void CTL_Deinit(void);
101 
102 #define CTL_VERSION         0x14063017
103 #define CTL_INFO_ADDR         0x0
104 
105 // _ctl_info statue
106 #define CTL_STU_NONE         0
107 #define CTL_STU_INIT         1
108 #define CTL_STU_TASK         2
109 
110 // _ctl_info task_statue[x]
111 #define CTL_TASK_NONE       0
112 #define CTL_TASK_CREATE     1  // task has already created by controller
113 #define CTL_TASK_CMDRDY     2  // task has already inited and ready to get command
114 
115 // _ctl_info task_mode
116 #define CTL_MODE_NORMAL                  0
117 #define CTL_MODE_3DWMV                 1  // 3d wmv
118 #define CTL_MODE_3DTV                  2  // mpeg2+h.264
119 #define CTL_MODE_3DTV_PROG             3  // Korea 3DTV forced progressive mode
120 #define CTL_MODE_ONE_STC               4  // only one STC, sub view sync main stc
121 #define CTL_MODE_SWITCH_STC            5  // switch target STC , main view sync sub stc and  sub view sync main stc
122 #define CTL_MODE_3DTV_TWO_PITCH        6  //Korea 3DTV, 2nd pitch enabled for 3DLR
123 #define CTL_MODE_3DTV_PROG_TWO_PITCH   7  // Korea 3DTV PROG, 2nd pitch enabled for 3DLR
124 #define CTL_MODE_SEC_MCU               8
125 
126 //fw allocate dram
127 #if defined(SUPPORT_NEW_MEM_LAYOUT)
128 #define DRAM_OFFSET 0x20000     // starts from 0xB0000+0x20000
129 #elif (SUPPORT_EVD) // Local FPGA verification
130 #define DRAM_START 0x100000
131 #else  //For HVD and MVD, or real chip verification
132 #define DRAM_START 0xA0000
133 #endif // #if defined(SUPPORT_NEW_MEM_LAYOUT)
134 
135 #if defined(SUPPORT_NEW_MEM_LAYOUT)
136   #if defined(SUPPORT_EVD) && (SUPPORT_EVD==1)
137   #define HEAP_START 0xD0000
138   #else
139   #define HEAP_START 0xC0000
140   #endif
141 #else
142   #define HEAP_START 0xA0000
143 #endif
144 
145 #define VSYNC_BRIDGE_OFFSET 0x1FA00
146 
147 
148 #if defined(SUPPORT_VDEC_STR)
149 /*
150     | STR_FLAG : 16byte | CTL_CMD : 15 set | MAIN_CMD : 120 set | SUB_CMD : 120 set |
151 
152     1 set = 16 byte
153     total str buffer ~ 4k
154 */
155 
156 #define VDEC_STR_ALIGN  16
157 #define VDEC_STR_CTL_CMD_RESERVERD  8
158 #define VDEC_STR_CMD_RESERVERD 120
159 
160 #define VDEC_STR_BUFFER_START      0x2B0000
161 #define VDEC_STR_MAIN_CTL_CMD_BUF  (VDEC_STR_BUFFER_START + VDEC_STR_ALIGN)
162 #define VDEC_STR_SUB_CTL_CMD_BUF   (VDEC_STR_MAIN_CTL_CMD_BUF + (VDEC_STR_ALIGN * VDEC_STR_CTL_CMD_RESERVERD))
163 #define VDEC_STR_MAIN_CMD_BUF      (VDEC_STR_SUB_CTL_CMD_BUF  + (VDEC_STR_ALIGN * VDEC_STR_CTL_CMD_RESERVERD))
164 #define VDEC_STR_SUB_CMD_BUF      (VDEC_STR_MAIN_CMD_BUF + (VDEC_STR_ALIGN * VDEC_STR_CMD_RESERVERD))
165 
166 #define VDEC_STR_MAIN_WORK         VDEC_STR_BUFFER_START
167 #define VDEC_STR_SUB_WORK          VDEC_STR_BUFFER_START+0x1
168 #define VDEC_STR_MAIN_RESUME       VDEC_STR_BUFFER_START+0x2
169 #define VDEC_STR_SUB_RESUME        VDEC_STR_BUFFER_START+0x3
170 #define VDEC_STR_MAIN_CTL_CMD_COUNT    VDEC_STR_BUFFER_START+0x4
171 #define VDEC_STR_SUB_CTL_CMD_COUNT     VDEC_STR_BUFFER_START+0x5
172 #define VDEC_STR_MAIN_CMD_COUNT        VDEC_STR_BUFFER_START+0x6
173 #define VDEC_STR_SUB_CMD_COUNT         VDEC_STR_BUFFER_START+0x8  //0x7 for VDEC_UNMUTE_BYTE
174 
175 #define VDEC_STR_CMD     4
176 #define VDEC_STR_ARG0    8
177 #define VDEC_STR_ARG1    9
178 #define VDEC_STR_ARG2    10
179 #define VDEC_STR_ARG3    11
180 #define VDEC_STR_ARG4    12
181 #define VDEC_STR_ARG5    13
182 
183 #define VDEC_STR_MVD 1
184 #define VDEC_STR_HVD 2
185 
186 #define VDEC_UNMUTE_BYTE  7
187 
188 #endif
189 /* Structure defination */
190 struct _ctl_info {
191     const unsigned int readonly[4];       // CTL_INFO_ADDR + 0x00 read only for tag.
192     unsigned int vpu_clk;                 // CTL_INFO_ADDR + 0x10 reserved for driver to fw message.(VDEC CPU clock)
193     unsigned int ctl_interface;           // CTL_INFO_ADDR + 0x14 driver interface(read only)
194     unsigned int heap_size[2];            // CTL_INFO_ADDR + 0x18 heap size available for each task
195     unsigned int verion;                  // CTL_INFO_ADDR + 0x20
196     unsigned int statue;                  // CTL_INFO_ADDR + 0x24
197     unsigned int last_ctl_cmd;            // CTL_INFO_ADDR + 0x28
198     unsigned int last_ctl_arg;            // CTL_INFO_ADDR + 0x2C
199     unsigned int task_statue[4];          // CTL_INFO_ADDR + 0x30 fixed to 4 elements for alignment
200     unsigned int task_single;             // CTL_INFO_ADDR + 0x40
201     unsigned short task_mode[2];          // CTL_INFO_ADDR + 0x44 0:normal 1:3d WMV 2:korea 3d TV
202     unsigned int burst_mode;              // CTL_INFO_ADDR + 0x48 0:normal 1:burst cmd
203     unsigned char task_hvd;               // CTL_INFO_ADDR + 0x4c
204     unsigned char task_mvd;               // CTL_INFO_ADDR + 0x4d
205     unsigned short u16TaskFeature;        // CTL_INFO_ADDR + 0x4e
206     unsigned int u32Reserved;             // CTL_INFO_ADDR + 0x50 reserved
207     unsigned int u32TaskShareInfoAddr[4]; // CTL_INFO_ADDR + 0x54 offset from FW beginning
208     unsigned int u32VsyncBridgeAddr;      // CTL_INFO_ADDR + 0x64
209     unsigned int FB_ADDRESS;              // CTL_INFO_ADDR + 0x68 , this value is offset of miu, unit is byte
210     unsigned int FB_Total_SIZE;           // CTL_INFO_ADDR + 0x6C , unit is byte
211     unsigned int FB_Used_SIZE;            // CTL_INFO_ADDR + 0x70 , unit is byte
212 } ;
213 
214 
215 extern struct _ctl_info *g_ctl_ptr;
216 extern unsigned char Wakeup_Controller(unsigned char ISR);
217 extern unsigned char CTL_burst_cmd(unsigned int cmd, unsigned int arg);
218 
219 
220 
221 #endif // _CONTROL_H_
222 
223