[src/trunk]: src/sys/dev/nor Initial work on a NOR driver; it's commited here...

[ahoka <ahoka%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/c0be099d34de
branches:  trunk
changeset: 766448:c0be099d34de
user:      ahoka <ahoka%NetBSD.org@localhost>
date:      Wed Jun 22 21:59:15 2011 +0000

description:
Initial work on a NOR driver; it's commited here as is,
so I can cooperate with Cliff Neighbors on finishing it.

Not any way connected to the build.

diffstat:

 sys/dev/nor/cfi.h     |   16 +
 sys/dev/nor/files.nor |   11 +
 sys/dev/nor/nor.c     |  582 ++++++++++++++++++++++++++++++++++++++++++++++++++
 sys/dev/nor/nor.h     |  340 +++++++++++++++++++++++++++++
 4 files changed, 949 insertions(+), 0 deletions(-)

diffs (truncated from 965 to 300 lines):

diff -r 82c7b58b9453 -r c0be099d34de sys/dev/nor/cfi.h
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/sys/dev/nor/cfi.h Wed Jun 22 21:59:15 2011 +0000
@@ -0,0 +1,16 @@
+#ifndef _CFI_H_
+#define _CFI_H_
+
+enum {
+       CFI_QUERY_MODE_ADDRESS = 0x55, /* some devices accept anything */
+       CFI_QUERY_DATA = 0x98,
+
+       CFI_READ_ARRAY_MODE_ADDRESS = 0x00, /* could be anything */
+       CFI_READ_ARRAY_MODE_DATA = 0xf0,    /* also can be 0xff */
+
+       CFI_ADDR_IDENTIFICATION_STRING = 0x10,
+       CFI_ADDR_SYS_INTERFACE_INFO = 0x1b,
+       CFI_ADDR_DEV_GEOMETRY = 0x27
+};
+
+#endif
diff -r 82c7b58b9453 -r c0be099d34de sys/dev/nor/files.nor
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/sys/dev/nor/files.nor     Wed Jun 22 21:59:15 2011 +0000
@@ -0,0 +1,11 @@
+# $NetBSD: files.nor,v 1.1 2011/06/22 21:59:15 ahoka Exp $
+
+define norbus  { }
+
+device nor: flashbus
+attach nor at norbus
+file   dev/nor/nor.c           nor
+#file  dev/nor/nor_io.c        nor
+
+defflag opt_nor.h              NOR_DEBUG
+defflag opt_nor.h              NOR_VERBOSE
diff -r 82c7b58b9453 -r c0be099d34de sys/dev/nor/nor.c
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/sys/dev/nor/nor.c Wed Jun 22 21:59:15 2011 +0000
@@ -0,0 +1,582 @@
+/*     $NetBSD: nor.c,v 1.1 2011/06/22 21:59:15 ahoka Exp $    */
+
+/*-
+ * Copyright (c) 2011 Department of Software Engineering,
+ *                   University of Szeged, Hungary
+ * Copyright (c) 2011 Adam Hoka <ahoka%NetBSD.org@localhost>
+ * All rights reserved.
+ *
+ * This code is derived from software contributed to The NetBSD Foundation
+ * by the Department of Software Engineering, University of Szeged, Hungary
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+/* Common driver for NOR chips implementing the ONFI CFI specification */
+
+#include <sys/cdefs.h>
+__KERNEL_RCSID(0, "$NetBSD: nor.c,v 1.1 2011/06/22 21:59:15 ahoka Exp $");
+
+#include "locators.h"
+
+#include <sys/param.h>
+#include <sys/types.h>
+#include <sys/device.h>
+#include <sys/kmem.h>
+#include <sys/sysctl.h>
+#include <sys/atomic.h>
+
+#include <dev/flash/flash.h>
+#include <dev/nor/nor.h>
+#include <dev/nor/cfi.h>
+
+//#include "opt_nor.h"
+
+int nor_match(device_t, cfdata_t, void *);
+void nor_attach(device_t, device_t, void *);
+int nor_detach(device_t, int);
+bool nor_shutdown(device_t, int);
+
+int nor_print(void *, const char *);
+static int nor_search(device_t, cfdata_t, const int *, void *);
+
+CFATTACH_DECL_NEW(nor, sizeof(struct nor_softc),
+    nor_match, nor_attach, nor_detach, NULL);
+
+#ifdef NOR_DEBUG
+int    nordebug = NOR_DEBUG;
+#endif
+
+int nor_cachesync_timeout = 1;
+int nor_cachesync_nodenum;
+
+#ifdef NOR_VERBOSE
+const struct nor_manufacturer nor_mfrs[] = {
+       { NOR_MFR_AMD,          "AMD" },
+       { NOR_MFR_FUJITSU,      "Fujitsu" },
+       { NOR_MFR_RENESAS,      "Renesas" },
+       { NOR_MFR_STMICRO,      "ST Micro" },
+       { NOR_MFR_MICRON,       "Micron" },
+       { NOR_MFR_NATIONAL,     "National" },
+       { NOR_MFR_TOSHIBA,      "Toshiba" },
+       { NOR_MFR_HYNIX,        "Hynix" },
+       { NOR_MFR_SAMSUNG,      "Samsung" },
+       { NOR_MFR_UNKNOWN,      "Unknown" }
+};
+
+static const char *
+nor_midtoname(int id)
+{
+       int i;
+
+       for (i = 0; nor_mfrs[i].id != 0; i++) {
+               if (nor_mfrs[i].id == id)
+                       return nor_mfrs[i].name;
+       }
+
+       KASSERT(nor_mfrs[i].id == 0);
+
+       return nor_mfrs[i].name;
+}
+#endif
+
+/* ARGSUSED */
+int
+nor_match(device_t parent, cfdata_t match, void *aux)
+{
+       /* pseudo device, always attaches */
+       return 1;
+}
+
+void
+nor_attach(device_t parent, device_t self, void *aux)
+{
+       struct nor_softc *sc = device_private(self);
+       struct nor_attach_args *naa = aux;
+       struct nor_chip *chip = &sc->sc_chip;
+
+       sc->sc_dev = self;
+       sc->controller_dev = parent;
+       sc->nor_if = naa->naa_nor_if;
+
+       aprint_naive("\n");
+
+       /* allocate cache */
+       chip->nc_oob_cache = kmem_alloc(chip->nc_spare_size, KM_SLEEP);
+       chip->nc_page_cache = kmem_alloc(chip->nc_page_size, KM_SLEEP);
+
+       mutex_init(&sc->sc_device_lock, MUTEX_DEFAULT, IPL_NONE);
+
+       if (nor_sync_thread_start(self)) {
+               goto error;
+       }
+
+       if (!pmf_device_register1(sc->sc_dev, NULL, NULL, nor_shutdown))
+               aprint_error_dev(sc->sc_dev,
+                   "couldn't establish power handler\n");
+
+#ifdef NOR_BBT
+       nor_bbt_init(self);
+       nor_bbt_scan(self);
+#endif
+
+       /*
+        * Attach all our devices
+        */
+       config_search_ia(nor_search, self, NULL, NULL);
+
+       return;
+error:
+       kmem_free(chip->nc_oob_cache, chip->nc_spare_size);
+       kmem_free(chip->nc_page_cache, chip->nc_page_size);
+       mutex_destroy(&sc->sc_device_lock);
+}
+
+static int
+nor_search(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
+{
+       struct nor_softc *sc = device_private(parent);
+       struct nor_chip *chip = &sc->sc_chip;
+       struct flash_interface *flash_if;
+       struct flash_attach_args faa;
+
+       flash_if = kmem_alloc(sizeof(*flash_if), KM_SLEEP);
+
+       flash_if->type = FLASH_TYPE_NOR;
+
+       flash_if->read = nor_flash_read;
+       flash_if->write = nor_flash_write;
+       flash_if->erase = nor_flash_erase;
+       flash_if->block_isbad = nor_flash_isbad;
+       flash_if->block_markbad = nor_flash_markbad;
+
+       flash_if->submit = nor_io_submit;
+
+       flash_if->erasesize = chip->nc_block_size;
+       flash_if->page_size = chip->nc_page_size;
+       flash_if->writesize = chip->nc_page_size;
+
+       flash_if->partition.part_offset = cf->cf_loc[FLASHBUSCF_OFFSET];
+
+       if (cf->cf_loc[FLASHBUSCF_SIZE] == 0) {
+               flash_if->size = chip->nc_size -
+                   flash_if->partition.part_offset;
+               flash_if->partition.part_size = flash_if->size;
+       } else {
+               flash_if->size = cf->cf_loc[FLASHBUSCF_SIZE];
+               flash_if->partition.part_size = cf->cf_loc[FLASHBUSCF_SIZE];
+       }
+
+       if (cf->cf_loc[FLASHBUSCF_READONLY])
+               flash_if->partition.part_flags = FLASH_PART_READONLY;
+       else
+               flash_if->partition.part_flags = 0;
+
+       faa.flash_if = flash_if;
+
+       if (config_match(parent, cf, &faa)) {
+               if (config_attach(parent, cf, &faa, nor_print) != NULL) {
+                       return 0;
+               } else {
+                       return 1;
+               }
+       } else {
+               kmem_free(flash_if, sizeof(*flash_if));
+       }
+
+       return 1;
+}
+
+int
+nor_detach(device_t self, int flags)
+{
+       struct nor_softc *sc = device_private(self);
+       struct nor_chip *chip = &sc->sc_chip;
+       int error = 0;
+
+       error = config_detach_children(self, flags);
+       if (error) {
+               return error;
+       }
+
+       nor_sync_thread_stop(self);
+#ifdef NOR_BBT
+       nor_bbt_detach(self);
+#endif
+       /* free oob cache */
+       kmem_free(chip->nc_oob_cache, chip->nc_spare_size);
+       kmem_free(chip->nc_page_cache, chip->nc_page_size);
+
+       mutex_destroy(&sc->sc_device_lock);
+
+       pmf_device_deregister(sc->sc_dev);
+
+       return error;
+}
+
+int
+nor_print(void *aux, const char *pnp)
+{
+       if (pnp != NULL)
+               aprint_normal("nor at %s\n", pnp);
+
+       return UNCONF;
+}
+
+/* ask for a nor driver to attach to the controller */
+device_t
+nor_attach_mi(struct nor_interface *nor_if, device_t parent)
+{
+       struct nor_attach_args arg;
+
+       KASSERT(nor_if != NULL);
+
+       arg.naa_nor_if = nor_if;
+       return config_found_ia(parent, "norbus", &arg, nor_print);
+}
+
+/* default everything to reasonable values, to ease future api changes */
+void
+nor_init_interface(struct nor_interface *interface)
+{
+       interface->select = &nor_default_select;