xref: /openbmc/u-boot/include/linux/mtd/doc2000.h (revision 7d9b5bae)
1 /*
2  * Linux driver for Disk-On-Chip devices
3  *
4  * Copyright (C) 1999 Machine Vision Holdings, Inc.
5  * Copyright (C) 2001-2003 David Woodhouse <dwmw2@infradead.org>
6  * Copyright (C) 2002-2003 Greg Ungerer <gerg@snapgear.com>
7  * Copyright (C) 2002-2003 SnapGear Inc
8  *
9  * $Id: doc2000.h,v 1.25 2005/11/07 11:14:54 gleixner Exp $
10  *
11  * Released under GPL
12  */
13 
14 #ifndef __MTD_DOC2000_H__
15 #define __MTD_DOC2000_H__
16 
17 #include <linux/mtd/mtd.h>
18 #if 0
19 #include <linux/mutex.h>
20 #endif
21 
22 #define DoC_Sig1 0
23 #define DoC_Sig2 1
24 
25 #define DoC_ChipID		0x1000
26 #define DoC_DOCStatus		0x1001
27 #define DoC_DOCControl		0x1002
28 #define DoC_FloorSelect		0x1003
29 #define DoC_CDSNControl		0x1004
30 #define DoC_CDSNDeviceSelect	0x1005
31 #define DoC_ECCConf		0x1006
32 #define DoC_2k_ECCStatus	0x1007
33 
34 #define DoC_CDSNSlowIO		0x100d
35 #define DoC_ECCSyndrome0	0x1010
36 #define DoC_ECCSyndrome1	0x1011
37 #define DoC_ECCSyndrome2	0x1012
38 #define DoC_ECCSyndrome3	0x1013
39 #define DoC_ECCSyndrome4	0x1014
40 #define DoC_ECCSyndrome5	0x1015
41 #define DoC_AliasResolution	0x101b
42 #define DoC_ConfigInput		0x101c
43 #define DoC_ReadPipeInit	0x101d
44 #define DoC_WritePipeTerm	0x101e
45 #define DoC_LastDataRead	0x101f
46 #define DoC_NOP			0x1020
47 
48 #define DoC_Mil_CDSN_IO		0x0800
49 #define DoC_2k_CDSN_IO		0x1800
50 
51 #define DoC_Mplus_NOP			0x1002
52 #define DoC_Mplus_AliasResolution	0x1004
53 #define DoC_Mplus_DOCControl		0x1006
54 #define DoC_Mplus_AccessStatus		0x1008
55 #define DoC_Mplus_DeviceSelect		0x1008
56 #define DoC_Mplus_Configuration		0x100a
57 #define DoC_Mplus_OutputControl		0x100c
58 #define DoC_Mplus_FlashControl		0x1020
59 #define DoC_Mplus_FlashSelect 		0x1022
60 #define DoC_Mplus_FlashCmd		0x1024
61 #define DoC_Mplus_FlashAddress		0x1026
62 #define DoC_Mplus_FlashData0		0x1028
63 #define DoC_Mplus_FlashData1		0x1029
64 #define DoC_Mplus_ReadPipeInit		0x102a
65 #define DoC_Mplus_LastDataRead		0x102c
66 #define DoC_Mplus_LastDataRead1		0x102d
67 #define DoC_Mplus_WritePipeTerm 	0x102e
68 #define DoC_Mplus_ECCSyndrome0		0x1040
69 #define DoC_Mplus_ECCSyndrome1		0x1041
70 #define DoC_Mplus_ECCSyndrome2		0x1042
71 #define DoC_Mplus_ECCSyndrome3		0x1043
72 #define DoC_Mplus_ECCSyndrome4		0x1044
73 #define DoC_Mplus_ECCSyndrome5		0x1045
74 #define DoC_Mplus_ECCConf 		0x1046
75 #define DoC_Mplus_Toggle		0x1046
76 #define DoC_Mplus_DownloadStatus	0x1074
77 #define DoC_Mplus_CtrlConfirm		0x1076
78 #define DoC_Mplus_Power			0x1fff
79 
80 /* How to access the device?
81  * On ARM, it'll be mmap'd directly with 32-bit wide accesses.
82  * On PPC, it's mmap'd and 16-bit wide.
83  * Others use readb/writeb
84  */
85 #if defined(__arm__)
86 #define ReadDOC_(adr, reg)      ((unsigned char)(*(volatile __u32 *)(((unsigned long)adr)+((reg)<<2))))
87 #define WriteDOC_(d, adr, reg)  do{ *(volatile __u32 *)(((unsigned long)adr)+((reg)<<2)) = (__u32)d; wmb();} while(0)
88 #define DOC_IOREMAP_LEN 0x8000
89 #elif defined(__ppc__)
90 #define ReadDOC_(adr, reg)      ((unsigned char)(*(volatile __u16 *)(((unsigned long)adr)+((reg)<<1))))
91 #define WriteDOC_(d, adr, reg)  do{ *(volatile __u16 *)(((unsigned long)adr)+((reg)<<1)) = (__u16)d; wmb();} while(0)
92 #define DOC_IOREMAP_LEN 0x4000
93 #else
94 #define ReadDOC_(adr, reg)      readb((void __iomem *)(adr) + (reg))
95 #define WriteDOC_(d, adr, reg)  writeb(d, (void __iomem *)(adr) + (reg))
96 #define DOC_IOREMAP_LEN 0x2000
97 
98 #endif
99 
100 #if defined(__i386__) || defined(__x86_64__)
101 #define USE_MEMCPY
102 #endif
103 
104 /* These are provided to directly use the DoC_xxx defines */
105 #define ReadDOC(adr, reg)      ReadDOC_(adr,DoC_##reg)
106 #define WriteDOC(d, adr, reg)  WriteDOC_(d,adr,DoC_##reg)
107 
108 #define DOC_MODE_RESET		0
109 #define DOC_MODE_NORMAL		1
110 #define DOC_MODE_RESERVED1	2
111 #define DOC_MODE_RESERVED2	3
112 
113 #define DOC_MODE_CLR_ERR	0x80
114 #define	DOC_MODE_RST_LAT	0x10
115 #define	DOC_MODE_BDECT		0x08
116 #define DOC_MODE_MDWREN	0x04
117 
118 #define DOC_ChipID_Doc2k	0x20
119 #define DOC_ChipID_Doc2kTSOP	0x21	/* internal number for MTD */
120 #define DOC_ChipID_DocMil	0x30
121 #define DOC_ChipID_DocMilPlus32	0x40
122 #define DOC_ChipID_DocMilPlus16	0x41
123 
124 #define CDSN_CTRL_FR_B		0x80
125 #define CDSN_CTRL_FR_B0		0x40
126 #define CDSN_CTRL_FR_B1		0x80
127 
128 #define CDSN_CTRL_ECC_IO	0x20
129 #define CDSN_CTRL_FLASH_IO	0x10
130 #define CDSN_CTRL_WP		0x08
131 #define CDSN_CTRL_ALE		0x04
132 #define CDSN_CTRL_CLE		0x02
133 #define CDSN_CTRL_CE		0x01
134 
135 #define DOC_ECC_RESET		0
136 #define DOC_ECC_ERROR		0x80
137 #define DOC_ECC_RW		0x20
138 #define DOC_ECC__EN		0x08
139 #define DOC_TOGGLE_BIT		0x04
140 #define DOC_ECC_RESV		0x02
141 #define DOC_ECC_IGNORE		0x01
142 
143 #define DOC_FLASH_CE		0x80
144 #define DOC_FLASH_WP		0x40
145 #define DOC_FLASH_BANK		0x02
146 
147 /* We have to also set the reserved bit 1 for enable */
148 #define DOC_ECC_EN (DOC_ECC__EN | DOC_ECC_RESV)
149 #define DOC_ECC_DIS (DOC_ECC_RESV)
150 
151 struct Nand {
152 	char floor, chip;
153 	unsigned long curadr;
154 	unsigned char curmode;
155 	/* Also some erase/write/pipeline info when we get that far */
156 };
157 
158 #define MAX_FLOORS 4
159 #define MAX_CHIPS 4
160 
161 #define MAX_FLOORS_MIL 1
162 #define MAX_CHIPS_MIL 1
163 
164 #define MAX_FLOORS_MPLUS 2
165 #define MAX_CHIPS_MPLUS 1
166 
167 #define ADDR_COLUMN 1
168 #define ADDR_PAGE 2
169 #define ADDR_COLUMN_PAGE 3
170 
171 struct DiskOnChip {
172 	unsigned long physadr;
173 	void __iomem *virtadr;
174 	unsigned long totlen;
175 	unsigned char ChipID; /* Type of DiskOnChip */
176 	int ioreg;
177 
178 	unsigned long mfr; /* Flash IDs - only one type of flash per device */
179 	unsigned long id;
180 	int chipshift;
181 	char page256;
182 	char pageadrlen;
183 	char interleave; /* Internal interleaving - Millennium Plus style */
184 	unsigned long erasesize;
185 
186 	int curfloor;
187 	int curchip;
188 
189 	int numchips;
190 	struct Nand *chips;
191 	struct mtd_info *nextdoc;
192 /* XXX U-BOOT XXX */
193 #if 0
194 	struct mutex lock;
195 #endif
196 };
197 
198 int doc_decode_ecc(unsigned char sector[512], unsigned char ecc1[6]);
199 
200 /* XXX U-BOOT XXX */
201 #if 1
202 /*
203  * NAND Flash Manufacturer ID Codes
204  */
205 #define NAND_MFR_TOSHIBA   0x98
206 #define NAND_MFR_SAMSUNG   0xec
207 #endif
208 
209 #endif /* __MTD_DOC2000_H__ */
210