4 * Copyright (C) 2008 Atmel Corporation
5 * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
7 * Licensed under the GPL-2 or later.
13 #include <spi_flash.h>
15 #include "spi_flash_internal.h"
17 static int spi_flash_read_write(struct spi_slave *spi,
18 const u8 *cmd, size_t cmd_len,
19 const u8 *data_out, u8 *data_in,
22 unsigned long flags = SPI_XFER_BEGIN;
26 flags |= SPI_XFER_END;
28 ret = spi_xfer(spi, cmd_len * 8, cmd, NULL, flags);
30 debug("SF: Failed to send command (%zu bytes): %d\n",
32 } else if (data_len != 0) {
33 ret = spi_xfer(spi, data_len * 8, data_out, data_in, SPI_XFER_END);
35 debug("SF: Failed to transfer %zu bytes of data: %d\n",
42 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len)
44 return spi_flash_cmd_read(spi, &cmd, 1, response, len);
47 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
48 size_t cmd_len, void *data, size_t data_len)
50 return spi_flash_read_write(spi, cmd, cmd_len, NULL, data, data_len);
53 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
54 const void *data, size_t data_len)
56 return spi_flash_read_write(spi, cmd, cmd_len, data, NULL, data_len);
59 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
60 size_t cmd_len, void *data, size_t data_len)
62 struct spi_slave *spi = flash->spi;
66 ret = spi_flash_cmd_read(spi, cmd, cmd_len, data, data_len);
72 int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout,
75 struct spi_slave *spi = flash->spi;
76 unsigned long timebase;
80 ret = spi_xfer(spi, 8, &cmd, NULL, SPI_XFER_BEGIN);
82 debug("SF: Failed to send command %02x: %d\n", cmd, ret);
86 timebase = get_timer(0);
88 ret = spi_xfer(spi, 8, NULL, &status, 0);
92 if ((status & poll_bit) == 0)
95 } while (get_timer(timebase) < timeout);
97 spi_xfer(spi, 0, NULL, NULL, SPI_XFER_END);
99 if ((status & poll_bit) == 0)
103 debug("SF: time out!\n");
107 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout)
109 return spi_flash_cmd_poll_bit(flash, timeout,
110 CMD_READ_STATUS, STATUS_WIP);
114 * The following table holds all device probe functions
116 * shift: number of continuation bytes before the ID
117 * idcode: the expected IDCODE or 0xff for non JEDEC devices
118 * probe: the function to call
120 * Non JEDEC devices should be ordered in the table such that
121 * the probe functions with best detection algorithms come first.
123 * Several matching entries are permitted, they will be tried
124 * in sequence until a probe function returns non NULL.
126 * IDCODE_CONT_LEN may be redefined if a device needs to declare a
127 * larger "shift" value. IDCODE_PART_LEN generally shouldn't be
128 * changed. This is the max number of bytes probe functions may
129 * examine when looking up part-specific identification info.
131 * Probe functions will be given the idcode buffer starting at their
132 * manu id byte (the "idcode" in the table below). In other words,
133 * all of the continuation bytes will be skipped (the "shift" below).
135 #define IDCODE_CONT_LEN 0
136 #define IDCODE_PART_LEN 5
137 static const struct {
140 struct spi_flash *(*probe) (struct spi_slave *spi, u8 *idcode);
142 /* Keep it sorted by define name */
143 #ifdef CONFIG_SPI_FLASH_ATMEL
144 { 0, 0x1f, spi_flash_probe_atmel, },
146 #ifdef CONFIG_SPI_FLASH_EON
147 { 0, 0x1c, spi_flash_probe_eon, },
149 #ifdef CONFIG_SPI_FLASH_MACRONIX
150 { 0, 0xc2, spi_flash_probe_macronix, },
152 #ifdef CONFIG_SPI_FLASH_SPANSION
153 { 0, 0x01, spi_flash_probe_spansion, },
155 #ifdef CONFIG_SPI_FLASH_SST
156 { 0, 0xbf, spi_flash_probe_sst, },
158 #ifdef CONFIG_SPI_FLASH_STMICRO
159 { 0, 0x20, spi_flash_probe_stmicro, },
161 #ifdef CONFIG_SPI_FLASH_WINBOND
162 { 0, 0xef, spi_flash_probe_winbond, },
164 #ifdef CONFIG_SPI_FRAM_RAMTRON
165 { 6, 0xc2, spi_fram_probe_ramtron, },
166 # undef IDCODE_CONT_LEN
167 # define IDCODE_CONT_LEN 6
169 /* Keep it sorted by best detection */
170 #ifdef CONFIG_SPI_FLASH_STMICRO
171 { 0, 0xff, spi_flash_probe_stmicro, },
173 #ifdef CONFIG_SPI_FRAM_RAMTRON_NON_JEDEC
174 { 0, 0xff, spi_fram_probe_ramtron, },
177 #define IDCODE_LEN (IDCODE_CONT_LEN + IDCODE_PART_LEN)
179 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
180 unsigned int max_hz, unsigned int spi_mode)
182 struct spi_slave *spi;
183 struct spi_flash *flash = NULL;
185 u8 idcode[IDCODE_LEN], *idp;
187 spi = spi_setup_slave(bus, cs, max_hz, spi_mode);
189 printf("SF: Failed to set up slave\n");
193 ret = spi_claim_bus(spi);
195 debug("SF: Failed to claim SPI bus: %d\n", ret);
199 /* Read the ID codes */
200 ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode));
205 printf("SF: Got idcodes\n");
206 print_buffer(0, idcode, 1, sizeof(idcode), 0);
209 /* count the number of continuation bytes */
210 for (shift = 0, idp = idcode;
211 shift < IDCODE_CONT_LEN && *idp == 0x7f;
215 /* search the table for matches in shift and id */
216 for (i = 0; i < ARRAY_SIZE(flashes); ++i)
217 if (flashes[i].shift == shift && flashes[i].idcode == *idp) {
218 /* we have a match, call probe */
219 flash = flashes[i].probe(spi, idp);
225 printf("SF: Unsupported manufacturer %02x\n", *idp);
226 goto err_manufacturer_probe;
229 spi_release_bus(spi);
233 err_manufacturer_probe:
235 spi_release_bus(spi);
241 void spi_flash_free(struct spi_flash *flash)
243 spi_free_slave(flash->spi);