xref: /utopia/UTPA2-700.0.x/modules/mfc/hal/maserati/mfc/madp_mfc_spi.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 #ifndef _MADP_MFC_SPI_H_
79 #define _MADP_MFC_SPI_H_
80 
81 #include "mdrv_mfc_platform.h"
82 
83 #define MFC_MADP_IIC_CHANNEL_ID 0x02
84 #define _BIT0			(0x0001)
85 #define _BIT1			(0x0002)
86 #define _BIT2			(0x0004)
87 #define _BIT3			(0x0008)
88 #define _BIT4			(0x0010)
89 #define _BIT5			(0x0020)
90 #define _BIT6			(0x0040)
91 #define _BIT7			(0x0080)
92 #define _BIT8			(0x0100)
93 #define _BIT9			(0x0200)
94 #define _BIT10			(0x0400)
95 #define _BIT11			(0x0800)
96 #define _BIT12			(0x1000)
97 #define _BIT13			(0x2000)
98 #define _BIT14			(0x4000)
99 #define _BIT15			(0x8000)
100 
101 //------------------------------------------------------------------------------
102 // SPI Definition
103 //------------------------------------------------------------------------------
104 #define MFC_SPI_SLAVE_ADDR 	0x94
105 enum
106 {
107 	SpiEnter = 0x23,
108 	SpiReset = 0x24,
109 };
110 
111 // Status register[7:0]
112 #define RDY    _BIT0
113 #define WEN    _BIT1
114 #define BP0    _BIT2
115 #define BP1    _BIT3
116 #define AAI    _BIT6
117 #define WPEN   _BIT7
118 
119 enum
120 {
121 	FV_ATMEL = 0x1F,
122 	FV_ST    = 0x20,
123 	FV_PMC   = 0x9D,
124 	FV_SST   = 0xBF,
125 	FV_MXIC  = 0xC2,
126 	FV_NUM   = 0xFF
127 };
128 
129 typedef struct
130 {
131   U8  ManufacturerID;
132   U8  ProductID;
133 
134   U16 ProgramCKS; // check sum
135   U16 VerifyCKS; // check sum
136 } _FLASHTYPE;
137 
138 U8 spiRDSR(void);
139 void spiWaitReady(U8 u8Flag);
140 void spiWREN(BOOL bCtrl); // Set write enable latch
141 void spiEWSR(void);
142 void spiWRSR(U8 u8ID, U8 u8Cmd);
143 void spiRDID(_FLASHTYPE* Flash);
144 void spiBlockErase(U8 u8ID, U16 wPage, U8 ucAddr);
145 U16 spiAAIWriteByte(U16 wPage, U8 u8Start, U16 u16Len, U8 *pBuf);
146 U16 spiPageWriteByte(U16 wPage, U8 u8Start, U8 u8End, U8 *pBuf);
147 void spiPageReadByte(U16 wPage, U8 ucStart, U8 ucEnd, U8 *pBuf);
148 
149 #endif
150