1 /* $NetBSD: m25p.c,v 1.14 2019/09/14 15:12:12 tnn 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.14 2019/09/14 15:12:12 tnn 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 { 0x00, 0xC2, 0x2011, "Macronix MX25L10", 128, 64 }, /* 1Mbit */ 102 { 0x00, 0xC2, 0x2012, "Macronix MX25L20", 256, 64 }, /* 2Mbit */ 103 { 0x00, 0xC2, 0x2013, "Macronix MX25L40", 512, 64 }, /* 4Mbit */ 104 { 0x00, 0xC2, 0x2014, "Macronix MX25L80", 1024, 64 }, /* 8Mbit */ 105 { 0x00, 0xC8, 0x4018, "GigaDevice 25Q127CSIG", 16384, 64 }, /* 128Mbit */ 106 { 0x00, 0xEF, 0x3011, "Winbond W25X10", 128, 64 }, /* 1Mbit */ 107 { 0x00, 0xEF, 0x3012, "Winbond W25X20", 256, 64 }, /* 2Mbit */ 108 { 0x00, 0xEF, 0x3013, "Winbond W25X40", 512, 64 }, /* 4Mbit */ 109 { 0x00, 0xEF, 0x3014, "Winbond W25X80", 1024, 64 }, /* 8Mbit */ 110 { 0x13, 0xEF, 0x4014, "Winbond W25Q80.V", 1024, 64 }, /* 8Mbit */ 111 { 0x14, 0xEF, 0x4015, "Winbond W25Q16.V", 2048, 64 }, /* 16Mbit */ 112 { 0x15, 0xEF, 0x4016, "Winbond W25Q32.V", 4096, 64 }, /* 32Mbit */ 113 { 0x15, 0xEF, 0x4018, "Winbond W25Q128.V", 16384, 64 }, /* 128Mbit */ 114 { 0x15, 0xEF, 0x6016, "Winbond W25Q32.W", 4096, 64 }, /* 32Mbit */ 115 { 0 } 116 }; 117 118 static const struct device_compatible_entry compat_data[] = { 119 { "jedec,spi-nor", 0 }, 120 { NULL, 0 } 121 }; 122 123 static int 124 m25p_match(device_t parent, cfdata_t cf, void *aux) 125 { 126 struct spi_attach_args *sa = aux; 127 int res; 128 129 res = spi_compatible_match(sa, cf, compat_data); 130 if (!res) 131 return res; 132 133 /* configure for 20MHz, which is the max for normal reads */ 134 if (spi_configure(sa->sa_handle, SPI_MODE_0, 20000000)) 135 res = 0; 136 137 return res; 138 } 139 140 static void 141 m25p_attach(device_t parent, device_t self, void *aux) 142 { 143 struct m25p_softc *sc = device_private(self); 144 struct spi_attach_args *sa = aux; 145 146 sc->sc_sh = sa->sa_handle; 147 148 aprint_normal("\n"); 149 aprint_naive("\n"); 150 151 config_interrupts(self, m25p_doattach); 152 } 153 154 static void 155 m25p_doattach(device_t self) 156 { 157 struct m25p_softc *sc = device_private(self); 158 const struct m25p_info *info; 159 uint8_t buf[4]; 160 uint8_t cmd; 161 uint8_t mfgid; 162 uint8_t sig; 163 uint16_t devid; 164 165 /* first we try JEDEC ID read */ 166 cmd = SPIFLASH_CMD_RDJI; 167 if (spi_send_recv(sc->sc_sh, 1, &cmd, 3, buf)) { 168 aprint_error(": failed to get JEDEC identification\n"); 169 return; 170 } 171 mfgid = buf[0]; 172 devid = ((uint16_t)buf[1] << 8) | buf[2]; 173 174 if ((mfgid == 0xff) || (mfgid == 0)) { 175 cmd = SPIFLASH_CMD_RDID; 176 if (spi_send_recv(sc->sc_sh, 1, &cmd, 4, buf)) { 177 aprint_error(": failed to get legacy signature\n"); 178 return; 179 } 180 sig = buf[3]; 181 } else { 182 sig = 0; 183 } 184 185 /* okay did it match */ 186 for (info = m25p_infos; info->name; info++) { 187 if ((info->mfgid == mfgid) && (info->devid == devid)) 188 break; 189 if ((sig != 0) && (sig == info->sig)) 190 break; 191 } 192 193 if (info->name == NULL) { 194 aprint_error(": vendor 0x%02X dev 0x%04X sig 0x%02X not supported\n", 195 mfgid, devid, sig); 196 return; 197 } 198 199 sc->sc_name = info->name; 200 sc->sc_sizes[SPIFLASH_SIZE_DEVICE] = info->size * 1024; 201 sc->sc_sizes[SPIFLASH_SIZE_ERASE] = info->sector * 1024; 202 sc->sc_sizes[SPIFLASH_SIZE_WRITE] = 256; 203 sc->sc_sizes[SPIFLASH_SIZE_READ] = -1; 204 205 sc->sc_flags = SPIFLASH_FLAG_FAST_READ; 206 207 aprint_normal_dev(self, "JEDEC ID mfgid:0x%02X, devid:0x%04X", 208 mfgid, devid); 209 aprint_normal("\n"); 210 211 spiflash_attach_mi(&m25p_hw_if, sc, self); 212 } 213 214 const char * 215 m25p_getname(void *cookie) 216 { 217 struct m25p_softc *sc = cookie; 218 219 return (sc->sc_name); 220 } 221 222 struct spi_handle * 223 m25p_gethandle(void *cookie) 224 { 225 struct m25p_softc *sc = cookie; 226 227 return (sc->sc_sh); 228 } 229 230 int 231 m25p_getflags(void *cookie) 232 { 233 struct m25p_softc *sc = cookie; 234 235 return (sc->sc_flags); 236 } 237 238 int 239 m25p_getsize(void *cookie, int idx) 240 { 241 struct m25p_softc *sc = cookie; 242 243 if ((idx < 0) || (idx >= SPIFLASH_SIZE_COUNT)) 244 return -1; 245 return (sc->sc_sizes[idx]); 246 } 247