blob: ed4ba8d2b609d4dc0bdb1d65bba4d45e5fae32d3 [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
Wolfgang Denk1a459662013-07-08 09:37:19 +020011 * version 2 as published by the Free Software Foundation.
Wolfgang Denk932394a2005-08-17 12:55:25 +020012 */
13
14#ifndef _NAND_H_
15#define _NAND_H_
16
Scott Woodc1783472012-01-12 19:42:58 -060017#include <config.h>
18
19/*
20 * All boards using a given driver must convert to self-init
21 * at the same time, so do it here. When all drivers are
22 * converted, this will go away.
23 */
Prabhakar Kushwahaa1b81ab2013-04-04 18:44:06 +000024#if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)\
25 || defined(CONFIG_NAND_FSL_IFC)
Scott Woodc1783472012-01-12 19:42:58 -060026#define CONFIG_SYS_NAND_SELF_INIT
27#endif
28
Scott Wood9d2e3942008-07-09 17:47:52 -050029extern void nand_init(void);
30
Mike Frysinger7b15e2b2012-04-09 13:39:55 +000031#include <linux/compat.h>
Wolfgang Denk932394a2005-08-17 12:55:25 +020032#include <linux/mtd/mtd.h>
33#include <linux/mtd/nand.h>
34
Scott Wood578931b2012-01-12 19:07:23 -060035#ifdef CONFIG_SYS_NAND_SELF_INIT
36void board_nand_init(void);
37int nand_register(int devnum);
38#else
Mike Frysinger69fb8be2008-12-06 02:40:55 -050039extern int board_nand_init(struct nand_chip *nand);
Scott Wood578931b2012-01-12 19:07:23 -060040#endif
Mike Frysinger69fb8be2008-12-06 02:40:55 -050041
Wolfgang Denk932394a2005-08-17 12:55:25 +020042typedef struct mtd_info nand_info_t;
43
44extern int nand_curr_device;
45extern nand_info_t nand_info[];
46
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020047static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020048{
Sergey Lapindfe64e22013-01-14 03:46:50 +000049 return mtd_read(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020050}
51
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020052static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020053{
Sergey Lapindfe64e22013-01-14 03:46:50 +000054 return mtd_write(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020055}
56
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020057static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
Wolfgang Denk932394a2005-08-17 12:55:25 +020058{
Sergey Lapindfe64e22013-01-14 03:46:50 +000059 return mtd_block_isbad(info, ofs);
Wolfgang Denk932394a2005-08-17 12:55:25 +020060}
61
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020062static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
Wolfgang Denk932394a2005-08-17 12:55:25 +020063{
Wolfgang Denk8e9655f2005-11-02 14:29:12 +010064 struct erase_info instr;
65
66 instr.mtd = info;
67 instr.addr = off;
68 instr.len = size;
69 instr.callback = 0;
70
Sergey Lapindfe64e22013-01-14 03:46:50 +000071 return mtd_erase(info, &instr);
Wolfgang Denk932394a2005-08-17 12:55:25 +020072}
73
Stefan Roese2255b2d2006-10-10 12:36:02 +020074
75/*****************************************************************************
76 * declarations from nand_util.c
77 ****************************************************************************/
78
79struct nand_write_options {
80 u_char *buffer; /* memory block containing image to write */
81 ulong length; /* number of bytes to write */
82 ulong offset; /* start address in NAND */
83 int quiet; /* don't display progress messages */
84 int autoplace; /* if true use auto oob layout */
85 int forcejffs2; /* force jffs2 oob layout */
86 int forceyaffs; /* force yaffs oob layout */
87 int noecc; /* write without ecc */
88 int writeoob; /* image contains oob data */
89 int pad; /* pad to page size */
90 int blockalign; /* 1|2|4 set multiple of eraseblocks
91 * to align to */
92};
93
94typedef struct nand_write_options nand_write_options_t;
William Juulcfa460a2007-10-31 13:53:06 +010095typedef struct mtd_oob_ops mtd_oob_ops_t;
Stefan Roese2255b2d2006-10-10 12:36:02 +020096
97struct nand_read_options {
98 u_char *buffer; /* memory block in which read image is written*/
99 ulong length; /* number of bytes to read */
100 ulong offset; /* start address in NAND */
101 int quiet; /* don't display progress messages */
102 int readoob; /* put oob data in image */
103};
104
105typedef struct nand_read_options nand_read_options_t;
106
107struct nand_erase_options {
Scott Wood30486322010-08-25 14:43:29 -0500108 loff_t length; /* number of bytes to erase */
109 loff_t offset; /* first address in NAND to erase */
Stefan Roese2255b2d2006-10-10 12:36:02 +0200110 int quiet; /* don't display progress messages */
111 int jffs2; /* if true: format for jffs2 usage
112 * (write appropriate cleanmarker blocks) */
113 int scrub; /* if true, really clean NAND by erasing
114 * bad blocks (UNSAFE) */
Scott Wood30486322010-08-25 14:43:29 -0500115
116 /* Don't include skipped bad blocks in size to be erased */
117 int spread;
Heiko Schochera67cc372013-06-24 18:50:40 +0200118 /* maximum size that actual may be in order to not exceed the buf */
119 loff_t lim;
Stefan Roese2255b2d2006-10-10 12:36:02 +0200120};
121
122typedef struct nand_erase_options nand_erase_options_t;
123
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200124int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rinic39d6a02013-03-14 05:32:50 +0000125 size_t *actual, loff_t lim, u_char *buffer);
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400126
Ben Gardinerc1354562011-06-14 16:35:05 -0400127#define WITH_YAFFS_OOB (1 << 0) /* whether write with yaffs format. This flag
128 * is a 'mode' meaning it cannot be mixed with
129 * other flags */
Ben Gardiner169d54d2011-06-14 16:35:06 -0400130#define WITH_DROP_FFS (1 << 1) /* drop trailing all-0xff pages */
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400131
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200132int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rinic39d6a02013-03-14 05:32:50 +0000133 size_t *actual, loff_t lim, u_char *buffer, int flags);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200134int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100135int nand_torture(nand_info_t *nand, loff_t offset);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200136
137#define NAND_LOCK_STATUS_TIGHT 0x01
Stefan Roese2255b2d2006-10-10 12:36:02 +0200138#define NAND_LOCK_STATUS_UNLOCK 0x04
139
Joe Hershbergereee623a2012-08-22 16:49:42 -0500140int nand_lock(nand_info_t *meminfo, int tight);
Joe Hershbergere331ab22012-08-22 16:49:43 -0500141int nand_unlock(nand_info_t *meminfo, loff_t start, size_t length,
142 int allexcept);
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200143int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200144
Simon Schwarz12c2f1e2011-09-14 15:30:16 -0400145int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
Simon Schwarzbb085b82011-09-14 15:29:26 -0400146void nand_deselect(void);
147
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200148#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
Stefan Roese43a2b0e2006-10-20 14:28:52 +0200149void board_nand_select_device(struct nand_chip *nand, int chip);
150#endif
151
Scott Woode4c09502008-06-30 14:13:28 -0500152__attribute__((noreturn)) void nand_boot(void);
153
Wolfgang Denk932394a2005-08-17 12:55:25 +0200154#endif
Ben Gardinerc9f73512010-07-05 13:27:07 -0400155
156#ifdef CONFIG_ENV_OFFSET_OOB
157#define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
158 as block number*/
159#define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
160 stored as byte number */
161#define ENV_OFFSET_SIZE 8
162int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
163#endif