nand.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * (C) Copyright 2005
  4. * 2N Telekomunikace, a.s. <www.2n.cz>
  5. * Ladislav Michl <michl@2n.cz>
  6. */
  7. #ifndef _NAND_H_
  8. #define _NAND_H_
  9. #include <config.h>
  10. /*
  11. * All boards using a given driver must convert to self-init
  12. * at the same time, so do it here. When all drivers are
  13. * converted, this will go away.
  14. */
  15. #ifdef CONFIG_SPL_BUILD
  16. #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_FSL_IFC)
  17. #define CONFIG_SYS_NAND_SELF_INIT
  18. #endif
  19. #else
  20. #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)\
  21. || defined(CONFIG_NAND_FSL_IFC)
  22. #define CONFIG_SYS_NAND_SELF_INIT
  23. #endif
  24. #endif
  25. extern void nand_init(void);
  26. unsigned long nand_size(void);
  27. #include <linux/compat.h>
  28. #include <linux/mtd/mtd.h>
  29. #include <linux/mtd/rawnand.h>
  30. int nand_mtd_to_devnum(struct mtd_info *mtd);
  31. #ifdef CONFIG_SYS_NAND_SELF_INIT
  32. void board_nand_init(void);
  33. int nand_register(int devnum, struct mtd_info *mtd);
  34. #else
  35. extern int board_nand_init(struct nand_chip *nand);
  36. #endif
  37. extern int nand_curr_device;
  38. static inline int nand_read(struct mtd_info *info, loff_t ofs, size_t *len,
  39. u_char *buf)
  40. {
  41. return mtd_read(info, ofs, *len, (size_t *)len, buf);
  42. }
  43. static inline int nand_write(struct mtd_info *info, loff_t ofs, size_t *len,
  44. u_char *buf)
  45. {
  46. return mtd_write(info, ofs, *len, (size_t *)len, buf);
  47. }
  48. static inline int nand_block_isbad(struct mtd_info *info, loff_t ofs)
  49. {
  50. return mtd_block_isbad(info, ofs);
  51. }
  52. static inline int nand_erase(struct mtd_info *info, loff_t off, size_t size)
  53. {
  54. struct erase_info instr;
  55. instr.mtd = info;
  56. instr.addr = off;
  57. instr.len = size;
  58. instr.callback = 0;
  59. return mtd_erase(info, &instr);
  60. }
  61. /*****************************************************************************
  62. * declarations from nand_util.c
  63. ****************************************************************************/
  64. typedef struct mtd_oob_ops mtd_oob_ops_t;
  65. struct nand_erase_options {
  66. loff_t length; /* number of bytes to erase */
  67. loff_t offset; /* first address in NAND to erase */
  68. int quiet; /* don't display progress messages */
  69. int jffs2; /* if true: format for jffs2 usage
  70. * (write appropriate cleanmarker blocks) */
  71. int scrub; /* if true, really clean NAND by erasing
  72. * bad blocks (UNSAFE) */
  73. /* Don't include skipped bad blocks in size to be erased */
  74. int spread;
  75. /* maximum size that actual may be in order to not exceed the buf */
  76. loff_t lim;
  77. };
  78. typedef struct nand_erase_options nand_erase_options_t;
  79. int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
  80. size_t *actual, loff_t lim, u_char *buffer);
  81. #define WITH_DROP_FFS (1 << 0) /* drop trailing all-0xff pages */
  82. #define WITH_WR_VERIFY (1 << 1) /* verify data was written correctly */
  83. int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
  84. size_t *actual, loff_t lim, u_char *buffer, int flags);
  85. int nand_erase_opts(struct mtd_info *mtd,
  86. const nand_erase_options_t *opts);
  87. int nand_torture(struct mtd_info *mtd, loff_t offset);
  88. int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
  89. loff_t ofs);
  90. int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf);
  91. #define NAND_LOCK_STATUS_TIGHT 0x01
  92. #define NAND_LOCK_STATUS_UNLOCK 0x04
  93. int nand_lock(struct mtd_info *mtd, int tight);
  94. int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
  95. int allexcept);
  96. int nand_get_lock_status(struct mtd_info *mtd, loff_t offset);
  97. u32 nand_spl_adjust_offset(u32 sector, u32 offs);
  98. int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
  99. int nand_spl_read_block(int block, int offset, int len, void *dst);
  100. void nand_deselect(void);
  101. #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
  102. void board_nand_select_device(struct nand_chip *nand, int chip);
  103. #endif
  104. __attribute__((noreturn)) void nand_boot(void);
  105. #ifdef CONFIG_ENV_OFFSET_OOB
  106. #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
  107. as block number*/
  108. #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
  109. stored as byte number */
  110. #define ENV_OFFSET_SIZE 8
  111. int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result);
  112. #endif
  113. int spl_nand_erase_one(int block, int page);
  114. /* platform specific init functions */
  115. void sunxi_nand_init(void);
  116. /*
  117. * get_nand_dev_by_index - Get the nand info based in index.
  118. *
  119. * @dev - index to the nand device.
  120. *
  121. * returns pointer to the nand device info structure or NULL on failure.
  122. */
  123. struct mtd_info *get_nand_dev_by_index(int dev);
  124. #endif /* _NAND_H_ */