blob: 7cbbbd327a61e3b3ad93263add43c10582fdb497 [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 *
Tom Rini5b8031c2016-01-14 22:05:13 -05006 * SPDX-License-Identifier: GPL-2.0
Wolfgang Denk932394a2005-08-17 12:55:25 +02007 */
8
9#ifndef _NAND_H_
10#define _NAND_H_
11
Scott Woodc1783472012-01-12 19:42:58 -060012#include <config.h>
13
14/*
15 * All boards using a given driver must convert to self-init
16 * at the same time, so do it here. When all drivers are
17 * converted, this will go away.
18 */
Bo Shen0b0b4f52014-03-03 14:47:16 +080019#ifdef CONFIG_SPL_BUILD
20#if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_FSL_IFC)
21#define CONFIG_SYS_NAND_SELF_INIT
22#endif
23#else
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
Bo Shen0b0b4f52014-03-03 14:47:16 +080028#endif
Scott Woodc1783472012-01-12 19:42:58 -060029
Scott Wood9d2e3942008-07-09 17:47:52 -050030extern void nand_init(void);
31
Mike Frysinger7b15e2b2012-04-09 13:39:55 +000032#include <linux/compat.h>
Wolfgang Denk932394a2005-08-17 12:55:25 +020033#include <linux/mtd/mtd.h>
34#include <linux/mtd/nand.h>
35
Scott Wood578931b2012-01-12 19:07:23 -060036#ifdef CONFIG_SYS_NAND_SELF_INIT
37void board_nand_init(void);
38int nand_register(int devnum);
39#else
Mike Frysinger69fb8be2008-12-06 02:40:55 -050040extern int board_nand_init(struct nand_chip *nand);
Scott Wood578931b2012-01-12 19:07:23 -060041#endif
Mike Frysinger69fb8be2008-12-06 02:40:55 -050042
Wolfgang Denk932394a2005-08-17 12:55:25 +020043typedef struct mtd_info nand_info_t;
44
45extern int nand_curr_device;
46extern nand_info_t nand_info[];
47
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020048static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020049{
Sergey Lapindfe64e22013-01-14 03:46:50 +000050 return mtd_read(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020051}
52
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020053static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020054{
Sergey Lapindfe64e22013-01-14 03:46:50 +000055 return mtd_write(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020056}
57
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020058static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
Wolfgang Denk932394a2005-08-17 12:55:25 +020059{
Sergey Lapindfe64e22013-01-14 03:46:50 +000060 return mtd_block_isbad(info, ofs);
Wolfgang Denk932394a2005-08-17 12:55:25 +020061}
62
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020063static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
Wolfgang Denk932394a2005-08-17 12:55:25 +020064{
Wolfgang Denk8e9655f2005-11-02 14:29:12 +010065 struct erase_info instr;
66
67 instr.mtd = info;
68 instr.addr = off;
69 instr.len = size;
70 instr.callback = 0;
71
Sergey Lapindfe64e22013-01-14 03:46:50 +000072 return mtd_erase(info, &instr);
Wolfgang Denk932394a2005-08-17 12:55:25 +020073}
74
Stefan Roese2255b2d2006-10-10 12:36:02 +020075
76/*****************************************************************************
77 * declarations from nand_util.c
78 ****************************************************************************/
79
William Juulcfa460a2007-10-31 13:53:06 +010080typedef struct mtd_oob_ops mtd_oob_ops_t;
Stefan Roese2255b2d2006-10-10 12:36:02 +020081
Stefan Roese2255b2d2006-10-10 12:36:02 +020082struct nand_erase_options {
Scott Wood30486322010-08-25 14:43:29 -050083 loff_t length; /* number of bytes to erase */
84 loff_t offset; /* first address in NAND to erase */
Stefan Roese2255b2d2006-10-10 12:36:02 +020085 int quiet; /* don't display progress messages */
86 int jffs2; /* if true: format for jffs2 usage
87 * (write appropriate cleanmarker blocks) */
88 int scrub; /* if true, really clean NAND by erasing
89 * bad blocks (UNSAFE) */
Scott Wood30486322010-08-25 14:43:29 -050090
91 /* Don't include skipped bad blocks in size to be erased */
92 int spread;
Heiko Schochera67cc372013-06-24 18:50:40 +020093 /* maximum size that actual may be in order to not exceed the buf */
94 loff_t lim;
Stefan Roese2255b2d2006-10-10 12:36:02 +020095};
96
97typedef struct nand_erase_options nand_erase_options_t;
98
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +020099int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rinic39d6a02013-03-14 05:32:50 +0000100 size_t *actual, loff_t lim, u_char *buffer);
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400101
Peter Tyser004a1fd2015-02-03 11:58:16 -0600102#define WITH_DROP_FFS (1 << 0) /* drop trailing all-0xff pages */
103#define WITH_WR_VERIFY (1 << 1) /* verify data was written correctly */
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400104
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200105int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
Tom Rinic39d6a02013-03-14 05:32:50 +0000106 size_t *actual, loff_t lim, u_char *buffer, int flags);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200107int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
Benoît Thébaudeau3287f6d2012-11-16 20:20:54 +0100108int nand_torture(nand_info_t *nand, loff_t offset);
Peter Tyser59b5a2a2015-02-03 11:58:12 -0600109int nand_verify_page_oob(nand_info_t *nand, struct mtd_oob_ops *ops,
110 loff_t ofs);
111int nand_verify(nand_info_t *nand, loff_t ofs, size_t len, u_char *buf);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200112
113#define NAND_LOCK_STATUS_TIGHT 0x01
Stefan Roese2255b2d2006-10-10 12:36:02 +0200114#define NAND_LOCK_STATUS_UNLOCK 0x04
115
Joe Hershbergereee623a2012-08-22 16:49:42 -0500116int nand_lock(nand_info_t *meminfo, int tight);
Joe Hershbergere331ab22012-08-22 16:49:43 -0500117int nand_unlock(nand_info_t *meminfo, loff_t start, size_t length,
118 int allexcept);
Jean-Christophe PLAGNIOL-VILLARD378adfc2009-05-16 14:27:40 +0200119int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200120
Simon Schwarz12c2f1e2011-09-14 15:30:16 -0400121int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
Simon Schwarzbb085b82011-09-14 15:29:26 -0400122void nand_deselect(void);
123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200124#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
Stefan Roese43a2b0e2006-10-20 14:28:52 +0200125void board_nand_select_device(struct nand_chip *nand, int chip);
126#endif
127
Scott Woode4c09502008-06-30 14:13:28 -0500128__attribute__((noreturn)) void nand_boot(void);
129
Wolfgang Denk932394a2005-08-17 12:55:25 +0200130#endif
Ben Gardinerc9f73512010-07-05 13:27:07 -0400131
132#ifdef CONFIG_ENV_OFFSET_OOB
133#define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
134 as block number*/
135#define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
136 stored as byte number */
137#define ENV_OFFSET_SIZE 8
138int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
139#endif
Heiko Schocher4dfd3602014-10-31 08:31:02 +0100140int spl_nand_erase_one(int block, int page);