spi_flash_internal.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. /*
  2. * SPI flash internal definitions
  3. *
  4. * Copyright (C) 2008 Atmel Corporation
  5. */
  6. /* Common parameters -- kind of high, but they should only occur when there
  7. * is a problem (and well your system already is broken), so err on the side
  8. * of caution in case we're dealing with slower SPI buses and/or processors.
  9. */
  10. #define SPI_FLASH_PROG_TIMEOUT (2 * CONFIG_SYS_HZ)
  11. #define SPI_FLASH_PAGE_ERASE_TIMEOUT (5 * CONFIG_SYS_HZ)
  12. #define SPI_FLASH_SECTOR_ERASE_TIMEOUT (10 * CONFIG_SYS_HZ)
  13. /* Common commands */
  14. #define CMD_READ_ID 0x9f
  15. #define CMD_READ_ARRAY_SLOW 0x03
  16. #define CMD_READ_ARRAY_FAST 0x0b
  17. #define CMD_READ_ARRAY_LEGACY 0xe8
  18. #define CMD_PAGE_PROGRAM 0x02
  19. #define CMD_READ_STATUS 0x05
  20. #define CMD_WRITE_ENABLE 0x06
  21. /* Common status */
  22. #define STATUS_WIP 0x01
  23. /* Send a single-byte command to the device and read the response */
  24. int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
  25. /*
  26. * Send a multi-byte command to the device and read the response. Used
  27. * for flash array reads, etc.
  28. */
  29. int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
  30. size_t cmd_len, void *data, size_t data_len);
  31. int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
  32. size_t len, void *data);
  33. /*
  34. * Send a multi-byte command to the device followed by (optional)
  35. * data. Used for programming the flash array, etc.
  36. */
  37. int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
  38. const void *data, size_t data_len);
  39. /*
  40. * Write the requested data out breaking it up into multiple write
  41. * commands as needed per the write size.
  42. */
  43. int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset,
  44. size_t len, const void *buf);
  45. /*
  46. * Enable writing on the SPI flash.
  47. */
  48. static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
  49. {
  50. return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
  51. }
  52. /*
  53. * Same as spi_flash_cmd_read() except it also claims/releases the SPI
  54. * bus. Used as common part of the ->read() operation.
  55. */
  56. int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
  57. size_t cmd_len, void *data, size_t data_len);
  58. /* Send a command to the device and wait for some bit to clear itself. */
  59. int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout,
  60. u8 cmd, u8 poll_bit);
  61. /*
  62. * Send the read status command to the device and wait for the wip
  63. * (write-in-progress) bit to clear itself.
  64. */
  65. int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
  66. /* Erase sectors. */
  67. int spi_flash_cmd_erase(struct spi_flash *flash, u8 erase_cmd,
  68. u32 offset, size_t len);
  69. /* Manufacturer-specific probe functions */
  70. struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
  71. struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
  72. struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
  73. struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
  74. struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
  75. struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
  76. struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
  77. struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);