Gitiles
Code Review Sign In
192.168.1.100 / T800_MD / 6c1fd8fba87d5723e0e5614ae30b4258b603cb70 / . / mcu / custom / driver / common / combo_flash_defs.h
blob: e59d7a4bd22de879d9f772f4fb659bc21d799260 [file] [log] [blame]
rjw6c1fd8f2022-11-30 14:33:01 +0800[diff] [blame^]1/*****************************************************************************
2* Copyright Statement:
3* --------------------
4* This software is protected by Copyright and the information contained
5* herein is confidential. The software may not be copied and the information
6* contained herein may not be used or disclosed except with the written
7* permission of MediaTek Inc. (C) 2005
8*
9* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
10* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
11* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
12* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
13* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
14* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
15* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
16* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
17* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
18* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
19* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
20* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
21*
22* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
23* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
24* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
25* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
26* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
27*
28* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
29* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
30* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
31* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
32* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
33*
34*****************************************************************************/
35
36/*****************************************************************************
37 *
38 * Filename:
39 * ---------
40 * combo_flash_defs.h
41 *
42 * Project:
43 * --------
44 * Maui_Software
45 *
46 * Description:
47 * ------------
48 * This Module defines the data structures used in ComboMCP
49 *
50 * Author:
51 * -------
52 * -------
53 *
54 *============================================================================
55 * HISTORY
56 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
57 *------------------------------------------------------------------------------
58 * removed!
59 * removed!
60 * removed!
61 *
62 * removed!
63 * removed!
64 * removed!
65 * removed!
66 * removed!
67 * removed!
68 * removed!
69 *
70 * removed!
71 * removed!
72 * removed!
73 *
74 * removed!
75 * removed!
76 * removed!
77 *
78 * removed!
79 * removed!
80 * removed!
81 *
82 * removed!
83 * removed!
84 * removed!
85 *
86 * removed!
87 * removed!
88 * removed!
89 *
90 * removed!
91 * removed!
92 * removed!
93 *
94 * removed!
95 * removed!
96 * removed!
97 *
98 * removed!
99 * removed!
100 * removed!
101 *
102 * removed!
103 * removed!
104 * removed!
105 *
106 * removed!
107 * removed!
108 * removed!
109 *
110 * removed!
111 * removed!
112 * removed!
113 *
114 * removed!
115 * removed!
116 * removed!
117 *
118 * removed!
119 * removed!
120 * removed!
121 *
122 *
123 *------------------------------------------------------------------------------
124 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
125 *============================================================================
126 ****************************************************************************/
127#ifndef _COMBO_FLASH_DEFS_H_
128#define _COMBO_FLASH_DEFS_H_
129
130#include "kal_public_api.h" //MSBB change #include "kal_release.h"
131#include "custom_MemoryDevice.h"
132#include "DrvFlash.h"
133#include "flash_opt.h"
134
135#if defined(__SERIAL_FLASH__) || (defined(_NAND_FLASH_BOOTING_) && defined(__NAND_MDL_APPEND__))
136
137#if defined(__SV5_ENABLED__) || defined(__SV5X_ENABLED__)
138#include "br_sw_types.h"
139#include "br_GFH.h"
140#endif
141
142#define CMEM_FLASH_ID_LEN_NOR 4
143#define CMEM_FLASH_ID_LEN_NAND 8
144#define CMEM_REGION_INFO_LEN 8
145#define CMEM_BLOCK_INFO_LEN 8
146#define CMEM_BANK_INFO_LEN 8
147#define CMEM_BLOCK_INFO_LEN 8
148#if defined(_NAND_FLASH_BOOTING_) && defined(__NAND_MDL_APPEND__)
149#define COMBO_MEM_ID_VER 2 // identify block/page/spare size MDL format
150#else
151#define COMBO_MEM_ID_VER 1
152#endif
153#define COMBO_MEM_NOR_VER 2
154#define COMBO_MEM_IDENTITY_ID "COMBOMEM_ID"
155#define COMBO_MEM_IDENTITY_NOR "COMBOMEM_NOR"
156#define COMBO_MEM_ID_GFH_HEADER GFH_HEADER(GFH_CMEM_ID_INFO, 1)
157#define COMBO_MEM_NOR_GFH_HEADER GFH_HEADER(GFH_CMEM_NOR_INFO, 1)
158
159#ifdef __SERIAL_FLASH__
160#include "combo_sfi_defs.h"
161#endif
162
163 #define COMBO_MEM_DEVICE_COUNT 1
164
165//-----------------------------------------------------------------------------
166// Combo MCP ID list
167//-----------------------------------------------------------------------------
168
169// Union: CMEMFlashID
170typedef union {
171 kal_uint8 NAND[CMEM_FLASH_ID_LEN_NAND];
172 kal_uint16 NOR[CMEM_FLASH_ID_LEN_NOR];
173} CMEMFlashID;
174
175#if defined(_NAND_FLASH_BOOTING_) && defined(__NAND_MDL_APPEND__)
176typedef struct {
177 kal_uint16 page_size;
178 kal_uint16 spare_size;
179 kal_uint16 block_size;
180} CMEMFlashInfo;
181#endif
182// Type: CMEMEntryID
183typedef struct {
184 kal_uint8 DeviceType; // rename to Flash Type: NOR / NAND /EMMC
185 kal_uint8 IDLength;
186#if defined(_NAND_FLASH_BOOTING_) && defined(__NAND_MDL_APPEND__)
187 CMEMFlashInfo FlashDevice_Info; //include block, page and spare size
188#endif
189 #if defined(_NAND_FLASH_BOOTING_)|| defined(__SERIAL_FLASH__)
190 kal_uint8 ID[CMEM_FLASH_ID_LEN_NAND];
191 #else
192 kal_uint16 ID[CMEM_FLASH_ID_LEN_NOR];
193 #endif
194} CMEMEntryID;
195
196// Type: CMEMEntryIDList
197typedef struct {
198 #if !defined(__SV5_ENABLED__) && !defined(__SV5X_ENABLED__)
199 char m_identifier[16]; // MTK_CMB_ID_INFO
200 #endif
201 unsigned int m_ver;
202 unsigned int Count;
203 CMEMEntryID List[COMBO_MEM_DEVICE_COUNT];
204} CMEMEntryIDList;
205
206//-----------------------------------------------------------------------------
207// Combo MCP SW Settings
208//-----------------------------------------------------------------------------
209// Type: FlashBlockLayout
210typedef struct {
211 kal_uint32 Offset;
212 kal_uint32 Size;
213} FlashBlockLayout;
214
215// Type: CMEMEntryNOR
216typedef struct {
217 kal_uint16 FDMType; // rename to Device Type: DEFAULT / SIB
218 kal_uint16 PageBufferSize; // Autogen from MDL
219 kal_uint32 UniformBlocks; // Uniform Block Layout
220 FlashBlockLayout BlockLayout[CMEM_REGION_INFO_LEN];
221 FlashBankInfo BankInfo[CMEM_BANK_INFO_LEN];
222} CMEMEntryNOR;
223
224// Type: CMEMEntryNORList
225typedef struct {
226 #if !defined(__SV5_ENABLED__) && !defined(__SV5X_ENABLED__)
227 char m_identifier[16]; // MTK_CMB_ID_INFO
228 #endif
229 unsigned int m_ver;
230 unsigned int Count;
231 CMEMEntryNOR List[COMBO_MEM_DEVICE_COUNT];
232} CMEMEntryNORList;
233
234
235#endif // defined(__COMBO_MEMORY_SUPPORT__) || defined(__SERIAL_FLASH__)
236
237#endif // ifndef _COMBO_FLASH_DEFS_H_
238