blob: b4f316f71a31a4a644ea0c805bae1acb3da6b31e [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
Jean-Christophe PLAGNIOL-VILLARDcc4a0ce2008-08-13 01:40:43 +020029#ifndef CONFIG_NAND_LEGACY
Wolfgang Denkac7eb8a32005-09-14 23:53:32 +020030#include <linux/mtd/compat.h>
Wolfgang Denk932394a2005-08-17 12:55:25 +020031#include <linux/mtd/mtd.h>
32#include <linux/mtd/nand.h>
33
34typedef struct mtd_info nand_info_t;
35
36extern int nand_curr_device;
37extern nand_info_t nand_info[];
38
Wolfgang Denk4ca79f42008-04-28 12:08:18 +020039static inline int nand_read(nand_info_t *info, off_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020040{
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +010041 return info->read(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020042}
43
Wolfgang Denk4ca79f42008-04-28 12:08:18 +020044static inline int nand_write(nand_info_t *info, off_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020045{
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +010046 return info->write(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020047}
48
Wolfgang Denk4ca79f42008-04-28 12:08:18 +020049static inline int nand_block_isbad(nand_info_t *info, off_t ofs)
Wolfgang Denk932394a2005-08-17 12:55:25 +020050{
51 return info->block_isbad(info, ofs);
52}
53
Wolfgang Denk4ca79f42008-04-28 12:08:18 +020054static inline int nand_erase(nand_info_t *info, off_t off, size_t size)
Wolfgang Denk932394a2005-08-17 12:55:25 +020055{
Wolfgang Denk8e9655f2005-11-02 14:29:12 +010056 struct erase_info instr;
57
58 instr.mtd = info;
59 instr.addr = off;
60 instr.len = size;
61 instr.callback = 0;
62
63 return info->erase(info, &instr);
Wolfgang Denk932394a2005-08-17 12:55:25 +020064}
65
Stefan Roese2255b2d2006-10-10 12:36:02 +020066
67/*****************************************************************************
68 * declarations from nand_util.c
69 ****************************************************************************/
70
71struct nand_write_options {
72 u_char *buffer; /* memory block containing image to write */
73 ulong length; /* number of bytes to write */
74 ulong offset; /* start address in NAND */
75 int quiet; /* don't display progress messages */
76 int autoplace; /* if true use auto oob layout */
77 int forcejffs2; /* force jffs2 oob layout */
78 int forceyaffs; /* force yaffs oob layout */
79 int noecc; /* write without ecc */
80 int writeoob; /* image contains oob data */
81 int pad; /* pad to page size */
82 int blockalign; /* 1|2|4 set multiple of eraseblocks
83 * to align to */
84};
85
86typedef struct nand_write_options nand_write_options_t;
William Juulcfa460a2007-10-31 13:53:06 +010087typedef struct mtd_oob_ops mtd_oob_ops_t;
Stefan Roese2255b2d2006-10-10 12:36:02 +020088
89struct nand_read_options {
90 u_char *buffer; /* memory block in which read image is written*/
91 ulong length; /* number of bytes to read */
92 ulong offset; /* start address in NAND */
93 int quiet; /* don't display progress messages */
94 int readoob; /* put oob data in image */
95};
96
97typedef struct nand_read_options nand_read_options_t;
98
99struct nand_erase_options {
100 ulong length; /* number of bytes to erase */
101 ulong offset; /* first address in NAND to erase */
102 int quiet; /* don't display progress messages */
103 int jffs2; /* if true: format for jffs2 usage
104 * (write appropriate cleanmarker blocks) */
105 int scrub; /* if true, really clean NAND by erasing
106 * bad blocks (UNSAFE) */
107};
108
109typedef struct nand_erase_options nand_erase_options_t;
110
Scott Wooddfbf6172008-06-12 13:20:16 -0500111int nand_read_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
Wolfgang Denk4b070802008-08-14 14:41:06 +0200112 u_char *buffer);
Scott Wooddfbf6172008-06-12 13:20:16 -0500113int nand_write_skip_bad(nand_info_t *nand, size_t offset, size_t *length,
Wolfgang Denk4b070802008-08-14 14:41:06 +0200114 u_char *buffer);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200115int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
116
117#define NAND_LOCK_STATUS_TIGHT 0x01
118#define NAND_LOCK_STATUS_LOCK 0x02
119#define NAND_LOCK_STATUS_UNLOCK 0x04
120
121int nand_lock( nand_info_t *meminfo, int tight );
122int nand_unlock( nand_info_t *meminfo, ulong start, ulong length );
123int nand_get_lock_status(nand_info_t *meminfo, ulong offset);
124
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200125#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
Stefan Roese43a2b0e2006-10-20 14:28:52 +0200126void board_nand_select_device(struct nand_chip *nand, int chip);
127#endif
128
Scott Woode4c09502008-06-30 14:13:28 -0500129__attribute__((noreturn)) void nand_boot(void);
130
Jean-Christophe PLAGNIOL-VILLARDcc4a0ce2008-08-13 01:40:43 +0200131#endif /* !CONFIG_NAND_LEGACY */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200132#endif