spi_flash_internal.h 4.6 KB

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