unified MX27, MX25, MX37 trees
[karo-tx-redboot.git] / packages / devs / flash / arm / mxc / v2_0 / include / imx_nfc.h
1 #ifndef _IMX_NFC_H_
2 #define _IMX_NFC_H_
3 //==========================================================================
4 //
5 //      imx_nfc.h
6 //
7 //      Flash programming to support NAND flash on Freescale MXC platforms
8 //
9 //==========================================================================
10 //####ECOSGPLCOPYRIGHTBEGIN####
11 // -------------------------------------------
12 // This file is part of eCos, the Embedded Configurable Operating System.
13 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
14 //
15 // eCos is free software; you can redistribute it and/or modify it under
16 // the terms of the GNU General Public License as published by the Free
17 // Software Foundation; either version 2 or (at your option) any later version.
18 //
19 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
20 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
22 // for more details.
23 //
24 // You should have received a copy of the GNU General Public License along
25 // with eCos; if not, write to the Free Software Foundation, Inc.,
26 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
27 //
28 // As a special exception, if other files instantiate templates or use macros
29 // or inline functions from this file, or you compile this file and link it
30 // with other works to produce a work based on this file, this file does not
31 // by itself cause the resulting work to be covered by the GNU General Public
32 // License. However the source code for this file must still be made available
33 // in accordance with section (3) of the GNU General Public License.
34 //
35 // This exception does not invalidate any other reasons why a work based on
36 // this file might be covered by the GNU General Public License.
37 //
38 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
39 // at http://sources.redhat.com/ecos/ecos-license/
40 // -------------------------------------------
41 //####ECOSGPLCOPYRIGHTEND####
42 //==========================================================================
43 //#####DESCRIPTIONBEGIN####
44 //
45 // Author(s):    Kevin Zhang <k.zhang@freescale.com>
46 // Contributors: Kevin Zhang <k.zhang@freescale.com>
47 // Date:         2008-06-02
48 // Purpose:
49 // Description:
50 //
51 //####DESCRIPTIONEND####
52 //
53 //==========================================================================
54
55 enum {
56         MXC_NFC_V1 = 0x10,
57         MXC_NFC_V1_1 = 0x11,
58         MXC_NFC_V2 = 0x20,
59         MXC_NFC_V3 = 0x30,
60 };
61
62 enum {
63         NFC_DEBUG_NONE,
64         NFC_DEBUG_MIN,
65         NFC_DEBUG_MED,
66         NFC_DEBUG_MAX,
67 };
68 #define NFC_DEBUG_DEF   NFC_DEBUG_NONE
69
70 extern int _mxc_boot;
71 typedef unsigned short u16;
72 typedef unsigned int u32;
73 typedef unsigned char u8;
74 typedef unsigned long long u64;
75
76 //----------------------------------------------------------------------------
77 // Common device details.
78 #define FLASH_Read_ID                                   0x90
79 #ifdef CYGHWR_DEVS_FLASH_MXC_NAND_RESET_WORKAROUND
80 #define FLASH_Reset                                             0xFFFF
81 #else
82 #define FLASH_Reset                                             0xFF
83 #endif
84 #define FLASH_Read_Mode1                                0x00
85 #define FLASH_Read_Mode1_LG                             0x30
86 #define FLASH_Read_Mode2                                0x01
87 #define FLASH_Read_Mode3                                0x50
88 #define FLASH_Program                                   0x10
89 #define FLASH_Send_Data                                 0x80
90 #define FLASH_Status                                    0x70
91 #define FLASH_Block_Erase                               0x60
92 #define FLASH_Start_Erase                               0xD0
93
94 enum nfc_page_area {
95         NFC_SPARE_ONLY,
96         NFC_MAIN_ONLY,
97 };
98
99 enum {
100         MXC_NAND_8_BIT = 8,
101         MXC_NAND_16_BIT =  16,
102 };
103
104 enum {
105         NAND_SLC = 0,
106         NAND_MLC = 1,
107 };
108
109 // read column 464-465 byte but only 464 for bad block marker
110 #define BAD_BLK_MARKER_464          (NAND_MAIN_BUF3 + 464)
111 // read column 4-5 byte, but only 5 is used for swapped main area data
112 #define BAD_BLK_MARKER_SP_5         (NAND_SPAR_BUF3 + 4)
113
114 typedef void nfc_iomuxsetup_func_t(void);
115
116 #endif // _IMX_NFC_H_