cfi.c revision 1.3 1 1.3 cliff /* $NetBSD: cfi.c,v 1.3 2011/07/19 20:52:10 cliff Exp $ */
2 1.3 cliff /*-
3 1.3 cliff * Copyright (c) 2011 The NetBSD Foundation, Inc.
4 1.3 cliff * All rights reserved.
5 1.3 cliff *
6 1.3 cliff * This code is derived from software contributed to The NetBSD Foundation
7 1.3 cliff * by Cliff Neighbors.
8 1.3 cliff *
9 1.3 cliff * Redistribution and use in source and binary forms, with or without
10 1.3 cliff * modification, are permitted provided that the following conditions
11 1.3 cliff * are met:
12 1.3 cliff * 1. Redistributions of source code must retain the above copyright
13 1.3 cliff * notice, this list of conditions and the following disclaimer.
14 1.3 cliff * 2. Redistributions in binary form must reproduce the above copyright
15 1.3 cliff * notice, this list of conditions and the following disclaimer in the
16 1.3 cliff * documentation and/or other materials provided with the distribution.
17 1.3 cliff *
18 1.3 cliff * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 1.3 cliff * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 1.3 cliff * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 1.3 cliff * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 1.3 cliff * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 1.3 cliff * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 1.3 cliff * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 1.3 cliff * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 1.3 cliff * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 1.3 cliff * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 1.3 cliff * POSSIBILITY OF SUCH DAMAGE.
29 1.3 cliff */
30 1.1 cliff
31 1.1 cliff #include "opt_nor.h"
32 1.1 cliff #include "opt_flash.h"
33 1.1 cliff
34 1.1 cliff #include <sys/cdefs.h>
35 1.3 cliff __KERNEL_RCSID(0, "$NetBSD: cfi.c,v 1.3 2011/07/19 20:52:10 cliff Exp $");
36 1.1 cliff
37 1.1 cliff #include <sys/param.h>
38 1.1 cliff #include <sys/systm.h>
39 1.1 cliff #include <sys/cdefs.h>
40 1.1 cliff #include <sys/device.h>
41 1.1 cliff #include <sys/endian.h>
42 1.1 cliff
43 1.2 dyoung #include <sys/bus.h>
44 1.1 cliff
45 1.1 cliff #include <dev/nor/nor.h>
46 1.1 cliff #include <dev/nor/cfi.h>
47 1.1 cliff #include <dev/nor/cfi_0002.h>
48 1.1 cliff
49 1.1 cliff
50 1.1 cliff static bool cfi_chip_query(struct cfi * const);
51 1.1 cliff static int cfi_scan_media(device_t self, struct nor_chip *chip);
52 1.1 cliff static void cfi_init(device_t);
53 1.1 cliff static void cfi_select(device_t, bool);
54 1.1 cliff static void cfi_read_1(device_t, flash_off_t, uint8_t *);
55 1.1 cliff static void cfi_read_2(device_t, flash_off_t, uint16_t *);
56 1.1 cliff static void cfi_read_4(device_t, flash_off_t, uint32_t *);
57 1.1 cliff static void cfi_read_buf_1(device_t, flash_off_t, uint8_t *, size_t);
58 1.1 cliff static void cfi_read_buf_2(device_t, flash_off_t, uint16_t *, size_t);
59 1.1 cliff static void cfi_read_buf_4(device_t, flash_off_t, uint32_t *, size_t);
60 1.1 cliff static void cfi_write_1(device_t, flash_off_t, uint8_t);
61 1.1 cliff static void cfi_write_2(device_t, flash_off_t, uint16_t);
62 1.1 cliff static void cfi_write_4(device_t, flash_off_t, uint32_t);
63 1.1 cliff static void cfi_write_buf_1(device_t, flash_off_t, const uint8_t *, size_t);
64 1.1 cliff static void cfi_write_buf_2(device_t, flash_off_t, const uint16_t *, size_t);
65 1.1 cliff static void cfi_write_buf_4(device_t, flash_off_t, const uint32_t *, size_t);
66 1.1 cliff static bool cfi_jedec_id(struct cfi * const);
67 1.1 cliff
68 1.1 cliff
69 1.1 cliff /*
70 1.1 cliff * NOTE these opmode tables are informed by "Table 1. CFI Query Read"
71 1.1 cliff * in Intel "Common Flash Interface (CFI) and Command Sets"
72 1.1 cliff * Application Note 646, April 2000
73 1.1 cliff *
74 1.1 cliff * The byte ordering of the signature string here varies from that table
75 1.1 cliff * because of discrepancy in observed behavior, for the case:
76 1.1 cliff * - x16 device operating in 16-bit mode
77 1.1 cliff * Similar discrepancy is expected (but not verified) for the case:
78 1.1 cliff * - x32 device operating in 32-bit mode
79 1.1 cliff * so the ordering is changed here for that case also.
80 1.1 cliff *
81 1.1 cliff * XXX down-sized, interleaved & multi-chip opmodes not yet supported
82 1.1 cliff */
83 1.1 cliff
84 1.1 cliff /* 1-byte access */
85 1.1 cliff static const struct cfi_opmodes cfi_opmodes_1[] = {
86 1.1 cliff { 0, 0, 0, 0x10, 3, "QRY", "x8 device operating in 8-bit mode" },
87 1.1 cliff };
88 1.1 cliff
89 1.1 cliff /* 2-byte access */
90 1.1 cliff static const struct cfi_opmodes cfi_opmodes_2[] = {
91 1.1 cliff { 1, 1, 0, 0x20, 6, "\0Q\0R\0Y",
92 1.1 cliff "x16 device operating in 16-bit mode" },
93 1.1 cliff };
94 1.1 cliff
95 1.1 cliff /* 4-byte access */
96 1.1 cliff static const struct cfi_opmodes cfi_opmodes_4[] = {
97 1.1 cliff { 2, 2, 0, 0x40, 12, "\0\0\0Q\0\0\0R\0\0\0Y",
98 1.1 cliff "x32 device operating in 32-bit mode" },
99 1.1 cliff };
100 1.1 cliff
101 1.1 cliff
102 1.1 cliff const struct nor_interface nor_interface_cfi = {
103 1.1 cliff .scan_media = cfi_scan_media,
104 1.1 cliff .init = cfi_init,
105 1.1 cliff .select = cfi_select,
106 1.1 cliff .read_1 = cfi_read_1,
107 1.1 cliff .read_2 = cfi_read_2,
108 1.1 cliff .read_4 = cfi_read_4,
109 1.1 cliff .read_buf_1 = cfi_read_buf_1,
110 1.1 cliff .read_buf_2 = cfi_read_buf_2,
111 1.1 cliff .read_buf_4 = cfi_read_buf_4,
112 1.1 cliff .write_1 = cfi_write_1,
113 1.1 cliff .write_2 = cfi_write_2,
114 1.1 cliff .write_4 = cfi_write_4,
115 1.1 cliff .write_buf_1 = cfi_write_buf_1,
116 1.1 cliff .write_buf_2 = cfi_write_buf_2,
117 1.1 cliff .write_buf_4 = cfi_write_buf_4,
118 1.1 cliff .read_page = NULL, /* cmdset */
119 1.1 cliff .program_page = NULL, /* cmdset */
120 1.1 cliff .busy = NULL,
121 1.1 cliff .private = NULL,
122 1.1 cliff .access_width = -1,
123 1.1 cliff .part_info = NULL,
124 1.1 cliff .part_num = -1,
125 1.1 cliff };
126 1.1 cliff
127 1.1 cliff
128 1.1 cliff /* only data[7..0] are used regardless of chip width */
129 1.1 cliff #define cfi_unpack_1(n) ((n) & 0xff)
130 1.1 cliff
131 1.1 cliff /* construct (arbitrarily big endian) uint16_t */
132 1.1 cliff #define cfi_unpack_2(b0, b1) \
133 1.1 cliff ((cfi_unpack_1(b1) << 8) | cfi_unpack_1(b0))
134 1.1 cliff
135 1.1 cliff /* construct (arbitrarily) big endian uint32_t */
136 1.1 cliff #define cfi_unpack_4(b0, b1, b2, b3) \
137 1.1 cliff ((cfi_unpack_1(b3) << 24) | \
138 1.1 cliff (cfi_unpack_1(b2) << 16) | \
139 1.1 cliff (cfi_unpack_1(b1) << 8) | \
140 1.1 cliff (cfi_unpack_1(b0)))
141 1.1 cliff
142 1.1 cliff #define cfi_unpack_qry(qryp, data) \
143 1.1 cliff do { \
144 1.1 cliff (qryp)->qry[0] = cfi_unpack_1(data[0x10]); \
145 1.1 cliff (qryp)->qry[1] = cfi_unpack_1(data[0x11]); \
146 1.1 cliff (qryp)->qry[2] = cfi_unpack_1(data[0x12]); \
147 1.1 cliff (qryp)->id_pri = be16toh(cfi_unpack_2(data[0x13], data[0x14])); \
148 1.1 cliff (qryp)->addr_pri = \
149 1.1 cliff be16toh(cfi_unpack_2(data[0x15], data[0x16])); \
150 1.1 cliff (qryp)->id_alt = be16toh(cfi_unpack_2(data[0x17], data[0x18])); \
151 1.1 cliff (qryp)->addr_alt = \
152 1.1 cliff be16toh(cfi_unpack_2(data[0x19], data[0x1a])); \
153 1.1 cliff (qryp)->vcc_min = cfi_unpack_1(data[0x1b]); \
154 1.1 cliff (qryp)->vcc_max = cfi_unpack_1(data[0x1c]); \
155 1.1 cliff (qryp)->vpp_min = cfi_unpack_1(data[0x1d]); \
156 1.1 cliff (qryp)->vpp_max = cfi_unpack_1(data[0x1e]); \
157 1.1 cliff (qryp)->write_word_time_typ = cfi_unpack_1(data[0x1f]); \
158 1.1 cliff (qryp)->write_nbyte_time_typ = cfi_unpack_1(data[0x20]); \
159 1.1 cliff (qryp)->erase_blk_time_typ = cfi_unpack_1(data[0x21]); \
160 1.1 cliff (qryp)->erase_chiptime_typ = cfi_unpack_1(data[0x22]); \
161 1.1 cliff (qryp)->write_word_time_max = cfi_unpack_1(data[0x23]); \
162 1.1 cliff (qryp)->write_nbyte_time_max = cfi_unpack_1(data[0x24]); \
163 1.1 cliff (qryp)->erase_blk_time_max = cfi_unpack_1(data[0x25]); \
164 1.1 cliff (qryp)->erase_chiptime_max = cfi_unpack_1(data[0x26]); \
165 1.1 cliff (qryp)->device_size = cfi_unpack_1(data[0x27]); \
166 1.1 cliff (qryp)->interface_code_desc = \
167 1.1 cliff be16toh(cfi_unpack_2(data[0x28], data[0x29])); \
168 1.1 cliff (qryp)->write_nbyte_size_max = \
169 1.1 cliff be16toh(cfi_unpack_2(data[0x2a], data[0x2b])); \
170 1.1 cliff (qryp)->erase_blk_regions = cfi_unpack_1(data[0x2c]); \
171 1.1 cliff u_int _i = 0x2d; \
172 1.1 cliff const u_int _n = (qryp)->erase_blk_regions; \
173 1.1 cliff KASSERT(_n <= 4); \
174 1.1 cliff for (u_int _r = 0; _r < _n; _r++, _i+=4) { \
175 1.1 cliff (qryp)->erase_blk_info[_r].y = \
176 1.1 cliff be32toh(cfi_unpack_2(data[_i+0], data[_i+1])); \
177 1.1 cliff (qryp)->erase_blk_info[_r].z = \
178 1.1 cliff be32toh(cfi_unpack_2(data[_i+2], data[_i+3])); \
179 1.1 cliff } \
180 1.1 cliff } while (0)
181 1.1 cliff
182 1.1 cliff #define cfi_unpack_pri_0002(qryp, data) \
183 1.1 cliff do { \
184 1.1 cliff (qryp)->pri.cmd_0002.pri[0] = cfi_unpack_1(data[0x00]); \
185 1.1 cliff (qryp)->pri.cmd_0002.pri[1] = cfi_unpack_1(data[0x01]); \
186 1.1 cliff (qryp)->pri.cmd_0002.pri[2] = cfi_unpack_1(data[0x02]); \
187 1.1 cliff (qryp)->pri.cmd_0002.version_maj = cfi_unpack_1(data[0x03]); \
188 1.1 cliff (qryp)->pri.cmd_0002.version_min = cfi_unpack_1(data[0x04]); \
189 1.1 cliff (qryp)->pri.cmd_0002.asupt = cfi_unpack_1(data[0x05]); \
190 1.1 cliff (qryp)->pri.cmd_0002.erase_susp = cfi_unpack_1(data[0x06]); \
191 1.1 cliff (qryp)->pri.cmd_0002.sector_prot = cfi_unpack_1(data[0x07]); \
192 1.1 cliff (qryp)->pri.cmd_0002.tmp_sector_unprot = \
193 1.1 cliff cfi_unpack_1(data[0x08]); \
194 1.1 cliff (qryp)->pri.cmd_0002.sector_prot_scheme = \
195 1.1 cliff cfi_unpack_1(data[0x09]); \
196 1.1 cliff (qryp)->pri.cmd_0002.simul_op = cfi_unpack_1(data[0x0a]); \
197 1.1 cliff (qryp)->pri.cmd_0002.burst_mode_type = cfi_unpack_1(data[0x0b]);\
198 1.1 cliff (qryp)->pri.cmd_0002.page_mode_type = cfi_unpack_1(data[0x0c]); \
199 1.1 cliff (qryp)->pri.cmd_0002.acc_min = cfi_unpack_1(data[0x0d]); \
200 1.1 cliff (qryp)->pri.cmd_0002.acc_max = cfi_unpack_1(data[0x0e]); \
201 1.1 cliff (qryp)->pri.cmd_0002.wp_prot = cfi_unpack_1(data[0x0f]); \
202 1.1 cliff /* XXX 1.3 stops here */ \
203 1.1 cliff (qryp)->pri.cmd_0002.prog_susp = cfi_unpack_1(data[0x10]); \
204 1.1 cliff (qryp)->pri.cmd_0002.unlock_bypass = cfi_unpack_1(data[0x11]); \
205 1.1 cliff (qryp)->pri.cmd_0002.sss_size = cfi_unpack_1(data[0x12]); \
206 1.1 cliff (qryp)->pri.cmd_0002.soft_feat = cfi_unpack_1(data[0x13]); \
207 1.1 cliff (qryp)->pri.cmd_0002.page_size = cfi_unpack_1(data[0x14]); \
208 1.1 cliff (qryp)->pri.cmd_0002.erase_susp_time_max = \
209 1.1 cliff cfi_unpack_1(data[0x15]); \
210 1.1 cliff (qryp)->pri.cmd_0002.prog_susp_time_max = \
211 1.1 cliff cfi_unpack_1(data[0x16]); \
212 1.1 cliff (qryp)->pri.cmd_0002.embhwrst_time_max = \
213 1.1 cliff cfi_unpack_1(data[0x38]); \
214 1.1 cliff (qryp)->pri.cmd_0002.hwrst_time_max = \
215 1.1 cliff cfi_unpack_1(data[0x39]); \
216 1.1 cliff } while (0)
217 1.1 cliff
218 1.1 cliff #define CFI_QRY_UNPACK_COMMON(cfi, data, type, found) \
219 1.1 cliff do { \
220 1.1 cliff struct cfi_query_data * const qryp = &cfi->cfi_qry_data; \
221 1.1 cliff \
222 1.1 cliff memset(qryp, 0, sizeof(*qryp)); \
223 1.1 cliff cfi_unpack_qry(qryp, data); \
224 1.1 cliff \
225 1.1 cliff switch (qryp->id_pri) { \
226 1.1 cliff case 0x0002: \
227 1.1 cliff if ((cfi_unpack_1(data[qryp->addr_pri + 0]) == 'P') && \
228 1.1 cliff (cfi_unpack_1(data[qryp->addr_pri + 1]) == 'R') && \
229 1.1 cliff (cfi_unpack_1(data[qryp->addr_pri + 2]) == 'I')) { \
230 1.1 cliff type *pri_data = &data[qryp->addr_pri]; \
231 1.1 cliff cfi_unpack_pri_0002(qryp, pri_data); \
232 1.1 cliff found = true; \
233 1.1 cliff break; \
234 1.1 cliff } \
235 1.1 cliff default: \
236 1.1 cliff printf("%s: unsupported id_pri=%#x\n", \
237 1.1 cliff __func__, qryp->id_pri); \
238 1.1 cliff break; /* unknown command set */ \
239 1.1 cliff } \
240 1.1 cliff } while (0)
241 1.1 cliff
242 1.1 cliff /*
243 1.1 cliff * cfi_chip_query_opmode - determine operational mode based on QRY signature
244 1.1 cliff */
245 1.1 cliff static bool
246 1.1 cliff cfi_chip_query_opmode(struct cfi *cfi, uint8_t *data,
247 1.1 cliff const struct cfi_opmodes *tab, u_int nentries)
248 1.1 cliff {
249 1.1 cliff for (u_int i=0; i < nentries; i++) {
250 1.1 cliff if (memcmp(&data[tab[i].qsa], tab[i].sig, tab[i].len) == 0) {
251 1.1 cliff cfi->cfi_opmode = &tab[i];
252 1.1 cliff return true;
253 1.1 cliff }
254 1.1 cliff }
255 1.1 cliff return false;
256 1.1 cliff }
257 1.1 cliff
258 1.1 cliff static bool
259 1.1 cliff cfi_chip_query_1(struct cfi * const cfi)
260 1.1 cliff {
261 1.1 cliff uint8_t data[0x80];
262 1.1 cliff
263 1.1 cliff bus_space_read_region_1(cfi->cfi_bst, cfi->cfi_bsh, 0, data,
264 1.1 cliff __arraycount(data));
265 1.1 cliff
266 1.1 cliff bool found = cfi_chip_query_opmode(cfi, data, cfi_opmodes_1,
267 1.1 cliff __arraycount(cfi_opmodes_1));
268 1.1 cliff
269 1.1 cliff if (found) {
270 1.1 cliff CFI_QRY_UNPACK_COMMON(cfi, data, uint8_t, found);
271 1.1 cliff }
272 1.1 cliff
273 1.1 cliff return found;
274 1.1 cliff }
275 1.1 cliff
276 1.1 cliff static bool
277 1.1 cliff cfi_chip_query_2(struct cfi * const cfi)
278 1.1 cliff {
279 1.1 cliff uint16_t data[0x80];
280 1.1 cliff
281 1.1 cliff bus_space_read_region_2(cfi->cfi_bst, cfi->cfi_bsh, 0, data,
282 1.1 cliff __arraycount(data));
283 1.1 cliff
284 1.1 cliff bool found = cfi_chip_query_opmode(cfi, (uint8_t *)data,
285 1.1 cliff cfi_opmodes_2, __arraycount(cfi_opmodes_2));
286 1.1 cliff
287 1.1 cliff if (found) {
288 1.1 cliff CFI_QRY_UNPACK_COMMON(cfi, data, uint16_t, found);
289 1.1 cliff }
290 1.1 cliff
291 1.1 cliff return found;
292 1.1 cliff }
293 1.1 cliff
294 1.1 cliff static bool
295 1.1 cliff cfi_chip_query_4(struct cfi * const cfi)
296 1.1 cliff {
297 1.1 cliff uint32_t data[0x80];
298 1.1 cliff
299 1.1 cliff bus_space_read_region_4(cfi->cfi_bst, cfi->cfi_bsh, 0, data,
300 1.1 cliff __arraycount(data));
301 1.1 cliff
302 1.1 cliff bool found = cfi_chip_query_opmode(cfi, (uint8_t *)data,
303 1.1 cliff cfi_opmodes_4, __arraycount(cfi_opmodes_4));
304 1.1 cliff
305 1.1 cliff if (found) {
306 1.1 cliff CFI_QRY_UNPACK_COMMON(cfi, data, uint32_t, found);
307 1.1 cliff }
308 1.1 cliff
309 1.1 cliff return found;
310 1.1 cliff }
311 1.1 cliff
312 1.1 cliff static bool
313 1.1 cliff cfi_chip_query_8(struct cfi * const cfi)
314 1.1 cliff {
315 1.1 cliff #ifdef NOTYET
316 1.1 cliff uint64_t data[0x80];
317 1.1 cliff
318 1.1 cliff bus_space_read_region_8(cfi->cfi_bst, cfi->cfi_bsh, 0, data,
319 1.1 cliff __arraycount(data));
320 1.1 cliff
321 1.1 cliff bool found = cfi_chip_query_opmode(cfi, (uint8_t *)data,
322 1.1 cliff cfi_opmodes_8, __arraycount(cfi_opmodes_8));
323 1.1 cliff
324 1.1 cliff if (found) {
325 1.1 cliff CFI_QRY_UNPACK_COMMON(cfi, data, uint64_t, found);
326 1.1 cliff }
327 1.1 cliff
328 1.1 cliff return found;
329 1.1 cliff #else
330 1.1 cliff return false;
331 1.1 cliff #endif
332 1.1 cliff }
333 1.1 cliff
334 1.1 cliff /*
335 1.1 cliff * cfi_chip_query - detect a CFI chip
336 1.1 cliff *
337 1.1 cliff * fill in the struct cfi as we discover what's there
338 1.1 cliff */
339 1.1 cliff static bool
340 1.1 cliff cfi_chip_query(struct cfi * const cfi)
341 1.1 cliff {
342 1.1 cliff bool found = false;
343 1.1 cliff const bus_size_t cfi_query_offset[] = {
344 1.1 cliff CFI_QUERY_MODE_ADDRESS,
345 1.1 cliff CFI_QUERY_MODE_ALT_ADDRESS
346 1.1 cliff };
347 1.1 cliff
348 1.1 cliff KASSERT(cfi != NULL);
349 1.1 cliff KASSERT(cfi->cfi_bst != NULL);
350 1.1 cliff
351 1.1 cliff for (int j=0; !found && j < __arraycount(cfi_query_offset); j++) {
352 1.1 cliff
353 1.1 cliff cfi_reset_default(cfi);
354 1.1 cliff cfi_cmd(cfi, cfi_query_offset[j], CFI_QUERY_DATA);
355 1.1 cliff
356 1.1 cliff switch(cfi->cfi_portwidth) {
357 1.1 cliff case 0:
358 1.1 cliff found = cfi_chip_query_1(cfi);
359 1.1 cliff break;
360 1.1 cliff case 1:
361 1.1 cliff found = cfi_chip_query_2(cfi);
362 1.1 cliff break;
363 1.1 cliff case 2:
364 1.1 cliff found = cfi_chip_query_4(cfi);
365 1.1 cliff break;
366 1.1 cliff case 3:
367 1.1 cliff found = cfi_chip_query_8(cfi);
368 1.1 cliff break;
369 1.1 cliff default:
370 1.1 cliff panic("%s: bad portwidth %d\n",
371 1.1 cliff __func__, cfi->cfi_portwidth);
372 1.1 cliff }
373 1.1 cliff }
374 1.1 cliff
375 1.1 cliff return found;
376 1.1 cliff }
377 1.1 cliff
378 1.1 cliff /*
379 1.1 cliff * cfi_probe - search for a CFI NOR trying various port & chip widths
380 1.1 cliff *
381 1.1 cliff * NOTE:
382 1.1 cliff * striped NOR chips design not supported yet,
383 1.1 cliff * so force portwidth=chipwidth for now
384 1.1 cliff * eventually permute portwidth seperately
385 1.1 cliff */
386 1.1 cliff bool
387 1.1 cliff cfi_probe(struct cfi * const cfi)
388 1.1 cliff {
389 1.1 cliff bool found;
390 1.1 cliff
391 1.1 cliff KASSERT(cfi != NULL);
392 1.1 cliff
393 1.1 cliff for (u_int cw = 0; cw < 3; cw++) {
394 1.1 cliff cfi->cfi_portwidth = /* XXX */
395 1.1 cliff cfi->cfi_chipwidth = cw;
396 1.1 cliff found = cfi_chip_query(cfi);
397 1.1 cliff if (found)
398 1.1 cliff goto out;
399 1.1 cliff }
400 1.1 cliff out:
401 1.1 cliff cfi_reset_default(cfi); /* exit QRY mode */
402 1.1 cliff return found;
403 1.1 cliff }
404 1.1 cliff
405 1.1 cliff bool
406 1.1 cliff cfi_identify(struct cfi * const cfi)
407 1.1 cliff {
408 1.1 cliff const bus_space_tag_t bst = cfi->cfi_bst;
409 1.1 cliff const bus_space_handle_t bsh = cfi->cfi_bsh;
410 1.1 cliff bool found = true;
411 1.1 cliff
412 1.1 cliff KASSERT(cfi != NULL);
413 1.1 cliff KASSERT(bst != NULL);
414 1.1 cliff
415 1.1 cliff memset(cfi, 0, sizeof(struct cfi)); /* XXX clean slate */
416 1.1 cliff cfi->cfi_bst = bst; /* restore bus space */
417 1.1 cliff cfi->cfi_bsh = bsh; /* " " " */
418 1.1 cliff
419 1.1 cliff /* gather CFI PRQ and PRI data */
420 1.1 cliff if (! cfi_probe(cfi)) {
421 1.1 cliff aprint_debug("%s: cfi_probe failed\n", __func__);
422 1.1 cliff found = false;
423 1.1 cliff goto out;
424 1.1 cliff }
425 1.1 cliff
426 1.1 cliff /* gather ID data if possible */
427 1.1 cliff if (! cfi_jedec_id(cfi)) {
428 1.1 cliff aprint_debug("%s: cfi_jedec_id failed\n", __func__);
429 1.1 cliff goto out;
430 1.1 cliff }
431 1.1 cliff
432 1.1 cliff out:
433 1.1 cliff cfi_reset_default(cfi); /* exit QRY mode */
434 1.1 cliff
435 1.1 cliff return found;
436 1.1 cliff }
437 1.1 cliff
438 1.1 cliff static int
439 1.1 cliff cfi_scan_media(device_t self, struct nor_chip *chip)
440 1.1 cliff {
441 1.1 cliff struct nor_softc *sc = device_private(self);
442 1.1 cliff KASSERT(sc != NULL);
443 1.1 cliff KASSERT(sc->sc_nor_if != NULL);
444 1.1 cliff struct cfi * const cfi = (struct cfi * const)sc->sc_nor_if->private;
445 1.1 cliff KASSERT(cfi != NULL);
446 1.1 cliff
447 1.1 cliff sc->sc_nor_if->access_width = cfi->cfi_portwidth;
448 1.1 cliff
449 1.1 cliff chip->nc_manf_id = cfi->cfi_id_data.id_mid;
450 1.1 cliff chip->nc_dev_id = cfi->cfi_id_data.id_did[0]; /* XXX 3 words */
451 1.1 cliff chip->nc_size = 1 << cfi->cfi_qry_data.device_size;
452 1.1 cliff
453 1.1 cliff /* size of line for Read Buf command */
454 1.1 cliff chip->nc_line_size = 1 << cfi->cfi_qry_data.pri.cmd_0002.page_size;
455 1.1 cliff
456 1.1 cliff /*
457 1.1 cliff * size of erase block
458 1.1 cliff * XXX depends on erase region
459 1.1 cliff */
460 1.1 cliff chip->nc_num_luns = 1;
461 1.1 cliff chip->nc_lun_blocks = cfi->cfi_qry_data.erase_blk_info[0].y + 1;
462 1.1 cliff chip->nc_block_size = cfi->cfi_qry_data.erase_blk_info[0].z * 256;
463 1.1 cliff
464 1.1 cliff switch (cfi->cfi_qry_data.id_pri) {
465 1.1 cliff case 0x0002:
466 1.1 cliff cfi_0002_init(sc, cfi, chip);
467 1.1 cliff break;
468 1.1 cliff default:
469 1.1 cliff return -1;
470 1.1 cliff }
471 1.1 cliff
472 1.1 cliff return 0;
473 1.1 cliff }
474 1.1 cliff
475 1.1 cliff void
476 1.1 cliff cfi_init(device_t self)
477 1.1 cliff {
478 1.1 cliff /* nothing */
479 1.1 cliff }
480 1.1 cliff
481 1.1 cliff static void
482 1.1 cliff cfi_select(device_t self, bool select)
483 1.1 cliff {
484 1.1 cliff /* nothing */
485 1.1 cliff }
486 1.1 cliff
487 1.1 cliff static void
488 1.1 cliff cfi_read_1(device_t self, flash_off_t offset, uint8_t *datap)
489 1.1 cliff {
490 1.1 cliff }
491 1.1 cliff
492 1.1 cliff static void
493 1.1 cliff cfi_read_2(device_t self, flash_off_t offset, uint16_t *datap)
494 1.1 cliff {
495 1.1 cliff }
496 1.1 cliff
497 1.1 cliff static void
498 1.1 cliff cfi_read_4(device_t self, flash_off_t offset, uint32_t *datap)
499 1.1 cliff {
500 1.1 cliff }
501 1.1 cliff
502 1.1 cliff static void
503 1.1 cliff cfi_read_buf_1(device_t self, flash_off_t offset, uint8_t *datap, size_t size)
504 1.1 cliff {
505 1.1 cliff }
506 1.1 cliff
507 1.1 cliff static void
508 1.1 cliff cfi_read_buf_2(device_t self, flash_off_t offset, uint16_t *datap, size_t size)
509 1.1 cliff {
510 1.1 cliff }
511 1.1 cliff
512 1.1 cliff static void
513 1.1 cliff cfi_read_buf_4(device_t self, flash_off_t offset, uint32_t *datap, size_t size)
514 1.1 cliff {
515 1.1 cliff }
516 1.1 cliff
517 1.1 cliff static void
518 1.1 cliff cfi_write_1(device_t self, flash_off_t offset, uint8_t data)
519 1.1 cliff {
520 1.1 cliff }
521 1.1 cliff
522 1.1 cliff static void
523 1.1 cliff cfi_write_2(device_t self, flash_off_t offset, uint16_t data)
524 1.1 cliff {
525 1.1 cliff }
526 1.1 cliff
527 1.1 cliff static void
528 1.1 cliff cfi_write_4(device_t self, flash_off_t offset, uint32_t data)
529 1.1 cliff {
530 1.1 cliff }
531 1.1 cliff
532 1.1 cliff static void
533 1.1 cliff cfi_write_buf_1(device_t self, flash_off_t offset, const uint8_t *datap,
534 1.1 cliff size_t size)
535 1.1 cliff {
536 1.1 cliff }
537 1.1 cliff
538 1.1 cliff static void
539 1.1 cliff cfi_write_buf_2(device_t self, flash_off_t offset, const uint16_t *datap,
540 1.1 cliff size_t size)
541 1.1 cliff {
542 1.1 cliff }
543 1.1 cliff
544 1.1 cliff static void
545 1.1 cliff cfi_write_buf_4(device_t self, flash_off_t offset, const uint32_t *datap,
546 1.1 cliff size_t size)
547 1.1 cliff {
548 1.1 cliff }
549 1.1 cliff
550 1.1 cliff void
551 1.1 cliff cfi_cmd(struct cfi * const cfi, bus_size_t off, uint32_t val)
552 1.1 cliff {
553 1.1 cliff const bus_space_tag_t bst = cfi->cfi_bst;
554 1.1 cliff bus_space_handle_t bsh = cfi->cfi_bsh;
555 1.1 cliff
556 1.1 cliff off <<= cfi->cfi_portwidth;
557 1.1 cliff
558 1.1 cliff DPRINTF(("%s: %p %x %x %x\n", __func__, bst, bsh, off, val));
559 1.1 cliff
560 1.1 cliff switch(cfi->cfi_portwidth) {
561 1.1 cliff case 0:
562 1.1 cliff bus_space_write_1(bst, bsh, off, (uint8_t)val);
563 1.1 cliff break;
564 1.1 cliff case 1:
565 1.1 cliff bus_space_write_2(bst, bsh, off, val);
566 1.1 cliff break;
567 1.1 cliff case 2:
568 1.1 cliff bus_space_write_4(bst, bsh, off, (uint32_t)val);
569 1.1 cliff break;
570 1.1 cliff #ifdef NOTYET
571 1.1 cliff case 3:
572 1.1 cliff bus_space_write_4(bst, bsh, off, (uint64_t)val);
573 1.1 cliff break;
574 1.1 cliff #endif
575 1.1 cliff default:
576 1.1 cliff panic("%s: bad portwidth %d bytes\n",
577 1.1 cliff __func__, 1 << cfi->cfi_portwidth);
578 1.1 cliff }
579 1.1 cliff }
580 1.1 cliff
581 1.1 cliff /*
582 1.1 cliff * cfi_reset_default - when we don't know which command will work, use both
583 1.1 cliff */
584 1.1 cliff void
585 1.1 cliff cfi_reset_default(struct cfi * const cfi)
586 1.1 cliff {
587 1.1 cliff cfi_cmd(cfi, CFI_ADDRESS_ANY, CFI_RESET_DATA);
588 1.1 cliff cfi_cmd(cfi, CFI_ADDRESS_ANY, CFI_ALT_RESET_DATA);
589 1.1 cliff }
590 1.1 cliff
591 1.1 cliff /*
592 1.1 cliff * cfi_reset_std - use standard reset command
593 1.1 cliff */
594 1.1 cliff void
595 1.1 cliff cfi_reset_std(struct cfi * const cfi)
596 1.1 cliff {
597 1.1 cliff cfi_cmd(cfi, CFI_ADDRESS_ANY, CFI_RESET_DATA);
598 1.1 cliff }
599 1.1 cliff
600 1.1 cliff /*
601 1.1 cliff * cfi_reset_alt - use "alternate" reset command
602 1.1 cliff */
603 1.1 cliff void
604 1.1 cliff cfi_reset_alt(struct cfi * const cfi)
605 1.1 cliff {
606 1.1 cliff cfi_cmd(cfi, CFI_ADDRESS_ANY, CFI_ALT_RESET_DATA);
607 1.1 cliff }
608 1.1 cliff
609 1.1 cliff static void
610 1.1 cliff cfi_jedec_id_2(struct cfi * const cfi)
611 1.1 cliff {
612 1.1 cliff struct cfi_jedec_id_data *idp = &cfi->cfi_id_data;
613 1.1 cliff uint16_t data[0x10];
614 1.1 cliff
615 1.1 cliff bus_space_read_region_2(cfi->cfi_bst, cfi->cfi_bsh, 0, data,
616 1.1 cliff __arraycount(data));
617 1.1 cliff
618 1.1 cliff idp->id_mid = data[0];
619 1.1 cliff idp->id_did[0] = data[1];
620 1.1 cliff idp->id_did[1] = data[0xe];
621 1.1 cliff idp->id_did[2] = data[0xf];
622 1.1 cliff idp->id_prot_state = data[2];
623 1.1 cliff idp->id_indicators = data[3];
624 1.1 cliff
625 1.1 cliff /* software bits, upper and lower
626 1.1 cliff * - undefined on S29GL-P
627 1.1 cliff * - defined on S29GL-S
628 1.1 cliff */
629 1.1 cliff idp->id_swb_lo = data[0xc];
630 1.1 cliff idp->id_swb_hi = data[0xd];
631 1.1 cliff }
632 1.1 cliff
633 1.1 cliff /*
634 1.1 cliff * cfi_jedec_id - get JEDEC ID info
635 1.1 cliff *
636 1.1 cliff * this should be ignored altogether for CFI chips?
637 1.1 cliff * JEDEC ID is superceded by CFI info except CFI is not
638 1.1 cliff * a true superset of the JEDEC, so some info provided
639 1.1 cliff * by JEDEC is not available via CFI QRY.
640 1.1 cliff * But the JEDEC info is unreliable:
641 1.1 cliff * - different chips not distinguishaable by IDs
642 1.1 cliff * - some fields undefined (read as 0xff) on some chips
643 1.1 cliff */
644 1.1 cliff static bool
645 1.1 cliff cfi_jedec_id(struct cfi * const cfi)
646 1.1 cliff {
647 1.1 cliff DPRINTF(("%s\n", __func__));
648 1.1 cliff
649 1.1 cliff cfi_cmd(cfi, 0x555, 0xaa);
650 1.1 cliff cfi_cmd(cfi, 0x2aa, 0x55);
651 1.1 cliff cfi_cmd(cfi, 0x555, 0x90);
652 1.1 cliff
653 1.1 cliff switch(cfi->cfi_portwidth) {
654 1.1 cliff case 1:
655 1.1 cliff cfi_jedec_id_2(cfi);
656 1.1 cliff break;
657 1.1 cliff #ifdef NOTYET
658 1.1 cliff case 0:
659 1.1 cliff cfi_jedec_id_1(cfi);
660 1.1 cliff break;
661 1.1 cliff case 2:
662 1.1 cliff cfi_jedec_id_4(cfi);
663 1.1 cliff break;
664 1.1 cliff case 3:
665 1.1 cliff cfi_jedec_id_8(cfi);
666 1.1 cliff break;
667 1.1 cliff #endif
668 1.1 cliff default:
669 1.1 cliff panic("%s: bad portwidth %d bytes\n",
670 1.1 cliff __func__, 1 << cfi->cfi_portwidth);
671 1.1 cliff }
672 1.1 cliff
673 1.1 cliff return true;
674 1.1 cliff }
675 1.1 cliff
676 1.1 cliff void
677 1.1 cliff cfi_print(device_t self, struct cfi * const cfi)
678 1.1 cliff {
679 1.1 cliff char pbuf[sizeof("XXXX MB")];
680 1.1 cliff struct cfi_query_data * const qryp = &cfi->cfi_qry_data;
681 1.1 cliff
682 1.1 cliff format_bytes(pbuf, sizeof(pbuf), 1 << qryp->device_size);
683 1.1 cliff aprint_normal_dev(self, "CFI NOR flash %s %s\n", pbuf,
684 1.1 cliff cfi_interface_desc_str(qryp->interface_code_desc));
685 1.1 cliff #ifdef NOR_VERBOSE
686 1.1 cliff aprint_normal_dev(self, "manufacturer id %#x, device id %#x %#x %#x\n",
687 1.1 cliff cfi->cfi_id_data.id_mid,
688 1.1 cliff cfi->cfi_id_data.id_did[0],
689 1.1 cliff cfi->cfi_id_data.id_did[1],
690 1.1 cliff cfi->cfi_id_data.id_did[2]);
691 1.1 cliff aprint_normal_dev(self, "%s\n", cfi->cfi_opmode->str);
692 1.1 cliff aprint_normal_dev(self, "sw bits lo=%#x hi=%#x\n",
693 1.1 cliff cfi->cfi_id_data.id_swb_lo,
694 1.1 cliff cfi->cfi_id_data.id_swb_hi);
695 1.1 cliff aprint_normal_dev(self, "max multibyte write size %d\n",
696 1.1 cliff 1 << qryp->write_nbyte_size_max);
697 1.1 cliff aprint_normal_dev(self, "%d Erase Block Region(s)\n",
698 1.1 cliff qryp->erase_blk_regions);
699 1.1 cliff for (u_int r=0; r < qryp->erase_blk_regions; r++) {
700 1.1 cliff size_t sz = qryp->erase_blk_info[r].z * 256;
701 1.1 cliff format_bytes(pbuf, sizeof(pbuf), sz);
702 1.1 cliff aprint_normal(" %d: %d blocks, size %s\n", r,
703 1.1 cliff qryp->erase_blk_info[r].y + 1, pbuf);
704 1.1 cliff }
705 1.1 cliff #endif
706 1.1 cliff
707 1.1 cliff switch (cfi->cfi_qry_data.id_pri) {
708 1.1 cliff case 0x0002:
709 1.1 cliff cfi_0002_print(self, cfi);
710 1.1 cliff break;
711 1.1 cliff }
712 1.1 cliff }
713