nandemulator.c revision 1.1.4.4 1 1.1.4.2 rmind /* $NetBSD: nandemulator.c,v 1.1.4.4 2011/05/31 03:04:39 rmind Exp $ */
2 1.1.4.2 rmind
3 1.1.4.2 rmind /*-
4 1.1.4.2 rmind * Copyright (c) 2011 Department of Software Engineering,
5 1.1.4.2 rmind * University of Szeged, Hungary
6 1.1.4.2 rmind * Copyright (c) 2011 Adam Hoka <ahoka (at) NetBSD.org>
7 1.1.4.2 rmind * All rights reserved.
8 1.1.4.2 rmind *
9 1.1.4.2 rmind * This code is derived from software contributed to The NetBSD Foundation
10 1.1.4.2 rmind * by the Department of Software Engineering, University of Szeged, Hungary
11 1.1.4.2 rmind *
12 1.1.4.2 rmind * Redistribution and use in source and binary forms, with or without
13 1.1.4.2 rmind * modification, are permitted provided that the following conditions
14 1.1.4.2 rmind * are met:
15 1.1.4.2 rmind * 1. Redistributions of source code must retain the above copyright
16 1.1.4.2 rmind * notice, this list of conditions and the following disclaimer.
17 1.1.4.2 rmind * 2. Redistributions in binary form must reproduce the above copyright
18 1.1.4.2 rmind * notice, this list of conditions and the following disclaimer in the
19 1.1.4.2 rmind * documentation and/or other materials provided with the distribution.
20 1.1.4.2 rmind *
21 1.1.4.2 rmind * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 1.1.4.2 rmind * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 1.1.4.2 rmind * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 1.1.4.2 rmind * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 1.1.4.2 rmind * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 1.1.4.2 rmind * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 1.1.4.2 rmind * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 1.1.4.2 rmind * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 1.1.4.2 rmind * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 1.1.4.2 rmind * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 1.1.4.2 rmind * SUCH DAMAGE.
32 1.1.4.2 rmind */
33 1.1.4.2 rmind
34 1.1.4.2 rmind #include <sys/cdefs.h>
35 1.1.4.2 rmind __KERNEL_RCSID(0, "$NetBSD: nandemulator.c,v 1.1.4.4 2011/05/31 03:04:39 rmind Exp $");
36 1.1.4.2 rmind
37 1.1.4.2 rmind #include <sys/param.h>
38 1.1.4.2 rmind #include <sys/device.h>
39 1.1.4.2 rmind #include <sys/conf.h>
40 1.1.4.2 rmind #include <sys/kmem.h>
41 1.1.4.2 rmind #include <sys/kernel.h>
42 1.1.4.2 rmind
43 1.1.4.2 rmind #include "nandemulator.h"
44 1.1.4.2 rmind
45 1.1.4.2 rmind #include <dev/nand/nand.h>
46 1.1.4.2 rmind #include <dev/nand/onfi.h>
47 1.1.4.2 rmind #include <dev/nand/nand_crc.h>
48 1.1.4.2 rmind
49 1.1.4.2 rmind extern struct cfdriver nandemulator_cd;
50 1.1.4.2 rmind void nandemulatorattach(int n);
51 1.1.4.2 rmind
52 1.1.4.2 rmind static int nandemulator_match(device_t, cfdata_t, void *);
53 1.1.4.2 rmind static void nandemulator_attach(device_t, device_t, void *);
54 1.1.4.2 rmind static int nandemulator_detach(device_t, int);
55 1.1.4.2 rmind
56 1.1.4.2 rmind static void nandemulator_device_reset(device_t);
57 1.1.4.2 rmind static void nandemulator_command(device_t, uint8_t);
58 1.1.4.2 rmind static void nandemulator_address(device_t, uint8_t);
59 1.1.4.2 rmind static void nandemulator_busy(device_t);
60 1.1.4.2 rmind static void nandemulator_read_byte(device_t, uint8_t *);
61 1.1.4.2 rmind static void nandemulator_write_byte(device_t, uint8_t);
62 1.1.4.2 rmind static void nandemulator_read_word(device_t, uint16_t *);
63 1.1.4.2 rmind static void nandemulator_write_word(device_t, uint16_t);
64 1.1.4.2 rmind static void nandemulator_read_buf_byte(device_t, void *, size_t);
65 1.1.4.2 rmind static void nandemulator_read_buf_word(device_t, void *, size_t);
66 1.1.4.2 rmind static void nandemulator_write_buf_byte(device_t, const void *, size_t);
67 1.1.4.2 rmind static void nandemulator_write_buf_word(device_t, const void *, size_t);
68 1.1.4.2 rmind
69 1.1.4.2 rmind static size_t nandemulator_address_to_page(device_t);
70 1.1.4.2 rmind static size_t nandemulator_page_to_backend_offset(device_t, size_t);
71 1.1.4.2 rmind static size_t nandemulator_column_address_to_subpage(device_t);
72 1.1.4.2 rmind /*
73 1.1.4.2 rmind #define NANDEMULATOR_DEBUG 1
74 1.1.4.2 rmind
75 1.1.4.2 rmind #ifdef NANDEMULATOR_DEBUG
76 1.1.4.2 rmind #warning debug enabled
77 1.1.4.2 rmind #define DPRINTF(x) if (nandemulatordebug) printf x
78 1.1.4.2 rmind #define DPRINTFN(n,x) if (nandemulatordebug>(n)) printf x
79 1.1.4.2 rmind #else
80 1.1.4.2 rmind #error no debug
81 1.1.4.2 rmind #define DPRINTF(x)
82 1.1.4.2 rmind #define DPRINTFN(n,x)
83 1.1.4.2 rmind #endif
84 1.1.4.2 rmind
85 1.1.4.2 rmind #ifdef NANDEMULATOR_DEBUG
86 1.1.4.2 rmind int nandemulatordebug = NANDEMULATOR_DEBUG;
87 1.1.4.2 rmind #endif
88 1.1.4.2 rmind */
89 1.1.4.2 rmind
90 1.1.4.2 rmind extern int nanddebug;
91 1.1.4.2 rmind
92 1.1.4.2 rmind enum {
93 1.1.4.2 rmind NANDEMULATOR_8BIT,
94 1.1.4.2 rmind NANDEMULATOR_16BIT
95 1.1.4.2 rmind };
96 1.1.4.2 rmind
97 1.1.4.2 rmind struct nandemulator_softc {
98 1.1.4.2 rmind device_t sc_dev;
99 1.1.4.2 rmind device_t sc_nanddev;
100 1.1.4.2 rmind
101 1.1.4.2 rmind int sc_buswidth;
102 1.1.4.2 rmind
103 1.1.4.2 rmind struct nand_interface sc_nand_if;
104 1.1.4.2 rmind
105 1.1.4.2 rmind uint8_t sc_command;
106 1.1.4.2 rmind size_t sc_io_len;
107 1.1.4.2 rmind uint8_t *sc_io_pointer;
108 1.1.4.2 rmind uint64_t sc_address;
109 1.1.4.2 rmind
110 1.1.4.2 rmind uint8_t *sc_backend;
111 1.1.4.2 rmind size_t sc_backend_size;
112 1.1.4.2 rmind size_t sc_device_size;
113 1.1.4.2 rmind bool sc_register_writable;
114 1.1.4.2 rmind
115 1.1.4.2 rmind uint8_t sc_status_register;
116 1.1.4.2 rmind uint8_t sc_ids[2];
117 1.1.4.2 rmind uint8_t sc_onfi[4];
118 1.1.4.2 rmind
119 1.1.4.2 rmind size_t sc_page_size;
120 1.1.4.2 rmind size_t sc_block_size;
121 1.1.4.2 rmind size_t sc_spare_size;
122 1.1.4.2 rmind size_t sc_lun_size;
123 1.1.4.2 rmind uint8_t sc_row_cycles;
124 1.1.4.2 rmind uint8_t sc_column_cycles;
125 1.1.4.2 rmind uint64_t sc_row_mask;
126 1.1.4.2 rmind
127 1.1.4.2 rmind int sc_address_counter;
128 1.1.4.2 rmind
129 1.1.4.2 rmind struct onfi_parameter_page *sc_parameter_page;
130 1.1.4.2 rmind };
131 1.1.4.2 rmind
132 1.1.4.2 rmind CFATTACH_DECL_NEW(nandemulator, sizeof(struct nandemulator_softc),
133 1.1.4.2 rmind nandemulator_match, nandemulator_attach, nandemulator_detach, NULL);
134 1.1.4.2 rmind
135 1.1.4.2 rmind void
136 1.1.4.2 rmind nandemulatorattach(int n)
137 1.1.4.2 rmind {
138 1.1.4.2 rmind int i, err;
139 1.1.4.2 rmind cfdata_t cf;
140 1.1.4.2 rmind
141 1.1.4.2 rmind aprint_debug("nandemulator: requested %d units\n", n);
142 1.1.4.2 rmind
143 1.1.4.2 rmind err = config_cfattach_attach(nandemulator_cd.cd_name,
144 1.1.4.2 rmind &nandemulator_ca);
145 1.1.4.2 rmind if (err) {
146 1.1.4.2 rmind aprint_error("%s: couldn't register cfattach: %d\n",
147 1.1.4.2 rmind nandemulator_cd.cd_name, err);
148 1.1.4.2 rmind config_cfdriver_detach(&nandemulator_cd);
149 1.1.4.2 rmind return;
150 1.1.4.2 rmind }
151 1.1.4.2 rmind for (i = 0; i < n; i++) {
152 1.1.4.2 rmind cf = kmem_alloc(sizeof(struct cfdata), KM_NOSLEEP);
153 1.1.4.2 rmind if (cf == NULL) {
154 1.1.4.2 rmind aprint_error("%s: couldn't allocate cfdata\n",
155 1.1.4.2 rmind nandemulator_cd.cd_name);
156 1.1.4.2 rmind continue;
157 1.1.4.2 rmind }
158 1.1.4.2 rmind cf->cf_name = nandemulator_cd.cd_name;
159 1.1.4.2 rmind cf->cf_atname = nandemulator_cd.cd_name;
160 1.1.4.2 rmind cf->cf_unit = i;
161 1.1.4.2 rmind cf->cf_fstate = FSTATE_STAR;
162 1.1.4.2 rmind
163 1.1.4.2 rmind (void)config_attach_pseudo(cf);
164 1.1.4.2 rmind }
165 1.1.4.2 rmind }
166 1.1.4.2 rmind
167 1.1.4.2 rmind /* ARGSUSED */
168 1.1.4.2 rmind static int
169 1.1.4.2 rmind nandemulator_match(device_t parent, cfdata_t match, void *aux)
170 1.1.4.2 rmind {
171 1.1.4.2 rmind /* pseudo device, always attaches */
172 1.1.4.2 rmind return 1;
173 1.1.4.2 rmind }
174 1.1.4.2 rmind
175 1.1.4.2 rmind static void
176 1.1.4.2 rmind nandemulator_attach(device_t parent, device_t self, void *aux)
177 1.1.4.2 rmind {
178 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
179 1.1.4.2 rmind int i;
180 1.1.4.2 rmind
181 1.1.4.2 rmind aprint_normal_dev(self, "NAND emulator\n");
182 1.1.4.2 rmind
183 1.1.4.2 rmind sc->sc_dev = self;
184 1.1.4.2 rmind
185 1.1.4.3 rmind nand_init_interface(&sc->sc_nand_if);
186 1.1.4.3 rmind
187 1.1.4.2 rmind sc->sc_nand_if.command = &nandemulator_command;
188 1.1.4.2 rmind sc->sc_nand_if.address = &nandemulator_address;
189 1.1.4.2 rmind sc->sc_nand_if.read_buf_byte = &nandemulator_read_buf_byte;
190 1.1.4.2 rmind sc->sc_nand_if.read_buf_word = &nandemulator_read_buf_word;
191 1.1.4.2 rmind sc->sc_nand_if.read_byte = &nandemulator_read_byte;
192 1.1.4.2 rmind sc->sc_nand_if.read_word = &nandemulator_read_word;
193 1.1.4.2 rmind sc->sc_nand_if.write_buf_byte = &nandemulator_write_buf_byte;
194 1.1.4.2 rmind sc->sc_nand_if.write_buf_word = &nandemulator_write_buf_word;
195 1.1.4.2 rmind sc->sc_nand_if.write_byte = &nandemulator_write_byte;
196 1.1.4.2 rmind sc->sc_nand_if.write_word = &nandemulator_write_word;
197 1.1.4.2 rmind sc->sc_nand_if.busy = &nandemulator_busy;
198 1.1.4.2 rmind
199 1.1.4.2 rmind sc->sc_nand_if.ecc.necc_code_size = 3;
200 1.1.4.2 rmind sc->sc_nand_if.ecc.necc_block_size = 256;
201 1.1.4.2 rmind
202 1.1.4.2 rmind if (!pmf_device_register1(sc->sc_dev, NULL, NULL, NULL))
203 1.1.4.2 rmind aprint_error_dev(sc->sc_dev,
204 1.1.4.2 rmind "couldn't establish power handler\n");
205 1.1.4.2 rmind
206 1.1.4.2 rmind sc->sc_buswidth = NANDEMULATOR_16BIT; /* 16bit for now */
207 1.1.4.2 rmind
208 1.1.4.2 rmind /* hardcode these now, make it configurable later */
209 1.1.4.2 rmind sc->sc_device_size = 32 * 1024 * 1024; /* 32MB */
210 1.1.4.2 rmind sc->sc_page_size = 2048;
211 1.1.4.2 rmind sc->sc_block_size = 64;
212 1.1.4.2 rmind sc->sc_lun_size =
213 1.1.4.2 rmind sc->sc_device_size / (sc->sc_page_size * sc->sc_block_size);
214 1.1.4.2 rmind KASSERT(sc->sc_device_size %
215 1.1.4.2 rmind (sc->sc_page_size * sc->sc_block_size) == 0);
216 1.1.4.2 rmind sc->sc_spare_size = 64;
217 1.1.4.2 rmind
218 1.1.4.2 rmind sc->sc_column_cycles = 2;
219 1.1.4.2 rmind sc->sc_row_cycles = 3;
220 1.1.4.2 rmind
221 1.1.4.2 rmind /* init the emulator data structures */
222 1.1.4.2 rmind sc->sc_backend_size =
223 1.1.4.2 rmind sc->sc_device_size +
224 1.1.4.2 rmind sc->sc_device_size / sc->sc_page_size * sc->sc_spare_size;
225 1.1.4.2 rmind
226 1.1.4.2 rmind sc->sc_backend = kmem_alloc(sc->sc_backend_size, KM_SLEEP);
227 1.1.4.2 rmind memset(sc->sc_backend, 0xff, sc->sc_backend_size);
228 1.1.4.2 rmind
229 1.1.4.2 rmind sc->sc_parameter_page =
230 1.1.4.2 rmind kmem_zalloc(sizeof(struct onfi_parameter_page) * 4, KM_SLEEP);
231 1.1.4.2 rmind
232 1.1.4.2 rmind struct onfi_parameter_page *opp;
233 1.1.4.2 rmind uint8_t sig[4] = { 'O', 'N', 'F', 'I' };
234 1.1.4.2 rmind
235 1.1.4.2 rmind for (i = 0; i < 4; i++) {
236 1.1.4.2 rmind opp = &sc->sc_parameter_page[i];
237 1.1.4.2 rmind
238 1.1.4.2 rmind opp->param_signature = *(uint32_t *)sig;
239 1.1.4.2 rmind opp->param_pagesize = sc->sc_page_size;
240 1.1.4.2 rmind opp->param_blocksize = sc->sc_block_size;
241 1.1.4.2 rmind opp->param_sparesize = sc->sc_spare_size;
242 1.1.4.2 rmind opp->param_lunsize = sc->sc_lun_size;
243 1.1.4.2 rmind opp->param_numluns = 1;
244 1.1.4.2 rmind
245 1.1.4.2 rmind opp->param_manufacturer_id = 0x00;
246 1.1.4.2 rmind memcpy(opp->param_manufacturer,
247 1.1.4.2 rmind "NETBSD", strlen("NETBSD"));
248 1.1.4.2 rmind memcpy(opp->param_model,
249 1.1.4.2 rmind "NANDEMULATOR", strlen("NANDEMULATOR"));
250 1.1.4.2 rmind
251 1.1.4.2 rmind opp->param_features = ONFI_FEATURE_16BIT;
252 1.1.4.2 rmind
253 1.1.4.2 rmind /* the lower 4 bits contain the row address cycles
254 1.1.4.2 rmind * the upper 4 bits contain the column address cycles
255 1.1.4.2 rmind */
256 1.1.4.2 rmind opp->param_addr_cycles = sc->sc_row_cycles;
257 1.1.4.2 rmind opp->param_addr_cycles |= (sc->sc_column_cycles << 4);
258 1.1.4.2 rmind
259 1.1.4.2 rmind opp->param_integrity_crc = nand_crc16((uint8_t *)opp, 254);
260 1.1.4.2 rmind }
261 1.1.4.2 rmind
262 1.1.4.2 rmind sc->sc_ids[0] = 0x00;
263 1.1.4.2 rmind sc->sc_ids[1] = 0x00;
264 1.1.4.2 rmind
265 1.1.4.2 rmind sc->sc_onfi[0] = 'O';
266 1.1.4.2 rmind sc->sc_onfi[1] = 'N';
267 1.1.4.2 rmind sc->sc_onfi[2] = 'F';
268 1.1.4.2 rmind sc->sc_onfi[3] = 'I';
269 1.1.4.2 rmind
270 1.1.4.2 rmind sc->sc_row_mask = 0x00;
271 1.1.4.2 rmind for (i = 0; i < sc->sc_row_cycles; i++) {
272 1.1.4.2 rmind sc->sc_row_mask <<= 8;
273 1.1.4.2 rmind sc->sc_row_mask |= 0xff;
274 1.1.4.2 rmind }
275 1.1.4.2 rmind
276 1.1.4.2 rmind nandemulator_device_reset(self);
277 1.1.4.2 rmind
278 1.1.4.2 rmind sc->sc_nanddev = nand_attach_mi(&sc->sc_nand_if, sc->sc_dev);
279 1.1.4.2 rmind }
280 1.1.4.2 rmind
281 1.1.4.2 rmind static int
282 1.1.4.2 rmind nandemulator_detach(device_t self, int flags)
283 1.1.4.2 rmind {
284 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
285 1.1.4.2 rmind int ret = 0;
286 1.1.4.2 rmind
287 1.1.4.2 rmind aprint_normal_dev(sc->sc_dev, "detaching emulator\n");
288 1.1.4.2 rmind
289 1.1.4.2 rmind pmf_device_deregister(sc->sc_dev);
290 1.1.4.2 rmind
291 1.1.4.2 rmind if (sc->sc_nanddev != NULL)
292 1.1.4.2 rmind ret = config_detach(sc->sc_nanddev, flags);
293 1.1.4.2 rmind
294 1.1.4.2 rmind kmem_free(sc->sc_backend, sc->sc_backend_size);
295 1.1.4.2 rmind kmem_free(sc->sc_parameter_page,
296 1.1.4.2 rmind sizeof(struct onfi_parameter_page) * 4);
297 1.1.4.2 rmind
298 1.1.4.2 rmind return ret;
299 1.1.4.2 rmind }
300 1.1.4.2 rmind
301 1.1.4.2 rmind /**
302 1.1.4.2 rmind * bring the emulated device to a known state
303 1.1.4.2 rmind */
304 1.1.4.2 rmind static void
305 1.1.4.2 rmind nandemulator_device_reset(device_t self)
306 1.1.4.2 rmind {
307 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
308 1.1.4.2 rmind
309 1.1.4.3 rmind DPRINTF(("device reset\n"));
310 1.1.4.3 rmind
311 1.1.4.2 rmind sc->sc_command = 0;
312 1.1.4.2 rmind sc->sc_register_writable = false;
313 1.1.4.2 rmind sc->sc_io_len = 0;
314 1.1.4.2 rmind sc->sc_io_pointer = NULL;
315 1.1.4.2 rmind sc->sc_address = 0;
316 1.1.4.2 rmind sc->sc_address_counter = 0;
317 1.1.4.2 rmind
318 1.1.4.2 rmind sc->sc_status_register = ONFI_STATUS_RDY | ONFI_STATUS_WP;
319 1.1.4.2 rmind }
320 1.1.4.2 rmind
321 1.1.4.2 rmind static void
322 1.1.4.2 rmind nandemulator_address_chip(device_t self)
323 1.1.4.2 rmind {
324 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
325 1.1.4.2 rmind size_t page, offset;
326 1.1.4.3 rmind
327 1.1.4.3 rmind KASSERT(sc->sc_address_counter ==
328 1.1.4.3 rmind sc->sc_column_cycles + sc->sc_row_cycles);
329 1.1.4.2 rmind
330 1.1.4.2 rmind if (sc->sc_address_counter !=
331 1.1.4.2 rmind sc->sc_column_cycles + sc->sc_row_cycles) {
332 1.1.4.2 rmind aprint_error_dev(self, "incorrect number of address cycles\n");
333 1.1.4.2 rmind aprint_error_dev(self, "cc: %d, rc: %d, ac: %d\n",
334 1.1.4.2 rmind sc->sc_column_cycles, sc->sc_row_cycles,
335 1.1.4.2 rmind sc->sc_address_counter);
336 1.1.4.2 rmind }
337 1.1.4.2 rmind
338 1.1.4.2 rmind page = nandemulator_address_to_page(self);
339 1.1.4.2 rmind offset = sc->sc_page_size * page;
340 1.1.4.2 rmind
341 1.1.4.2 rmind DPRINTF(("READ/PROGRAM; page: 0x%jx (row addr: 0x%jx)\n",
342 1.1.4.2 rmind (uintmax_t )page,
343 1.1.4.2 rmind (uintmax_t )offset));
344 1.1.4.2 rmind
345 1.1.4.3 rmind KASSERT(offset < sc->sc_device_size);
346 1.1.4.3 rmind
347 1.1.4.2 rmind if (offset >= sc->sc_device_size) {
348 1.1.4.2 rmind aprint_error_dev(self, "address > device size!\n");
349 1.1.4.2 rmind sc->sc_io_len = 0;
350 1.1.4.2 rmind } else {
351 1.1.4.2 rmind size_t addr =
352 1.1.4.2 rmind nandemulator_page_to_backend_offset(self, page);
353 1.1.4.2 rmind size_t pageoff =
354 1.1.4.2 rmind nandemulator_column_address_to_subpage(self);
355 1.1.4.2 rmind
356 1.1.4.2 rmind DPRINTF(("subpage: 0x%jx\n", (uintmax_t )pageoff));
357 1.1.4.2 rmind
358 1.1.4.2 rmind KASSERT(pageoff <
359 1.1.4.2 rmind sc->sc_page_size + sc->sc_spare_size);
360 1.1.4.2 rmind KASSERT(addr < sc->sc_backend_size);
361 1.1.4.2 rmind
362 1.1.4.2 rmind sc->sc_io_pointer = sc->sc_backend + addr + pageoff;
363 1.1.4.2 rmind sc->sc_io_len =
364 1.1.4.2 rmind sc->sc_page_size + sc->sc_spare_size - pageoff;
365 1.1.4.2 rmind }
366 1.1.4.2 rmind }
367 1.1.4.2 rmind
368 1.1.4.2 rmind static void
369 1.1.4.2 rmind nandemulator_command(device_t self, uint8_t command)
370 1.1.4.2 rmind {
371 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
372 1.1.4.2 rmind size_t offset, page;
373 1.1.4.2 rmind
374 1.1.4.2 rmind sc->sc_command = command;
375 1.1.4.2 rmind sc->sc_register_writable = false;
376 1.1.4.2 rmind
377 1.1.4.2 rmind DPRINTF(("nandemulator command: 0x%hhx\n", command));
378 1.1.4.2 rmind
379 1.1.4.2 rmind switch (command) {
380 1.1.4.2 rmind case ONFI_READ_STATUS:
381 1.1.4.2 rmind sc->sc_io_pointer = &sc->sc_status_register;
382 1.1.4.2 rmind sc->sc_io_len = 1;
383 1.1.4.2 rmind break;
384 1.1.4.2 rmind case ONFI_RESET:
385 1.1.4.2 rmind nandemulator_device_reset(self);
386 1.1.4.2 rmind break;
387 1.1.4.2 rmind case ONFI_PAGE_PROGRAM:
388 1.1.4.2 rmind sc->sc_register_writable = true;
389 1.1.4.2 rmind case ONFI_READ:
390 1.1.4.2 rmind case ONFI_BLOCK_ERASE:
391 1.1.4.2 rmind sc->sc_address_counter = 0;
392 1.1.4.2 rmind case ONFI_READ_ID:
393 1.1.4.2 rmind case ONFI_READ_PARAMETER_PAGE:
394 1.1.4.2 rmind sc->sc_io_len = 0;
395 1.1.4.2 rmind sc->sc_address = 0;
396 1.1.4.2 rmind break;
397 1.1.4.2 rmind case ONFI_PAGE_PROGRAM_START:
398 1.1.4.2 rmind /* XXX the program should only happen here */
399 1.1.4.2 rmind break;
400 1.1.4.2 rmind case ONFI_READ_START:
401 1.1.4.2 rmind nandemulator_address_chip(self);
402 1.1.4.2 rmind break;
403 1.1.4.2 rmind case ONFI_BLOCK_ERASE_START:
404 1.1.4.2 rmind page = nandemulator_address_to_page(self);
405 1.1.4.2 rmind offset = sc->sc_page_size * page;
406 1.1.4.2 rmind
407 1.1.4.2 rmind KASSERT(offset %
408 1.1.4.2 rmind (sc->sc_block_size * sc->sc_page_size) == 0);
409 1.1.4.2 rmind
410 1.1.4.3 rmind KASSERT(offset < sc->sc_device_size);
411 1.1.4.3 rmind
412 1.1.4.2 rmind if (offset >= sc->sc_device_size) {
413 1.1.4.2 rmind aprint_error_dev(self, "address > device size!\n");
414 1.1.4.2 rmind } else {
415 1.1.4.2 rmind size_t addr =
416 1.1.4.2 rmind nandemulator_page_to_backend_offset(self, page);
417 1.1.4.2 rmind
418 1.1.4.2 rmind size_t blocklen =
419 1.1.4.2 rmind sc->sc_block_size *
420 1.1.4.2 rmind (sc->sc_page_size + sc->sc_spare_size);
421 1.1.4.2 rmind
422 1.1.4.2 rmind KASSERT(addr < sc->sc_backend_size);
423 1.1.4.2 rmind uint8_t *block = sc->sc_backend + addr;
424 1.1.4.2 rmind
425 1.1.4.2 rmind DPRINTF(("erasing block at 0x%jx\n",
426 1.1.4.2 rmind (uintmax_t )offset));
427 1.1.4.2 rmind
428 1.1.4.2 rmind memset(block, 0xff, blocklen);
429 1.1.4.2 rmind }
430 1.1.4.2 rmind sc->sc_io_len = 0;
431 1.1.4.2 rmind break;
432 1.1.4.2 rmind default:
433 1.1.4.2 rmind aprint_error_dev(self,
434 1.1.4.2 rmind "invalid nand command (0x%hhx)\n", command);
435 1.1.4.3 rmind KASSERT(false);
436 1.1.4.2 rmind sc->sc_io_len = 0;
437 1.1.4.2 rmind }
438 1.1.4.2 rmind };
439 1.1.4.2 rmind
440 1.1.4.2 rmind static void
441 1.1.4.2 rmind nandemulator_address(device_t self, uint8_t address)
442 1.1.4.2 rmind {
443 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
444 1.1.4.2 rmind
445 1.1.4.3 rmind DPRINTF(("nandemulator_address: %hhx\n", address));
446 1.1.4.3 rmind
447 1.1.4.2 rmind /**
448 1.1.4.2 rmind * we have to handle read id/parameter page here,
449 1.1.4.2 rmind * as we can read right after giving the address.
450 1.1.4.2 rmind */
451 1.1.4.2 rmind switch (sc->sc_command) {
452 1.1.4.2 rmind case ONFI_READ_ID:
453 1.1.4.2 rmind if (address == 0x00) {
454 1.1.4.2 rmind sc->sc_io_len = 2;
455 1.1.4.2 rmind sc->sc_io_pointer = sc->sc_ids;
456 1.1.4.2 rmind } else if (address == 0x20) {
457 1.1.4.2 rmind sc->sc_io_len = 4;
458 1.1.4.2 rmind sc->sc_io_pointer = sc->sc_onfi;
459 1.1.4.2 rmind } else {
460 1.1.4.2 rmind sc->sc_io_len = 0;
461 1.1.4.2 rmind }
462 1.1.4.2 rmind break;
463 1.1.4.2 rmind case ONFI_READ_PARAMETER_PAGE:
464 1.1.4.2 rmind if (address == 0x00) {
465 1.1.4.2 rmind sc->sc_io_len = sizeof(struct onfi_parameter_page) * 4;
466 1.1.4.2 rmind sc->sc_io_pointer = (uint8_t *)sc->sc_parameter_page;
467 1.1.4.2 rmind } else {
468 1.1.4.2 rmind sc->sc_io_len = 0;
469 1.1.4.2 rmind }
470 1.1.4.2 rmind break;
471 1.1.4.2 rmind case ONFI_PAGE_PROGRAM:
472 1.1.4.2 rmind sc->sc_address <<= 8;
473 1.1.4.2 rmind sc->sc_address |= address;
474 1.1.4.2 rmind sc->sc_address_counter++;
475 1.1.4.2 rmind
476 1.1.4.2 rmind if (sc->sc_address_counter ==
477 1.1.4.2 rmind sc->sc_column_cycles + sc->sc_row_cycles) {
478 1.1.4.2 rmind nandemulator_address_chip(self);
479 1.1.4.2 rmind }
480 1.1.4.2 rmind break;
481 1.1.4.2 rmind default:
482 1.1.4.2 rmind sc->sc_address <<= 8;
483 1.1.4.2 rmind sc->sc_address |= address;
484 1.1.4.2 rmind sc->sc_address_counter++;
485 1.1.4.2 rmind }
486 1.1.4.2 rmind };
487 1.1.4.2 rmind
488 1.1.4.2 rmind static void
489 1.1.4.2 rmind nandemulator_busy(device_t self)
490 1.1.4.2 rmind {
491 1.1.4.2 rmind #ifdef NANDEMULATOR_DELAYS
492 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
493 1.1.4.2 rmind
494 1.1.4.2 rmind /* do some delay depending on command */
495 1.1.4.2 rmind switch (sc->sc_command) {
496 1.1.4.2 rmind case ONFI_PAGE_PROGRAM_START:
497 1.1.4.2 rmind case ONFI_BLOCK_ERASE_START:
498 1.1.4.2 rmind DELAY(10);
499 1.1.4.2 rmind break;
500 1.1.4.2 rmind case ONFI_READ_START:
501 1.1.4.2 rmind default:
502 1.1.4.2 rmind DELAY(1);
503 1.1.4.2 rmind }
504 1.1.4.2 rmind #endif
505 1.1.4.2 rmind }
506 1.1.4.2 rmind
507 1.1.4.2 rmind static void
508 1.1.4.2 rmind nandemulator_read_byte(device_t self, uint8_t *data)
509 1.1.4.2 rmind {
510 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
511 1.1.4.2 rmind
512 1.1.4.3 rmind KASSERT(sc->sc_io_len > 0);
513 1.1.4.3 rmind
514 1.1.4.2 rmind if (sc->sc_io_len > 0) {
515 1.1.4.2 rmind *data = *sc->sc_io_pointer;
516 1.1.4.2 rmind
517 1.1.4.2 rmind sc->sc_io_pointer++;
518 1.1.4.2 rmind sc->sc_io_len--;
519 1.1.4.2 rmind } else {
520 1.1.4.2 rmind aprint_error_dev(self, "reading byte from invalid location\n");
521 1.1.4.2 rmind *data = 0xff;
522 1.1.4.2 rmind }
523 1.1.4.2 rmind }
524 1.1.4.2 rmind
525 1.1.4.2 rmind static void
526 1.1.4.2 rmind nandemulator_write_byte(device_t self, uint8_t data)
527 1.1.4.2 rmind {
528 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
529 1.1.4.2 rmind
530 1.1.4.3 rmind KASSERT(sc->sc_register_writable);
531 1.1.4.3 rmind
532 1.1.4.2 rmind if (!sc->sc_register_writable) {
533 1.1.4.2 rmind aprint_error_dev(self,
534 1.1.4.2 rmind "trying to write read only location without effect\n");
535 1.1.4.2 rmind return;
536 1.1.4.2 rmind }
537 1.1.4.2 rmind
538 1.1.4.3 rmind KASSERT(sc->sc_io_len > 0);
539 1.1.4.3 rmind
540 1.1.4.2 rmind if (sc->sc_io_len > 0) {
541 1.1.4.2 rmind *sc->sc_io_pointer = data;
542 1.1.4.2 rmind
543 1.1.4.2 rmind sc->sc_io_pointer++;
544 1.1.4.2 rmind sc->sc_io_len--;
545 1.1.4.2 rmind } else {
546 1.1.4.2 rmind aprint_error_dev(self, "write to invalid location\n");
547 1.1.4.2 rmind }
548 1.1.4.2 rmind }
549 1.1.4.2 rmind
550 1.1.4.2 rmind static void
551 1.1.4.2 rmind nandemulator_read_word(device_t self, uint16_t *data)
552 1.1.4.2 rmind {
553 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
554 1.1.4.2 rmind
555 1.1.4.3 rmind KASSERT(sc->sc_buswidth == NANDEMULATOR_16BIT);
556 1.1.4.3 rmind
557 1.1.4.2 rmind if (sc->sc_buswidth != NANDEMULATOR_16BIT) {
558 1.1.4.2 rmind aprint_error_dev(self,
559 1.1.4.2 rmind "trying to read a word on an 8bit chip\n");
560 1.1.4.2 rmind return;
561 1.1.4.2 rmind }
562 1.1.4.2 rmind
563 1.1.4.3 rmind KASSERT(sc->sc_io_len > 1);
564 1.1.4.3 rmind
565 1.1.4.2 rmind if (sc->sc_io_len > 1) {
566 1.1.4.2 rmind *data = *(uint16_t *)sc->sc_io_pointer;
567 1.1.4.2 rmind
568 1.1.4.2 rmind sc->sc_io_pointer += 2;
569 1.1.4.2 rmind sc->sc_io_len -= 2;
570 1.1.4.2 rmind } else {
571 1.1.4.2 rmind aprint_error_dev(self, "reading word from invalid location\n");
572 1.1.4.2 rmind *data = 0xffff;
573 1.1.4.2 rmind }
574 1.1.4.2 rmind }
575 1.1.4.2 rmind
576 1.1.4.2 rmind static void
577 1.1.4.2 rmind nandemulator_write_word(device_t self, uint16_t data)
578 1.1.4.2 rmind {
579 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
580 1.1.4.2 rmind
581 1.1.4.3 rmind KASSERT(sc->sc_register_writable);
582 1.1.4.3 rmind
583 1.1.4.2 rmind if (!sc->sc_register_writable) {
584 1.1.4.2 rmind aprint_error_dev(self,
585 1.1.4.2 rmind "trying to write read only location without effect\n");
586 1.1.4.2 rmind return;
587 1.1.4.2 rmind }
588 1.1.4.2 rmind
589 1.1.4.3 rmind KASSERT(sc->sc_buswidth == NANDEMULATOR_16BIT);
590 1.1.4.3 rmind
591 1.1.4.2 rmind if (sc->sc_buswidth != NANDEMULATOR_16BIT) {
592 1.1.4.2 rmind aprint_error_dev(self,
593 1.1.4.2 rmind "trying to write a word to an 8bit chip");
594 1.1.4.2 rmind return;
595 1.1.4.2 rmind }
596 1.1.4.2 rmind
597 1.1.4.3 rmind KASSERT(sc->sc_io_len > 1);
598 1.1.4.3 rmind
599 1.1.4.2 rmind if (sc->sc_io_len > 1) {
600 1.1.4.2 rmind *(uint16_t *)sc->sc_io_pointer = data;
601 1.1.4.2 rmind
602 1.1.4.2 rmind sc->sc_io_pointer += 2;
603 1.1.4.2 rmind sc->sc_io_len -= 2;
604 1.1.4.2 rmind } else {
605 1.1.4.2 rmind aprint_error_dev(self, "writing to invalid location");
606 1.1.4.2 rmind }
607 1.1.4.2 rmind }
608 1.1.4.2 rmind
609 1.1.4.2 rmind static void
610 1.1.4.2 rmind nandemulator_read_buf_byte(device_t self, void *buf, size_t len)
611 1.1.4.2 rmind {
612 1.1.4.2 rmind uint8_t *addr;
613 1.1.4.2 rmind
614 1.1.4.2 rmind KASSERT(buf != NULL);
615 1.1.4.2 rmind KASSERT(len >= 1);
616 1.1.4.2 rmind
617 1.1.4.2 rmind addr = buf;
618 1.1.4.2 rmind while (len > 0) {
619 1.1.4.2 rmind nandemulator_read_byte(self, addr);
620 1.1.4.2 rmind addr++, len--;
621 1.1.4.2 rmind }
622 1.1.4.2 rmind }
623 1.1.4.2 rmind
624 1.1.4.2 rmind static void
625 1.1.4.2 rmind nandemulator_read_buf_word(device_t self, void *buf, size_t len)
626 1.1.4.2 rmind {
627 1.1.4.2 rmind uint16_t *addr;
628 1.1.4.2 rmind
629 1.1.4.2 rmind KASSERT(buf != NULL);
630 1.1.4.2 rmind KASSERT(len >= 2);
631 1.1.4.2 rmind KASSERT(!(len & 0x01));
632 1.1.4.2 rmind
633 1.1.4.2 rmind addr = buf;
634 1.1.4.2 rmind len /= 2;
635 1.1.4.2 rmind while (len > 0) {
636 1.1.4.2 rmind nandemulator_read_word(self, addr);
637 1.1.4.2 rmind addr++, len--;
638 1.1.4.2 rmind }
639 1.1.4.2 rmind }
640 1.1.4.2 rmind
641 1.1.4.2 rmind static void
642 1.1.4.2 rmind nandemulator_write_buf_byte(device_t self, const void *buf, size_t len)
643 1.1.4.2 rmind {
644 1.1.4.2 rmind const uint8_t *addr;
645 1.1.4.2 rmind
646 1.1.4.2 rmind KASSERT(buf != NULL);
647 1.1.4.2 rmind KASSERT(len >= 1);
648 1.1.4.2 rmind
649 1.1.4.2 rmind addr = buf;
650 1.1.4.2 rmind while (len > 0) {
651 1.1.4.2 rmind nandemulator_write_byte(self, *addr);
652 1.1.4.2 rmind addr++, len--;
653 1.1.4.2 rmind }
654 1.1.4.2 rmind }
655 1.1.4.2 rmind
656 1.1.4.2 rmind static void
657 1.1.4.2 rmind nandemulator_write_buf_word(device_t self, const void *buf, size_t len)
658 1.1.4.2 rmind {
659 1.1.4.2 rmind const uint16_t *addr;
660 1.1.4.2 rmind
661 1.1.4.2 rmind KASSERT(buf != NULL);
662 1.1.4.2 rmind KASSERT(len >= 2);
663 1.1.4.2 rmind KASSERT(!(len & 0x01));
664 1.1.4.2 rmind
665 1.1.4.2 rmind addr = buf;
666 1.1.4.2 rmind len /= 2;
667 1.1.4.2 rmind while (len > 0) {
668 1.1.4.2 rmind nandemulator_write_word(self, *addr);
669 1.1.4.2 rmind addr++, len--;
670 1.1.4.2 rmind }
671 1.1.4.2 rmind }
672 1.1.4.2 rmind
673 1.1.4.2 rmind static size_t
674 1.1.4.2 rmind nandemulator_address_to_page(device_t self)
675 1.1.4.2 rmind {
676 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
677 1.1.4.2 rmind uint64_t address, offset;
678 1.1.4.2 rmind int i;
679 1.1.4.2 rmind
680 1.1.4.2 rmind address = htole64(sc->sc_address);
681 1.1.4.2 rmind address &= sc->sc_row_mask;
682 1.1.4.2 rmind
683 1.1.4.2 rmind offset = 0;
684 1.1.4.2 rmind for (i = 0; i < sc->sc_row_cycles; i++) {
685 1.1.4.2 rmind offset <<= 8;
686 1.1.4.2 rmind offset |= (address & 0xff);
687 1.1.4.2 rmind address >>= 8;
688 1.1.4.2 rmind }
689 1.1.4.2 rmind
690 1.1.4.2 rmind return le64toh(offset);
691 1.1.4.2 rmind }
692 1.1.4.2 rmind
693 1.1.4.2 rmind static size_t
694 1.1.4.2 rmind nandemulator_column_address_to_subpage(device_t self)
695 1.1.4.2 rmind {
696 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
697 1.1.4.2 rmind uint64_t address, offset;
698 1.1.4.2 rmind int i;
699 1.1.4.2 rmind
700 1.1.4.2 rmind address = htole64(sc->sc_address);
701 1.1.4.2 rmind address >>= (8 * sc->sc_row_cycles);
702 1.1.4.2 rmind
703 1.1.4.2 rmind offset = 0;
704 1.1.4.2 rmind for (i = 0; i < sc->sc_column_cycles; i++) {
705 1.1.4.2 rmind offset <<= 8;
706 1.1.4.2 rmind offset |= (address & 0xff);
707 1.1.4.2 rmind address >>= 8;
708 1.1.4.2 rmind }
709 1.1.4.2 rmind
710 1.1.4.2 rmind if (sc->sc_buswidth == NANDEMULATOR_16BIT)
711 1.1.4.2 rmind return (size_t )le64toh(offset << 1);
712 1.1.4.2 rmind else
713 1.1.4.2 rmind return (size_t )le64toh(offset);
714 1.1.4.2 rmind }
715 1.1.4.2 rmind
716 1.1.4.2 rmind static size_t
717 1.1.4.2 rmind nandemulator_page_to_backend_offset(device_t self, size_t page)
718 1.1.4.2 rmind {
719 1.1.4.2 rmind struct nandemulator_softc *sc = device_private(self);
720 1.1.4.2 rmind
721 1.1.4.2 rmind return (sc->sc_page_size + sc->sc_spare_size) * page;
722 1.1.4.2 rmind }
723 1.1.4.2 rmind
724 1.1.4.2 rmind #ifdef _MODULE
725 1.1.4.2 rmind
726 1.1.4.2 rmind MODULE(MODULE_CLASS_DRIVER, nandemulator, "nand");
727 1.1.4.2 rmind
728 1.1.4.2 rmind static const struct cfiattrdata nandbuscf_iattrdata = {
729 1.1.4.2 rmind "nandbus", 0, { { NULL, NULL, 0 }, }
730 1.1.4.2 rmind };
731 1.1.4.2 rmind static const struct cfiattrdata * const nandemulator_attrs[] = {
732 1.1.4.2 rmind &nandbuscf_iattrdata, NULL
733 1.1.4.2 rmind };
734 1.1.4.2 rmind
735 1.1.4.2 rmind CFDRIVER_DECL(nandemulator, DV_DULL, nandemulator_attrs);
736 1.1.4.2 rmind extern struct cfattach nandemulator_ca;
737 1.1.4.2 rmind static int nandemulatorloc[] = { -1, -1 };
738 1.1.4.2 rmind
739 1.1.4.2 rmind static struct cfdata nandemulator_cfdata[] = {
740 1.1.4.2 rmind {
741 1.1.4.2 rmind .cf_name = "nandemulator",
742 1.1.4.2 rmind .cf_atname = "nandemulator",
743 1.1.4.2 rmind .cf_unit = 0,
744 1.1.4.2 rmind .cf_fstate = FSTATE_STAR,
745 1.1.4.2 rmind .cf_loc = nandemulatorloc,
746 1.1.4.2 rmind .cf_flags = 0,
747 1.1.4.2 rmind .cf_pspec = NULL,
748 1.1.4.2 rmind },
749 1.1.4.2 rmind { NULL, NULL, 0, 0, NULL, 0, NULL }
750 1.1.4.2 rmind };
751 1.1.4.2 rmind
752 1.1.4.2 rmind static int
753 1.1.4.2 rmind nandemulator_modcmd(modcmd_t cmd, void *arg)
754 1.1.4.2 rmind {
755 1.1.4.2 rmind int error;
756 1.1.4.2 rmind
757 1.1.4.2 rmind switch (cmd) {
758 1.1.4.2 rmind case MODULE_CMD_INIT:
759 1.1.4.2 rmind error = config_cfdriver_attach(&nandemulator_cd);
760 1.1.4.2 rmind if (error) {
761 1.1.4.2 rmind return error;
762 1.1.4.2 rmind }
763 1.1.4.2 rmind
764 1.1.4.2 rmind error = config_cfattach_attach(nandemulator_cd.cd_name,
765 1.1.4.2 rmind &nandemulator_ca);
766 1.1.4.2 rmind if (error) {
767 1.1.4.2 rmind config_cfdriver_detach(&nandemulator_cd);
768 1.1.4.2 rmind aprint_error("%s: unable to register cfattach\n",
769 1.1.4.2 rmind nandemulator_cd.cd_name);
770 1.1.4.2 rmind
771 1.1.4.2 rmind return error;
772 1.1.4.2 rmind }
773 1.1.4.2 rmind
774 1.1.4.2 rmind error = config_cfdata_attach(nandemulator_cfdata, 1);
775 1.1.4.2 rmind if (error) {
776 1.1.4.2 rmind config_cfattach_detach(nandemulator_cd.cd_name,
777 1.1.4.2 rmind &nandemulator_ca);
778 1.1.4.2 rmind config_cfdriver_detach(&nandemulator_cd);
779 1.1.4.2 rmind aprint_error("%s: unable to register cfdata\n",
780 1.1.4.2 rmind nandemulator_cd.cd_name);
781 1.1.4.2 rmind
782 1.1.4.2 rmind return error;
783 1.1.4.2 rmind }
784 1.1.4.2 rmind
785 1.1.4.2 rmind (void)config_attach_pseudo(nandemulator_cfdata);
786 1.1.4.2 rmind
787 1.1.4.2 rmind return 0;
788 1.1.4.4 rmind
789 1.1.4.2 rmind case MODULE_CMD_FINI:
790 1.1.4.2 rmind error = config_cfdata_detach(nandemulator_cfdata);
791 1.1.4.2 rmind if (error) {
792 1.1.4.2 rmind return error;
793 1.1.4.2 rmind }
794 1.1.4.2 rmind
795 1.1.4.2 rmind config_cfattach_detach(nandemulator_cd.cd_name,
796 1.1.4.2 rmind &nandemulator_ca);
797 1.1.4.2 rmind config_cfdriver_detach(&nandemulator_cd);
798 1.1.4.2 rmind
799 1.1.4.2 rmind return 0;
800 1.1.4.4 rmind
801 1.1.4.4 rmind case MODULE_CMD_AUTOUNLOAD:
802 1.1.4.4 rmind /* prevent auto-unload */
803 1.1.4.4 rmind return EBUSY;
804 1.1.4.4 rmind
805 1.1.4.2 rmind default:
806 1.1.4.2 rmind return ENOTTY;
807 1.1.4.2 rmind }
808 1.1.4.2 rmind }
809 1.1.4.2 rmind
810 1.1.4.2 rmind #endif
811