You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

208 lines
8.4KB

  1. /***************************************************************************
  2. * Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de> *
  3. * Copyright (C) 2007,2008 √ėyvind Harboe <oyvind.harboe@zylin.com> *
  4. * Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk> *
  5. * Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net> *
  6. * Copyright (C) 2010 by Antonio Borneo <borneo.antonio@gmail.com> *
  7. * *
  8. * This program is free software; you can redistribute it and/or modify *
  9. * it under the terms of the GNU General Public License as published by *
  10. * the Free Software Foundation; either version 2 of the License, or *
  11. * (at your option) any later version. *
  12. * *
  13. * This program is distributed in the hope that it will be useful, *
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of *
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
  16. * GNU General Public License for more details. *
  17. * *
  18. * You should have received a copy of the GNU General Public License *
  19. * along with this program; if not, write to the *
  20. * Free Software Foundation, Inc., *
  21. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
  22. ***************************************************************************/
  23. #ifndef FLASH_NOR_CORE_H
  24. #define FLASH_NOR_CORE_H
  25. #include <flash/common.h>
  26. /**
  27. * @file
  28. * Upper level NOR flash interfaces.
  29. */
  30. struct image;
  31. #define FLASH_MAX_ERROR_STR (128)
  32. /**
  33. * Describes the geometry and status of a single flash sector
  34. * within a flash bank. A single bank typically consists of multiple
  35. * sectors, each of which can be erased and protected independently.
  36. */
  37. struct flash_sector {
  38. /** Bus offset from start of the flash chip (in bytes). */
  39. uint32_t offset;
  40. /** Number of bytes in this flash sector. */
  41. uint32_t size;
  42. /**
  43. * Indication of erasure status: 0 = not erased, 1 = erased,
  44. * other = unknown. Set by @c flash_driver_s::erase_check.
  45. */
  46. int is_erased;
  47. /**
  48. * Indication of protection status: 0 = unprotected/unlocked,
  49. * 1 = protected/locked, other = unknown. Set by
  50. * @c flash_driver_s::protect_check.
  51. *
  52. * This information must be considered stale immediately.
  53. * A million things could make it stale: power cycle,
  54. * reset of target, code running on target, etc.
  55. */
  56. int is_protected;
  57. };
  58. /**
  59. * Provides details of a flash bank, available either on-chip or through
  60. * a major interface.
  61. *
  62. * This structure will be passed as a parameter to the callbacks in the
  63. * flash_driver_s structure, some of which may modify the contents of
  64. * this structure of the area of flash that it defines. Driver writers
  65. * may use the @c driver_priv member to store additional data on a
  66. * per-bank basis, if required.
  67. */
  68. struct flash_bank {
  69. const char *name;
  70. struct target *target; /**< Target to which this bank belongs. */
  71. struct flash_driver *driver; /**< Driver for this bank. */
  72. void *driver_priv; /**< Private driver storage pointer */
  73. int bank_number; /**< The 'bank' (or chip number) of this instance. */
  74. uint32_t base; /**< The base address of this bank */
  75. uint32_t size; /**< The size of this chip bank, in bytes */
  76. int chip_width; /**< Width of the chip in bytes (1,2,4 bytes) */
  77. int bus_width; /**< Maximum bus width, in bytes (1,2,4 bytes) */
  78. /**
  79. * The number of sectors on this chip. This value will
  80. * be set intially to 0, and the flash driver must set this to
  81. * some non-zero value during "probe()" or "auto_probe()".
  82. */
  83. int num_sectors;
  84. /** Array of sectors, allocated and initilized by the flash driver */
  85. struct flash_sector *sectors;
  86. struct flash_bank *next; /**< The next flash bank on this chip */
  87. };
  88. /** Registers the 'flash' subsystem commands */
  89. int flash_register_commands(struct command_context *cmd_ctx);
  90. /**
  91. * Erases @a length bytes in the @a target flash, starting at @a addr.
  92. * The range @a addr to @a addr + @a length - 1 must be strictly
  93. * sector aligned, unless @a pad is true. Setting @a pad true extends
  94. * the range, at beginning and/or end, if needed for sector alignment.
  95. * @returns ERROR_OK if successful; otherwise, an error code.
  96. */
  97. int flash_erase_address_range(struct target *target,
  98. bool pad, uint32_t addr, uint32_t length);
  99. int flash_unlock_address_range(struct target *target, uint32_t addr,
  100. uint32_t length);
  101. /**
  102. * Writes @a image into the @a target flash. The @a written parameter
  103. * will contain the
  104. * @param target The target with the flash to be programmed.
  105. * @param image The image that will be programmed to flash.
  106. * @param written On return, contains the number of bytes written.
  107. * @param erase If non-zero, indicates the flash driver should first
  108. * erase the corresponding banks or sectors before programming.
  109. * @returns ERROR_OK if successful; otherwise, an error code.
  110. */
  111. int flash_write(struct target *target,
  112. struct image *image, uint32_t *written, int erase);
  113. /**
  114. * Forces targets to re-examine their erase/protection state.
  115. * This routine must be called when the system may modify the status.
  116. */
  117. void flash_set_dirty(void);
  118. /** @returns The number of flash banks currently defined. */
  119. int flash_get_bank_count(void);
  120. /**
  121. * Provides default read implementation for flash memory.
  122. * @param bank The bank to read.
  123. * @param buffer The data bytes read.
  124. * @param offset The offset into the chip to read.
  125. * @param count The number of bytes to read.
  126. * @returns ERROR_OK if successful; otherwise, an error code.
  127. */
  128. int default_flash_read(struct flash_bank *bank,
  129. uint8_t *buffer, uint32_t offset, uint32_t count);
  130. /**
  131. * Provides default erased-bank check handling. Checks to see if
  132. * the flash driver knows they are erased; if things look uncertain,
  133. * this routine will call default_flash_mem_blank_check() to confirm.
  134. * @returns ERROR_OK if successful; otherwise, an error code.
  135. */
  136. int default_flash_blank_check(struct flash_bank *bank);
  137. /**
  138. * Returns the flash bank specified by @a name, which matches the
  139. * driver name and a suffix (option) specify the driver-specific
  140. * bank number. The suffix consists of the '.' and the driver-specific
  141. * bank number: when two str9x banks are defined, then 'str9x.1' refers
  142. * to the second.
  143. */
  144. int get_flash_bank_by_name(const char *name, struct flash_bank **bank_result);
  145. /**
  146. * Returns the flash bank specified by @a name, which matches the
  147. * driver name and a suffix (option) specify the driver-specific
  148. * bank number. The suffix consists of the '.' and the driver-specific
  149. * bank number: when two str9x banks are defined, then 'str9x.1' refers
  150. * to the second.
  151. */
  152. struct flash_bank *get_flash_bank_by_name_noprobe(const char *name);
  153. /**
  154. * Returns the flash bank like get_flash_bank_by_name(), without probing.
  155. * @param num The flash bank number.
  156. * @param bank returned bank if fn returns ERROR_OK
  157. * @returns ERROR_OK if successful
  158. */
  159. int get_flash_bank_by_num(int num, struct flash_bank **bank);
  160. /**
  161. * Retreives @a bank from a command argument, reporting errors parsing
  162. * the bank identifier or retreiving the specified bank. The bank
  163. * may be identified by its bank number or by @c name.instance, where
  164. * @a instance is driver-specific.
  165. * @param name_index The index to the string in args containing the
  166. * bank identifier.
  167. * @param bank On output, contians a pointer to the bank or NULL.
  168. * @returns ERROR_OK on success, or an error indicating the problem.
  169. */
  170. COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
  171. struct flash_bank **bank);
  172. /**
  173. * Returns the flash bank like get_flash_bank_by_num(), without probing.
  174. * @param num The flash bank number.
  175. * @returns A struct flash_bank for flash bank @a num, or NULL.
  176. */
  177. struct flash_bank *get_flash_bank_by_num_noprobe(int num);
  178. /**
  179. * Returns the flash bank located at a specified address.
  180. * @param target The target, presumed to contain one or more banks.
  181. * @param addr An address that is within the range of the bank.
  182. * @param check return ERROR_OK and result_bank NULL if the bank does not exist
  183. * @returns The struct flash_bank located at @a addr, or NULL.
  184. */
  185. int get_flash_bank_by_addr(struct target *target, uint32_t addr, bool check,
  186. struct flash_bank **result_bank);
  187. #endif /* FLASH_NOR_CORE_H */