blob: d444ddcefea7c37a9dbb96aa97f10109b39cd0ce [file] [log] [blame]
Wolfgang Denk932394a2005-08-17 12:55:25 +02001/*
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
Scott Wood9d2e3942008-07-09 17:47:52 -050027extern void nand_init(void);
28
Wolfgang Denkac7eb8a32005-09-14 23:53:32 +020029#include <linux/mtd/compat.h>
Wolfgang Denk932394a2005-08-17 12:55:25 +020030#include <linux/mtd/mtd.h>
31#include <linux/mtd/nand.h>
32
Mike Frysinger69fb8be2008-12-06 02:40:55 -050033extern int board_nand_init(struct nand_chip *nand);
34
Wolfgang Denk932394a2005-08-17 12:55:25 +020035typedef struct mtd_info nand_info_t;
36
37extern int nand_curr_device;
38extern nand_info_t nand_info[];
39
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020040static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020041{
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +010042 return info->read(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020043}
44
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020045static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020046{
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +010047 return info->write(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020048}
49
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020050static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
Wolfgang Denk932394a2005-08-17 12:55:25 +020051{
52 return info->block_isbad(info, ofs);
53}
54
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020055static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
Wolfgang Denk932394a2005-08-17 12:55:25 +020056{
Wolfgang Denk8e9655f2005-11-02 14:29:12 +010057 struct erase_info instr;
58
59 instr.mtd = info;
60 instr.addr = off;
61 instr.len = size;
62 instr.callback = 0;
63
64 return info->erase(info, &instr);
Wolfgang Denk932394a2005-08-17 12:55:25 +020065}
66
Stefan Roese2255b2d2006-10-10 12:36:02 +020067
68/*****************************************************************************
69 * declarations from nand_util.c
70 ****************************************************************************/
71
72struct nand_write_options {
73 u_char *buffer; /* memory block containing image to write */
74 ulong length; /* number of bytes to write */
75 ulong offset; /* start address in NAND */
76 int quiet; /* don't display progress messages */
77 int autoplace; /* if true use auto oob layout */
78 int forcejffs2; /* force jffs2 oob layout */
79 int forceyaffs; /* force yaffs oob layout */
80 int noecc; /* write without ecc */
81 int writeoob; /* image contains oob data */
82 int pad; /* pad to page size */
83 int blockalign; /* 1|2|4 set multiple of eraseblocks
84 * to align to */
85};
86
87typedef struct nand_write_options nand_write_options_t;
William Juulcfa460a2007-10-31 13:53:06 +010088typedef struct mtd_oob_ops mtd_oob_ops_t;
Stefan Roese2255b2d2006-10-10 12:36:02 +020089
90struct nand_read_options {
91 u_char *buffer; /* memory block in which read image is written*/
92 ulong length; /* number of bytes to read */
93 ulong offset; /* start address in NAND */
94 int quiet; /* don't display progress messages */
95 int readoob; /* put oob data in image */
96};
97
98typedef struct nand_read_options nand_read_options_t;
99
100struct nand_erase_options {
Scott Wood30486322010-08-25 14:43:29 -0500101 loff_t length; /* number of bytes to erase */
102 loff_t offset; /* first address in NAND to erase */
Stefan Roese2255b2d2006-10-10 12:36:02 +0200103 int quiet; /* don't display progress messages */
104 int jffs2; /* if true: format for jffs2 usage
105 * (write appropriate cleanmarker blocks) */
106 int scrub; /* if true, really clean NAND by erasing
107 * bad blocks (UNSAFE) */
Scott Wood30486322010-08-25 14:43:29 -0500108
109 /* Don't include skipped bad blocks in size to be erased */
110 int spread;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200111};
112
113typedef struct nand_erase_options nand_erase_options_t;
114
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200115int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Wolfgang Denk4b070802008-08-14 14:41:06 +0200116 u_char *buffer);
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400117
Ben Gardinerc1354562011-06-14 16:35:05 -0400118#define WITH_YAFFS_OOB (1 << 0) /* whether write with yaffs format. This flag
119 * is a 'mode' meaning it cannot be mixed with
120 * other flags */
Ben Gardiner169d54d2011-06-14 16:35:06 -0400121#define WITH_DROP_FFS (1 << 1) /* drop trailing all-0xff pages */
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400122
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200123int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400124 u_char *buffer, int flags);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200125int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
126
127#define NAND_LOCK_STATUS_TIGHT 0x01
128#define NAND_LOCK_STATUS_LOCK 0x02
129#define NAND_LOCK_STATUS_UNLOCK 0x04
130
131int nand_lock( nand_info_t *meminfo, int tight );
132int nand_unlock( nand_info_t *meminfo, ulong start, ulong length );
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200133int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200134
Simon Schwarz12c2f1e2011-09-14 15:30:16 -0400135int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
Simon Schwarzbb085b82011-09-14 15:29:26 -0400136void nand_deselect(void);
137
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200138#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
Stefan Roese43a2b0e2006-10-20 14:28:52 +0200139void board_nand_select_device(struct nand_chip *nand, int chip);
140#endif
141
Scott Woode4c09502008-06-30 14:13:28 -0500142__attribute__((noreturn)) void nand_boot(void);
143
Wolfgang Denk932394a2005-08-17 12:55:25 +0200144#endif
Ben Gardinerc9f73512010-07-05 13:27:07 -0400145
146#ifdef CONFIG_ENV_OFFSET_OOB
147#define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
148 as block number*/
149#define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
150 stored as byte number */
151#define ENV_OFFSET_SIZE 8
152int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
153#endif