blob: f0f3bf94b555d4c6055d65cdc81d30c264cdd9a9 [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 Woodc1783472012-01-12 19:42:58 -060027#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 */
Wu, Joshfe2185e2012-08-23 00:05:34 +000034#if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)
Scott Woodc1783472012-01-12 19:42:58 -060035#define CONFIG_SYS_NAND_SELF_INIT
36#endif
37
Scott Wood9d2e3942008-07-09 17:47:52 -050038extern void nand_init(void);
39
Mike Frysinger7b15e2b2012-04-09 13:39:55 +000040#include <linux/compat.h>
Wolfgang Denk932394a2005-08-17 12:55:25 +020041#include <linux/mtd/mtd.h>
42#include <linux/mtd/nand.h>
43
Scott Wood578931b2012-01-12 19:07:23 -060044#ifdef CONFIG_SYS_NAND_SELF_INIT
45void board_nand_init(void);
46int nand_register(int devnum);
47#else
Mike Frysinger69fb8be2008-12-06 02:40:55 -050048extern int board_nand_init(struct nand_chip *nand);
Scott Wood578931b2012-01-12 19:07:23 -060049#endif
Mike Frysinger69fb8be2008-12-06 02:40:55 -050050
Wolfgang Denk932394a2005-08-17 12:55:25 +020051typedef struct mtd_info nand_info_t;
52
53extern int nand_curr_device;
54extern nand_info_t nand_info[];
55
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020056static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020057{
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +010058 return info->read(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020059}
60
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020061static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020062{
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +010063 return info->write(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020064}
65
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020066static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
Wolfgang Denk932394a2005-08-17 12:55:25 +020067{
68 return info->block_isbad(info, ofs);
69}
70
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020071static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
Wolfgang Denk932394a2005-08-17 12:55:25 +020072{
Wolfgang Denk8e9655f2005-11-02 14:29:12 +010073 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);
Wolfgang Denk932394a2005-08-17 12:55:25 +020081}
82
Stefan Roese2255b2d2006-10-10 12:36:02 +020083
84/*****************************************************************************
85 * declarations from nand_util.c
86 ****************************************************************************/
87
88struct 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
103typedef struct nand_write_options nand_write_options_t;
William Juulcfa460a2007-10-31 13:53:06 +0100104typedef struct mtd_oob_ops mtd_oob_ops_t;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200105
106struct 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
114typedef struct nand_read_options nand_read_options_t;
115
116struct nand_erase_options {
Scott Wood30486322010-08-25 14:43:29 -0500117 loff_t length; /* number of bytes to erase */
118 loff_t offset; /* first address in NAND to erase */
Stefan Roese2255b2d2006-10-10 12:36:02 +0200119 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) */
Scott Wood30486322010-08-25 14:43:29 -0500124
125 /* Don't include skipped bad blocks in size to be erased */
126 int spread;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200127};
128
129typedef struct nand_erase_options nand_erase_options_t;
130
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200131int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rinic39d6a02013-03-14 05:32:50 +0000132 size_t *actual, loff_t lim, u_char *buffer);
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400133
Ben Gardinerc1354562011-06-14 16:35:05 -0400134#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 */
Ben Gardiner169d54d2011-06-14 16:35:06 -0400137#define WITH_DROP_FFS (1 << 1) /* drop trailing all-0xff pages */
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400138
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200139int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rinic39d6a02013-03-14 05:32:50 +0000140 size_t *actual, loff_t lim, u_char *buffer, int flags);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200141int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100142int nand_torture(nand_info_t *nand, loff_t offset);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200143
144#define NAND_LOCK_STATUS_TIGHT 0x01
Stefan Roese2255b2d2006-10-10 12:36:02 +0200145#define NAND_LOCK_STATUS_UNLOCK 0x04
146
Joe Hershbergereee623a2012-08-22 16:49:42 -0500147int nand_lock(nand_info_t *meminfo, int tight);
Joe Hershbergere331ab22012-08-22 16:49:43 -0500148int nand_unlock(nand_info_t *meminfo, loff_t start, size_t length,
149 int allexcept);
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200150int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200151
Simon Schwarz12c2f1e2011-09-14 15:30:16 -0400152int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
Simon Schwarzbb085b82011-09-14 15:29:26 -0400153void nand_deselect(void);
154
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200155#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
Stefan Roese43a2b0e2006-10-20 14:28:52 +0200156void board_nand_select_device(struct nand_chip *nand, int chip);
157#endif
158
Scott Woode4c09502008-06-30 14:13:28 -0500159__attribute__((noreturn)) void nand_boot(void);
160
Wolfgang Denk932394a2005-08-17 12:55:25 +0200161#endif
Ben Gardinerc9f73512010-07-05 13:27:07 -0400162
163#ifdef CONFIG_ENV_OFFSET_OOB
164#define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
165 as block number*/
166#define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
167 stored as byte number */
168#define ENV_OFFSET_SIZE 8
169int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
170#endif