1 /* $NetBSD: m25p.c,v 1.5 2017/08/07 09:24:43 hkenken 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.5 2017/08/07 09:24:43 hkenken 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 void m25p_doattach(device_t); 64 static const char *m25p_getname(void *); 65 static struct spi_handle *m25p_gethandle(void *); 66 static int m25p_getflags(void *); 67 static int m25p_getsize(void *, int); 68 69 struct m25p_softc { 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_NEW(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 { 0x14, 0x20, 0x2015, "STMicro M25P16", 2048, 64 }, /* 16Mbit */ 97 { 0x12, 0x20, 0x2013, "STMicro M25P40", 512, 64 }, /* 4Mbit */ 98 { 0xc0, 0x20, 0x7117, "STMicro M25PX64", 8192, 64 }, /* 64Mbit */ 99 { 0x00, 0x20, 0xBB18, "Numonyx N25Q128", 16384, 64 }, /* 128Mbit */ 100 { 0x00, 0xBF, 0x2541, "Microchip SST25VF016B", 2048, 64 }, /* 16Mbit */ 101 { 0 } 102 }; 103 104 static int 105 m25p_match(device_t parent, cfdata_t cf, void *aux) 106 { 107 struct spi_attach_args *sa = aux; 108 109 /* configure for 20MHz, which is the max for normal reads */ 110 if (spi_configure(sa->sa_handle, SPI_MODE_0, 20000000)) 111 return 0; 112 113 return 1; 114 } 115 116 static void 117 m25p_attach(device_t parent, device_t self, void *aux) 118 { 119 struct m25p_softc *sc = device_private(self); 120 struct spi_attach_args *sa = aux; 121 122 sc->sc_sh = sa->sa_handle; 123 124 config_interrupts(self, m25p_doattach); 125 } 126 127 static void 128 m25p_doattach(device_t self) 129 { 130 struct m25p_softc *sc = device_private(self); 131 const struct m25p_info *info; 132 uint8_t buf[4]; 133 uint8_t cmd; 134 uint8_t mfgid; 135 uint8_t sig; 136 uint16_t devid; 137 138 /* first we try JEDEC ID read */ 139 cmd = SPIFLASH_CMD_RDJI; 140 if (spi_send_recv(sc->sc_sh, 1, &cmd, 3, buf)) { 141 aprint_error(": failed to get JEDEC identification\n"); 142 return; 143 } 144 mfgid = buf[0]; 145 devid = ((uint16_t)buf[1] << 8) | buf[2]; 146 147 if ((mfgid == 0xff) || (mfgid == 0)) { 148 cmd = SPIFLASH_CMD_RDID; 149 if (spi_send_recv(sc->sc_sh, 1, &cmd, 4, buf)) { 150 aprint_error(": failed to get legacy signature\n"); 151 return; 152 } 153 sig = buf[3]; 154 } else { 155 sig = 0; 156 } 157 158 /* okay did it match */ 159 for (info = m25p_infos; info->name; info++) { 160 if ((info->mfgid == mfgid) && (info->devid == devid)) 161 break; 162 if ((sig != 0) && (sig == info->sig)) 163 break; 164 } 165 166 if (info->name == NULL) { 167 aprint_error(": unknown or unsupported device\n"); 168 return; 169 } 170 171 sc->sc_name = info->name; 172 sc->sc_sizes[SPIFLASH_SIZE_DEVICE] = info->size * 1024; 173 sc->sc_sizes[SPIFLASH_SIZE_ERASE] = info->sector * 1024; 174 sc->sc_sizes[SPIFLASH_SIZE_WRITE] = 256; 175 sc->sc_sizes[SPIFLASH_SIZE_READ] = -1; 176 177 sc->sc_flags = SPIFLASH_FLAG_FAST_READ; 178 179 aprint_normal_dev(self, "JEDEC ID mfgid:0x%02X, devid:0x%04X", 180 mfgid, devid); 181 aprint_normal("\n"); 182 183 spiflash_attach_mi(&m25p_hw_if, sc, self); 184 } 185 186 const char * 187 m25p_getname(void *cookie) 188 { 189 struct m25p_softc *sc = cookie; 190 191 return (sc->sc_name); 192 } 193 194 struct spi_handle * 195 m25p_gethandle(void *cookie) 196 { 197 struct m25p_softc *sc = cookie; 198 199 return (sc->sc_sh); 200 } 201 202 int 203 m25p_getflags(void *cookie) 204 { 205 struct m25p_softc *sc = cookie; 206 207 return (sc->sc_flags); 208 } 209 210 int 211 m25p_getsize(void *cookie, int idx) 212 { 213 struct m25p_softc *sc = cookie; 214 215 if ((idx < 0) || (idx >= SPIFLASH_SIZE_COUNT)) 216 return -1; 217 return (sc->sc_sizes[idx]); 218 } 219