blob: cead563553196c7d4a7ba8c52e07e16807d3e2be [file] [log] [blame]
Wolfgang Denk2f9b7e42005-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 Rinie2378802016-01-14 22:05:13 -05006 * SPDX-License-Identifier: GPL-2.0
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +02007 */
8
9#ifndef _NAND_H_
10#define _NAND_H_
11
Scott Woodea0da782012-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 Shen9415b872014-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 Kushwaha895d0392013-04-04 18:44:06 +000024#if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)\
25 || defined(CONFIG_NAND_FSL_IFC)
Scott Woodea0da782012-01-12 19:42:58 -060026#define CONFIG_SYS_NAND_SELF_INIT
27#endif
Bo Shen9415b872014-03-03 14:47:16 +080028#endif
Scott Woodea0da782012-01-12 19:42:58 -060029
Scott Wood8238dd42008-07-09 17:47:52 -050030extern void nand_init(void);
Hou Zhiqiang9c8b3c72017-03-17 16:12:31 +080031unsigned long nand_size(void);
Scott Wood8238dd42008-07-09 17:47:52 -050032
Mike Frysinger11d1a092012-04-09 13:39:55 +000033#include <linux/compat.h>
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020034#include <linux/mtd/mtd.h>
Masahiro Yamada2b7a8732017-11-30 13:45:24 +090035#include <linux/mtd/rawnand.h>
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020036
Scott Wood2c1b7e12016-05-30 13:57:55 -050037int nand_mtd_to_devnum(struct mtd_info *mtd);
38
Scott Wood193a0f52012-01-12 19:07:23 -060039#ifdef CONFIG_SYS_NAND_SELF_INIT
40void board_nand_init(void);
Scott Wood2c1b7e12016-05-30 13:57:55 -050041int nand_register(int devnum, struct mtd_info *mtd);
Scott Wood193a0f52012-01-12 19:07:23 -060042#else
Mike Frysingerf7911722008-12-06 02:40:55 -050043extern int board_nand_init(struct nand_chip *nand);
Scott Wood193a0f52012-01-12 19:07:23 -060044#endif
Mike Frysingerf7911722008-12-06 02:40:55 -050045
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020046extern int nand_curr_device;
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020047
Scott Wood08364d92016-05-30 13:57:54 -050048static inline int nand_read(struct mtd_info *info, loff_t ofs, size_t *len,
49 u_char *buf)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020050{
Sergey Lapin3a38a552013-01-14 03:46:50 +000051 return mtd_read(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020052}
53
Scott Wood08364d92016-05-30 13:57:54 -050054static inline int nand_write(struct mtd_info *info, loff_t ofs, size_t *len,
55 u_char *buf)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020056{
Sergey Lapin3a38a552013-01-14 03:46:50 +000057 return mtd_write(info, ofs, *len, (size_t *)len, buf);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020058}
59
Scott Wood08364d92016-05-30 13:57:54 -050060static inline int nand_block_isbad(struct mtd_info *info, loff_t ofs)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020061{
Sergey Lapin3a38a552013-01-14 03:46:50 +000062 return mtd_block_isbad(info, ofs);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020063}
64
Scott Wood08364d92016-05-30 13:57:54 -050065static inline int nand_erase(struct mtd_info *info, loff_t off, size_t size)
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020066{
Wolfgang Denk9a08dd12005-11-02 14:29:12 +010067 struct erase_info instr;
68
69 instr.mtd = info;
70 instr.addr = off;
71 instr.len = size;
72 instr.callback = 0;
73
Sergey Lapin3a38a552013-01-14 03:46:50 +000074 return mtd_erase(info, &instr);
Wolfgang Denk2f9b7e42005-08-17 12:55:25 +020075}
76
Stefan Roesed351b2b2006-10-10 12:36:02 +020077
78/*****************************************************************************
79 * declarations from nand_util.c
80 ****************************************************************************/
81
William Juul52c07962007-10-31 13:53:06 +010082typedef struct mtd_oob_ops mtd_oob_ops_t;
Stefan Roesed351b2b2006-10-10 12:36:02 +020083
Stefan Roesed351b2b2006-10-10 12:36:02 +020084struct nand_erase_options {
Scott Wood1b5cd512010-08-25 14:43:29 -050085 loff_t length; /* number of bytes to erase */
86 loff_t offset; /* first address in NAND to erase */
Stefan Roesed351b2b2006-10-10 12:36:02 +020087 int quiet; /* don't display progress messages */
88 int jffs2; /* if true: format for jffs2 usage
89 * (write appropriate cleanmarker blocks) */
90 int scrub; /* if true, really clean NAND by erasing
91 * bad blocks (UNSAFE) */
Scott Wood1b5cd512010-08-25 14:43:29 -050092
93 /* Don't include skipped bad blocks in size to be erased */
94 int spread;
Heiko Schocher0ae98b42013-06-24 18:50:40 +020095 /* maximum size that actual may be in order to not exceed the buf */
96 loff_t lim;
Stefan Roesed351b2b2006-10-10 12:36:02 +020097};
98
99typedef struct nand_erase_options nand_erase_options_t;
100
Scott Wood08364d92016-05-30 13:57:54 -0500101int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000102 size_t *actual, loff_t lim, u_char *buffer);
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400103
Peter Tyserae6ad782015-02-03 11:58:16 -0600104#define WITH_DROP_FFS (1 << 0) /* drop trailing all-0xff pages */
105#define WITH_WR_VERIFY (1 << 1) /* verify data was written correctly */
Ben Gardiner1caafbb2011-05-24 10:18:35 -0400106
Scott Wood08364d92016-05-30 13:57:54 -0500107int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
Tom Rini32d96182013-03-14 05:32:50 +0000108 size_t *actual, loff_t lim, u_char *buffer, int flags);
Scott Wood08364d92016-05-30 13:57:54 -0500109int nand_erase_opts(struct mtd_info *mtd,
110 const nand_erase_options_t *opts);
111int nand_torture(struct mtd_info *mtd, loff_t offset);
112int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
113 loff_t ofs);
114int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200115
116#define NAND_LOCK_STATUS_TIGHT 0x01
Stefan Roesed351b2b2006-10-10 12:36:02 +0200117#define NAND_LOCK_STATUS_UNLOCK 0x04
118
Scott Wood08364d92016-05-30 13:57:54 -0500119int nand_lock(struct mtd_info *mtd, int tight);
120int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
121 int allexcept);
122int nand_get_lock_status(struct mtd_info *mtd, loff_t offset);
Stefan Roesed351b2b2006-10-10 12:36:02 +0200123
Simon Schwarz4f62e982011-09-14 15:30:16 -0400124int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
Thomas Gleixnerdaec8a42016-07-12 20:28:10 +0200125int nand_spl_read_block(int block, int offset, int len, void *dst);
Simon Schwarz992dcf72011-09-14 15:29:26 -0400126void nand_deselect(void);
127
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200128#ifdef CONFIG_SYS_NAND_SELECT_DEVICE
Stefan Roese3cdd3fd2006-10-20 14:28:52 +0200129void board_nand_select_device(struct nand_chip *nand, int chip);
130#endif
131
Scott Woodb71689b2008-06-30 14:13:28 -0500132__attribute__((noreturn)) void nand_boot(void);
133
Ben Gardiner5fc8b7f2010-07-05 13:27:07 -0400134#ifdef CONFIG_ENV_OFFSET_OOB
135#define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
136 as block number*/
137#define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
138 stored as byte number */
139#define ENV_OFFSET_SIZE 8
Scott Wood08364d92016-05-30 13:57:54 -0500140int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result);
Ben Gardiner5fc8b7f2010-07-05 13:27:07 -0400141#endif
Heiko Schocher4ff0c372014-10-31 08:31:02 +0100142int spl_nand_erase_one(int block, int page);
Boris Brezillon57f20382016-06-15 21:09:23 +0200143
144/* platform specific init functions */
145void sunxi_nand_init(void);
Mugunthan V N375ec002017-01-23 16:04:34 -0600146
Mugunthan V N7b670cc2017-06-26 19:12:51 -0500147/*
148 * get_nand_dev_by_index - Get the nand info based in index.
149 *
150 * @dev - index to the nand device.
151 *
152 * returns pointer to the nand device info structure or NULL on failure.
153 */
154struct mtd_info *get_nand_dev_by_index(int dev);
155
Mugunthan V N375ec002017-01-23 16:04:34 -0600156#endif /* _NAND_H_ */