4 * Enter bugs at http://blackfin.uclinux.org/
6 * Copyright (c) 2005-2008 Analog Devices Inc.
8 * Licensed under the GPL-2 or later.
11 /* Configuration options:
12 * CONFIG_SPI_BAUD - value to load into SPI_BAUD (divisor of SCLK to get SPI CLK)
13 * CONFIG_SPI_FLASH_SLOW_READ - force usage of the slower read
14 * WARNING: make sure your SCLK + SPI_BAUD is slow enough
20 #include <asm/mach-common/bits/spi.h>
22 /* Forcibly phase out these */
23 #ifdef CONFIG_SPI_FLASH_NUM_SECTORS
24 # error do not set CONFIG_SPI_FLASH_NUM_SECTORS
26 #ifdef CONFIG_SPI_FLASH_SECTOR_SIZE
27 # error do not set CONFIG_SPI_FLASH_SECTOR_SIZE
30 #if defined(CONFIG_SPI)
39 /* SPI Speeds: 50 MHz / 33 MHz */
40 static struct flash_info flash_spansion_serial_flash[] = {
41 { "S25FL016", 0x0215, 64 * 1024, 32 },
42 { "S25FL032", 0x0216, 64 * 1024, 64 },
43 { "S25FL064", 0x0217, 64 * 1024, 128 },
44 { "S25FL0128", 0x0218, 256 * 1024, 64 },
48 /* SPI Speeds: 50 MHz / 20 MHz */
49 static struct flash_info flash_st_serial_flash[] = {
50 { "m25p05", 0x2010, 32 * 1024, 2 },
51 { "m25p10", 0x2011, 32 * 1024, 4 },
52 { "m25p20", 0x2012, 64 * 1024, 4 },
53 { "m25p40", 0x2013, 64 * 1024, 8 },
54 { "m25p16", 0x2015, 64 * 1024, 32 },
55 { "m25p32", 0x2016, 64 * 1024, 64 },
56 { "m25p64", 0x2017, 64 * 1024, 128 },
57 { "m25p128", 0x2018, 256 * 1024, 64 },
61 /* SPI Speeds: 66 MHz / 33 MHz */
62 static struct flash_info flash_atmel_dataflash[] = {
63 { "AT45DB011x", 0x0c, 264, 512 },
64 { "AT45DB021x", 0x14, 264, 1025 },
65 { "AT45DB041x", 0x1c, 264, 2048 },
66 { "AT45DB081x", 0x24, 264, 4096 },
67 { "AT45DB161x", 0x2c, 528, 4096 },
68 { "AT45DB321x", 0x34, 528, 8192 },
69 { "AT45DB642x", 0x3c, 1056, 8192 },
73 /* SPI Speed: 50 MHz / 25 MHz or 40 MHz / 20 MHz */
74 static struct flash_info flash_winbond_serial_flash[] = {
75 { "W25X10", 0x3011, 16 * 256, 32 },
76 { "W25X20", 0x3012, 16 * 256, 64 },
77 { "W25X40", 0x3013, 16 * 256, 128 },
78 { "W25X80", 0x3014, 16 * 256, 256 },
79 { "W25P80", 0x2014, 256 * 256, 16 },
80 { "W25P16", 0x2015, 256 * 256, 32 },
85 uint8_t read, write, erase, status;
88 #ifdef CONFIG_SPI_FLASH_SLOW_READ
93 static struct flash_ops flash_st_ops = {
100 static struct flash_ops flash_atmel_ops = {
107 static struct flash_ops flash_winbond_ops = {
114 struct manufacturer_info {
117 struct flash_info *flashes;
118 struct flash_ops *ops;
122 struct manufacturer_info *manufacturer;
123 struct flash_info *flash;
124 struct flash_ops *ops;
125 uint8_t manufacturer_id, device_id1, device_id2;
126 unsigned int write_length;
127 unsigned long sector_size, num_sectors;
131 JED_MANU_SPANSION = 0x01,
133 JED_MANU_ATMEL = 0x1F,
134 JED_MANU_WINBOND = 0xEF,
137 static struct manufacturer_info flash_manufacturers[] = {
140 .id = JED_MANU_SPANSION,
141 .flashes = flash_spansion_serial_flash,
142 .ops = &flash_st_ops,
147 .flashes = flash_st_serial_flash,
148 .ops = &flash_st_ops,
152 .id = JED_MANU_ATMEL,
153 .flashes = flash_atmel_dataflash,
154 .ops = &flash_atmel_ops,
158 .id = JED_MANU_WINBOND,
159 .flashes = flash_winbond_serial_flash,
160 .ops = &flash_winbond_ops,
164 #define TIMEOUT 5000 /* timeout of 5 seconds */
166 /* If part has multiple SPI flashes, assume SPI0 as that is
167 * the one we can boot off of ...
170 # define pSPI_CTL pSPI0_CTL
171 # define pSPI_BAUD pSPI0_BAUD
172 # define pSPI_FLG pSPI0_FLG
173 # define pSPI_RDBR pSPI0_RDBR
174 # define pSPI_STAT pSPI0_STAT
175 # define pSPI_TDBR pSPI0_TDBR
178 /* Default to the SPI SSEL that we boot off of:
179 * BF54x, BF537, (everything new?): SSEL1
180 * BF51x, BF533, BF561: SSEL2
182 #ifndef CONFIG_SPI_FLASH_SSEL
183 # if defined(__ADSPBF531__) || defined(__ADSPBF532__) || defined(__ADSPBF533__) || \
184 defined(__ADSPBF538__) || defined(__ADSPBF539__) || defined(__ADSPBF561__) || \
185 defined(__ADSPBF51x__)
186 # define CONFIG_SPI_FLASH_SSEL 2
188 # define CONFIG_SPI_FLASH_SSEL 1
191 #define SSEL_MASK (1 << CONFIG_SPI_FLASH_SSEL)
193 static void SPI_INIT(void)
195 /* [#3541] This delay appears to be necessary, but not sure
196 * exactly why as the history behind it is non-existant.
198 udelay(CONFIG_CCLK_HZ / 25000000);
200 /* enable SPI pins: SSEL, MOSI, MISO, SCK */
202 *pPORTE_FER |= (PE0 | PE1 | PE2 | PE4);
203 #elif defined(__ADSPBF534__) || defined(__ADSPBF536__) || defined(__ADSPBF537__)
204 *pPORTF_FER |= (PF10 | PF11 | PF12 | PF13);
205 #elif defined(__ADSPBF52x__)
206 bfin_write_PORTG_MUX((bfin_read_PORTG_MUX() & ~PORT_x_MUX_0_MASK) | PORT_x_MUX_0_FUNC_3);
207 bfin_write_PORTG_FER(bfin_read_PORTG_FER() | PG1 | PG2 | PG3 | PG4);
208 #elif defined(__ADSPBF51x__)
209 bfin_write_PORTG_MUX((bfin_read_PORTG_MUX() & ~PORT_x_MUX_7_MASK) | PORT_x_MUX_7_FUNC_1);
210 bfin_write_PORTG_FER(bfin_read_PORTG_FER() | PG12 | PG13 | PG14 | PG15);
213 /* initate communication upon write of TDBR */
214 *pSPI_CTL = (SPE|MSTR|CPHA|CPOL|0x01);
215 *pSPI_BAUD = CONFIG_SPI_BAUD;
218 static void SPI_DEINIT(void)
220 /* put SPI settings back to reset state */
226 static void SPI_ON(void)
228 /* toggle SSEL to reset the device so it'll take a new command */
229 *pSPI_FLG = 0xFF00 | SSEL_MASK;
232 *pSPI_FLG = ((0xFF & ~SSEL_MASK) << 8) | SSEL_MASK;
236 static void SPI_OFF(void)
238 /* put SPI settings back to reset state */
243 static uint8_t spi_write_read_byte(uint8_t transmit)
245 *pSPI_TDBR = transmit;
248 while ((*pSPI_STAT & TXS))
251 while (!(*pSPI_STAT & SPIF))
254 while (!(*pSPI_STAT & RXS))
258 /* Read dummy to empty the receive register */
262 static uint8_t read_status_register(void)
264 uint8_t status_register;
266 /* send instruction to read status register */
268 spi_write_read_byte(flash.ops->status);
269 /* send dummy to receive the status register */
270 status_register = spi_write_read_byte(0);
273 return status_register;
276 static int wait_for_ready_status(void)
278 ulong start = get_timer(0);
280 while (get_timer(0) - start < TIMEOUT) {
281 switch (flash.manufacturer_id) {
282 case JED_MANU_SPANSION:
284 case JED_MANU_WINBOND:
285 if (!(read_status_register() & 0x01))
290 if (read_status_register() & 0x80)
305 /* Request and read the manufacturer and device id of parts which
306 * are compatible with the JEDEC standard (JEP106) and use that to
307 * setup other operating conditions.
309 static int spi_detect_part(void)
314 static char called_init;
320 /* Send the request for the part identification */
321 spi_write_read_byte(0x9F);
323 /* Now read in the manufacturer id bytes */
325 flash.manufacturer_id = spi_write_read_byte(0);
326 if (flash.manufacturer_id == 0x7F)
327 puts("Warning: unhandled manufacturer continuation byte!\n");
328 } while (flash.manufacturer_id == 0x7F);
330 /* Now read in the first device id byte */
331 flash.device_id1 = spi_write_read_byte(0);
333 /* Now read in the second device id byte */
334 flash.device_id2 = spi_write_read_byte(0);
338 dev_id = (flash.device_id1 << 8) | flash.device_id2;
340 for (i = 0; i < ARRAY_SIZE(flash_manufacturers); ++i) {
341 if (flash.manufacturer_id == flash_manufacturers[i].id)
344 if (i == ARRAY_SIZE(flash_manufacturers))
347 flash.manufacturer = &flash_manufacturers[i];
348 flash.ops = flash_manufacturers[i].ops;
350 switch (flash.manufacturer_id) {
351 case JED_MANU_SPANSION:
353 case JED_MANU_WINBOND:
354 for (i = 0; flash.manufacturer->flashes[i].name; ++i) {
355 if (dev_id == flash.manufacturer->flashes[i].id)
358 if (!flash.manufacturer->flashes[i].name)
361 flash.flash = &flash.manufacturer->flashes[i];
362 flash.sector_size = flash.flash->sector_size;
363 flash.num_sectors = flash.flash->num_sectors;
364 flash.write_length = 256;
367 case JED_MANU_ATMEL: {
368 uint8_t status = read_status_register();
370 for (i = 0; flash.manufacturer->flashes[i].name; ++i) {
371 if ((status & 0x3c) == flash.manufacturer->flashes[i].id)
374 if (!flash.manufacturer->flashes[i].name)
377 flash.flash = &flash.manufacturer->flashes[i];
378 flash.sector_size = flash.flash->sector_size;
379 flash.num_sectors = flash.flash->num_sectors;
381 /* see if flash is in "power of 2" mode */
383 flash.sector_size &= ~(1 << (ffs(flash.sector_size) - 1));
385 flash.write_length = flash.sector_size;
394 printf("Unknown SPI device: 0x%02X 0x%02X 0x%02X\n",
395 flash.manufacturer_id, flash.device_id1, flash.device_id2);
400 * Function: spi_init_f
401 * Description: Init SPI-Controller (ROM part)
404 void spi_init_f(void)
409 * Function: spi_init_r
410 * Description: Init SPI-Controller (RAM part) -
411 * The malloc engine is ready and we can move our buffers to
415 void spi_init_r(void)
417 #if defined(CONFIG_POST) && (CONFIG_POST & CONFIG_SYS_POST_SPI)
418 /* Our testing strategy here is pretty basic:
419 * - fill src memory with an 8-bit pattern
420 * - write the src memory to the SPI flash
421 * - read the SPI flash into the dst memory
422 * - compare src and dst memory regions
423 * - repeat a few times
424 * The variations we test for:
425 * - change the 8-bit pattern a bit
426 * - change the read/write block size so we know:
427 * - writes smaller/equal/larger than the buffer work
428 * - writes smaller/equal/larger than the sector work
429 * - change the SPI offsets so we know:
430 * - writing partial sectors works
432 uint8_t *mem_src, *mem_dst;
434 size_t test_count, errors;
439 if (spi_detect_part())
445 flash.write_length * 2,
446 flash.write_length / 2,
448 flash.sector_size * 2,
449 flash.sector_size / 2
454 flash.write_length * 2,
455 flash.write_length / 2,
456 flash.write_length / 4,
458 flash.sector_size * 2,
459 flash.sector_size / 2,
460 flash.sector_size / 4,
463 /* the exact addresses are arbitrary ... they just need to not overlap */
464 mem_src = (void *)(0);
465 mem_dst = (void *)(max(flash.write_length, flash.sector_size) * 2);
471 for (i = 0; i < 16; ++i) { /* 16 = 8 bits * 2 iterations */
472 for (l = 0; l < ARRAY_SIZE(lengths); ++l) {
473 for (o = 0; o < ARRAY_SIZE(offsets); ++o) {
474 ulong len = lengths[l];
475 ulong off = offsets[o];
477 printf("Testing pattern 0x%02X of length %5lu and offset %5lu: ", pattern, len, off);
479 /* setup the source memory region */
480 memset(mem_src, pattern, len);
483 for (c = 0; c < 4; ++c) { /* 4 is just a random repeat count */
489 /* make sure background fill pattern != pattern */
490 memset(mem_dst, pattern ^ 0xFF, len);
492 /* write out the source memory and then read it back and compare */
493 eeprom_write(0, off, mem_src, len);
494 eeprom_read(0, off, mem_dst, len);
496 if (memcmp(mem_src, mem_dst, len)) {
497 for (c = 0; c < len; ++c)
498 if (mem_src[c] != mem_dst[c])
500 printf(" FAIL @ offset %u, skipping repeats ", c);
505 /* XXX: should shrink write region here to test with
506 * leading/trailing canaries so we know surrounding
507 * bytes don't get screwed.
514 /* invert the pattern every other run and shift out bits slowly */
517 pattern = (pattern | 0x01) << 1;
521 printf("SPI FAIL: Out of %i tests, there were %i errors ;(\n", test_count, errors);
523 printf("SPI PASS: %i tests worked!\n", test_count);
531 static void transmit_address(uint32_t addr)
533 /* Send the highest byte of the 24 bit address at first */
534 spi_write_read_byte(addr >> 16);
535 /* Send the middle byte of the 24 bit address at second */
536 spi_write_read_byte(addr >> 8);
537 /* Send the lowest byte of the 24 bit address finally */
538 spi_write_read_byte(addr);
542 * Read a value from flash for verify purpose
543 * Inputs: unsigned long ulStart - holds the SPI start address
544 * int pnData - pointer to store value read from flash
545 * long lCount - number of elements to read
547 static int read_flash(unsigned long address, long count, uchar *buffer)
551 /* Send the read command to SPI device */
553 spi_write_read_byte(flash.ops->read);
554 transmit_address(address);
556 #ifndef CONFIG_SPI_FLASH_SLOW_READ
557 /* Send dummy byte when doing SPI fast reads */
558 spi_write_read_byte(0);
561 /* After the SPI device address has been placed on the MOSI pin the data can be */
562 /* received on the MISO pin. */
563 for (i = 1; i <= count; ++i) {
564 *buffer++ = spi_write_read_byte(0);
565 if (i % flash.sector_size == 0)
574 static int enable_writing(void)
578 if (flash.manufacturer_id == JED_MANU_ATMEL)
581 /* A write enable instruction must previously have been executed */
583 spi_write_read_byte(0x06);
586 /* The status register will be polled to check the write enable latch "WREN" */
587 start = get_timer(0);
588 while (get_timer(0) - start < TIMEOUT) {
589 if (read_status_register() & 0x02)
602 static long address_to_sector(unsigned long address)
604 if (address > (flash.num_sectors * flash.sector_size) - 1)
606 return address / flash.sector_size;
609 static int erase_sector(int address)
611 /* sector gets checked in higher function, so assume it's valid
612 * here and figure out the offset of the sector in flash
614 if (enable_writing())
618 * Send the erase block command to the flash followed by the 24 address
619 * to point to the start of a sector
622 spi_write_read_byte(flash.ops->erase);
623 transmit_address(address);
626 return wait_for_ready_status();
629 /* Write [count] bytes out of [buffer] into the given SPI [address] */
630 static long write_flash(unsigned long address, long count, uchar *buffer)
632 long i, write_buffer_size;
634 if (enable_writing())
637 /* Send write command followed by the 24 bit address */
639 spi_write_read_byte(flash.ops->write);
640 transmit_address(address);
642 /* Shoot out a single write buffer */
643 write_buffer_size = min(count, flash.write_length);
644 for (i = 0; i < write_buffer_size; ++i)
645 spi_write_read_byte(buffer[i]);
649 /* Wait for the flash to do its thing */
650 if (wait_for_ready_status()) {
651 puts("SPI Program Time out! ");
658 /* Write [count] bytes out of [buffer] into the given SPI [address] */
659 static int write_sector(unsigned long address, long count, uchar *buffer)
664 write_cnt = write_flash(address, count, buffer);
668 /* Now that we've sent some bytes out to the flash, update
672 address += write_cnt;
676 /* return the appropriate error code */
681 * Function: spi_write
683 ssize_t spi_write(uchar *addr, int alen, uchar *buffer, int len)
685 unsigned long offset;
686 int start_sector, end_sector;
687 int start_byte, end_byte;
693 if (spi_detect_part())
696 offset = addr[0] << 16 | addr[1] << 8 | addr[2];
698 /* Get the start block number */
699 start_sector = address_to_sector(offset);
700 if (start_sector == -1) {
701 puts("Invalid sector! ");
704 end_sector = address_to_sector(offset + len - 1);
705 if (end_sector == -1) {
706 puts("Invalid sector! ");
710 /* Since flashes operate in sector units but the eeprom command
711 * operates as a continuous stream of bytes, we need to emulate
712 * the eeprom behavior. So here we read in the sector, overlay
713 * any bytes we're actually modifying, erase the sector, and
714 * then write back out the new sector.
716 temp = malloc(flash.sector_size);
718 puts("Malloc for sector failed! ");
722 for (num = start_sector; num <= end_sector; num++) {
723 unsigned long address = num * flash.sector_size;
725 /* XXX: should add an optimization when spanning sectors:
726 * No point in reading in a sector if we're going to be
727 * clobbering the whole thing. Need to also add a test
728 * case to make sure the optimization is correct.
730 if (read_flash(address, flash.sector_size, temp)) {
731 puts("Read sector failed! ");
736 start_byte = max(address, offset);
737 end_byte = address + flash.sector_size - 1;
738 if (end_byte > (offset + len))
739 end_byte = (offset + len - 1);
741 memcpy(temp + start_byte - address,
742 buffer + start_byte - offset,
743 end_byte - start_byte + 1);
745 if (erase_sector(address)) {
746 puts("Erase sector failed! ");
750 if (write_sector(address, flash.sector_size, temp)) {
751 puts("Write sector failed! ");
771 ssize_t spi_read(uchar *addr, int alen, uchar *buffer, int len)
773 unsigned long offset;
777 if (spi_detect_part())
780 offset = addr[0] << 16 | addr[1] << 8 | addr[2];
781 read_flash(offset, len, buffer);
790 * Spit out some useful information about the SPI eeprom
792 int eeprom_info(void)
798 if (spi_detect_part())
801 printf("SPI Device: %s 0x%02X (%s) 0x%02X 0x%02X\n"
802 "Parameters: num sectors = %lu, sector size = %lu, write size = %i\n"
803 "Flash Size: %lu mbit (%lu mbyte)\n"
805 flash.flash->name, flash.manufacturer_id, flash.manufacturer->name,
806 flash.device_id1, flash.device_id2, flash.num_sectors,
807 flash.sector_size, flash.write_length,
808 (flash.num_sectors * flash.sector_size) >> 17,
809 (flash.num_sectors * flash.sector_size) >> 20,
810 read_status_register());