Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 1 | /* |
| 2 | * (C) Copyright 2005 |
| 3 | * 2N Telekomunikace, a.s. <www.2n.cz> |
| 4 | * Ladislav Michl <michl@2n.cz> |
| 5 | * |
Tom Rini | e237880 | 2016-01-14 22:05:13 -0500 | [diff] [blame] | 6 | * SPDX-License-Identifier: GPL-2.0 |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 7 | */ |
| 8 | |
| 9 | #ifndef _NAND_H_ |
| 10 | #define _NAND_H_ |
| 11 | |
Scott Wood | ea0da78 | 2012-01-12 19:42:58 -0600 | [diff] [blame] | 12 | #include <config.h> |
| 13 | |
| 14 | /* |
| 15 | * All boards using a given driver must convert to self-init |
| 16 | * at the same time, so do it here. When all drivers are |
| 17 | * converted, this will go away. |
| 18 | */ |
Bo Shen | 9415b87 | 2014-03-03 14:47:16 +0800 | [diff] [blame] | 19 | #ifdef CONFIG_SPL_BUILD |
| 20 | #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_FSL_IFC) |
| 21 | #define CONFIG_SYS_NAND_SELF_INIT |
| 22 | #endif |
| 23 | #else |
Prabhakar Kushwaha | 895d039 | 2013-04-04 18:44:06 +0000 | [diff] [blame] | 24 | #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)\ |
| 25 | || defined(CONFIG_NAND_FSL_IFC) |
Scott Wood | ea0da78 | 2012-01-12 19:42:58 -0600 | [diff] [blame] | 26 | #define CONFIG_SYS_NAND_SELF_INIT |
| 27 | #endif |
Bo Shen | 9415b87 | 2014-03-03 14:47:16 +0800 | [diff] [blame] | 28 | #endif |
Scott Wood | ea0da78 | 2012-01-12 19:42:58 -0600 | [diff] [blame] | 29 | |
Scott Wood | 8238dd4 | 2008-07-09 17:47:52 -0500 | [diff] [blame] | 30 | extern void nand_init(void); |
Hou Zhiqiang | 9c8b3c7 | 2017-03-17 16:12:31 +0800 | [diff] [blame] | 31 | unsigned long nand_size(void); |
Scott Wood | 8238dd4 | 2008-07-09 17:47:52 -0500 | [diff] [blame] | 32 | |
Mike Frysinger | 11d1a09 | 2012-04-09 13:39:55 +0000 | [diff] [blame] | 33 | #include <linux/compat.h> |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 34 | #include <linux/mtd/mtd.h> |
Masahiro Yamada | 2b7a873 | 2017-11-30 13:45:24 +0900 | [diff] [blame] | 35 | #include <linux/mtd/rawnand.h> |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 36 | |
Scott Wood | 2c1b7e1 | 2016-05-30 13:57:55 -0500 | [diff] [blame] | 37 | int nand_mtd_to_devnum(struct mtd_info *mtd); |
| 38 | |
Scott Wood | 193a0f5 | 2012-01-12 19:07:23 -0600 | [diff] [blame] | 39 | #ifdef CONFIG_SYS_NAND_SELF_INIT |
| 40 | void board_nand_init(void); |
Scott Wood | 2c1b7e1 | 2016-05-30 13:57:55 -0500 | [diff] [blame] | 41 | int nand_register(int devnum, struct mtd_info *mtd); |
Scott Wood | 193a0f5 | 2012-01-12 19:07:23 -0600 | [diff] [blame] | 42 | #else |
Mike Frysinger | f791172 | 2008-12-06 02:40:55 -0500 | [diff] [blame] | 43 | extern int board_nand_init(struct nand_chip *nand); |
Scott Wood | 193a0f5 | 2012-01-12 19:07:23 -0600 | [diff] [blame] | 44 | #endif |
Mike Frysinger | f791172 | 2008-12-06 02:40:55 -0500 | [diff] [blame] | 45 | |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 46 | extern int nand_curr_device; |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 47 | |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 48 | static inline int nand_read(struct mtd_info *info, loff_t ofs, size_t *len, |
| 49 | u_char *buf) |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 50 | { |
Sergey Lapin | 3a38a55 | 2013-01-14 03:46:50 +0000 | [diff] [blame] | 51 | return mtd_read(info, ofs, *len, (size_t *)len, buf); |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 52 | } |
| 53 | |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 54 | static inline int nand_write(struct mtd_info *info, loff_t ofs, size_t *len, |
| 55 | u_char *buf) |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 56 | { |
Sergey Lapin | 3a38a55 | 2013-01-14 03:46:50 +0000 | [diff] [blame] | 57 | return mtd_write(info, ofs, *len, (size_t *)len, buf); |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 58 | } |
| 59 | |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 60 | static inline int nand_block_isbad(struct mtd_info *info, loff_t ofs) |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 61 | { |
Sergey Lapin | 3a38a55 | 2013-01-14 03:46:50 +0000 | [diff] [blame] | 62 | return mtd_block_isbad(info, ofs); |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 63 | } |
| 64 | |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 65 | static inline int nand_erase(struct mtd_info *info, loff_t off, size_t size) |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 66 | { |
Wolfgang Denk | 9a08dd1 | 2005-11-02 14:29:12 +0100 | [diff] [blame] | 67 | struct erase_info instr; |
| 68 | |
| 69 | instr.mtd = info; |
| 70 | instr.addr = off; |
| 71 | instr.len = size; |
| 72 | instr.callback = 0; |
| 73 | |
Sergey Lapin | 3a38a55 | 2013-01-14 03:46:50 +0000 | [diff] [blame] | 74 | return mtd_erase(info, &instr); |
Wolfgang Denk | 2f9b7e4 | 2005-08-17 12:55:25 +0200 | [diff] [blame] | 75 | } |
| 76 | |
Stefan Roese | d351b2b | 2006-10-10 12:36:02 +0200 | [diff] [blame] | 77 | |
| 78 | /***************************************************************************** |
| 79 | * declarations from nand_util.c |
| 80 | ****************************************************************************/ |
| 81 | |
William Juul | 52c0796 | 2007-10-31 13:53:06 +0100 | [diff] [blame] | 82 | typedef struct mtd_oob_ops mtd_oob_ops_t; |
Stefan Roese | d351b2b | 2006-10-10 12:36:02 +0200 | [diff] [blame] | 83 | |
Stefan Roese | d351b2b | 2006-10-10 12:36:02 +0200 | [diff] [blame] | 84 | struct nand_erase_options { |
Scott Wood | 1b5cd51 | 2010-08-25 14:43:29 -0500 | [diff] [blame] | 85 | loff_t length; /* number of bytes to erase */ |
| 86 | loff_t offset; /* first address in NAND to erase */ |
Stefan Roese | d351b2b | 2006-10-10 12:36:02 +0200 | [diff] [blame] | 87 | int quiet; /* don't display progress messages */ |
| 88 | int jffs2; /* if true: format for jffs2 usage |
| 89 | * (write appropriate cleanmarker blocks) */ |
| 90 | int scrub; /* if true, really clean NAND by erasing |
| 91 | * bad blocks (UNSAFE) */ |
Scott Wood | 1b5cd51 | 2010-08-25 14:43:29 -0500 | [diff] [blame] | 92 | |
| 93 | /* Don't include skipped bad blocks in size to be erased */ |
| 94 | int spread; |
Heiko Schocher | 0ae98b4 | 2013-06-24 18:50:40 +0200 | [diff] [blame] | 95 | /* maximum size that actual may be in order to not exceed the buf */ |
| 96 | loff_t lim; |
Stefan Roese | d351b2b | 2006-10-10 12:36:02 +0200 | [diff] [blame] | 97 | }; |
| 98 | |
| 99 | typedef struct nand_erase_options nand_erase_options_t; |
| 100 | |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 101 | int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length, |
Tom Rini | 32d9618 | 2013-03-14 05:32:50 +0000 | [diff] [blame] | 102 | size_t *actual, loff_t lim, u_char *buffer); |
Ben Gardiner | 1caafbb | 2011-05-24 10:18:35 -0400 | [diff] [blame] | 103 | |
Peter Tyser | ae6ad78 | 2015-02-03 11:58:16 -0600 | [diff] [blame] | 104 | #define WITH_DROP_FFS (1 << 0) /* drop trailing all-0xff pages */ |
| 105 | #define WITH_WR_VERIFY (1 << 1) /* verify data was written correctly */ |
Ben Gardiner | 1caafbb | 2011-05-24 10:18:35 -0400 | [diff] [blame] | 106 | |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 107 | int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length, |
Tom Rini | 32d9618 | 2013-03-14 05:32:50 +0000 | [diff] [blame] | 108 | size_t *actual, loff_t lim, u_char *buffer, int flags); |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 109 | int nand_erase_opts(struct mtd_info *mtd, |
| 110 | const nand_erase_options_t *opts); |
| 111 | int nand_torture(struct mtd_info *mtd, loff_t offset); |
| 112 | int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops, |
| 113 | loff_t ofs); |
| 114 | int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf); |
Stefan Roese | d351b2b | 2006-10-10 12:36:02 +0200 | [diff] [blame] | 115 | |
| 116 | #define NAND_LOCK_STATUS_TIGHT 0x01 |
Stefan Roese | d351b2b | 2006-10-10 12:36:02 +0200 | [diff] [blame] | 117 | #define NAND_LOCK_STATUS_UNLOCK 0x04 |
| 118 | |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 119 | int nand_lock(struct mtd_info *mtd, int tight); |
| 120 | int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length, |
| 121 | int allexcept); |
| 122 | int nand_get_lock_status(struct mtd_info *mtd, loff_t offset); |
Stefan Roese | d351b2b | 2006-10-10 12:36:02 +0200 | [diff] [blame] | 123 | |
Simon Schwarz | 4f62e98 | 2011-09-14 15:30:16 -0400 | [diff] [blame] | 124 | int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst); |
Thomas Gleixner | daec8a4 | 2016-07-12 20:28:10 +0200 | [diff] [blame] | 125 | int nand_spl_read_block(int block, int offset, int len, void *dst); |
Simon Schwarz | 992dcf7 | 2011-09-14 15:29:26 -0400 | [diff] [blame] | 126 | void nand_deselect(void); |
| 127 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 128 | #ifdef CONFIG_SYS_NAND_SELECT_DEVICE |
Stefan Roese | 3cdd3fd | 2006-10-20 14:28:52 +0200 | [diff] [blame] | 129 | void board_nand_select_device(struct nand_chip *nand, int chip); |
| 130 | #endif |
| 131 | |
Scott Wood | b71689b | 2008-06-30 14:13:28 -0500 | [diff] [blame] | 132 | __attribute__((noreturn)) void nand_boot(void); |
| 133 | |
Ben Gardiner | 5fc8b7f | 2010-07-05 13:27:07 -0400 | [diff] [blame] | 134 | #ifdef CONFIG_ENV_OFFSET_OOB |
| 135 | #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored |
| 136 | as block number*/ |
| 137 | #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is |
| 138 | stored as byte number */ |
| 139 | #define ENV_OFFSET_SIZE 8 |
Scott Wood | 08364d9 | 2016-05-30 13:57:54 -0500 | [diff] [blame] | 140 | int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result); |
Ben Gardiner | 5fc8b7f | 2010-07-05 13:27:07 -0400 | [diff] [blame] | 141 | #endif |
Heiko Schocher | 4ff0c37 | 2014-10-31 08:31:02 +0100 | [diff] [blame] | 142 | int spl_nand_erase_one(int block, int page); |
Boris Brezillon | 57f2038 | 2016-06-15 21:09:23 +0200 | [diff] [blame] | 143 | |
| 144 | /* platform specific init functions */ |
| 145 | void sunxi_nand_init(void); |
Mugunthan V N | 375ec00 | 2017-01-23 16:04:34 -0600 | [diff] [blame] | 146 | |
Mugunthan V N | 7b670cc | 2017-06-26 19:12:51 -0500 | [diff] [blame] | 147 | /* |
| 148 | * get_nand_dev_by_index - Get the nand info based in index. |
| 149 | * |
| 150 | * @dev - index to the nand device. |
| 151 | * |
| 152 | * returns pointer to the nand device info structure or NULL on failure. |
| 153 | */ |
| 154 | struct mtd_info *get_nand_dev_by_index(int dev); |
| 155 | |
Mugunthan V N | 375ec00 | 2017-01-23 16:04:34 -0600 | [diff] [blame] | 156 | #endif /* _NAND_H_ */ |