xref: /rk3399_rockchip-uboot/drivers/block/systemace.c (revision f6d000edbeaddfe8e5b5e3be9fd3f6c76fdff6d2)
1 /*
2  * Copyright (c) 2004 Picture Elements, Inc.
3  *    Stephen Williams (XXXXXXXXXXXXXXXX)
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 /*
9  * The Xilinx SystemACE chip support is activated by defining
10  * CONFIG_SYSTEMACE to turn on support, and CONFIG_SYS_SYSTEMACE_BASE
11  * to set the base address of the device. This code currently
12  * assumes that the chip is connected via a byte-wide bus.
13  *
14  * The CONFIG_SYSTEMACE also adds to fat support the device class
15  * "ace" that allows the user to execute "fatls ace 0" and the
16  * like. This works by making the systemace_get_dev function
17  * available to cmd_fat.c:get_dev and filling in a block device
18  * description that has all the bits needed for FAT support to
19  * read sectors.
20  *
21  * According to Xilinx technical support, before accessing the
22  * SystemACE CF you need to set the following control bits:
23  *      FORCECFGMODE : 1
24  *      CFGMODE : 0
25  *      CFGSTART : 0
26  */
27 
28 #include <common.h>
29 #include <command.h>
30 #include <systemace.h>
31 #include <part.h>
32 #include <asm/io.h>
33 
34 /*
35  * The ace_readw and writew functions read/write 16bit words, but the
36  * offset value is the BYTE offset as most used in the Xilinx
37  * datasheet for the SystemACE chip. The CONFIG_SYS_SYSTEMACE_BASE is defined
38  * to be the base address for the chip, usually in the local
39  * peripheral bus.
40  */
41 
42 static u32 base = CONFIG_SYS_SYSTEMACE_BASE;
43 static u32 width = CONFIG_SYS_SYSTEMACE_WIDTH;
44 
45 static void ace_writew(u16 val, unsigned off)
46 {
47 	if (width == 8) {
48 #if !defined(__BIG_ENDIAN)
49 		writeb(val >> 8, base + off);
50 		writeb(val, base + off + 1);
51 #else
52 		writeb(val, base + off);
53 		writeb(val >> 8, base + off + 1);
54 #endif
55 	} else
56 		out16(base + off, val);
57 }
58 
59 static u16 ace_readw(unsigned off)
60 {
61 	if (width == 8) {
62 #if !defined(__BIG_ENDIAN)
63 		return (readb(base + off) << 8) | readb(base + off + 1);
64 #else
65 		return readb(base + off) | (readb(base + off + 1) << 8);
66 #endif
67 	}
68 
69 	return in16(base + off);
70 }
71 
72 static unsigned long systemace_read(struct blk_desc *block_dev,
73 				    unsigned long start, lbaint_t blkcnt,
74 				    void *buffer);
75 
76 static struct blk_desc systemace_dev = { 0 };
77 
78 static int get_cf_lock(void)
79 {
80 	int retry = 10;
81 
82 	/* CONTROLREG = LOCKREG */
83 	unsigned val = ace_readw(0x18);
84 	val |= 0x0002;
85 	ace_writew((val & 0xffff), 0x18);
86 
87 	/* Wait for MPULOCK in STATUSREG[15:0] */
88 	while (!(ace_readw(0x04) & 0x0002)) {
89 
90 		if (retry < 0)
91 			return -1;
92 
93 		udelay(100000);
94 		retry -= 1;
95 	}
96 
97 	return 0;
98 }
99 
100 static void release_cf_lock(void)
101 {
102 	unsigned val = ace_readw(0x18);
103 	val &= ~(0x0002);
104 	ace_writew((val & 0xffff), 0x18);
105 }
106 
107 static int systemace_get_dev(int dev, struct blk_desc **descp)
108 {
109 	/* The first time through this, the systemace_dev object is
110 	   not yet initialized. In that case, fill it in. */
111 	if (systemace_dev.blksz == 0) {
112 		systemace_dev.if_type = IF_TYPE_UNKNOWN;
113 		systemace_dev.devnum = 0;
114 		systemace_dev.part_type = PART_TYPE_UNKNOWN;
115 		systemace_dev.type = DEV_TYPE_HARDDISK;
116 		systemace_dev.blksz = 512;
117 		systemace_dev.log2blksz = LOG2(systemace_dev.blksz);
118 		systemace_dev.removable = 1;
119 		systemace_dev.block_read = systemace_read;
120 
121 		/*
122 		 * Ensure the correct bus mode (8/16 bits) gets enabled
123 		 */
124 		ace_writew(width == 8 ? 0 : 0x0001, 0);
125 
126 		part_init(&systemace_dev);
127 
128 	}
129 	*descp = &systemace_dev;
130 
131 	return 0;
132 }
133 
134 /*
135  * This function is called (by dereferencing the block_read pointer in
136  * the dev_desc) to read blocks of data. The return value is the
137  * number of blocks read. A zero return indicates an error.
138  */
139 static unsigned long systemace_read(struct blk_desc *block_dev,
140 				    unsigned long start, lbaint_t blkcnt,
141 				    void *buffer)
142 {
143 	int retry;
144 	unsigned blk_countdown;
145 	unsigned char *dp = buffer;
146 	unsigned val;
147 
148 	if (get_cf_lock() < 0) {
149 		unsigned status = ace_readw(0x04);
150 
151 		/* If CFDETECT is false, card is missing. */
152 		if (!(status & 0x0010)) {
153 			printf("** CompactFlash card not present. **\n");
154 			return 0;
155 		}
156 
157 		printf("**** ACE locked away from me (STATUSREG=%04x)\n",
158 		       status);
159 		return 0;
160 	}
161 #ifdef DEBUG_SYSTEMACE
162 	printf("... systemace read %lu sectors at %lu\n", blkcnt, start);
163 #endif
164 
165 	retry = 2000;
166 	for (;;) {
167 		val = ace_readw(0x04);
168 
169 		/* If CFDETECT is false, card is missing. */
170 		if (!(val & 0x0010)) {
171 			printf("**** ACE CompactFlash not found.\n");
172 			release_cf_lock();
173 			return 0;
174 		}
175 
176 		/* If RDYFORCMD, then we are ready to go. */
177 		if (val & 0x0100)
178 			break;
179 
180 		if (retry < 0) {
181 			printf("**** SystemACE not ready.\n");
182 			release_cf_lock();
183 			return 0;
184 		}
185 
186 		udelay(1000);
187 		retry -= 1;
188 	}
189 
190 	/* The SystemACE can only transfer 256 sectors at a time, so
191 	   limit the current chunk of sectors. The blk_countdown
192 	   variable is the number of sectors left to transfer. */
193 
194 	blk_countdown = blkcnt;
195 	while (blk_countdown > 0) {
196 		unsigned trans = blk_countdown;
197 
198 		if (trans > 256)
199 			trans = 256;
200 
201 #ifdef DEBUG_SYSTEMACE
202 		printf("... transfer %lu sector in a chunk\n", trans);
203 #endif
204 		/* Write LBA block address */
205 		ace_writew((start >> 0) & 0xffff, 0x10);
206 		ace_writew((start >> 16) & 0x0fff, 0x12);
207 
208 		/* NOTE: in the Write Sector count below, a count of 0
209 		   causes a transfer of 256, so &0xff gives the right
210 		   value for whatever transfer count we want. */
211 
212 		/* Write sector count | ReadMemCardData. */
213 		ace_writew((trans & 0xff) | 0x0300, 0x14);
214 
215 /*
216  * For FPGA configuration via SystemACE is reset unacceptable
217  * CFGDONE bit in STATUSREG is not set to 1.
218  */
219 #ifndef SYSTEMACE_CONFIG_FPGA
220 		/* Reset the configruation controller */
221 		val = ace_readw(0x18);
222 		val |= 0x0080;
223 		ace_writew(val, 0x18);
224 #endif
225 
226 		retry = trans * 16;
227 		while (retry > 0) {
228 			int idx;
229 
230 			/* Wait for buffer to become ready. */
231 			while (!(ace_readw(0x04) & 0x0020)) {
232 				udelay(100);
233 			}
234 
235 			/* Read 16 words of 2bytes from the sector buffer. */
236 			for (idx = 0; idx < 16; idx += 1) {
237 				unsigned short val = ace_readw(0x40);
238 				*dp++ = val & 0xff;
239 				*dp++ = (val >> 8) & 0xff;
240 			}
241 
242 			retry -= 1;
243 		}
244 
245 		/* Clear the configruation controller reset */
246 		val = ace_readw(0x18);
247 		val &= ~0x0080;
248 		ace_writew(val, 0x18);
249 
250 		/* Count the blocks we transfer this time. */
251 		start += trans;
252 		blk_countdown -= trans;
253 	}
254 
255 	release_cf_lock();
256 
257 	return blkcnt;
258 }
259 
260 U_BOOT_LEGACY_BLK(systemace) = {
261 	.if_typename	= "ace",
262 	.if_type	= IF_TYPE_SYSTEMACE,
263 	.max_devs	= 1,
264 	.get_dev	= systemace_get_dev,
265 };
266