Home | History | Annotate | Line # | Download | only in spi
m25p.c revision 1.6.4.1
      1 /* $NetBSD: m25p.c,v 1.6.4.1 2020/04/08 14:08:12 martin 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.6.4.1 2020/04/08 14:08:12 martin 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, 0xBA18, "Micron MT25QL128", 16384, 64 },  /* 128Mbit (3V) */
    100 	{ 0x00, 0x20, 0xBB18, "Micron MT25QU128", 16384, 64 },  /* 128Mbit (1.8V)  */
    101 	{ 0x00, 0xBF, 0x2541, "Microchip SST25VF016B", 2048, 64 }, /* 16Mbit */
    102 	{ 0x13, 0xEF, 0x4014, "Winbond W25Q80.V", 1024, 64 },	/* 8Mbit */
    103 	{ 0x14, 0xEF, 0x4015, "Winbond W25Q16.V", 2048, 64 },	/* 16Mbit */
    104 	{ 0x15, 0xEF, 0x4016, "Winbond W25Q32.V", 4096, 64 },	/* 32Mbit */
    105 	{ 0x15, 0xEF, 0x6016, "Winbond W25Q32.W", 4096, 64 },	/* 32Mbit */
    106 	{ 0 }
    107 };
    108 
    109 static int
    110 m25p_match(device_t parent, cfdata_t cf, void *aux)
    111 {
    112 	struct spi_attach_args *sa = aux;
    113 
    114 	/* configure for 20MHz, which is the max for normal reads */
    115 	if (spi_configure(sa->sa_handle, SPI_MODE_0, 20000000))
    116 		return 0;
    117 
    118 	return 1;
    119 }
    120 
    121 static void
    122 m25p_attach(device_t parent, device_t self, void *aux)
    123 {
    124 	struct m25p_softc *sc = device_private(self);
    125 	struct spi_attach_args *sa = aux;
    126 
    127 	sc->sc_sh = sa->sa_handle;
    128 
    129 	config_interrupts(self, m25p_doattach);
    130 }
    131 
    132 static void
    133 m25p_doattach(device_t self)
    134 {
    135 	struct m25p_softc *sc = device_private(self);
    136 	const struct m25p_info *info;
    137 	uint8_t	buf[4];
    138 	uint8_t	cmd;
    139 	uint8_t mfgid;
    140 	uint8_t sig;
    141 	uint16_t devid;
    142 
    143 	/* first we try JEDEC ID read */
    144 	cmd = SPIFLASH_CMD_RDJI;
    145 	if (spi_send_recv(sc->sc_sh, 1, &cmd, 3, buf)) {
    146 		aprint_error(": failed to get JEDEC identification\n");
    147 		return;
    148 	}
    149 	mfgid = buf[0];
    150 	devid = ((uint16_t)buf[1] << 8) | buf[2];
    151 
    152 	if ((mfgid == 0xff) || (mfgid == 0)) {
    153 		cmd = SPIFLASH_CMD_RDID;
    154 		if (spi_send_recv(sc->sc_sh, 1, &cmd, 4, buf)) {
    155 			aprint_error(": failed to get legacy signature\n");
    156 			return;
    157 		}
    158 		sig = buf[3];
    159 	} else {
    160 		sig = 0;
    161 	}
    162 
    163 	/* okay did it match */
    164 	for (info = m25p_infos; info->name; info++) {
    165 		if ((info->mfgid == mfgid) && (info->devid == devid))
    166 			break;
    167 		if ((sig != 0) && (sig == info->sig))
    168 			break;
    169 	}
    170 
    171 	if (info->name == NULL) {
    172 		aprint_error(": unknown or unsupported device\n");
    173 		return;
    174 	}
    175 
    176 	sc->sc_name = info->name;
    177 	sc->sc_sizes[SPIFLASH_SIZE_DEVICE] = info->size * 1024;
    178 	sc->sc_sizes[SPIFLASH_SIZE_ERASE] = info->sector * 1024;
    179 	sc->sc_sizes[SPIFLASH_SIZE_WRITE] = 256;
    180 	sc->sc_sizes[SPIFLASH_SIZE_READ] = -1;
    181 
    182 	sc->sc_flags = SPIFLASH_FLAG_FAST_READ;
    183 
    184 	aprint_normal_dev(self, "JEDEC ID mfgid:0x%02X, devid:0x%04X",
    185 	    mfgid, devid);
    186 	aprint_normal("\n");
    187 
    188 	spiflash_attach_mi(&m25p_hw_if, sc, self);
    189 }
    190 
    191 const char *
    192 m25p_getname(void *cookie)
    193 {
    194 	struct m25p_softc *sc = cookie;
    195 
    196 	return (sc->sc_name);
    197 }
    198 
    199 struct spi_handle *
    200 m25p_gethandle(void *cookie)
    201 {
    202 	struct m25p_softc *sc = cookie;
    203 
    204 	return (sc->sc_sh);
    205 }
    206 
    207 int
    208 m25p_getflags(void *cookie)
    209 {
    210 	struct m25p_softc *sc = cookie;
    211 
    212 	return (sc->sc_flags);
    213 }
    214 
    215 int
    216 m25p_getsize(void *cookie, int idx)
    217 {
    218 	struct m25p_softc *sc = cookie;
    219 
    220 	if ((idx < 0) || (idx >= SPIFLASH_SIZE_COUNT))
    221 		return -1;
    222 	return (sc->sc_sizes[idx]);
    223 }
    224