blob: 93cbe1e25db9eb2bf3e1a8c7ec7dececd971d7e4 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0 */
Wolfgang Denk932394a2005-08-17 12:55:25 +02002/*
3 * (C) Copyright 2005
4 * 2N Telekomunikace, a.s. <www.2n.cz>
5 * Ladislav Michl <michl@2n.cz>
Wolfgang Denk932394a2005-08-17 12:55:25 +02006 */
7
8#ifndef _NAND_H_
9#define _NAND_H_
10
Scott Woodc1783472012-01-12 19:42:58 -060011#include <config.h>
12
13/*
14 * All boards using a given driver must convert to self-init
15 * at the same time, so do it here. When all drivers are
16 * converted, this will go away.
17 */
Bo Shen0b0b4f52014-03-03 14:47:16 +080018#ifdef CONFIG_SPL_BUILD
19#if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_FSL_IFC)
20#define CONFIG_SYS_NAND_SELF_INIT
21#endif
22#else
Prabhakar Kushwahaa1b81ab2013-04-04 18:44:06 +000023#if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)\
24 || defined(CONFIG_NAND_FSL_IFC)
Scott Woodc1783472012-01-12 19:42:58 -060025#define CONFIG_SYS_NAND_SELF_INIT
26#endif
Bo Shen0b0b4f52014-03-03 14:47:16 +080027#endif
Scott Woodc1783472012-01-12 19:42:58 -060028
Scott Wood9d2e3942008-07-09 17:47:52 -050029extern void nand_init(void);
Hou Zhiqiang203db382017-03-17 16:12:31 +080030unsigned long nand_size(void);
Scott Wood9d2e3942008-07-09 17:47:52 -050031
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>
Masahiro Yamada6ae39002017-11-30 13:45:24 +090034#include <linux/mtd/rawnand.h>
Wolfgang Denk932394a2005-08-17 12:55:25 +020035
Scott Woodb616d9b2016-05-30 13:57:55 -050036int nand_mtd_to_devnum(struct mtd_info *mtd);
37
Scott Wood578931b2012-01-12 19:07:23 -060038#ifdef CONFIG_SYS_NAND_SELF_INIT
39void board_nand_init(void);
Scott Woodb616d9b2016-05-30 13:57:55 -050040int nand_register(int devnum, struct mtd_info *mtd);
Scott Wood578931b2012-01-12 19:07:23 -060041#else
Mike Frysinger69fb8be2008-12-06 02:40:55 -050042extern int board_nand_init(struct nand_chip *nand);
Scott Wood578931b2012-01-12 19:07:23 -060043#endif
Mike Frysinger69fb8be2008-12-06 02:40:55 -050044
Wolfgang Denk932394a2005-08-17 12:55:25 +020045extern int nand_curr_device;
Wolfgang Denk932394a2005-08-17 12:55:25 +020046
Scott Wood151c06e2016-05-30 13:57:54 -050047static inline int nand_read(struct mtd_info *info, loff_t ofs, size_t *len,
48 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
Scott Wood151c06e2016-05-30 13:57:54 -050053static inline int nand_write(struct mtd_info *info, loff_t ofs, size_t *len,
54 u_char *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +020055{
Sergey Lapindfe64e22013-01-14 03:46:50 +000056 return mtd_write(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +020057}
58
Scott Wood151c06e2016-05-30 13:57:54 -050059static inline int nand_block_isbad(struct mtd_info *info, loff_t ofs)
Wolfgang Denk932394a2005-08-17 12:55:25 +020060{
Sergey Lapindfe64e22013-01-14 03:46:50 +000061 return mtd_block_isbad(info, ofs);
Wolfgang Denk932394a2005-08-17 12:55:25 +020062}
63
Scott Wood151c06e2016-05-30 13:57:54 -050064static inline int nand_erase(struct mtd_info *info, loff_t off, size_t size)
Wolfgang Denk932394a2005-08-17 12:55:25 +020065{
Wolfgang Denk8e9655f2005-11-02 14:29:12 +010066 struct erase_info instr;
67
68 instr.mtd = info;
69 instr.addr = off;
70 instr.len = size;
71 instr.callback = 0;
72
Sergey Lapindfe64e22013-01-14 03:46:50 +000073 return mtd_erase(info, &instr);
Wolfgang Denk932394a2005-08-17 12:55:25 +020074}
75
Stefan Roese2255b2d2006-10-10 12:36:02 +020076
77/*****************************************************************************
78 * declarations from nand_util.c
79 ****************************************************************************/
80
William Juulcfa460a2007-10-31 13:53:06 +010081typedef struct mtd_oob_ops mtd_oob_ops_t;
Stefan Roese2255b2d2006-10-10 12:36:02 +020082
Stefan Roese2255b2d2006-10-10 12:36:02 +020083struct nand_erase_options {
Scott Wood30486322010-08-25 14:43:29 -050084 loff_t length; /* number of bytes to erase */
85 loff_t offset; /* first address in NAND to erase */
Stefan Roese2255b2d2006-10-10 12:36:02 +020086 int quiet; /* don't display progress messages */
87 int jffs2; /* if true: format for jffs2 usage
88 * (write appropriate cleanmarker blocks) */
89 int scrub; /* if true, really clean NAND by erasing
90 * bad blocks (UNSAFE) */
Scott Wood30486322010-08-25 14:43:29 -050091
92 /* Don't include skipped bad blocks in size to be erased */
93 int spread;
Heiko Schochera67cc372013-06-24 18:50:40 +020094 /* maximum size that actual may be in order to not exceed the buf */
95 loff_t lim;
Stefan Roese2255b2d2006-10-10 12:36:02 +020096};
97
98typedef struct nand_erase_options nand_erase_options_t;
99
Scott Wood151c06e2016-05-30 13:57:54 -0500100int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
Tom Rinic39d6a02013-03-14 05:32:50 +0000101 size_t *actual, loff_t lim, u_char *buffer);
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400102
Peter Tyser004a1fd2015-02-03 11:58:16 -0600103#define WITH_DROP_FFS (1 << 0) /* drop trailing all-0xff pages */
104#define WITH_WR_VERIFY (1 << 1) /* verify data was written correctly */
Ben Gardinera6c9aa12011-05-24 10:18:35 -0400105
Scott Wood151c06e2016-05-30 13:57:54 -0500106int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
Tom Rinic39d6a02013-03-14 05:32:50 +0000107 size_t *actual, loff_t lim, u_char *buffer, int flags);
Scott Wood151c06e2016-05-30 13:57:54 -0500108int nand_erase_opts(struct mtd_info *mtd,
109 const nand_erase_options_t *opts);
110int nand_torture(struct mtd_info *mtd, loff_t offset);
111int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
112 loff_t ofs);
113int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200114
115#define NAND_LOCK_STATUS_TIGHT 0x01
Stefan Roese2255b2d2006-10-10 12:36:02 +0200116#define NAND_LOCK_STATUS_UNLOCK 0x04
117
Scott Wood151c06e2016-05-30 13:57:54 -0500118int nand_lock(struct mtd_info *mtd, int tight);
119int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
120 int allexcept);
121int nand_get_lock_status(struct mtd_info *mtd, loff_t offset);
Stefan Roese2255b2d2006-10-10 12:36:02 +0200122
Simon Schwarz12c2f1e2011-09-14 15:30:16 -0400123int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
Thomas Gleixnere1a89e92016-07-12 20:28:10 +0200124int nand_spl_read_block(int block, int offset, int len, void *dst);
Simon Schwarzbb085b82011-09-14 15:29:26 -0400125void nand_deselect(void);
126
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200127#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
Stefan Roese43a2b0e2006-10-20 14:28:52 +0200128void board_nand_select_device(struct nand_chip *nand, int chip);
129#endif
130
Scott Woode4c09502008-06-30 14:13:28 -0500131__attribute__((noreturn)) void nand_boot(void);
132
Ben Gardinerc9f73512010-07-05 13:27:07 -0400133#ifdef CONFIG_ENV_OFFSET_OOB
134#define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
135 as block number*/
136#define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
137 stored as byte number */
138#define ENV_OFFSET_SIZE 8
Scott Wood151c06e2016-05-30 13:57:54 -0500139int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result);
Ben Gardinerc9f73512010-07-05 13:27:07 -0400140#endif
Heiko Schocher4dfd3602014-10-31 08:31:02 +0100141int spl_nand_erase_one(int block, int page);
Boris Brezillon4ccae812016-06-15 21:09:23 +0200142
143/* platform specific init functions */
144void sunxi_nand_init(void);
Mugunthan V N2afc7412017-01-23 16:04:34 -0600145
Mugunthan V Nad92dff2017-06-26 19:12:51 -0500146/*
147 * get_nand_dev_by_index - Get the nand info based in index.
148 *
149 * @dev - index to the nand device.
150 *
151 * returns pointer to the nand device info structure or NULL on failure.
152 */
153struct mtd_info *get_nand_dev_by_index(int dev);
154
Mugunthan V N2afc7412017-01-23 16:04:34 -0600155#endif /* _NAND_H_ */