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(struct device *, struct cfdata *, void *); 62 static void m25p_attach(struct device *, struct device *, 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 device sc_dev; 70 struct spi_handle *sc_sh; 71 const char *sc_name; 72 int sc_sizes[SPIFLASH_SIZE_COUNT]; 73 int sc_flags; 74 }; 75 76 CFATTACH_DECL(m25p, sizeof(struct m25p_softc), 77 m25p_match, m25p_attach, NULL, NULL); 78 79 static const struct spiflash_hw_if m25p_hw_if = { 80 .sf_getname = m25p_getname, 81 .sf_gethandle = m25p_gethandle, 82 .sf_getsize = m25p_getsize, 83 .sf_getflags = m25p_getflags, 84 }; 85 86 static const struct m25p_info { 87 uint8_t sig; 88 uint8_t mfgid; 89 uint16_t devid; 90 const char *name; 91 uint16_t size; /* in KB */ 92 uint16_t sector; /* in KB */ 93 uint16_t mhz; 94 } m25p_infos[] = { 95 { 0x16, 0x20, 0x2017, "STMicro M25P64", 8192, 64 }, /* 64Mbit */ 96 { 0x12, 0x20, 0x2013, "STMicro M25P40", 512, 64 }, /* 4Mbit */ 97 { 0 } 98 }; 99 100 static int 101 m25p_match(struct device *parent, struct cfdata *cf, void *aux) 102 { 103 struct spi_attach_args *sa = aux; 104 105 /* configure for 20MHz, which is the max for normal reads */ 106 if (spi_configure(sa->sa_handle, SPI_MODE_0, 20000000)) 107 return 0; 108 109 return 1; 110 } 111 112 static void 113 m25p_attach(struct device *parent, struct device *self, void *aux) 114 { 115 struct m25p_softc *sc = device_private(self); 116 struct spi_attach_args *sa = aux; 117 const struct m25p_info *info; 118 uint8_t buf[4]; 119 uint8_t cmd; 120 uint8_t mfgid; 121 uint8_t sig; 122 uint16_t devid; 123 124 sc->sc_sh = sa->sa_handle; 125 126 /* first we try JEDEC ID read */ 127 128 cmd = SPIFLASH_CMD_RDJI; 129 if (spi_send_recv(sa->sa_handle, 1, &cmd, 3, buf)) { 130 aprint_error(": failed to get JEDEC identification\n"); 131 return; 132 } 133 mfgid = buf[0]; 134 devid = ((uint16_t)buf[1] << 8) | buf[2]; 135 136 if ((mfgid == 0xff) || (mfgid == 0)) { 137 cmd = SPIFLASH_CMD_RDID; 138 if (spi_send_recv(sa->sa_handle, 1, &cmd, 4, buf)) { 139 aprint_error(": failed to get legacy signature\n"); 140 return; 141 } 142 sig = buf[3]; 143 } else { 144 sig = 0; 145 } 146 147 /* okay did it match */ 148 for (info = m25p_infos; info->name; info++) { 149 if ((info->mfgid == mfgid) && (info->devid == devid)) 150 break; 151 if (sig == info->sig) 152 break; 153 } 154 155 if (info->name == NULL) { 156 aprint_error(": unknown or unsupported device\n"); 157 return; 158 } 159 160 sc->sc_name = info->name; 161 sc->sc_sh = sa->sa_handle; 162 sc->sc_sizes[SPIFLASH_SIZE_DEVICE] = info->size * 1024; 163 sc->sc_sizes[SPIFLASH_SIZE_ERASE] = info->sector * 1024; 164 sc->sc_sizes[SPIFLASH_SIZE_WRITE] = 256; 165 sc->sc_sizes[SPIFLASH_SIZE_READ] = -1; 166 167 sc->sc_flags = SPIFLASH_FLAG_FAST_READ; 168 169 printf("\n"); 170 171 spiflash_attach_mi(&m25p_hw_if, sc, self); 172 } 173 174 const char * 175 m25p_getname(void *cookie) 176 { 177 struct m25p_softc *sc = cookie; 178 179 return (sc->sc_name); 180 } 181 182 struct spi_handle * 183 m25p_gethandle(void *cookie) 184 { 185 struct m25p_softc *sc = cookie; 186 187 return (sc->sc_sh); 188 } 189 190 int 191 m25p_getflags(void *cookie) 192 { 193 struct m25p_softc *sc = cookie; 194 195 return (sc->sc_flags); 196 } 197 198 int 199 m25p_getsize(void *cookie, int idx) 200 { 201 struct m25p_softc *sc = cookie; 202 203 if ((idx < 0) || (idx >= SPIFLASH_SIZE_COUNT)) 204 return -1; 205 return (sc->sc_sizes[idx]); 206 } 207