1*3de5e56bSriastradh /* $NetBSD: nandemulator.c,v 1.10 2023/05/10 00:11:16 riastradh Exp $ */
22b6ee221Sahoka
32b6ee221Sahoka /*-
42b6ee221Sahoka * Copyright (c) 2011 Department of Software Engineering,
52b6ee221Sahoka * University of Szeged, Hungary
62b6ee221Sahoka * Copyright (c) 2011 Adam Hoka <ahoka@NetBSD.org>
72b6ee221Sahoka * All rights reserved.
82b6ee221Sahoka *
92b6ee221Sahoka * This code is derived from software contributed to The NetBSD Foundation
102b6ee221Sahoka * by the Department of Software Engineering, University of Szeged, Hungary
112b6ee221Sahoka *
122b6ee221Sahoka * Redistribution and use in source and binary forms, with or without
132b6ee221Sahoka * modification, are permitted provided that the following conditions
142b6ee221Sahoka * are met:
152b6ee221Sahoka * 1. Redistributions of source code must retain the above copyright
162b6ee221Sahoka * notice, this list of conditions and the following disclaimer.
172b6ee221Sahoka * 2. Redistributions in binary form must reproduce the above copyright
182b6ee221Sahoka * notice, this list of conditions and the following disclaimer in the
192b6ee221Sahoka * documentation and/or other materials provided with the distribution.
202b6ee221Sahoka *
212b6ee221Sahoka * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
222b6ee221Sahoka * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
232b6ee221Sahoka * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
242b6ee221Sahoka * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
252b6ee221Sahoka * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
262b6ee221Sahoka * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
272b6ee221Sahoka * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
282b6ee221Sahoka * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
292b6ee221Sahoka * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
302b6ee221Sahoka * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
312b6ee221Sahoka * SUCH DAMAGE.
322b6ee221Sahoka */
332b6ee221Sahoka
342b6ee221Sahoka #include <sys/cdefs.h>
35*3de5e56bSriastradh __KERNEL_RCSID(0, "$NetBSD: nandemulator.c,v 1.10 2023/05/10 00:11:16 riastradh Exp $");
36c63685beSmrg
37c63685beSmrg /* XXX this code likely needs work */
382b6ee221Sahoka
392b6ee221Sahoka #include <sys/param.h>
402b6ee221Sahoka #include <sys/device.h>
412b6ee221Sahoka #include <sys/conf.h>
422b6ee221Sahoka #include <sys/kmem.h>
432b6ee221Sahoka #include <sys/kernel.h>
442b6ee221Sahoka
452b6ee221Sahoka #include "nandemulator.h"
462b6ee221Sahoka
472b6ee221Sahoka #include <dev/nand/nand.h>
482b6ee221Sahoka #include <dev/nand/onfi.h>
492b6ee221Sahoka #include <dev/nand/nand_crc.h>
502b6ee221Sahoka
51e7ae23fdSchristos #include "ioconf.h"
52e7ae23fdSchristos
532b6ee221Sahoka extern struct cfdriver nandemulator_cd;
542b6ee221Sahoka
552b6ee221Sahoka static int nandemulator_match(device_t, cfdata_t, void *);
562b6ee221Sahoka static void nandemulator_attach(device_t, device_t, void *);
572b6ee221Sahoka static int nandemulator_detach(device_t, int);
582b6ee221Sahoka
592b6ee221Sahoka static void nandemulator_device_reset(device_t);
602b6ee221Sahoka static void nandemulator_command(device_t, uint8_t);
612b6ee221Sahoka static void nandemulator_address(device_t, uint8_t);
622b6ee221Sahoka static void nandemulator_busy(device_t);
63fff85086Sahoka static void nandemulator_read_1(device_t, uint8_t *);
64fff85086Sahoka static void nandemulator_write_1(device_t, uint8_t);
65fff85086Sahoka static void nandemulator_read_2(device_t, uint16_t *);
66fff85086Sahoka static void nandemulator_write_2(device_t, uint16_t);
67fff85086Sahoka static void nandemulator_read_buf_1(device_t, void *, size_t);
68fff85086Sahoka static void nandemulator_read_buf_2(device_t, void *, size_t);
69fff85086Sahoka static void nandemulator_write_buf_1(device_t, const void *, size_t);
70fff85086Sahoka static void nandemulator_write_buf_2(device_t, const void *, size_t);
712b6ee221Sahoka
722b6ee221Sahoka static size_t nandemulator_address_to_page(device_t);
732b6ee221Sahoka static size_t nandemulator_page_to_backend_offset(device_t, size_t);
742b6ee221Sahoka static size_t nandemulator_column_address_to_subpage(device_t);
752b6ee221Sahoka /*
762b6ee221Sahoka #define NANDEMULATOR_DEBUG 1
772b6ee221Sahoka
782b6ee221Sahoka #ifdef NANDEMULATOR_DEBUG
792b6ee221Sahoka #warning debug enabled
802b6ee221Sahoka #define DPRINTF(x) if (nandemulatordebug) printf x
812b6ee221Sahoka #define DPRINTFN(n,x) if (nandemulatordebug>(n)) printf x
822b6ee221Sahoka #else
832b6ee221Sahoka #error no debug
842b6ee221Sahoka #define DPRINTF(x)
852b6ee221Sahoka #define DPRINTFN(n,x)
862b6ee221Sahoka #endif
872b6ee221Sahoka
882b6ee221Sahoka #ifdef NANDEMULATOR_DEBUG
892b6ee221Sahoka int nandemulatordebug = NANDEMULATOR_DEBUG;
902b6ee221Sahoka #endif
912b6ee221Sahoka */
922b6ee221Sahoka
932b6ee221Sahoka extern int nanddebug;
942b6ee221Sahoka
952b6ee221Sahoka enum {
962b6ee221Sahoka NANDEMULATOR_8BIT,
972b6ee221Sahoka NANDEMULATOR_16BIT
982b6ee221Sahoka };
992b6ee221Sahoka
1002b6ee221Sahoka struct nandemulator_softc {
1012b6ee221Sahoka device_t sc_dev;
1022b6ee221Sahoka device_t sc_nanddev;
1032b6ee221Sahoka
1042b6ee221Sahoka int sc_buswidth;
1052b6ee221Sahoka
1062b6ee221Sahoka struct nand_interface sc_nand_if;
1072b6ee221Sahoka
1082b6ee221Sahoka uint8_t sc_command;
1092b6ee221Sahoka size_t sc_io_len;
1102b6ee221Sahoka uint8_t *sc_io_pointer;
1112b6ee221Sahoka uint64_t sc_address;
1122b6ee221Sahoka
1132b6ee221Sahoka uint8_t *sc_backend;
1142b6ee221Sahoka size_t sc_backend_size;
1152b6ee221Sahoka size_t sc_device_size;
1162b6ee221Sahoka bool sc_register_writable;
1172b6ee221Sahoka
1182b6ee221Sahoka uint8_t sc_status_register;
1192b6ee221Sahoka uint8_t sc_ids[2];
1202b6ee221Sahoka uint8_t sc_onfi[4];
1212b6ee221Sahoka
1222b6ee221Sahoka size_t sc_page_size;
1232b6ee221Sahoka size_t sc_block_size;
1242b6ee221Sahoka size_t sc_spare_size;
1252b6ee221Sahoka size_t sc_lun_size;
1262b6ee221Sahoka uint8_t sc_row_cycles;
1272b6ee221Sahoka uint8_t sc_column_cycles;
1282b6ee221Sahoka uint64_t sc_row_mask;
1292b6ee221Sahoka
1302b6ee221Sahoka int sc_address_counter;
1312b6ee221Sahoka
1322b6ee221Sahoka struct onfi_parameter_page *sc_parameter_page;
1332b6ee221Sahoka };
1342b6ee221Sahoka
1352b6ee221Sahoka CFATTACH_DECL_NEW(nandemulator, sizeof(struct nandemulator_softc),
1362b6ee221Sahoka nandemulator_match, nandemulator_attach, nandemulator_detach, NULL);
1372b6ee221Sahoka
1382b6ee221Sahoka void
nandemulatorattach(int n)1392b6ee221Sahoka nandemulatorattach(int n)
1402b6ee221Sahoka {
1412b6ee221Sahoka int i, err;
1422b6ee221Sahoka cfdata_t cf;
1432b6ee221Sahoka
1442b6ee221Sahoka aprint_debug("nandemulator: requested %d units\n", n);
1452b6ee221Sahoka
1462b6ee221Sahoka err = config_cfattach_attach(nandemulator_cd.cd_name,
1472b6ee221Sahoka &nandemulator_ca);
1482b6ee221Sahoka if (err) {
1492b6ee221Sahoka aprint_error("%s: couldn't register cfattach: %d\n",
1502b6ee221Sahoka nandemulator_cd.cd_name, err);
1512b6ee221Sahoka config_cfdriver_detach(&nandemulator_cd);
1522b6ee221Sahoka return;
1532b6ee221Sahoka }
1542b6ee221Sahoka for (i = 0; i < n; i++) {
15502991323Schs cf = kmem_alloc(sizeof(struct cfdata), KM_SLEEP);
1562b6ee221Sahoka cf->cf_name = nandemulator_cd.cd_name;
1572b6ee221Sahoka cf->cf_atname = nandemulator_cd.cd_name;
1582b6ee221Sahoka cf->cf_unit = i;
1592b6ee221Sahoka cf->cf_fstate = FSTATE_STAR;
1602b6ee221Sahoka
1612b6ee221Sahoka (void)config_attach_pseudo(cf);
1622b6ee221Sahoka }
1632b6ee221Sahoka }
1642b6ee221Sahoka
1652b6ee221Sahoka /* ARGSUSED */
1662b6ee221Sahoka static int
nandemulator_match(device_t parent,cfdata_t match,void * aux)1672b6ee221Sahoka nandemulator_match(device_t parent, cfdata_t match, void *aux)
1682b6ee221Sahoka {
1692b6ee221Sahoka /* pseudo device, always attaches */
1702b6ee221Sahoka return 1;
1712b6ee221Sahoka }
1722b6ee221Sahoka
1732b6ee221Sahoka static void
nandemulator_attach(device_t parent,device_t self,void * aux)1742b6ee221Sahoka nandemulator_attach(device_t parent, device_t self, void *aux)
1752b6ee221Sahoka {
1762b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
1772b6ee221Sahoka int i;
1782b6ee221Sahoka
1792b6ee221Sahoka aprint_normal_dev(self, "NAND emulator\n");
1802b6ee221Sahoka
1812b6ee221Sahoka sc->sc_dev = self;
1822b6ee221Sahoka
183c68f5a83Sahoka nand_init_interface(&sc->sc_nand_if);
184c68f5a83Sahoka
1852b6ee221Sahoka sc->sc_nand_if.command = &nandemulator_command;
1862b6ee221Sahoka sc->sc_nand_if.address = &nandemulator_address;
187fff85086Sahoka sc->sc_nand_if.read_buf_1 = &nandemulator_read_buf_1;
188fff85086Sahoka sc->sc_nand_if.read_buf_2 = &nandemulator_read_buf_2;
189fff85086Sahoka sc->sc_nand_if.read_1 = &nandemulator_read_1;
190fff85086Sahoka sc->sc_nand_if.read_2 = &nandemulator_read_2;
191fff85086Sahoka sc->sc_nand_if.write_buf_1 = &nandemulator_write_buf_1;
192fff85086Sahoka sc->sc_nand_if.write_buf_2 = &nandemulator_write_buf_2;
193fff85086Sahoka sc->sc_nand_if.write_1 = &nandemulator_write_1;
194fff85086Sahoka sc->sc_nand_if.write_2 = &nandemulator_write_2;
1952b6ee221Sahoka sc->sc_nand_if.busy = &nandemulator_busy;
1962b6ee221Sahoka
1972b6ee221Sahoka sc->sc_nand_if.ecc.necc_code_size = 3;
1982b6ee221Sahoka sc->sc_nand_if.ecc.necc_block_size = 256;
1992b6ee221Sahoka
2002b6ee221Sahoka if (!pmf_device_register1(sc->sc_dev, NULL, NULL, NULL))
2012b6ee221Sahoka aprint_error_dev(sc->sc_dev,
2022b6ee221Sahoka "couldn't establish power handler\n");
2032b6ee221Sahoka
2042b6ee221Sahoka sc->sc_buswidth = NANDEMULATOR_16BIT; /* 16bit for now */
2052b6ee221Sahoka
2062b6ee221Sahoka /* hardcode these now, make it configurable later */
2072b6ee221Sahoka sc->sc_device_size = 32 * 1024 * 1024; /* 32MB */
2082b6ee221Sahoka sc->sc_page_size = 2048;
2092b6ee221Sahoka sc->sc_block_size = 64;
2102b6ee221Sahoka sc->sc_lun_size =
2112b6ee221Sahoka sc->sc_device_size / (sc->sc_page_size * sc->sc_block_size);
2122b6ee221Sahoka KASSERT(sc->sc_device_size %
2132b6ee221Sahoka (sc->sc_page_size * sc->sc_block_size) == 0);
2142b6ee221Sahoka sc->sc_spare_size = 64;
2152b6ee221Sahoka
2162b6ee221Sahoka sc->sc_column_cycles = 2;
2172b6ee221Sahoka sc->sc_row_cycles = 3;
2182b6ee221Sahoka
2192b6ee221Sahoka /* init the emulator data structures */
2202b6ee221Sahoka sc->sc_backend_size =
2212b6ee221Sahoka sc->sc_device_size +
2222b6ee221Sahoka sc->sc_device_size / sc->sc_page_size * sc->sc_spare_size;
2232b6ee221Sahoka
2242b6ee221Sahoka sc->sc_backend = kmem_alloc(sc->sc_backend_size, KM_SLEEP);
2252b6ee221Sahoka memset(sc->sc_backend, 0xff, sc->sc_backend_size);
2262b6ee221Sahoka
2272b6ee221Sahoka sc->sc_parameter_page =
2282b6ee221Sahoka kmem_zalloc(sizeof(struct onfi_parameter_page) * 4, KM_SLEEP);
2292b6ee221Sahoka
2302b6ee221Sahoka struct onfi_parameter_page *opp;
2312b6ee221Sahoka uint8_t sig[4] = { 'O', 'N', 'F', 'I' };
2322b6ee221Sahoka
2332b6ee221Sahoka for (i = 0; i < 4; i++) {
2342b6ee221Sahoka opp = &sc->sc_parameter_page[i];
2352b6ee221Sahoka
23657f2b3b2Sahoka opp->param_signature = htole32(*(uint32_t *)sig);
23757f2b3b2Sahoka opp->param_pagesize = htole32(sc->sc_page_size);
23857f2b3b2Sahoka opp->param_blocksize = htole32(sc->sc_block_size);
23957f2b3b2Sahoka opp->param_sparesize = htole16(sc->sc_spare_size);
24057f2b3b2Sahoka opp->param_lunsize = htole32(sc->sc_lun_size);
2412b6ee221Sahoka opp->param_numluns = 1;
2422b6ee221Sahoka
2432b6ee221Sahoka opp->param_manufacturer_id = 0x00;
2442b6ee221Sahoka memcpy(opp->param_manufacturer,
2452b6ee221Sahoka "NETBSD", strlen("NETBSD"));
2462b6ee221Sahoka memcpy(opp->param_model,
2472b6ee221Sahoka "NANDEMULATOR", strlen("NANDEMULATOR"));
2482b6ee221Sahoka
24957f2b3b2Sahoka uint16_t features = ONFI_FEATURE_16BIT;
25057f2b3b2Sahoka opp->param_features = htole16(features);
2512b6ee221Sahoka
2522b6ee221Sahoka /* the lower 4 bits contain the row address cycles
2532b6ee221Sahoka * the upper 4 bits contain the column address cycles
2542b6ee221Sahoka */
2552b6ee221Sahoka opp->param_addr_cycles = sc->sc_row_cycles;
2562b6ee221Sahoka opp->param_addr_cycles |= (sc->sc_column_cycles << 4);
2572b6ee221Sahoka
2582b6ee221Sahoka opp->param_integrity_crc = nand_crc16((uint8_t *)opp, 254);
2592b6ee221Sahoka }
2602b6ee221Sahoka
2612b6ee221Sahoka sc->sc_ids[0] = 0x00;
2622b6ee221Sahoka sc->sc_ids[1] = 0x00;
2632b6ee221Sahoka
2642b6ee221Sahoka sc->sc_onfi[0] = 'O';
2652b6ee221Sahoka sc->sc_onfi[1] = 'N';
2662b6ee221Sahoka sc->sc_onfi[2] = 'F';
2672b6ee221Sahoka sc->sc_onfi[3] = 'I';
2682b6ee221Sahoka
2692b6ee221Sahoka sc->sc_row_mask = 0x00;
2702b6ee221Sahoka for (i = 0; i < sc->sc_row_cycles; i++) {
2712b6ee221Sahoka sc->sc_row_mask <<= 8;
2722b6ee221Sahoka sc->sc_row_mask |= 0xff;
2732b6ee221Sahoka }
2742b6ee221Sahoka
2752b6ee221Sahoka nandemulator_device_reset(self);
2762b6ee221Sahoka
2772b6ee221Sahoka sc->sc_nanddev = nand_attach_mi(&sc->sc_nand_if, sc->sc_dev);
2782b6ee221Sahoka }
2792b6ee221Sahoka
2802b6ee221Sahoka static int
nandemulator_detach(device_t self,int flags)2812b6ee221Sahoka nandemulator_detach(device_t self, int flags)
2822b6ee221Sahoka {
2832b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
284*3de5e56bSriastradh int error;
2852b6ee221Sahoka
2862b6ee221Sahoka aprint_normal_dev(sc->sc_dev, "detaching emulator\n");
2872b6ee221Sahoka
288*3de5e56bSriastradh error = config_detach_children(self, flags);
289*3de5e56bSriastradh if (error)
290*3de5e56bSriastradh return error;
291*3de5e56bSriastradh
2922b6ee221Sahoka pmf_device_deregister(sc->sc_dev);
2932b6ee221Sahoka kmem_free(sc->sc_backend, sc->sc_backend_size);
2942b6ee221Sahoka kmem_free(sc->sc_parameter_page,
2952b6ee221Sahoka sizeof(struct onfi_parameter_page) * 4);
296*3de5e56bSriastradh return 0;
2972b6ee221Sahoka }
2982b6ee221Sahoka
2992b6ee221Sahoka /**
3002b6ee221Sahoka * bring the emulated device to a known state
3012b6ee221Sahoka */
3022b6ee221Sahoka static void
nandemulator_device_reset(device_t self)3032b6ee221Sahoka nandemulator_device_reset(device_t self)
3042b6ee221Sahoka {
3052b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
3062b6ee221Sahoka
3079491044fSahoka DPRINTF(("device reset\n"));
3089491044fSahoka
3092b6ee221Sahoka sc->sc_command = 0;
3102b6ee221Sahoka sc->sc_register_writable = false;
3112b6ee221Sahoka sc->sc_io_len = 0;
3122b6ee221Sahoka sc->sc_io_pointer = NULL;
3132b6ee221Sahoka sc->sc_address = 0;
3142b6ee221Sahoka sc->sc_address_counter = 0;
3152b6ee221Sahoka
3162b6ee221Sahoka sc->sc_status_register = ONFI_STATUS_RDY | ONFI_STATUS_WP;
3172b6ee221Sahoka }
3182b6ee221Sahoka
3192b6ee221Sahoka static void
nandemulator_address_chip(device_t self)3202b6ee221Sahoka nandemulator_address_chip(device_t self)
3212b6ee221Sahoka {
3222b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
3232b6ee221Sahoka size_t page, offset;
3242b6ee221Sahoka
3259491044fSahoka KASSERT(sc->sc_address_counter ==
3269491044fSahoka sc->sc_column_cycles + sc->sc_row_cycles);
3279491044fSahoka
3282b6ee221Sahoka if (sc->sc_address_counter !=
3292b6ee221Sahoka sc->sc_column_cycles + sc->sc_row_cycles) {
3302b6ee221Sahoka aprint_error_dev(self, "incorrect number of address cycles\n");
3312b6ee221Sahoka aprint_error_dev(self, "cc: %d, rc: %d, ac: %d\n",
3322b6ee221Sahoka sc->sc_column_cycles, sc->sc_row_cycles,
3332b6ee221Sahoka sc->sc_address_counter);
3342b6ee221Sahoka }
3352b6ee221Sahoka
3362b6ee221Sahoka page = nandemulator_address_to_page(self);
3372b6ee221Sahoka offset = sc->sc_page_size * page;
3382b6ee221Sahoka
3392b6ee221Sahoka DPRINTF(("READ/PROGRAM; page: 0x%jx (row addr: 0x%jx)\n",
3402b6ee221Sahoka (uintmax_t )page,
3412b6ee221Sahoka (uintmax_t )offset));
3422b6ee221Sahoka
3439491044fSahoka KASSERT(offset < sc->sc_device_size);
3449491044fSahoka
3452b6ee221Sahoka if (offset >= sc->sc_device_size) {
3462b6ee221Sahoka aprint_error_dev(self, "address > device size!\n");
3472b6ee221Sahoka sc->sc_io_len = 0;
3482b6ee221Sahoka } else {
3492b6ee221Sahoka size_t addr =
3502b6ee221Sahoka nandemulator_page_to_backend_offset(self, page);
3512b6ee221Sahoka size_t pageoff =
3522b6ee221Sahoka nandemulator_column_address_to_subpage(self);
3532b6ee221Sahoka
3542b6ee221Sahoka DPRINTF(("subpage: 0x%jx\n", (uintmax_t )pageoff));
3552b6ee221Sahoka
3562b6ee221Sahoka KASSERT(pageoff <
3572b6ee221Sahoka sc->sc_page_size + sc->sc_spare_size);
3582b6ee221Sahoka KASSERT(addr < sc->sc_backend_size);
3592b6ee221Sahoka
3602b6ee221Sahoka sc->sc_io_pointer = sc->sc_backend + addr + pageoff;
3612b6ee221Sahoka sc->sc_io_len =
3622b6ee221Sahoka sc->sc_page_size + sc->sc_spare_size - pageoff;
3632b6ee221Sahoka }
3642b6ee221Sahoka }
3652b6ee221Sahoka
3662b6ee221Sahoka static void
nandemulator_command(device_t self,uint8_t command)3672b6ee221Sahoka nandemulator_command(device_t self, uint8_t command)
3682b6ee221Sahoka {
3692b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
3702b6ee221Sahoka size_t offset, page;
3712b6ee221Sahoka
3722b6ee221Sahoka sc->sc_command = command;
3732b6ee221Sahoka sc->sc_register_writable = false;
3742b6ee221Sahoka
3752b6ee221Sahoka DPRINTF(("nandemulator command: 0x%hhx\n", command));
3762b6ee221Sahoka
3772b6ee221Sahoka switch (command) {
3782b6ee221Sahoka case ONFI_READ_STATUS:
3792b6ee221Sahoka sc->sc_io_pointer = &sc->sc_status_register;
3802b6ee221Sahoka sc->sc_io_len = 1;
3812b6ee221Sahoka break;
3822b6ee221Sahoka case ONFI_RESET:
3832b6ee221Sahoka nandemulator_device_reset(self);
3842b6ee221Sahoka break;
3852b6ee221Sahoka case ONFI_PAGE_PROGRAM:
3862b6ee221Sahoka sc->sc_register_writable = true;
387c63685beSmrg /* FALLTHROUGH */
3882b6ee221Sahoka case ONFI_READ:
3892b6ee221Sahoka case ONFI_BLOCK_ERASE:
3902b6ee221Sahoka sc->sc_address_counter = 0;
391c63685beSmrg /* FALLTHROUGH */
3922b6ee221Sahoka case ONFI_READ_ID:
3932b6ee221Sahoka case ONFI_READ_PARAMETER_PAGE:
3942b6ee221Sahoka sc->sc_io_len = 0;
3952b6ee221Sahoka sc->sc_address = 0;
3962b6ee221Sahoka break;
3972b6ee221Sahoka case ONFI_PAGE_PROGRAM_START:
3982b6ee221Sahoka /* XXX the program should only happen here */
3992b6ee221Sahoka break;
4002b6ee221Sahoka case ONFI_READ_START:
4012b6ee221Sahoka nandemulator_address_chip(self);
4022b6ee221Sahoka break;
4032b6ee221Sahoka case ONFI_BLOCK_ERASE_START:
4042b6ee221Sahoka page = nandemulator_address_to_page(self);
4052b6ee221Sahoka offset = sc->sc_page_size * page;
4062b6ee221Sahoka
4072b6ee221Sahoka KASSERT(offset %
4082b6ee221Sahoka (sc->sc_block_size * sc->sc_page_size) == 0);
4092b6ee221Sahoka
4109491044fSahoka KASSERT(offset < sc->sc_device_size);
4119491044fSahoka
4122b6ee221Sahoka if (offset >= sc->sc_device_size) {
4132b6ee221Sahoka aprint_error_dev(self, "address > device size!\n");
4142b6ee221Sahoka } else {
4152b6ee221Sahoka size_t addr =
4162b6ee221Sahoka nandemulator_page_to_backend_offset(self, page);
4172b6ee221Sahoka
4182b6ee221Sahoka size_t blocklen =
4192b6ee221Sahoka sc->sc_block_size *
4202b6ee221Sahoka (sc->sc_page_size + sc->sc_spare_size);
4212b6ee221Sahoka
4222b6ee221Sahoka KASSERT(addr < sc->sc_backend_size);
4232b6ee221Sahoka uint8_t *block = sc->sc_backend + addr;
4242b6ee221Sahoka
4252b6ee221Sahoka DPRINTF(("erasing block at 0x%jx\n",
4262b6ee221Sahoka (uintmax_t )offset));
4272b6ee221Sahoka
4282b6ee221Sahoka memset(block, 0xff, blocklen);
4292b6ee221Sahoka }
4302b6ee221Sahoka sc->sc_io_len = 0;
4312b6ee221Sahoka break;
4322b6ee221Sahoka default:
4332b6ee221Sahoka aprint_error_dev(self,
4342b6ee221Sahoka "invalid nand command (0x%hhx)\n", command);
4359491044fSahoka KASSERT(false);
4362b6ee221Sahoka sc->sc_io_len = 0;
4372b6ee221Sahoka }
4382b6ee221Sahoka };
4392b6ee221Sahoka
4402b6ee221Sahoka static void
nandemulator_address(device_t self,uint8_t address)4412b6ee221Sahoka nandemulator_address(device_t self, uint8_t address)
4422b6ee221Sahoka {
4432b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
4442b6ee221Sahoka
4459491044fSahoka DPRINTF(("nandemulator_address: %hhx\n", address));
4469491044fSahoka
4472b6ee221Sahoka /**
4482b6ee221Sahoka * we have to handle read id/parameter page here,
4492b6ee221Sahoka * as we can read right after giving the address.
4502b6ee221Sahoka */
4512b6ee221Sahoka switch (sc->sc_command) {
4522b6ee221Sahoka case ONFI_READ_ID:
4532b6ee221Sahoka if (address == 0x00) {
4542b6ee221Sahoka sc->sc_io_len = 2;
4552b6ee221Sahoka sc->sc_io_pointer = sc->sc_ids;
4562b6ee221Sahoka } else if (address == 0x20) {
4572b6ee221Sahoka sc->sc_io_len = 4;
4582b6ee221Sahoka sc->sc_io_pointer = sc->sc_onfi;
4592b6ee221Sahoka } else {
4602b6ee221Sahoka sc->sc_io_len = 0;
4612b6ee221Sahoka }
4622b6ee221Sahoka break;
4632b6ee221Sahoka case ONFI_READ_PARAMETER_PAGE:
4642b6ee221Sahoka if (address == 0x00) {
4652b6ee221Sahoka sc->sc_io_len = sizeof(struct onfi_parameter_page) * 4;
4662b6ee221Sahoka sc->sc_io_pointer = (uint8_t *)sc->sc_parameter_page;
4672b6ee221Sahoka } else {
4682b6ee221Sahoka sc->sc_io_len = 0;
4692b6ee221Sahoka }
4702b6ee221Sahoka break;
4712b6ee221Sahoka case ONFI_PAGE_PROGRAM:
4722b6ee221Sahoka sc->sc_address <<= 8;
4732b6ee221Sahoka sc->sc_address |= address;
4742b6ee221Sahoka sc->sc_address_counter++;
4752b6ee221Sahoka
4762b6ee221Sahoka if (sc->sc_address_counter ==
4772b6ee221Sahoka sc->sc_column_cycles + sc->sc_row_cycles) {
4782b6ee221Sahoka nandemulator_address_chip(self);
4792b6ee221Sahoka }
4802b6ee221Sahoka break;
4812b6ee221Sahoka default:
4822b6ee221Sahoka sc->sc_address <<= 8;
4832b6ee221Sahoka sc->sc_address |= address;
4842b6ee221Sahoka sc->sc_address_counter++;
4852b6ee221Sahoka }
4862b6ee221Sahoka };
4872b6ee221Sahoka
4882b6ee221Sahoka static void
nandemulator_busy(device_t self)4892b6ee221Sahoka nandemulator_busy(device_t self)
4902b6ee221Sahoka {
4912b6ee221Sahoka #ifdef NANDEMULATOR_DELAYS
4922b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
4932b6ee221Sahoka
4942b6ee221Sahoka /* do some delay depending on command */
4952b6ee221Sahoka switch (sc->sc_command) {
4962b6ee221Sahoka case ONFI_PAGE_PROGRAM_START:
4972b6ee221Sahoka case ONFI_BLOCK_ERASE_START:
4982b6ee221Sahoka DELAY(10);
4992b6ee221Sahoka break;
5002b6ee221Sahoka case ONFI_READ_START:
5012b6ee221Sahoka default:
5022b6ee221Sahoka DELAY(1);
5032b6ee221Sahoka }
5042b6ee221Sahoka #endif
5052b6ee221Sahoka }
5062b6ee221Sahoka
5072b6ee221Sahoka static void
nandemulator_read_1(device_t self,uint8_t * data)508fff85086Sahoka nandemulator_read_1(device_t self, uint8_t *data)
5092b6ee221Sahoka {
5102b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
5112b6ee221Sahoka
5129491044fSahoka KASSERT(sc->sc_io_len > 0);
5139491044fSahoka
5142b6ee221Sahoka if (sc->sc_io_len > 0) {
5152b6ee221Sahoka *data = *sc->sc_io_pointer;
5162b6ee221Sahoka
5172b6ee221Sahoka sc->sc_io_pointer++;
5182b6ee221Sahoka sc->sc_io_len--;
5192b6ee221Sahoka } else {
5202b6ee221Sahoka aprint_error_dev(self, "reading byte from invalid location\n");
5212b6ee221Sahoka *data = 0xff;
5222b6ee221Sahoka }
5232b6ee221Sahoka }
5242b6ee221Sahoka
5252b6ee221Sahoka static void
nandemulator_write_1(device_t self,uint8_t data)526fff85086Sahoka nandemulator_write_1(device_t self, uint8_t data)
5272b6ee221Sahoka {
5282b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
5292b6ee221Sahoka
5309491044fSahoka KASSERT(sc->sc_register_writable);
5319491044fSahoka
5322b6ee221Sahoka if (!sc->sc_register_writable) {
5332b6ee221Sahoka aprint_error_dev(self,
5342b6ee221Sahoka "trying to write read only location without effect\n");
5352b6ee221Sahoka return;
5362b6ee221Sahoka }
5372b6ee221Sahoka
5389491044fSahoka KASSERT(sc->sc_io_len > 0);
5399491044fSahoka
5402b6ee221Sahoka if (sc->sc_io_len > 0) {
5412b6ee221Sahoka *sc->sc_io_pointer = data;
5422b6ee221Sahoka
5432b6ee221Sahoka sc->sc_io_pointer++;
5442b6ee221Sahoka sc->sc_io_len--;
5452b6ee221Sahoka } else {
5462b6ee221Sahoka aprint_error_dev(self, "write to invalid location\n");
5472b6ee221Sahoka }
5482b6ee221Sahoka }
5492b6ee221Sahoka
5502b6ee221Sahoka static void
nandemulator_read_2(device_t self,uint16_t * data)551fff85086Sahoka nandemulator_read_2(device_t self, uint16_t *data)
5522b6ee221Sahoka {
5532b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
5542b6ee221Sahoka
5559491044fSahoka KASSERT(sc->sc_buswidth == NANDEMULATOR_16BIT);
5569491044fSahoka
5572b6ee221Sahoka if (sc->sc_buswidth != NANDEMULATOR_16BIT) {
5582b6ee221Sahoka aprint_error_dev(self,
5592b6ee221Sahoka "trying to read a word on an 8bit chip\n");
5602b6ee221Sahoka return;
5612b6ee221Sahoka }
5622b6ee221Sahoka
5639491044fSahoka KASSERT(sc->sc_io_len > 1);
5649491044fSahoka
5652b6ee221Sahoka if (sc->sc_io_len > 1) {
5662b6ee221Sahoka *data = *(uint16_t *)sc->sc_io_pointer;
5672b6ee221Sahoka
5682b6ee221Sahoka sc->sc_io_pointer += 2;
5692b6ee221Sahoka sc->sc_io_len -= 2;
5702b6ee221Sahoka } else {
5712b6ee221Sahoka aprint_error_dev(self, "reading word from invalid location\n");
5722b6ee221Sahoka *data = 0xffff;
5732b6ee221Sahoka }
5742b6ee221Sahoka }
5752b6ee221Sahoka
5762b6ee221Sahoka static void
nandemulator_write_2(device_t self,uint16_t data)577fff85086Sahoka nandemulator_write_2(device_t self, uint16_t data)
5782b6ee221Sahoka {
5792b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
5802b6ee221Sahoka
5819491044fSahoka KASSERT(sc->sc_register_writable);
5829491044fSahoka
5832b6ee221Sahoka if (!sc->sc_register_writable) {
5842b6ee221Sahoka aprint_error_dev(self,
5852b6ee221Sahoka "trying to write read only location without effect\n");
5862b6ee221Sahoka return;
5872b6ee221Sahoka }
5882b6ee221Sahoka
5899491044fSahoka KASSERT(sc->sc_buswidth == NANDEMULATOR_16BIT);
5909491044fSahoka
5912b6ee221Sahoka if (sc->sc_buswidth != NANDEMULATOR_16BIT) {
5922b6ee221Sahoka aprint_error_dev(self,
5932b6ee221Sahoka "trying to write a word to an 8bit chip");
5942b6ee221Sahoka return;
5952b6ee221Sahoka }
5962b6ee221Sahoka
5979491044fSahoka KASSERT(sc->sc_io_len > 1);
5989491044fSahoka
5992b6ee221Sahoka if (sc->sc_io_len > 1) {
6002b6ee221Sahoka *(uint16_t *)sc->sc_io_pointer = data;
6012b6ee221Sahoka
6022b6ee221Sahoka sc->sc_io_pointer += 2;
6032b6ee221Sahoka sc->sc_io_len -= 2;
6042b6ee221Sahoka } else {
6052b6ee221Sahoka aprint_error_dev(self, "writing to invalid location");
6062b6ee221Sahoka }
6072b6ee221Sahoka }
6082b6ee221Sahoka
6092b6ee221Sahoka static void
nandemulator_read_buf_1(device_t self,void * buf,size_t len)610fff85086Sahoka nandemulator_read_buf_1(device_t self, void *buf, size_t len)
6112b6ee221Sahoka {
6122b6ee221Sahoka uint8_t *addr;
6132b6ee221Sahoka
6142b6ee221Sahoka KASSERT(buf != NULL);
6152b6ee221Sahoka KASSERT(len >= 1);
6162b6ee221Sahoka
6172b6ee221Sahoka addr = buf;
6182b6ee221Sahoka while (len > 0) {
619fff85086Sahoka nandemulator_read_1(self, addr);
6202b6ee221Sahoka addr++, len--;
6212b6ee221Sahoka }
6222b6ee221Sahoka }
6232b6ee221Sahoka
6242b6ee221Sahoka static void
nandemulator_read_buf_2(device_t self,void * buf,size_t len)625fff85086Sahoka nandemulator_read_buf_2(device_t self, void *buf, size_t len)
6262b6ee221Sahoka {
6272b6ee221Sahoka uint16_t *addr;
6282b6ee221Sahoka
6292b6ee221Sahoka KASSERT(buf != NULL);
6302b6ee221Sahoka KASSERT(len >= 2);
6312b6ee221Sahoka KASSERT(!(len & 0x01));
6322b6ee221Sahoka
6332b6ee221Sahoka addr = buf;
6342b6ee221Sahoka len /= 2;
6352b6ee221Sahoka while (len > 0) {
636fff85086Sahoka nandemulator_read_2(self, addr);
6372b6ee221Sahoka addr++, len--;
6382b6ee221Sahoka }
6392b6ee221Sahoka }
6402b6ee221Sahoka
6412b6ee221Sahoka static void
nandemulator_write_buf_1(device_t self,const void * buf,size_t len)642fff85086Sahoka nandemulator_write_buf_1(device_t self, const void *buf, size_t len)
6432b6ee221Sahoka {
6442b6ee221Sahoka const uint8_t *addr;
6452b6ee221Sahoka
6462b6ee221Sahoka KASSERT(buf != NULL);
6472b6ee221Sahoka KASSERT(len >= 1);
6482b6ee221Sahoka
6492b6ee221Sahoka addr = buf;
6502b6ee221Sahoka while (len > 0) {
651fff85086Sahoka nandemulator_write_1(self, *addr);
6522b6ee221Sahoka addr++, len--;
6532b6ee221Sahoka }
6542b6ee221Sahoka }
6552b6ee221Sahoka
6562b6ee221Sahoka static void
nandemulator_write_buf_2(device_t self,const void * buf,size_t len)657fff85086Sahoka nandemulator_write_buf_2(device_t self, const void *buf, size_t len)
6582b6ee221Sahoka {
6592b6ee221Sahoka const uint16_t *addr;
6602b6ee221Sahoka
6612b6ee221Sahoka KASSERT(buf != NULL);
6622b6ee221Sahoka KASSERT(len >= 2);
6632b6ee221Sahoka KASSERT(!(len & 0x01));
6642b6ee221Sahoka
6652b6ee221Sahoka addr = buf;
6662b6ee221Sahoka len /= 2;
6672b6ee221Sahoka while (len > 0) {
668fff85086Sahoka nandemulator_write_2(self, *addr);
6692b6ee221Sahoka addr++, len--;
6702b6ee221Sahoka }
6712b6ee221Sahoka }
6722b6ee221Sahoka
6732b6ee221Sahoka static size_t
nandemulator_address_to_page(device_t self)6742b6ee221Sahoka nandemulator_address_to_page(device_t self)
6752b6ee221Sahoka {
6762b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
6772b6ee221Sahoka uint64_t address, offset;
6782b6ee221Sahoka int i;
6792b6ee221Sahoka
6802b6ee221Sahoka address = htole64(sc->sc_address);
6812b6ee221Sahoka address &= sc->sc_row_mask;
6822b6ee221Sahoka
6832b6ee221Sahoka offset = 0;
6842b6ee221Sahoka for (i = 0; i < sc->sc_row_cycles; i++) {
6852b6ee221Sahoka offset <<= 8;
6862b6ee221Sahoka offset |= (address & 0xff);
6872b6ee221Sahoka address >>= 8;
6882b6ee221Sahoka }
6892b6ee221Sahoka
6902b6ee221Sahoka return le64toh(offset);
6912b6ee221Sahoka }
6922b6ee221Sahoka
6932b6ee221Sahoka static size_t
nandemulator_column_address_to_subpage(device_t self)6942b6ee221Sahoka nandemulator_column_address_to_subpage(device_t self)
6952b6ee221Sahoka {
6962b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
6972b6ee221Sahoka uint64_t address, offset;
6982b6ee221Sahoka int i;
6992b6ee221Sahoka
7002b6ee221Sahoka address = htole64(sc->sc_address);
7012b6ee221Sahoka address >>= (8 * sc->sc_row_cycles);
7022b6ee221Sahoka
7032b6ee221Sahoka offset = 0;
7042b6ee221Sahoka for (i = 0; i < sc->sc_column_cycles; i++) {
7052b6ee221Sahoka offset <<= 8;
7062b6ee221Sahoka offset |= (address & 0xff);
7072b6ee221Sahoka address >>= 8;
7082b6ee221Sahoka }
7092b6ee221Sahoka
7102b6ee221Sahoka if (sc->sc_buswidth == NANDEMULATOR_16BIT)
7112b6ee221Sahoka return (size_t )le64toh(offset << 1);
7122b6ee221Sahoka else
7132b6ee221Sahoka return (size_t )le64toh(offset);
7142b6ee221Sahoka }
7152b6ee221Sahoka
7162b6ee221Sahoka static size_t
nandemulator_page_to_backend_offset(device_t self,size_t page)7172b6ee221Sahoka nandemulator_page_to_backend_offset(device_t self, size_t page)
7182b6ee221Sahoka {
7192b6ee221Sahoka struct nandemulator_softc *sc = device_private(self);
7202b6ee221Sahoka
7212b6ee221Sahoka return (sc->sc_page_size + sc->sc_spare_size) * page;
7222b6ee221Sahoka }
7232b6ee221Sahoka
7242b6ee221Sahoka #ifdef _MODULE
7252b6ee221Sahoka
7262b6ee221Sahoka MODULE(MODULE_CLASS_DRIVER, nandemulator, "nand");
7272b6ee221Sahoka
7282b6ee221Sahoka static const struct cfiattrdata nandbuscf_iattrdata = {
7292b6ee221Sahoka "nandbus", 0, { { NULL, NULL, 0 }, }
7302b6ee221Sahoka };
7312b6ee221Sahoka static const struct cfiattrdata * const nandemulator_attrs[] = {
7322b6ee221Sahoka &nandbuscf_iattrdata, NULL
7332b6ee221Sahoka };
7342b6ee221Sahoka
7352b6ee221Sahoka CFDRIVER_DECL(nandemulator, DV_DULL, nandemulator_attrs);
7362b6ee221Sahoka extern struct cfattach nandemulator_ca;
7372b6ee221Sahoka static int nandemulatorloc[] = { -1, -1 };
7382b6ee221Sahoka
7392b6ee221Sahoka static struct cfdata nandemulator_cfdata[] = {
7402b6ee221Sahoka {
7412b6ee221Sahoka .cf_name = "nandemulator",
7422b6ee221Sahoka .cf_atname = "nandemulator",
7432b6ee221Sahoka .cf_unit = 0,
7442b6ee221Sahoka .cf_fstate = FSTATE_STAR,
7452b6ee221Sahoka .cf_loc = nandemulatorloc,
7462b6ee221Sahoka .cf_flags = 0,
7472b6ee221Sahoka .cf_pspec = NULL,
7482b6ee221Sahoka },
7492b6ee221Sahoka { NULL, NULL, 0, 0, NULL, 0, NULL }
7502b6ee221Sahoka };
7512b6ee221Sahoka
7522b6ee221Sahoka static int
nandemulator_modcmd(modcmd_t cmd,void * arg)7532b6ee221Sahoka nandemulator_modcmd(modcmd_t cmd, void *arg)
7542b6ee221Sahoka {
7552b6ee221Sahoka int error;
7562b6ee221Sahoka
7572b6ee221Sahoka switch (cmd) {
7582b6ee221Sahoka case MODULE_CMD_INIT:
7592b6ee221Sahoka error = config_cfdriver_attach(&nandemulator_cd);
7602b6ee221Sahoka if (error) {
7612b6ee221Sahoka return error;
7622b6ee221Sahoka }
7632b6ee221Sahoka
7642b6ee221Sahoka error = config_cfattach_attach(nandemulator_cd.cd_name,
7652b6ee221Sahoka &nandemulator_ca);
7662b6ee221Sahoka if (error) {
7672b6ee221Sahoka config_cfdriver_detach(&nandemulator_cd);
7682b6ee221Sahoka aprint_error("%s: unable to register cfattach\n",
7692b6ee221Sahoka nandemulator_cd.cd_name);
7702b6ee221Sahoka
7712b6ee221Sahoka return error;
7722b6ee221Sahoka }
7732b6ee221Sahoka
7742b6ee221Sahoka error = config_cfdata_attach(nandemulator_cfdata, 1);
7752b6ee221Sahoka if (error) {
7762b6ee221Sahoka config_cfattach_detach(nandemulator_cd.cd_name,
7772b6ee221Sahoka &nandemulator_ca);
7782b6ee221Sahoka config_cfdriver_detach(&nandemulator_cd);
7792b6ee221Sahoka aprint_error("%s: unable to register cfdata\n",
7802b6ee221Sahoka nandemulator_cd.cd_name);
7812b6ee221Sahoka
7822b6ee221Sahoka return error;
7832b6ee221Sahoka }
7842b6ee221Sahoka
7852b6ee221Sahoka (void)config_attach_pseudo(nandemulator_cfdata);
7862b6ee221Sahoka
7872b6ee221Sahoka return 0;
7888f72be80Sahoka
7892b6ee221Sahoka case MODULE_CMD_FINI:
7902b6ee221Sahoka error = config_cfdata_detach(nandemulator_cfdata);
7912b6ee221Sahoka if (error) {
7922b6ee221Sahoka return error;
7932b6ee221Sahoka }
7942b6ee221Sahoka
7952b6ee221Sahoka config_cfattach_detach(nandemulator_cd.cd_name,
7962b6ee221Sahoka &nandemulator_ca);
7972b6ee221Sahoka config_cfdriver_detach(&nandemulator_cd);
7982b6ee221Sahoka
7992b6ee221Sahoka return 0;
8008f72be80Sahoka
8018f72be80Sahoka case MODULE_CMD_AUTOUNLOAD:
8028f72be80Sahoka /* prevent auto-unload */
8038f72be80Sahoka return EBUSY;
8048f72be80Sahoka
8052b6ee221Sahoka default:
8062b6ee221Sahoka return ENOTTY;
8072b6ee221Sahoka }
8082b6ee221Sahoka }
8092b6ee221Sahoka
8102b6ee221Sahoka #endif
811