sys/dev/spi/m25p.c

   1 /* $NetBSD: m25p.c,v 1.1 2006/10/07 07:21:13 gdamore Exp $ */
   2
   3 /*-
   4  * Copyright (c) 2006 Urbana-Champaign Independent Media Center.
   5  * Copyright (c) 2006 Garrett D'Amore.
   6  * All rights reserved.
   7  *
   8  * Portions of this code were written by Garrett D'Amore for the
   9  * Champaign-Urbana Community Wireless Network Project.
  10  *
  11  * Redistribution and use in source and binary forms, with or
  12  * without modification, are permitted provided that the following
  13  * conditions are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above
  17  *    copyright notice, this list of conditions and the following
  18  *    disclaimer in the documentation and/or other materials provided
  19  *    with the distribution.
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgements:
  22  *      This product includes software developed by the Urbana-Champaign
  23  *      Independent Media Center.
  24  *      This product includes software developed by Garrett D'Amore.
  25  * 4. Urbana-Champaign Independent Media Center's name and Garrett
  26  *    D'Amore's name may not be used to endorse or promote products
  27  *    derived from this software without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE URBANA-CHAMPAIGN INDEPENDENT
  30  * MEDIA CENTER AND GARRETT D'AMORE ``AS IS'' AND ANY EXPRESS OR
  31  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  32  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33  * ARE DISCLAIMED.  IN NO EVENT SHALL THE URBANA-CHAMPAIGN INDEPENDENT
  34  * MEDIA CENTER OR GARRETT D'AMORE BE LIABLE FOR ANY DIRECT, INDIRECT,
  35  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  36  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  38  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  40  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42  */
  43
  44 #include <sys/cdefs.h>
  45 __KERNEL_RCSID(0, "$NetBSD: m25p.c,v 1.1 2006/10/07 07:21:13 gdamore Exp $");
  46
  47 #include <sys/param.h>
  48 #include <sys/systm.h>
  49 #include <sys/device.h>
  50 #include <sys/kernel.h>
  51
  52 #include <dev/sysmon/sysmonvar.h>
  53
  54 #include <dev/spi/spivar.h>
  55 #include <dev/spi/spiflash.h>
  56
  57 /*
  58  * Device driver for STMicroelectronics M25P Family SPI Flash Devices
  59  */
  60
  61 static int m25p_match(device_t , cfdata_t , void *);
  62 static void m25p_attach(device_t , device_t , void *);
  63 static const char *m25p_getname(void *);
  64 static struct spi_handle *m25p_gethandle(void *);
  65 static int m25p_getflags(void *);
  66 static int m25p_getsize(void *, int);
  67
  68 struct m25p_softc {
  69         struct spi_handle       *sc_sh;
  70         const char              *sc_name;
  71         int                     sc_sizes[SPIFLASH_SIZE_COUNT];
  72         int                     sc_flags;
  73 };
  74
  75 CFATTACH_DECL_NEW(m25p, sizeof(struct m25p_softc),
  76     m25p_match, m25p_attach, NULL, NULL);
  77
  78 static const struct spiflash_hw_if m25p_hw_if = {
  79         .sf_getname = m25p_getname,
  80         .sf_gethandle = m25p_gethandle,
  81         .sf_getsize = m25p_getsize,
  82         .sf_getflags = m25p_getflags,
  83 };
  84
  85 static const struct m25p_info {
  86         uint8_t         sig;
  87         uint8_t         mfgid;
  88         uint16_t        devid;
  89         const char      *name;
  90         uint16_t        size;   /* in KB */
  91         uint16_t        sector; /* in KB */
  92         uint16_t        mhz;
  93 } m25p_infos[] = {
  94         { 0x16, 0x20, 0x2017, "STMicro M25P64", 8192, 64 },     /* 64Mbit */
  95         { 0x12, 0x20, 0x2013, "STMicro M25P40", 512, 64 },      /* 4Mbit */
  96         { 0 }
  97 };
  98
  99 static int
 100 m25p_match(device_t parent, cfdata_t cf, void *aux)
 101 {
 102         struct spi_attach_args *sa = aux;
 103
 104         /* configure for 20MHz, which is the max for normal reads */
 105         if (spi_configure(sa->sa_handle, SPI_MODE_0, 20000000))
 106                 return 0;
 107
 108         return 1;
 109 }
 110
 111 static void
 112 m25p_attach(device_t parent, device_t self, void *aux)
 113 {
 114         struct m25p_softc *sc = device_private(self);
 115         struct spi_attach_args *sa = aux;
 116         const struct m25p_info *info;
 117         uint8_t  buf[4];
 118         uint8_t cmd;
 119         uint8_t mfgid;
 120         uint8_t sig;
 121         uint16_t devid;
 122
 123         sc->sc_sh = sa->sa_handle;
 124
 125         /* first we try JEDEC ID read */
 126
 127         cmd = SPIFLASH_CMD_RDJI;
 128         if (spi_send_recv(sa->sa_handle, 1, &cmd, 3, buf)) {
 129                 aprint_error(": failed to get JEDEC identification\n");
 130                 return;
 131         }
 132         mfgid = buf[0];
 133         devid = ((uint16_t)buf[1] << 8) | buf[2];
 134
 135         if ((mfgid == 0xff) || (mfgid == 0)) {
 136                 cmd = SPIFLASH_CMD_RDID;
 137                 if (spi_send_recv(sa->sa_handle, 1, &cmd, 4, buf)) {
 138                         aprint_error(": failed to get legacy signature\n");
 139                         return;
 140                 }
 141                 sig = buf[3];
 142         } else {
 143                 sig = 0;
 144         }
 145
 146         /* okay did it match */
 147         for (info = m25p_infos; info->name; info++) {
 148                 if ((info->mfgid == mfgid) && (info->devid == devid))
 149                         break;
 150                 if (sig == info->sig)
 151                         break;
 152         }
 153
 154         if (info->name == NULL) {
 155                 aprint_error(": unknown or unsupported device\n");
 156                 return;
 157         }
 158
 159         sc->sc_name = info->name;
 160         sc->sc_sh = sa->sa_handle;
 161         sc->sc_sizes[SPIFLASH_SIZE_DEVICE] = info->size * 1024;
 162         sc->sc_sizes[SPIFLASH_SIZE_ERASE] = info->sector * 1024;
 163         sc->sc_sizes[SPIFLASH_SIZE_WRITE] = 256;
 164         sc->sc_sizes[SPIFLASH_SIZE_READ] = -1;
 165
 166         sc->sc_flags = SPIFLASH_FLAG_FAST_READ;
 167
 168         aprint_normal("\n");
 169
 170         spiflash_attach_mi(&m25p_hw_if, sc, self);
 171 }
 172
 173 const char *
 174 m25p_getname(void *cookie)
 175 {
 176         struct m25p_softc *sc = cookie;
 177
 178         return (sc->sc_name);
 179 }
 180
 181 struct spi_handle *
 182 m25p_gethandle(void *cookie)
 183 {
 184         struct m25p_softc *sc = cookie;
 185
 186         return (sc->sc_sh);
 187 }
 188
 189 int
 190 m25p_getflags(void *cookie)
 191 {
 192         struct m25p_softc *sc = cookie;
 193
 194         return (sc->sc_flags);
 195 }
 196
 197 int
 198 m25p_getsize(void *cookie, int idx)
 199 {
 200         struct m25p_softc *sc = cookie;
 201
 202         if ((idx < 0) || (idx >= SPIFLASH_SIZE_COUNT))
 203                 return -1;
 204         return (sc->sc_sizes[idx]);
 205 }