spi_flash_internal.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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_WRITE_STATUS 0x01
  18. #define CMD_PAGE_PROGRAM 0x02
  19. #define CMD_WRITE_DISABLE 0x04
  20. #define CMD_READ_STATUS 0x05
  21. #define CMD_WRITE_ENABLE 0x06
  22. #define CMD_ERASE_4K 0x20
  23. #define CMD_ERASE_32K 0x52
  24. #define CMD_ERASE_64K 0xd8
  25. #define CMD_ERASE_CHIP 0xc7
  26. #define SPI_FLASH_16MB_BOUN 0x1000000
  27. /* Manufacture ID's */
  28. #define SPI_FLASH_SPANSION_IDCODE0 0x01
  29. #define SPI_FLASH_STMICRO_IDCODE0 0x20
  30. #define SPI_FLASH_WINBOND_IDCODE0 0xef
  31. #ifdef CONFIG_SPI_FLASH_BAR
  32. /* Bank addr access commands */
  33. # define CMD_BANKADDR_BRWR 0x17
  34. # define CMD_BANKADDR_BRRD 0x16
  35. # define CMD_EXTNADDR_WREAR 0xC5
  36. # define CMD_EXTNADDR_RDEAR 0xC8
  37. #endif
  38. /* Common status */
  39. #define STATUS_WIP 0x01
  40. /* Send a single-byte command to the device and read the response */
  41. int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
  42. /*
  43. * Send a multi-byte command to the device and read the response. Used
  44. * for flash array reads, etc.
  45. */
  46. int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
  47. size_t cmd_len, void *data, size_t data_len);
  48. int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
  49. size_t len, void *data);
  50. /*
  51. * Send a multi-byte command to the device followed by (optional)
  52. * data. Used for programming the flash array, etc.
  53. */
  54. int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
  55. const void *data, size_t data_len);
  56. /*
  57. * Write the requested data out breaking it up into multiple write
  58. * commands as needed per the write size.
  59. */
  60. int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset,
  61. size_t len, const void *buf);
  62. /*
  63. * Enable writing on the SPI flash.
  64. */
  65. static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
  66. {
  67. return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
  68. }
  69. /*
  70. * Disable writing on the SPI flash.
  71. */
  72. static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
  73. {
  74. return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
  75. }
  76. /* Program the status register. */
  77. int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr);
  78. #ifdef CONFIG_SPI_FLASH_BAR
  79. /* Program the bank address register */
  80. int spi_flash_cmd_bankaddr_write(struct spi_flash *flash, u8 bank_sel);
  81. /* Configure the BAR - discover the bank cmds */
  82. int spi_flash_bank_config(struct spi_flash *flash, u8 idcode0);
  83. #endif
  84. /*
  85. * Same as spi_flash_cmd_read() except it also claims/releases the SPI
  86. * bus. Used as common part of the ->read() operation.
  87. */
  88. int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
  89. size_t cmd_len, void *data, size_t data_len);
  90. /*
  91. * Send the read status command to the device and wait for the wip
  92. * (write-in-progress) bit to clear itself.
  93. */
  94. int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
  95. /* Erase sectors. */
  96. int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len);
  97. /* Manufacturer-specific probe functions */
  98. struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
  99. struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
  100. struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
  101. struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
  102. struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
  103. struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
  104. struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
  105. struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);