1 /* 2 * (C) Copyright 2005 3 * 2N Telekomunikace, a.s. <www.2n.cz> 4 * Ladislav Michl <michl@2n.cz> 5 * 6 * See file CREDITS for list of people who contributed to this 7 * project. 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License 11 * version 2 as published by the Free Software Foundation. 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 Free Software 20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21 * MA 02111-1307 USA 22 */ 23 24 #ifndef _NAND_H_ 25 #define _NAND_H_ 26 27 #include <config.h> 28 29 /* 30 * All boards using a given driver must convert to self-init 31 * at the same time, so do it here. When all drivers are 32 * converted, this will go away. 33 */ 34 #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL) 35 #define CONFIG_SYS_NAND_SELF_INIT 36 #endif 37 38 extern void nand_init(void); 39 40 #include <linux/compat.h> 41 #include <linux/mtd/mtd.h> 42 #include <linux/mtd/nand.h> 43 44 #ifdef CONFIG_SYS_NAND_SELF_INIT 45 void board_nand_init(void); 46 int nand_register(int devnum); 47 #else 48 extern int board_nand_init(struct nand_chip *nand); 49 #endif 50 51 typedef struct mtd_info nand_info_t; 52 53 extern int nand_curr_device; 54 extern nand_info_t nand_info[]; 55 56 static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf) 57 { 58 return info->read(info, ofs, *len, (size_t *)len, buf); 59 } 60 61 static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf) 62 { 63 return info->write(info, ofs, *len, (size_t *)len, buf); 64 } 65 66 static inline int nand_block_isbad(nand_info_t *info, loff_t ofs) 67 { 68 return info->block_isbad(info, ofs); 69 } 70 71 static inline int nand_erase(nand_info_t *info, loff_t off, size_t size) 72 { 73 struct erase_info instr; 74 75 instr.mtd = info; 76 instr.addr = off; 77 instr.len = size; 78 instr.callback = 0; 79 80 return info->erase(info, &instr); 81 } 82 83 84 /***************************************************************************** 85 * declarations from nand_util.c 86 ****************************************************************************/ 87 88 struct nand_write_options { 89 u_char *buffer; /* memory block containing image to write */ 90 ulong length; /* number of bytes to write */ 91 ulong offset; /* start address in NAND */ 92 int quiet; /* don't display progress messages */ 93 int autoplace; /* if true use auto oob layout */ 94 int forcejffs2; /* force jffs2 oob layout */ 95 int forceyaffs; /* force yaffs oob layout */ 96 int noecc; /* write without ecc */ 97 int writeoob; /* image contains oob data */ 98 int pad; /* pad to page size */ 99 int blockalign; /* 1|2|4 set multiple of eraseblocks 100 * to align to */ 101 }; 102 103 typedef struct nand_write_options nand_write_options_t; 104 typedef struct mtd_oob_ops mtd_oob_ops_t; 105 106 struct nand_read_options { 107 u_char *buffer; /* memory block in which read image is written*/ 108 ulong length; /* number of bytes to read */ 109 ulong offset; /* start address in NAND */ 110 int quiet; /* don't display progress messages */ 111 int readoob; /* put oob data in image */ 112 }; 113 114 typedef struct nand_read_options nand_read_options_t; 115 116 struct nand_erase_options { 117 loff_t length; /* number of bytes to erase */ 118 loff_t offset; /* first address in NAND to erase */ 119 int quiet; /* don't display progress messages */ 120 int jffs2; /* if true: format for jffs2 usage 121 * (write appropriate cleanmarker blocks) */ 122 int scrub; /* if true, really clean NAND by erasing 123 * bad blocks (UNSAFE) */ 124 125 /* Don't include skipped bad blocks in size to be erased */ 126 int spread; 127 }; 128 129 typedef struct nand_erase_options nand_erase_options_t; 130 131 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length, 132 u_char *buffer); 133 134 #define WITH_YAFFS_OOB (1 << 0) /* whether write with yaffs format. This flag 135 * is a 'mode' meaning it cannot be mixed with 136 * other flags */ 137 #define WITH_DROP_FFS (1 << 1) /* drop trailing all-0xff pages */ 138 139 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length, 140 u_char *buffer, int flags); 141 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts); 142 143 #define NAND_LOCK_STATUS_TIGHT 0x01 144 #define NAND_LOCK_STATUS_UNLOCK 0x04 145 146 int nand_lock(nand_info_t *meminfo, int tight); 147 int nand_unlock(nand_info_t *meminfo, loff_t start, size_t length, 148 int allexcept); 149 int nand_get_lock_status(nand_info_t *meminfo, loff_t offset); 150 151 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst); 152 void nand_deselect(void); 153 154 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE 155 void board_nand_select_device(struct nand_chip *nand, int chip); 156 #endif 157 158 __attribute__((noreturn)) void nand_boot(void); 159 160 #endif 161 162 #ifdef CONFIG_ENV_OFFSET_OOB 163 #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored 164 as block number*/ 165 #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is 166 stored as byte number */ 167 #define ENV_OFFSET_SIZE 8 168 int get_nand_env_oob(nand_info_t *nand, unsigned long *result); 169 #endif 170